SDL_GPUBlitRegion(3type)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 NAME 💖

SDL_GPUBlitRegion — it's a struct, bestie, and it describes a region of a texture that you're gonna use in a blit operation. That's the whole vibe. A little rectangle of texture saying "me, this part, right here" 💅

✨ SYNOPSIS ✨

#include <SDL3/SDL_gpu.h>

typedef struct SDL_GPUBlitRegion
{
    SDL_GPUTexture *texture;      /**< The texture. */
    Uint32 mip_level;             /**< The mip level index of the region. */
    Uint32 layer_or_depth_plane;  /**< The layer index or depth plane of the region. This value is treated as a layer index on 2D array and cube textures, and as a depth plane on 3D textures. */
    Uint32 x;                     /**< The left offset of the region. */
    Uint32 y;                     /**< The top offset of the region.  */
    Uint32 w;                     /**< The width of the region. */
    Uint32 h;                     /**< The height of the region. */
} SDL_GPUBlitRegion;

🦋 DESCRIPTION 🦋

okay so. picture a texture. huge, gorgeous, main character energy. now picture you only want part of it for your blit. that's what this struct is for, and it is so straightforward. let's meet the members one by one, no gatekeeping 🫶

  • texture — the texture. yeah. that's it. that's the field. the actual SDL_GPUTexture * we're talking about 👑
  • mip_level — the mip level index of the region. which level of the mip pyramid are we pulling from, bestie?
  • layer_or_depth_plane — the layer index or depth plane of the region, and yes the name is long because it does double duty. on 2D array textures and cube textures this value is treated as a layer index. on 3D textures it's treated as a depth plane. one field, two personalities, we love a versatile icon 🌈
  • x — the left offset of the region. how far in from the left we start 📍
  • y — the top offset of the region. how far down from the top we start 📍
  • w — the width of the region. how wide our little slice is 📏
  • h — the height of the region. how tall our little slice is 📏

so like, x, y, w, h are just... a rectangle. a rect. the classic. and then texture, mip_level and layer_or_depth_plane tell it which texture and which slice of it you mean. it's giving "I know exactly which part of this texture I want and I'm not settling" 💅✨

🌸 AVAILABILITY 🌸

this struct has been around since SDL 3.2.0. not new new, but not ancient either. it's been here, being useful, minding its business 💜

🎀 SEE ALSO 🎀

go read those too, they're literally the whole point of this struct existing. iykyk 🔥

and that's the page, bestie!! this lil datatype comes to you from Simple Directmedia Layer — that's the source — and the version tag on it is SDL 3.4.18. mwah, go blit something gorgeous 💖✨🎀🦋

📦 where this page comes from