Struct SDL_GPUBufferUsageFlags 

#[repr(transparent)]
pub struct SDL_GPUBufferUsageFlags(pub Uint32);

Specifies how a buffer is intended to be used by the client.

A buffer must have at least one usage flag.

If a buffer has multiple read usages, this may lead to a performance penalty due to more conservative memory barriers, but it also may not necessarily affect the performance.

Unlike textures, READ | WRITE can be used for simultaneous read-write usage. The same data synchronization concerns as textures apply.

If you use a STORAGE flag, the data in the buffer must respect std140 layout conventions. In practical terms this means you must ensure that vec3 and vec4 fields are 16-byte aligned.

Availability

This datatype is available since SDL 3.2.0.

See also

• SDL_CreateGPUBuffer

Known values (sdl3-sys)

Associated constant	Global constant	Description
VERTEX	SDL_GPU_BUFFERUSAGE_VERTEX	Buffer is a vertex buffer.
INDEX	SDL_GPU_BUFFERUSAGE_INDEX	Buffer is an index buffer.
INDIRECT	SDL_GPU_BUFFERUSAGE_INDIRECT	Buffer is an indirect buffer.
GRAPHICS_STORAGE_READ	SDL_GPU_BUFFERUSAGE_GRAPHICS_STORAGE_READ	Buffer supports storage reads in graphics stages.
COMPUTE_STORAGE_READ	SDL_GPU_BUFFERUSAGE_COMPUTE_STORAGE_READ	Buffer supports storage reads in the compute stage.
COMPUTE_STORAGE_WRITE	SDL_GPU_BUFFERUSAGE_COMPUTE_STORAGE_WRITE	Buffer supports storage writes in the compute stage.

Tuple Fields

0: Uint32

Implementations

impl SDL_GPUBufferUsageFlags

pub const VERTEX: Self

Buffer is a vertex buffer.

pub const INDEX: Self

Buffer is an index buffer.

pub const INDIRECT: Self

Buffer is an indirect buffer.

pub const GRAPHICS_STORAGE_READ: Self

Buffer supports storage reads in graphics stages.

pub const COMPUTE_STORAGE_READ: Self

Buffer supports storage reads in the compute stage.

pub const COMPUTE_STORAGE_WRITE: Self

Buffer supports storage writes in the compute stage.

impl SDL_GPUBufferUsageFlags

pub const fn new(value: Uint32) -> Self

Initialize a SDL_GPUBufferUsageFlags from a raw value.

impl SDL_GPUBufferUsageFlags

pub const fn value(&self) -> Uint32

Get a copy of the inner raw value.

Trait Implementations

impl BitAnd for SDL_GPUBufferUsageFlags

type Output = SDL_GPUBufferUsageFlags

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for SDL_GPUBufferUsageFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_GPUBufferUsageFlags

type Output = SDL_GPUBufferUsageFlags

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for SDL_GPUBufferUsageFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_GPUBufferUsageFlags

type Output = SDL_GPUBufferUsageFlags

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for SDL_GPUBufferUsageFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_GPUBufferUsageFlags

fn clone(&self) -> SDL_GPUBufferUsageFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SDL_GPUBufferUsageFlags

impl Debug for SDL_GPUBufferUsageFlags

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_GPUBufferUsageFlags

fn default() -> SDL_GPUBufferUsageFlags

Returns the “default value” for a type.

impl Eq for SDL_GPUBufferUsageFlags

impl From<SDL_GPUBufferUsageFlags> for Uint32

fn from(value: SDL_GPUBufferUsageFlags) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_GPUBufferUsageFlags

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_GPUBufferUsageFlags

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 Not for SDL_GPUBufferUsageFlags

type Output = SDL_GPUBufferUsageFlags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for SDL_GPUBufferUsageFlags

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<SDL_GPUBufferUsageFlags> for Uint32

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u32> for SDL_GPUBufferUsageFlags

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SDL_GPUBufferUsageFlags