Struct vulkano::image::ImageUsage

pub struct ImageUsage {
    pub transfer_src: bool,
    pub transfer_dst: bool,
    pub sampled: bool,
    pub storage: bool,
    pub color_attachment: bool,
    pub depth_stencil_attachment: bool,
    pub transient_attachment: bool,
    pub input_attachment: bool,
    pub _ne: NonExhaustive,
}

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, an error will occur.

Fields

transfer_src: bool

The image can be used as a source for transfer, blit, resolve and clear commands.

transfer_dst: bool

The image can be used as a destination for transfer, blit, resolve and clear commands.

sampled: bool

The image can be used as a sampled image in a shader.

storage: bool

The image can be used as a storage image in a shader.

color_attachment: bool

The image can be used as a color attachment in a render pass/framebuffer.

depth_stencil_attachment: bool

The image can be used as a depth/stencil attachment in a render pass/framebuffer.

transient_attachment: bool

The image will be used as an attachment, and will only ever be used temporarily. 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.

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.

input_attachment: bool

The image can be used as an input attachment in a render pass/framebuffer.

_ne: NonExhaustive

Implementations

impl ImageUsage

pub const fn empty() -> Self

Returns a ImageUsage with none of the flags set.

pub const fn none() -> Self

👎Deprecated since 0.31.0:

Use empty instead.

Returns a ImageUsage with none of the flags set.

pub const fn is_empty(&self) -> bool

Returns whether no flags are set in self.

pub const fn intersects(&self, other: &Self) -> bool

Returns whether any flags are set in both self and other.

pub const fn contains(&self, other: &Self) -> bool

Returns whether all flags in other are set in self.

pub const fn union(&self, other: &Self) -> Self

Returns the union of self and other.

pub const fn intersection(&self, other: &Self) -> Self

Returns the intersection of self and other.

pub const fn difference(&self, other: &Self) -> Self

Returns self without the flags set in other.

pub const fn symmetric_difference(&self, other: &Self) -> Self

Returns the flags set in self or other, but not both.

Trait Implementations

impl BitAnd<ImageUsage> for ImageUsage

type Output = ImageUsage

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<ImageUsage> for ImageUsage

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<ImageUsage> for ImageUsage

type Output = ImageUsage

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<ImageUsage> for ImageUsage

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<ImageUsage> for ImageUsage

type Output = ImageUsage

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<ImageUsage> for ImageUsage

fn bitxor_assign(&mut self, rhs: 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 Default for ImageUsage

fn default() -> Self

Returns the “default value” for a type.

impl From<ImageUsage> for ImageUsageFlags

fn from(val: ImageUsage) -> Self

Converts to this type from the input type.

impl From<ImageUsageFlags> for ImageUsage

fn from(val: ImageUsageFlags) -> Self

Converts to this type from the input type.

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

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

impl Sub<ImageUsage> for ImageUsage

type Output = ImageUsage

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<ImageUsage> for ImageUsage

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for ImageUsage

impl Eq for ImageUsage

impl StructuralEq for ImageUsage

impl StructuralPartialEq for ImageUsage