Enum basis_universal::transcoding::TranscoderTextureFormat

#[repr(i32)]pub enum TranscoderTextureFormat {
    ETC1_RGB,
    ETC2_RBG,
    BC1_RGB,
    BC3_RGBA,
    BC4_R,
    BC5_RG,
    BC7_RGBA,
    PVRTC1_4_RGB,
    PVRTC1_4_RGBA,
    ASTC_4x4_RGBA,
    ATC_RGB,
    ATC_RGBA,
    FXT1_RGB,
    PVRTC2_4_RGB,
    PVRTC2_4_RGBA,
    ETC2_EAC_R11,
    ETC2_EAC_RG11,
    RGBA32,
    RGB565,
    BGR565,
    RGBA4444,
}

The texture format to transcode basis-universal data into

Variants

ETC1_RGB

Opaque only, returns RGB or alpha data if cDecodeFlagsTranscodeAlphaDataToOpaqueFormats flag is specified

ETC2_RBG

Opaque+alpha, ETC2_EAC_A8 block followed by a ETC1 block, alpha channel will be opaque for opaque .basis files

BC1_RGB

Opaque only, no punchthrough alpha support yet, transcodes alpha slice if cDecodeFlagsTranscodeAlphaDataToOpaqueFormats flag is specified

BC3_RGBA

Opaque+alpha, BC4 followed by a BC1 block, alpha channel will be opaque for opaque .basis files

BC4_R

Red only, alpha slice is transcoded to output if cDecodeFlagsTranscodeAlphaDataToOpaqueFormats flag is specified

BC5_RG

XY: Two BC4 blocks, X=R and Y=Alpha, .basis file should have alpha data (if not Y will be all 255’s)

BC7_RGBA

RGB or RGBA, mode 5 for ETC1S, modes (1,2,3,5,6,7) for UASTC

PVRTC1_4_RGB

Opaque only, RGB or alpha if cDecodeFlagsTranscodeAlphaDataToOpaqueFormats flag is specified, nearly lowest quality of any texture format.

PVRTC1_4_RGBA

Opaque+alpha, most useful for simple opacity maps. If .basis file doesn’t have alpha cTFPVRTC1_4_RGB will be used instead. Lowest quality of any supported texture format.

ASTC_4x4_RGBA

Opaque+alpha, ASTC 4x4, alpha channel will be opaque for opaque .basis files. Transcoder uses RGB/RGBA/L/LA modes, void extent, and up to two ([0,47] and [0,255]) endpoint precisions.

ATC_RGB

Opaque, RGB or alpha if cDecodeFlagsTranscodeAlphaDataToOpaqueFormats flag is specified. ATI ATC (GL_ATC_RGB_AMD)

ATC_RGBA

Opaque+alpha, alpha channel will be opaque for opaque .basis files. ATI ATC (GL_ATC_RGBA_INTERPOLATED_ALPHA_AMD)

FXT1_RGB

Opaque only, uses exclusively CC_MIXED blocks. Notable for having a 8x4 block size. GL_3DFX_texture_compression_FXT1 is supported on Intel integrated GPU’s (such as HD 630). Punch-through alpha is relatively easy to support, but full alpha is harder. This format is only here for completeness so opaque-only is fine for now. See the BASISU_USE_ORIGINAL_3DFX_FXT1_ENCODING macro in basisu_transcoder_internal.h.

PVRTC2_4_RGB

Opaque-only, almost BC1 quality, much faster to transcode and supports arbitrary texture dimensions (unlike PVRTC1 RGB).

PVRTC2_4_RGBA

Opaque+alpha, slower to encode than cTFPVRTC2_4_RGB. Premultiplied alpha is highly recommended, otherwise the color channel can leak into the alpha channel on transparent blocks.

ETC2_EAC_R11

R only (ETC2 EAC R11 unsigned)

ETC2_EAC_RG11

RG only (ETC2 EAC RG11 unsigned), R=opaque.r, G=alpha - for tangent space normal maps

RGBA32

32bpp RGBA image stored in raster (not block) order in memory, R is first byte, A is last byte.

RGB565

16bpp RGB image stored in raster (not block) order in memory, R at bit position 11

BGR565

16bpp RGB image stored in raster (not block) order in memory, R at bit position 0

RGBA4444

16bpp RGBA image stored in raster (not block) order in memory, R at bit position 12, A at bit position 0

Implementations

impl TranscoderTextureFormat

pub fn bytes_per_block_or_pixel(self) -> u32

For compressed texture formats, this returns the # of bytes per block. For uncompressed, it returns the # of bytes per pixel. NOTE: Previously, this function was called basis_get_bytes_per_block(), and it always returned 16*bytes_per_pixel for uncompressed formats which was confusing.

pub fn format_name(self) -> &'static str

Returns format’s name in ASCII

pub fn has_alpha(self) -> bool

Returns true if the format supports an alpha channel.

pub fn is_compressed(self) -> bool

Returns true if the transcoder texture type is an uncompressed (raw pixel) format.

pub fn uncompressed_bytes_per_pixel(self) -> u32

Returns the # of bytes per pixel for uncompressed formats, or 0 for block texture formats.

pub fn block_width(self) -> u32

Returns the block width for the specified texture format, which is currently either 4 or 8 for FXT1.

pub fn block_height(self) -> u32

Returns the block height for the specified texture format, which is currently always 4.

pub fn can_transcode_from_format(
    self,
    basis_texture_format: BasisTextureFormat
) -> bool

Returns true if the specified format was enabled at compile time.

pub fn calculate_minimum_output_buffer_blocks_or_pixels(
    self,
    original_width: u32,
    original_height: u32,
    total_slice_blocks: u32,
    output_row_pitch_in_blocks_or_pixels: Option<u32>,
    output_rows_in_pixels: Option<u32>
) -> u32

Calculate the minimum output buffer required to store transcoded data in blocks for compressed formats and pixels for uncompressed formats

pub fn calculate_minimum_output_buffer_bytes(
    self,
    original_width: u32,
    original_height: u32,
    total_slice_blocks: u32,
    output_row_pitch_in_blocks_or_pixels: Option<u32>,
    output_rows_in_pixels: Option<u32>
) -> u32

Calculate the minimum output buffer required to store transcoded data in bytes

pub fn validate_output_buffer_size(
    self,
    output_blocks_buf_size_in_blocks_or_pixels: u32,
    original_width: u32,
    original_height: u32,
    total_slice_blocks: u32,
    output_row_pitch_in_blocks_or_pixels: Option<u32>,
    output_rows_in_pixels: Option<u32>
) -> bool

Verify that the buffer size is large enough for the transcoded data

Trait Implementations

impl Clone for TranscoderTextureFormat

fn clone(&self) -> TranscoderTextureFormat

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TranscoderTextureFormat

impl Debug for TranscoderTextureFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<i32> for TranscoderTextureFormat

fn from(value: basist_transcoder_texture_format) -> Self

Performs the conversion.

impl Into<i32> for TranscoderTextureFormat

fn into(self) -> basist_transcoder_texture_format

Performs the conversion.

impl PartialEq<TranscoderTextureFormat> for TranscoderTextureFormat

fn eq(&self, other: &TranscoderTextureFormat) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for TranscoderTextureFormat