Man page - sdl_renderdebugtextformat(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_RenderDebugTextFormat

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

NAME

SDL_RenderDebugTextFormat - Draw debug text to an SDL_Renderer .

HEADER FILE

Defined in SDL3/SDL_render.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_RenderDebugTextFormat(SDL_Renderer *renderer, float x, float y, const char *fmt, ...);

DESCRIPTION

This function will render a printf()-style format string to a renderer. Note that this is a convinence function for debugging, with severe limitations, and is not intended to be used for production apps and games.

For the full list of limitations and other useful information, see

SDL_RenderDebugText .

FUNCTION PARAMETERS

renderer

the renderer which should draw the text.

	x		the x coordinate where the top-left corner of the text will draw.
	y		the y coordinate where the top-left corner of the text will draw.
	fmt		the format string to draw.
	...		additional parameters matching % tokens in the fmt string, if any.

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.