Struct vulkano::buffer::BufferUsage

source ·
pub struct BufferUsage(/* private fields */);
Expand description

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§

source§

impl BufferUsage

source

pub const TRANSFER_SRC: Self = _

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

source

pub const TRANSFER_DST: Self = _

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

source

pub const UNIFORM_TEXEL_BUFFER: Self = _

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

source

pub const STORAGE_TEXEL_BUFFER: Self = _

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

source

pub const UNIFORM_BUFFER: Self = _

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

source

pub const STORAGE_BUFFER: Self = _

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

source

pub const INDEX_BUFFER: Self = _

The buffer can be used as an index buffer.

source

pub const VERTEX_BUFFER: Self = _

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

source

pub const INDIRECT_BUFFER: Self = _

The buffer can be used as an indirect buffer.

source

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.

source

pub const ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY: Self = _

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

source

pub const ACCELERATION_STRUCTURE_STORAGE: Self = _

An acceleration structure can be created from the buffer.

source

pub const fn empty() -> Self

Returns a BufferUsage with none of the flags set.

source

pub const fn none() -> Self

👎Deprecated since 0.31.0: use empty instead

Returns a BufferUsage with none of the flags set.

source

pub const fn count(self) -> u32

Returns the number of flags set in self.

source

pub const fn is_empty(self) -> bool

Returns whether no flags are set in self.

source

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

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

source

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

Returns whether all flags in other are set in self.

source

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

Returns the union of self and other.

source

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

Returns the intersection of self and other.

source

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

Returns self without the flags set in other.

source

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§

source§

impl BitAnd for BufferUsage

§

type Output = BufferUsage

The resulting type after applying the & operator.
source§

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

Performs the & operation. Read more
source§

impl BitAndAssign for BufferUsage

source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
source§

impl BitOr for BufferUsage

§

type Output = BufferUsage

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl BitOrAssign for BufferUsage

source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
source§

impl BitXor for BufferUsage

§

type Output = BufferUsage

The resulting type after applying the ^ operator.
source§

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

Performs the ^ operation. Read more
source§

impl BitXorAssign for BufferUsage

source§

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more
source§

impl Clone for BufferUsage

source§

fn clone(&self) -> BufferUsage

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for BufferUsage

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for BufferUsage

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl From<BufferUsage> for BufferUsageFlags

source§

fn from(val: BufferUsage) -> Self

Converts to this type from the input type.
source§

impl From<BufferUsageFlags> for BufferUsage

source§

fn from(val: BufferUsageFlags) -> Self

Converts to this type from the input type.
source§

impl Hash for BufferUsage

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for BufferUsage

source§

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

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

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.
source§

impl Sub for BufferUsage

§

type Output = BufferUsage

The resulting type after applying the - operator.
source§

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

Performs the - operation. Read more
source§

impl SubAssign for BufferUsage

source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
source§

impl Copy for BufferUsage

source§

impl Eq for BufferUsage

source§

impl StructuralEq for BufferUsage

source§

impl StructuralPartialEq for BufferUsage

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.