SDL_GPUTextureUsageFlags(3type)

💖 SDL_GPUTextureUsageFlags 💖

okay bestie, welcome to the SDL_GPUTextureUsageFlags page — it's a datatype from the SDL3 manual (the 3type girlies know), and she's here to tell you exactly how a texture is intended to be used by the client. no cap. 🎀

---

✨ NAME ✨

SDL_GPUTextureUsageFlags — specifies how a texture is intended to be used by the client. that's the whole vibe. 👑

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_gpu.h>

typedef Uint32 SDL_GPUTextureUsageFlags;

#define SDL_GPU_TEXTUREUSAGE_SAMPLER                                 (1u << 0) /**< Texture supports sampling. */
#define SDL_GPU_TEXTUREUSAGE_COLOR_TARGET                            (1u << 1) /**< Texture is a color render target. */
#define SDL_GPU_TEXTUREUSAGE_DEPTH_STENCIL_TARGET                    (1u << 2) /**< Texture is a depth stencil target. */
#define SDL_GPU_TEXTUREUSAGE_GRAPHICS_STORAGE_READ                   (1u << 3) /**< Texture supports storage reads in graphics stages. */
#define SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_READ                    (1u << 4) /**< Texture supports storage reads in the compute stage. */
#define SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_WRITE                   (1u << 5) /**< Texture supports storage writes in the compute stage. */
#define SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_SIMULTANEOUS_READ_WRITE (1u << 6) /**< Texture supports reads and writes in the same compute shader. This is NOT equivalent to READ | WRITE. */

so it's literally just a typedef Uint32 and then a lil family of #defines. bit flags. iconic behavior honestly. 💅

• SDL_GPU_TEXTUREUSAGE_SAMPLER — (1u << 0) — texture supports sampling. 🦋
• SDL_GPU_TEXTUREUSAGE_COLOR_TARGET — (1u << 1) — texture is a color render target. 🎨
• SDL_GPU_TEXTUREUSAGE_DEPTH_STENCIL_TARGET — (1u << 2) — texture is a depth stencil target. 🌈
• SDL_GPU_TEXTUREUSAGE_GRAPHICS_STORAGE_READ — (1u << 3) — texture supports storage reads in graphics stages. 👀
• SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_READ — (1u << 4) — texture supports storage reads in the compute stage. 📖
• SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_WRITE — (1u << 5) — texture supports storage writes in the compute stage. ✍️
• SDL_GPU_TEXTUREUSAGE_COMPUTE_STORAGE_SIMULTANEOUS_READ_WRITE — (1u << 6) — texture supports reads and writes in the same compute shader. and listen — this is NOT equivalent to READ | WRITE. do not come for me about it, they are different, periodt. 💀

---

🧚 DESCRIPTION 🧚

first thing's first: a texture must have at least one usage flag. zero flags is not a lewk, it's not allowed, she needs at least one. 🫶

also — combining SAMPLER with the STORAGE_READ flags is invalid. like, don't. it's giving error. 🚫

now the compute storage tea, because this is the part everyone gets confused about, and honestly valid:

• READ | WRITE means you can have shader A that only writes into the texture and shader B that only reads from the texture, and you bind the same texture to either shader respectively. two different shaders, two different jobs, same texture, no overlap. 🤝
• SIMULTANEOUS means 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, because there is no data synchronization within a compute pass. that's on you, bestie. no one's coming to save you. 😭

and one more lil caveat — SIMULTANEOUS usage is only supported by a limited number of texture formats. so vibe check your format first. 🌸

---

💜 AVAILABILITY 💜

this datatype has been available since SDL 3.2.0. she's a newer girl but she's thriving. ⭐

---

👑 SEE ALSO 👑

• SDL_CreateGPUTexture(3)

---

and that's the whole page, bestie!! 🎀 go forth and flag your textures responsibly. mwah. 💖

Simple Directmedia Layer · SDL 3.4.18 · SDL_GPUTextureUsageFlags(3type) — sending u all my love, xoxo, see u in the next manpage 🫶💅✨