Enum gfx_hal::image::Kind

pub enum Kind {
    D1(Size, Layer),
    D2(Size, Size, Layer, NumSamples),
    D3(Size, Size, Size),
}

Specifies the dimensionality of an image to be allocated, along with the number of mipmap layers and MSAA samples if applicable.

Variants

D1(Size, Layer)

A single one-dimensional row of texels.

D2(Size, Size, Layer, NumSamples)

Two-dimensional image.

D3(Size, Size, Size)

Volumetric image.

Methods

impl Kind

pub fn extent(&self) -> Extent

Get the image extent.

pub fn level_extent(&self, level: Level) -> Extent

Get the extent of a particular mipmap level.

pub fn num_levels(&self) -> Level

Count the number of mipmap levels.

pub fn num_layers(&self) -> Layer

Return the number of layers in an array type.

Each cube face counts as separate layer.

pub fn num_samples(&self) -> NumSamples

Return the number of MSAA samples for the kind.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Kind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Kind

impl Debug for Kind

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

Formats the value using the given formatter.

impl Eq for Kind

impl Hash for Kind

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, 

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

impl Ord for Kind

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Kind> for Kind

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

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

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

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

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

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

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

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

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

fn ge(&self, other: &Kind) -> 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