Struct Dds 

pub struct Dds {
    pub header: Header,
    pub data: Vec<u8>,
    pub source_flavor: DdsSourceFlavor,
}

In-memory DDS container.

Fields

header: Header

Standard DDS header.

data: Vec<u8>

Raw surface payload bytes.

source_flavor: DdsSourceFlavor

Source container flavor used on decode.

Implementations

impl Dds

pub fn new_d3d(params: DdsNewD3dParams) -> Result<Self, DdsBinaryError>

Creates a DDS container with a D3D format.

Errors

DdsBinaryError::InvalidHeader when params.format is DXT3, which vanilla never writes and this crate refuses to produce, and DdsBinaryError::Ddsfile when the dimensions or mipmap count do not describe a buildable surface.

pub fn width(&self) -> u32

Returns the image width from the DDS header.

pub fn height(&self) -> u32

Returns the image height from the DDS header.

pub fn depth(&self) -> u32

Returns depth for 3D textures; defaults to 1 for 2D textures.

pub fn mipmap_levels(&self) -> u32

Returns the mipmap level count (at least 1).

pub fn array_layers(&self) -> u32

Returns the array-layer count derived from headers.

pub fn is_cubemap(&self) -> bool

Returns whether the container is marked as a cubemap.

pub fn d3d_format(&self) -> Option<DdsD3dFormat>

Returns the parsed D3D format when representable from pixel format fields.

Trait Implementations

impl Clone for Dds

fn clone(&self) -> Dds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dds

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

Formats the value using the given formatter.

impl DecodeBinary for Dds

type Error = DdsBinaryError

Error type used by the format.

fn decode_binary(bytes: &[u8]) -> Result<Self, Self::Error>

Decodes a value from raw bytes.

impl EncodeBinary for Dds

type Error = DdsBinaryError

Error type used by the format.

fn encode_binary(&self) -> Result<Vec<u8>, Self::Error>

Encodes a value into an owned byte buffer.