Struct gfx::texture::ImageInfoCommon

pub struct ImageInfoCommon<F> {
    pub xoffset: u16,
    pub yoffset: u16,
    pub zoffset: u16,
    pub width: u16,
    pub height: u16,
    pub depth: u16,
    pub format: F,
    pub mipmap: u8,
}

Describes a subvolume of a texture, which image data can be uploaded into.

Fields

xoffset: u16

yoffset: u16

zoffset: u16

width: u16

height: u16

depth: u16

format: F

Format of each texel.

mipmap: u8

Which mipmap to select.

Methods

impl<F> ImageInfoCommon<F>

pub fn get_texel_count(&self) -> usize

Get the total number of texels.

pub fn convert<T>(&self, new_format: T) -> ImageInfoCommon<T>

Convert into a differently typed format.

pub fn is_inside(&self, (u16, u16, u16, AaMode)) -> bool

Check if it fits inside given dimensions.

impl ImageInfoCommon<Format>

pub fn get_byte_count(&self) -> usize

Get the total number of bytes.

Trait Implementations

impl<F> Ord for ImageInfoCommon<F> where
    F: Ord, 

fn cmp(&self, other: &ImageInfoCommon<F>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<F> Eq for ImageInfoCommon<F> where
    F: Eq, 

impl<F> Clone for ImageInfoCommon<F> where
    F: Clone, 

fn clone(&self) -> ImageInfoCommon<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> PartialOrd<ImageInfoCommon<F>> for ImageInfoCommon<F> where
    F: PartialOrd<F>, 

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

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

fn lt(&self, other: &ImageInfoCommon<F>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ImageInfoCommon<F>) -> bool

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

fn gt(&self, other: &ImageInfoCommon<F>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ImageInfoCommon<F>) -> bool

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

impl<F> Copy for ImageInfoCommon<F> where
    F: Copy, 

impl<F> PartialEq<ImageInfoCommon<F>> for ImageInfoCommon<F> where
    F: PartialEq<F>, 

fn eq(&self, other: &ImageInfoCommon<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ImageInfoCommon<F>) -> bool

This method tests for !=.

impl<F> Hash for ImageInfoCommon<F> where
    F: Hash, 

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<F> Debug for ImageInfoCommon<F> where
    F: Debug, 

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

Formats the value using the given formatter.