Struct ddsfile::PixelFormat

pub struct PixelFormat {
    pub size: u32,
    pub flags: PixelFormatFlags,
    pub fourcc: Option<FourCC>,
    pub rgb_bit_count: Option<u32>,
    pub r_bit_mask: Option<u32>,
    pub g_bit_mask: Option<u32>,
    pub b_bit_mask: Option<u32>,
    pub a_bit_mask: Option<u32>,
}

Fields

size: u32

Size of this structure in bytes; set to 32

flags: PixelFormatFlags

Values which indicate what type of data is in the surface

fourcc: Option<FourCC>

Codes for specifying compressed or custom formats.

rgb_bit_count: Option<u32>

Number of bits in an RGB (possibly including alpha) format. Valid when flags includes RGB or LUMINANCE.

r_bit_mask: Option<u32>

Red (or Y) mask for reading color data. For instance, given the A8R8G8B8 format, the red mask would be 0x00ff0000.

g_bit_mask: Option<u32>

Green (or U) mask for reading color data. For instance, given the A8R8G8B8 format, the green mask would be 0x0000ff00.

b_bit_mask: Option<u32>

Blue (or V) mask for reading color data. For instance, given the A8R8G8B8 format, the blue mask would be 0x000000ff

a_bit_mask: Option<u32>

Alpha mask for reading alpha data. Valid of flags includes ALPHA_PIXELS or ALPHA. For instance, given the A8R8G8B8 format, the alpha mask would be 0xff000000

Methods

impl PixelFormat

pub fn read<R: Read>(r: &mut R) -> Result<PixelFormat, Error>

pub fn write<W: Write>(&self, w: &mut W) -> Result<(), Error>

Trait Implementations

impl From<D3DFormat> for PixelFormat

fn from(format: D3DFormat) -> PixelFormat

Performs the conversion.

impl From<DxgiFormat> for PixelFormat

fn from(format: DxgiFormat) -> PixelFormat

Performs the conversion.

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PixelFormat

fn default() -> PixelFormat

Returns the "default value" for a type.

impl Debug for PixelFormat

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

Formats the value using the given formatter.