plucky (3) SDL_DispatchGPUCompute.3.gz

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

NAME

       SDL_DispatchGPUCompute - Dispatches compute work.

HEADER FILE

       Defined in SDL3/SDL_gpu.h

SYNOPSIS

       #include "SDL3/SDL.h"

       void SDL_DispatchGPUCompute(
           SDL_GPUComputePass *compute_pass,
           Uint32 groupcount_x,
           Uint32 groupcount_y,
           Uint32 groupcount_z);

DESCRIPTION

       You must not call this function before binding a compute pipeline.

       A  VERY  IMPORTANT NOTE If you dispatch multiple times in a compute pass, and the dispatches write to the
       same resource region as each other, there is no guarantee of which order the writes will  occur.  If  the
       write order matters, you MUST end the compute pass and begin another one.

FUNCTION PARAMETERS

       compute_pass
              a compute pass handle.

       groupcount_x
              number of local workgroups to dispatch in the X dimension.

       groupcount_y
              number of local workgroups to dispatch in the Y dimension.

       groupcount_z
              number of local workgroups to dispatch in the Z dimension.

AVAILABILITY

       This function is available since SDL 3.2.0.