Enum ImageLayoutType

#[non_exhaustive]
pub enum ImageLayoutType {
    Optimal,
    General,
}

Specifies which type of layout an image resource is accessed in.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Optimal

The image is accessed in an optimal layout. This is what you should be using most of the time.

The optimal layout depends on the access type. For instance, for color attachment output, the only valid optimal layout is ColorAttachmentOptimal. For transfer sources, it’s TransferSrcOptimal, and so on. Some access types don’t have an optimal layout for them. In such cases, using this option makes no difference, as the general layout will always be used.

General

The image is accessed in the general layout. This layout may be less efficient to access on some hardware than an optimal layout. However, you may still want to use it in certain cases if you want to minimize the number of layout transitions.

Implementations

impl ImageLayoutType

pub const fn is_optimal(self) -> bool

Returns true if the layout type is Optimal.

pub const fn is_general(self) -> bool

Returns true if the layout type is General.

Trait Implementations

impl Clone for ImageLayoutType

fn clone(&self) -> ImageLayoutType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageLayoutType

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

Formats the value using the given formatter.

impl Hash for ImageLayoutType

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 PartialEq for ImageLayoutType

fn eq(&self, other: &ImageLayoutType) -> 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 Copy for ImageLayoutType

impl Eq for ImageLayoutType

impl StructuralPartialEq for ImageLayoutType