Struct bedrock::resources::ImageUsage

pub struct ImageUsage(pub VkImageUsageFlags);

Bitmask specifying intended usage of an image

Methods

impl ImageUsage

pub const TRANSFER_SRC: Self

The image can be used as the source of a transfer command

pub const TRANSFER_DEST: Self

The image can be used as the destination of a transfer command

pub const SAMPLED: Self

The image can be used to create ImageView suitable for occupying a DescriptorSet slot either of type DescriptorType::SampledImage or DescriptorType::CombinedImageSampler, and be sampled by a shader

pub const STORAGE: Self

The image can be used to create a ImageView suitable for occupying a DescriptorSet slot of type DescriptorType::StorageImage

pub const COLOR_ATTACHMENT: Self

The image can be used to create a ImageView suitable for use as a color or resolve attachment in a Framebuffer

pub const DEPTH_STENCIL_ATTACHMENT: Self

The image can be used to create a ImageView suitable for use as a depth/stencil attachment in a Framebuffer

pub const TRANSIENT_ATTACHMENT: Self

The memory bound to this image will have been allocated with the VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT This bit can be set for any image that can be used to create a ImageView suitable for use as a color, resolve, depth/stencil, or input attachment

pub const INPUT_ATTACHMENT: Self

The image can be used to create a ImageView suitable for occupying DescriptorSet slot of type DescriptorType::InputAttachment; be read from a shader as an input attachment; and be used as an input attachment in a framebuffer

pub fn transfer_src(self) -> Self

The image can be used as the source of a transfer command

pub fn transfer_dest(self) -> Self

The image can be used as the destination of a transfer command

pub fn sampled(self) -> Self

The image can be used to create ImageView suitable for occupying a DescriptorSet slot either of type DescriptorType::SampledImage or DescriptorType::CombinedImageSampler, and be sampled by a shader

pub fn storage(self) -> Self

The image can be used to create a ImageView suitable for occupying a DescriptorSet slot of type DescriptorType::StorageImage

pub fn color_attachment(self) -> Self

The image can be used to create a ImageView suitable for use as a color or resolve attachment in a Framebuffer

pub fn depth_stencil_attachment(self) -> Self

The image can be used to create a ImageView suitable for use as a depth/stencil attachment in a Framebuffer

pub fn transient_attachment(self) -> Self

The memory bound to this image will have been allocated with the VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT This bit can be set for any image that can be used to create a ImageView suitable for use as a color, resolve, depth/stencil, or input attachment

pub fn input_attachment(self) -> Self

The image can be used to create a ImageView suitable for occupying DescriptorSet slot of type DescriptorType::InputAttachment; be read from a shader as an input attachment; and be used as an input attachment in a framebuffer

Trait Implementations

impl Clone for ImageUsage

fn clone(&self) -> ImageUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ImageUsage

impl Debug for ImageUsage

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

Formats the value using the given formatter.

impl Eq for ImageUsage

impl PartialEq<ImageUsage> for ImageUsage

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

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

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

This method tests for !=.

impl StructuralEq for ImageUsage

impl StructuralPartialEq for ImageUsage