Struct Dx9Header 

pub struct Dx9Header {
    pub height: u32,
    pub width: u32,
    pub depth: Option<u32>,
    pub mipmap_count: NonZeroU32,
    pub caps2: Caps2,
    pub pixel_format: Dx9PixelFormat,
}

DX9-specific header data.

Fields

height: u32

Surface height (in pixels).

width: u32

Surface width (in pixels).

depth: Option<u32>

Depth of a volume texture (in pixels).

mipmap_count: NonZeroU32

Number of mipmap levels.

caps2: Caps2

Additional detail about the surfaces stored.

pixel_format: Dx9PixelFormat

Implementations

impl Dx9Header

pub const fn alpha_mode(&self) -> AlphaMode

Returns the alpha mode of the pixel format.

This will mostly be AlphaMode::Unknown because DX9 doesn’t have a concept of alpha modes. However, DXT2 and DXT4 formats are specified to be premultiplied alpha and will return AlphaMode::Premultiplied.

pub const fn is_cube_map(&self) -> bool

Whether this header describes a cube map by checking for the Caps2::CUBE_MAP flag.

Note: DX9 supports partial cube maps, which will also return true. See Dx9Header::cube_map_faces.

pub fn cube_map_faces(&self) -> Option<CubeMapFaces>

Returns the cube map faces iff this header describes a cube map.

pub const fn is_volume(&self) -> bool

Whether this header describes a volume texture by checking for the Caps2::VOLUME flag.

pub const fn new_image(width: u32, height: u32, format: Dx9PixelFormat) -> Self

Creates a new header for DX10 texture 2D with the given dimensions and format.

The mipmap count is set to 1.

pub const fn new_volume( width: u32, height: u32, depth: u32, format: Dx9PixelFormat, ) -> Self

Creates a new header for DX10 texture 3D with the given dimensions and format.

The mipmap count is set to 1.

pub const fn new_cube_map( width: u32, height: u32, format: Dx9PixelFormat, ) -> Self

Creates a new header for DX9 cube map with the given dimensions and format.

The mipmap count is set to 1 and the cube map faces are set.

pub fn with_size(self, size: Size) -> Self

A builder-pattern-style method to set the width and height of the header.

Depth will be set to None. If you want to leave the depth unchanged or change it as well, use Self::with_dimensions.

pub fn with_dimensions( self, width: u32, height: u32, depth: Option<u32>, ) -> Self

A builder-pattern-style method to set the width, height, and depth of the header.

For headers of 2D textures, Self::with_size is more appropriate.

pub fn with_mipmap_count(self, mipmap_count: NonZeroU32) -> Self

A builder-pattern-style method to set the mipmap count of the header.

pub fn with_cube_map_faces(self, faces: CubeMapFaces) -> Self

A builder-pattern-style method to set the cube map faces of the header.

This will set the Caps2::CUBE_MAP flag and the flags of all given faces. Faces not given will have their flags unset.

pub fn with_pixel_format(self, pixel_format: Dx9PixelFormat) -> Self

A builder-pattern-style method to set the pixel format of the header.

pub fn to_dx10(&self) -> Option<Dx10Header>

Trait Implementations

impl Clone for Dx9Header

fn clone(&self) -> Dx9Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dx9Header

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

Formats the value using the given formatter.

impl Eq for Dx9Header

impl From<Dx9Header> for Header

fn from(header: Dx9Header) -> Self

Converts to this type from the input type.

impl Hash for Dx9Header

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Dx9Header

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Dx9Header