Struct vulkano::buffer::BufferUsage

pub struct BufferUsage {
    pub transfer_src: bool,
    pub transfer_dst: bool,
    pub uniform_texel_buffer: bool,
    pub storage_texel_buffer: bool,
    pub uniform_buffer: bool,
    pub storage_buffer: bool,
    pub index_buffer: bool,
    pub vertex_buffer: bool,
    pub indirect_buffer: bool,
    pub shader_device_address: bool,
    pub _ne: NonExhaustive,
}

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

If you try to use a buffer in a way that you didn’t declare, an error will be returned.

Fields

transfer_src: bool

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

transfer_dst: bool

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

uniform_texel_buffer: bool

The buffer can be used as a uniform texel buffer in a descriptor set.

storage_texel_buffer: bool

The buffer can be used as a storage texel buffer in a descriptor set.

uniform_buffer: bool

The buffer can be used as a uniform buffer in a descriptor set.

storage_buffer: bool

The buffer can be used as a storage buffer in a descriptor set.

index_buffer: bool

The buffer can be used as an index buffer.

vertex_buffer: bool

The buffer can be used as a vertex or instance buffer.

indirect_buffer: bool

The buffer can be used as an indirect buffer.

shader_device_address: bool

The buffer’s device address can be retrieved.

_ne: NonExhaustive

Implementations

impl BufferUsage

pub const fn empty() -> Self

Returns a BufferUsage with none of the flags set.

pub const fn none() -> Self

👎Deprecated since 0.31.0:

Use empty instead.

Returns a BufferUsage 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<BufferUsage> for BufferUsage

type Output = BufferUsage

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<BufferUsage> for BufferUsage

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<BufferUsage> for BufferUsage

type Output = BufferUsage

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<BufferUsage> for BufferUsage

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<BufferUsage> for BufferUsage

type Output = BufferUsage

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<BufferUsage> for BufferUsage

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for BufferUsage

fn clone(&self) -> BufferUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BufferUsage

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

Formats the value using the given formatter.

impl Default for BufferUsage

fn default() -> Self

Returns the “default value” for a type.

impl From<BufferUsage> for BufferUsageFlags

fn from(val: BufferUsage) -> Self

Converts to this type from the input type.

impl From<BufferUsageFlags> for BufferUsage

fn from(val: BufferUsageFlags) -> Self

Converts to this type from the input type.

impl Hash for BufferUsage

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<BufferUsage> for BufferUsage

fn eq(&self, other: &BufferUsage) -> 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<BufferUsage> for BufferUsage

type Output = BufferUsage

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<BufferUsage> for BufferUsage

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for BufferUsage

impl Eq for BufferUsage

impl StructuralEq for BufferUsage

impl StructuralPartialEq for BufferUsage