plucky (3) SDL_CreateGPUSampler.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME

       SDL_CreateGPUSampler - Creates a sampler object to be used when binding textures in a graphics workflow.

HEADER FILE

       Defined in SDL3/SDL_gpu.h

SYNOPSIS

       #include "SDL3/SDL.h"

       SDL_GPUSampler * SDL_CreateGPUSampler(
           SDL_GPUDevice *device,
           const SDL_GPUSamplerCreateInfo *createinfo);

DESCRIPTION

       There are optional properties that can be provided through props . These are the supported properties:

       •  SDL_PROP_GPU_SAMPLER_CREATE_NAME_STRING :
         a name that can be displayed in debugging tools.

FUNCTION PARAMETERS

       device a GPU Context.

       createinfo
              a struct describing the state of the sampler to create.

RETURN VALUE

       ( SDL_GPUSampler
        *) Returns a sampler object on success, or NULL on failure; call SDL_GetError () for more information.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_BindGPUVertexSamplers(3), (3), SDL_BindGPUFragmentSamplers(3), (3), SDL_ReleaseGPUSampler(3)