Struct SDL_GPUTextureUsageFlags 

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

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

A texture must have at least one usage flag. Note that some usage flag combinations are invalid.

With regards to compute storage usage, READ | WRITE means that you can have shader A that only writes into the texture and shader B that only reads from the texture and bind the same texture to either shader respectively. SIMULTANEOUS means that you can do reads and writes within the same shader or compute pass. It also implies that atomic ops can be used, since those are read-modify-write operations. If you use SIMULTANEOUS, you are responsible for avoiding data races, as there is no data synchronization within a compute pass. Note that SIMULTANEOUS usage is only supported by a limited number of texture formats.

Availability

This datatype is available since SDL 3.2.0.

See also

• SDL_CreateGPUTexture

Known values (sdl3-sys)

Associated constant	Global constant	Description
SAMPLER	SDL_GPU_TEXTUREUSAGE_SAMPLER	Texture supports sampling.
COLOR_TARGET	SDL_GPU_TEXTUREUSAGE_COLOR_TARGET	Texture is a color render target.
DEPTH_STENCIL_TARGET	SDL_GPU_TEXTUREUSAGE_DEPTH_STENCIL_TARGET	Texture is a depth stencil target.
GRAPHICS_STORAGE_READ	SDL_GPU_TEXTUREUSAGE_GRAPHICS_STORAGE_READ	Texture supports storage reads in graphics stages.
COMPUTE_STORAGE_READ	SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_READ	Texture supports storage reads in the compute stage.
COMPUTE_STORAGE_WRITE	SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_WRITE	Texture supports storage writes in the compute stage.
COMPUTE_STORAGE_SIMULTANEOUS_READ_WRITE	SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_SIMULTANEOUS_READ_WRITE	Texture supports reads and writes in the same compute shader. This is NOT equivalent to READ

Tuple Fields

0: Uint32

Implementations

impl SDL_GPUTextureUsageFlags

pub const SAMPLER: Self

Texture supports sampling.

pub const COLOR_TARGET: Self

Texture is a color render target.

pub const DEPTH_STENCIL_TARGET: Self

Texture is a depth stencil target.

pub const GRAPHICS_STORAGE_READ: Self

Texture supports storage reads in graphics stages.

pub const COMPUTE_STORAGE_READ: Self

Texture supports storage reads in the compute stage.

pub const COMPUTE_STORAGE_WRITE: Self

Texture supports storage writes in the compute stage.

pub const COMPUTE_STORAGE_SIMULTANEOUS_READ_WRITE: Self

Texture supports reads and writes in the same compute shader. This is NOT equivalent to READ | WRITE.

Trait Implementations

impl BitAnd for SDL_GPUTextureUsageFlags

type Output = SDL_GPUTextureUsageFlags

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for SDL_GPUTextureUsageFlags

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_GPUTextureUsageFlags

type Output = SDL_GPUTextureUsageFlags

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for SDL_GPUTextureUsageFlags

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_GPUTextureUsageFlags

type Output = SDL_GPUTextureUsageFlags

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for SDL_GPUTextureUsageFlags

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_GPUTextureUsageFlags

fn clone(&self) -> SDL_GPUTextureUsageFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_GPUTextureUsageFlags

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_GPUTextureUsageFlags

fn default() -> SDL_GPUTextureUsageFlags

Returns the “default value” for a type.

impl From<SDL_GPUTextureUsageFlags> for Uint32

fn from(value: SDL_GPUTextureUsageFlags) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_GPUTextureUsageFlags

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_GPUTextureUsageFlags

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_GPUTextureUsageFlags

type Output = SDL_GPUTextureUsageFlags

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<SDL_GPUTextureUsageFlags> for Uint32

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

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

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

impl Eq for SDL_GPUTextureUsageFlags

impl StructuralPartialEq for SDL_GPUTextureUsageFlags