Enum vulkano::image::ImageAspect

#[non_exhaustive]
#[repr(u32)]
pub enum ImageAspect {
    Color = 1,
    Depth = 2,
    Stencil = 4,
    Metadata = 8,
    Plane0 = 16,
    Plane1 = 32,
    Plane2 = 64,
    MemoryPlane0 = 128,
    MemoryPlane1 = 256,
    MemoryPlane2 = 512,
    MemoryPlane3 = 1_024,
}

An individual data type within an image.

Most images have only the Color aspect, but some may have others.

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.

Color = 1

The single aspect of images with a color format, or the combined aspect of all planes of images with a multi-planar format.

Depth = 2

The single aspect of images with a depth format, or one of the two aspects of images with a combined depth/stencil format.

Stencil = 4

The single aspect of images with a stencil format, or one of the two aspects of images with a combined depth/stencil format.

Metadata = 8

An aspect used with sparse memory on some implementations, to hold implementation-defined metadata of an image.

Plane0 = 16

The first plane of an image with a multi-planar format, holding the green color component.

Plane1 = 32

The second plane of an image with a multi-planar format, holding the blue color component if the format has three planes, and a combination of blue and red if the format has two planes.

Plane2 = 64

The third plane of an image with a multi-planar format, holding the red color component.

MemoryPlane0 = 128

The first memory plane of images created through the ext_image_drm_format_modifier extension.

MemoryPlane1 = 256

The second memory plane of images created through the ext_image_drm_format_modifier extension.

MemoryPlane2 = 512

The third memory plane of images created through the ext_image_drm_format_modifier extension.

MemoryPlane3 = 1_024

The fourth memory plane of images created through the ext_image_drm_format_modifier extension.

Trait Implementations

impl Clone for ImageAspect

fn clone(&self) -> ImageAspect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageAspect

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

Formats the value using the given formatter.

impl From<ImageAspect> for ImageAspectFlags

fn from(val: ImageAspect) -> Self

Converts to this type from the input type.

impl From<ImageAspect> for ImageAspects

fn from(val: ImageAspect) -> Self

Converts to this type from the input type.

impl FromIterator<ImageAspect> for ImageAspects

fn from_iter<T>(iter: T) -> Selfwhere T: IntoIterator<Item = ImageAspect>,

Creates a value from an iterator.

impl Hash for ImageAspect

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 ImageAspect

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

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

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

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

impl TryFrom<ImageAspectFlags> for ImageAspect

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: ImageAspectFlags) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for ImageAspect

impl Eq for ImageAspect

impl StructuralEq for ImageAspect

impl StructuralPartialEq for ImageAspect