Enum gfx_core::texture::Kind

pub enum Kind {
    D1(Size),
    D1Array(Size, Layer),
    D2(Size, Size, AaMode),
    D2Array(Size, Size, Layer, AaMode),
    D3(Size, Size, Size),
    Cube(Size),
    CubeArray(Size, Layer),
}

[−] Expand description

Specifies the kind of a texture storage to be allocated.

Variants

D1(Size)

[−] Expand description

A single row of texels.

D1Array(Size, Layer)

[−] Expand description

An array of rows of texels. Equivalent to Texture2D except that texels in a different row are not sampled.

D2(Size, Size, AaMode)

[−] Expand description

A traditional 2D texture, with rows arranged contiguously.

D2Array(Size, Size, Layer, AaMode)

[−] Expand description

An array of 2D textures. Equivalent to Texture3D except that texels in a different depth level are not sampled.

D3(Size, Size, Size)

[−] Expand description

A volume texture, with each 2D layer arranged contiguously.

Cube(Size)

[−] Expand description

A set of 6 2D textures, one for each face of a cube.

CubeArray(Size, Layer)

[−] Expand description

An array of Cube textures.

Implementations

impl Kind[−]

pub fn get_dimensions(&self) -> Dimensions[−]

Get texture dimensions, with 0 values where not applicable.

pub fn get_level_dimensions(&self, level: Level) -> Dimensions[−]

Get the dimensionality of a particular mipmap level.

pub fn get_num_levels(&self) -> Level[−]

Count the number of mipmap levels.

pub fn get_num_slices(&self) -> Option<Layer>[−]

Return the number of slices for an array, or None for non-arrays.

pub fn is_cube(&self) -> bool[−]

Check if it’s one of the cube kinds.

Trait Implementations

impl Clone for Kind[+]

[+] Show hidden undocumented items

fn clone(&self) -> Kind[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Kind

impl Debug for Kind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for Kind

impl Hash for Kind[+]

[+] Show hidden undocumented items

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Kind[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Kind) -> Ordering[−]

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<Kind> for Kind[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Kind) -> bool[−]

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

fn ne(&self, other: &Kind) -> bool[−]

This method tests for !=.

impl PartialOrd<Kind> for Kind[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Kind) -> Option<Ordering>[−]

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

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn le(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool[−]

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

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool[−]

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

impl StructuralEq for Kind

impl StructuralPartialEq for Kind