plucky (3) SDL_DrawGPUPrimitives.3.gz

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

NAME

       SDL_DrawGPUPrimitives - Draws data using bound graphics state.

HEADER FILE

       Defined in SDL3/SDL_gpu.h

SYNOPSIS

       #include "SDL3/SDL.h"

       void SDL_DrawGPUPrimitives(
           SDL_GPURenderPass *render_pass,
           Uint32 num_vertices,
           Uint32 num_instances,
           Uint32 first_vertex,
           Uint32 first_instance);

DESCRIPTION

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

       Note that the first_vertex and first_instance parameters are NOT compatible with built-in vertex/instance
       ID variables in shaders (for example, SV_VertexID); GPU APIs and shader languages  do  not  define  these
       built-in  variables  consistently,  so  if  your  shader  depends  on them, the only way to keep behavior
       consistent and portable is to always pass 0 for the correlating parameter in the draw calls.

FUNCTION PARAMETERS

       render_pass
              a render pass handle.

       num_vertices
              the number of vertices to draw.

       num_instances
              the number of instances that will be drawn.

       first_vertex
              the index of the first vertex to draw.

       first_instance
              the ID of the first instance to draw.

AVAILABILITY

       This function is available since SDL 3.2.0.