Struct vulkano::image::ImageAspect

pub struct ImageAspect {
    pub color: bool,
    pub depth: bool,
    pub stencil: bool,
    pub metadata: bool,
    pub plane0: bool,
    pub plane1: bool,
    pub plane2: bool,
    pub memory_plane0: bool,
    pub memory_plane1: bool,
    pub memory_plane2: bool,
}

Describes how an aspect of the image that be used to query Vulkan. This is not just a suggestion. Check out VkImageAspectFlagBits in the Vulkan spec.

If you specify an aspect of the image that doesn’t exist (for example, depth for a YUV image), a panic will happen.

Fields

color: bool

depth: bool

stencil: bool

metadata: bool

plane0: bool

plane1: bool

plane2: bool

memory_plane0: bool

memory_plane1: bool

memory_plane2: bool

Implementations

impl ImageAspect

pub fn none() -> ImageAspect

Builds a ImageAspect with all values set to false. Useful as a default value.

Example

use vulkano::image::ImageAspect as ImageAspect;

let _aspect = ImageAspect {
    color: true,
    depth: true,
    .. ImageAspect::none()
};

Trait Implementations

impl BitOr<ImageAspect> for ImageAspect

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for ImageAspect

fn clone(&self) -> ImageAspect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ImageAspect

impl Debug for ImageAspect

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

Formats the value using the given formatter.

impl Eq for ImageAspect

impl Hash for ImageAspect

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 PartialEq<ImageAspect> 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: &ImageAspect) -> bool

This method tests for !=.

impl StructuralEq for ImageAspect

impl StructuralPartialEq for ImageAspect