Struct BufferUsage

pub struct BufferUsage(/* private fields */);

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.

Implementations

impl BufferUsage

pub const TRANSFER_SRC: Self

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

pub const TRANSFER_DST: Self

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

pub const UNIFORM_TEXEL_BUFFER: Self

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

pub const STORAGE_TEXEL_BUFFER: Self

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

pub const UNIFORM_BUFFER: Self

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

pub const STORAGE_BUFFER: Self

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

pub const INDEX_BUFFER: Self

The buffer can be used as an index buffer.

pub const VERTEX_BUFFER: Self

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

pub const INDIRECT_BUFFER: Self

The buffer can be used as an indirect buffer.

pub const SHADER_DEVICE_ADDRESS: Self

The buffer’s device address can be retrieved.

A buffer created with this usage can only be bound to device memory allocated with the MemoryAllocateFlags::DEVICE_ADDRESS flag, unless the ext_buffer_device_address extension is enabled on the device.

pub const ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY: Self

The buffer can be used as input data for an acceleration structure build operation.

pub const ACCELERATION_STRUCTURE_STORAGE: Self

An acceleration structure can be created from the buffer.

pub const SHADER_BINDING_TABLE: Self

pub const fn empty() -> Self

Returns a BufferUsage with none of the flags set.

pub const fn count(self) -> u32

Returns the number of flags set in self.

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 that are set in self or other, but not in both.

Trait Implementations

impl BitAnd for BufferUsage

type Output = BufferUsage

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for BufferUsage

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for BufferUsage

type Output = BufferUsage

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for BufferUsage

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for BufferUsage

type Output = BufferUsage

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign 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<(), Error>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BufferUsage

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for BufferUsage

type Output = BufferUsage

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for BufferUsage

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for BufferUsage

impl Eq for BufferUsage

impl StructuralPartialEq for BufferUsage