Struct BlpHeader

pub struct BlpHeader {
    pub version: BlpVersion,
    pub content: BlpContentTag,
    pub flags: BlpFlags,
    pub width: u32,
    pub height: u32,
    pub mipmap_locator: MipmapLocator,
}

Fields

version: BlpVersion

content: BlpContentTag

flags: BlpFlags

width: u32

height: u32

mipmap_locator: MipmapLocator

Implementations

impl BlpHeader

pub fn mipmaps_count(&self) -> usize

Calculate needed count of mipmaps for the defined size

pub fn has_mipmaps(&self) -> bool

Returns ‘true’ if the header defines that the image has mipmaps

pub fn mipmap_size(&self, i: usize) -> (u32, u32)

Return expected size of mipmap for the given mipmap level. 0 level means original image.

pub fn mipmap_pixels(&self, i: usize) -> u32

Return expected count of pixels in mipmap at the level i. 0 level means original image.

pub fn alpha_bits(&self) -> u32

Return alpha bits count in encoding

pub fn internal_mipmaps(&self) -> Option<([u32; 16], [u32; 16])>

Return offsets and sizes of internal mipmaps. For external returns None

pub fn size(version: BlpVersion) -> usize

Get size of header in bytes. Doesn’t count jpeg header or color map.

Trait Implementations

impl Clone for BlpHeader

fn clone(&self) -> BlpHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlpHeader

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

Formats the value using the given formatter.

impl Default for BlpHeader

fn default() -> Self

Returns the “default value” for a type.

impl Hash for BlpHeader

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 Ord for BlpHeader

fn cmp(&self, other: &BlpHeader) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BlpHeader

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BlpHeader

fn partial_cmp(&self, other: &BlpHeader) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for BlpHeader

impl StructuralPartialEq for BlpHeader