Record Class SDL_GPUSamplerCreateInfo

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

A structure specifying the parameters of a sampler.

Note that mip_lod_bias is a no-op for the Metal driver. For Metal, LOD bias must be applied via shader instead.

Since: This function is available since SDL 3.2.0.

See also:

  • SDL_CreateGPUSampler
  • SDL_GPUFilter
  • SDL_GPUSamplerMipmapMode
  • SDL_GPUSamplerAddressMode
  • SDL_GPUCompareOp

Structure

typedef struct SDL_GPUSamplerCreateInfo {
    SDL_GPUFilter min_filter;
    SDL_GPUFilter mag_filter;
    SDL_GPUSamplerMipmapMode mipmap_mode;
    SDL_GPUSamplerAddressMode address_mode_u;
    SDL_GPUSamplerAddressMode address_mode_v;
    SDL_GPUSamplerAddressMode address_mode_w;
    float mip_lod_bias;
    float max_anisotropy;
    SDL_GPUCompareOp compare_op;
    float min_lod;
    float max_lod;
    bool enable_anisotropy;
    bool enable_compare;
    Uint8 padding1;
    Uint8 padding2;
    SDL_PropertiesID props;
} SDL_GPUSamplerCreateInfo;

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.