Man page - sdl_rendergeometry(3)

Packages contains this manual

Manual

SDL_RenderGeometry

NAME
HEADER FILE
SYNOPSIS
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

SDL_RenderGeometry - Render a list of triangles, optionally using a texture and indices into the vertex array Color and alpha modulation is done per vertex ( SDL_SetTextureColorMod
and SDL_SetTextureAlphaMod
are ignored).

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_RenderGeometry(SDL_Renderer *renderer,
SDL_Texture *texture,
const SDL_Vertex *vertices, int num_vertices,
const int *indices, int num_indices);

FUNCTION PARAMETERS

renderer

the rendering context.

texture

(optional) The SDL texture to use.

vertices

vertices.

num_vertices

number of vertices.

indices

(optional) An array of integer indices into the ’vertices’ array, if NULL all vertices will be rendered in sequential order.

num_indices

number of indices.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

This function should only be called on the main thread.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

β€’ (3), SDL_RenderGeometryRaw (3)