Record Class SDL_GPUTextureRegion

java.lang.Object
java.lang.Record
club.doki7.sdl3.datatype.SDL_GPUTextureRegion
All Implemented Interfaces:
IPointer, ISDL_GPUTextureRegion
@ValueBasedCandidate @UnsafeConstructor public record SDL_GPUTextureRegion(@NotNull MemorySegment segment) extends Record implements ISDL_GPUTextureRegion

A structure specifying a region of a texture.

Used when transferring data to or from a texture.

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_UploadToGPUTexture
  • SDL_DownloadFromGPUTexture
  • SDL_CreateGPUTexture

Structure

typedef struct SDL_GPUTextureRegion {
    SDL_GPUTexture* texture;
    Uint32 mip_level;
    Uint32 layer;
    Uint32 x;
    Uint32 y;
    Uint32 z;
    Uint32 w;
    Uint32 h;
    Uint32 d;
} SDL_GPUTextureRegion;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.