Struct ddsfile::Header

pub struct Header {
    pub height: u32,
    pub width: u32,
    pub pitch: Option<u32>,
    pub linear_size: Option<u32>,
    pub depth: Option<u32>,
    pub mip_map_count: Option<u32>,
    pub spf: PixelFormat,
    pub caps: Caps,
    pub caps2: Caps2,
    // some fields omitted
}

Fields

height: u32

Surface height (in pixels)

width: u32

Surface width (in pixels)

pitch: Option<u32>

The pitch or number of bytes per scan line in an uncompressed texture;

linear_size: Option<u32>

The total number of bytes in a top level texture for a compressed texture

depth: Option<u32>

Depth of a volume texture (in pixels)

mip_map_count: Option<u32>

Number of mipmap levels

spf: PixelFormat

The pixel format

caps: Caps

Specifies the complexity of the surfaces stored.

caps2: Caps2

Additional detail about the surfaces stored

Methods

impl Header

pub fn new_d3d(
    height: u32,
    width: u32,
    depth: Option<u32>,
    format: D3DFormat,
    mipmap_levels: Option<u32>,
    caps2: Option<Caps2>
) -> Result<Header, Error>

pub fn new_dxgi(
    height: u32,
    width: u32,
    depth: Option<u32>,
    format: DxgiFormat,
    mipmap_levels: Option<u32>,
    array_layers: Option<u32>,
    caps2: Option<Caps2>
) -> Result<Header, Error>

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

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

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Header

fn default() -> Header

Returns the "default value" for a type.

impl Debug for Header

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

Formats the value using the given formatter.