Struct vulkano::image::ImageUsage

pub struct ImageUsage {
    pub transfer_source: bool,
    pub transfer_destination: bool,
    pub sampled: bool,
    pub storage: bool,
    pub color_attachment: bool,
    pub depth_stencil_attachment: bool,
    pub transient_attachment: bool,
    pub input_attachment: bool,
}

Describes how an image is going to be used. This is not just an optimization.

If you try to use an image in a way that you didn’t declare, a panic will happen.

If transient_attachment is true, then only color_attachment, depth_stencil_attachment and input_attachment can be true as well. The rest must be false or an error will be returned when creating the image.

Fields

transfer_source: bool

Can be used as a source for transfers. Includes blits.

transfer_destination: bool

Can be used as a destination for transfers. Includes blits.

sampled: bool

Can be sampled from a shader.

storage: bool

Can be used as an image storage in a shader.

color_attachment: bool

Can be attached as a color attachment to a framebuffer.

depth_stencil_attachment: bool

Can be attached as a depth, stencil or depth-stencil attachment to a framebuffer.

transient_attachment: bool

Indicates that this image will only ever be used as a temporary framebuffer attachment. As soon as you leave a render pass, the content of transient images becomes undefined.

This is a hint to the Vulkan implementation that it may not need allocate any memory for this image if the image can live entirely in some cache.

input_attachment: bool

Can be used as an input attachment. In other words, you can draw to it in a subpass then read from it in a following pass.

Implementations

impl ImageUsage

pub fn all() -> ImageUsage

Builds a ImageUsage with all values set to true. Note that using the returned value will produce an error because of transient_attachment being true.

pub fn none() -> ImageUsage

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

Example

use vulkano::image::ImageUsage as ImageUsage;

let _usage = ImageUsage {
    transfer_destination: true,
    sampled: true,
    .. ImageUsage::none()
};

pub fn color_attachment() -> ImageUsage

Builds a ImageUsage with color_attachment set to true and the rest to false.

pub fn depth_stencil_attachment() -> ImageUsage

Builds a ImageUsage with depth_stencil_attachment set to true and the rest to false.

pub fn transient_color_attachment() -> ImageUsage

Builds a ImageUsage with color_attachment and transient_attachment set to true and the rest to false.

pub fn transient_depth_stencil_attachment() -> ImageUsage

Builds a ImageUsage with depth_stencil_attachment and transient_attachment set to true and the rest to false.

Trait Implementations

impl BitOr<ImageUsage> for ImageUsage

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

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 Debug for ImageUsage

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

Formats the value using the given formatter.

impl From<ImageUsage> for ImageUsageFlags

fn from(val: ImageUsage) -> Self

Performs the conversion.

impl From<ImageUsageFlags> for ImageUsage

fn from(val: ImageUsageFlags) -> ImageUsage

Performs the conversion.

impl Hash for ImageUsage

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 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 Copy for ImageUsage

impl Eq for ImageUsage

impl StructuralEq for ImageUsage

impl StructuralPartialEq for ImageUsage