logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_RenderDebugText - Draw debug text to an SDL_Renderer .

Availability

       This function is available since SDL 3.2.0.

Description

       This function will render a string of text to an

       SDL_Renderer  .  Note that this is a convenience function for debugging, with severe limitations, and not
       intended to be used for production apps and games.

       Among these limitations:

       • It accepts UTF-8 strings, but will only renders ASCII characters.

       • It has a single, tiny size (8x8 pixels). One can use logical presentation
         or scaling to adjust it, but it will be blurry.

       • It uses a simple, hardcoded bitmap font. It does not allow different font
         selections and it does not support truetype, for proper scaling.

       • It does no word-wrapping and does not treat newline characters as a line
         break. If the text goes out of the window, it's gone.

       For serious text rendering, there are several good options, such as

       SDL_ttf , stb_truetype, or other external libraries.

       On first use, this will create an internal texture for rendering glyphs.  This texture  will  live  until
       the renderer is destroyed.

       The text is drawn in the color specified by

       SDL_SetRenderDrawColor ().

Function Parameters

renderer
              the renderer which should draw a line of 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.

       str    the string to render.

Header File

       Defined in SDL3/SDL_render.h

Name

       SDL_RenderDebugText - Draw debug text to an SDL_Renderer .

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

(3), SDL_RenderDebugTextFormat(3), (3), SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE(3)

Simple Directmedia Layer                           SDL 3.2.10                             SDL_RenderDebugText(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_RenderDebugText(SDL_Renderer*renderer,floatx,floaty,constchar*str);

Thread Safety

       This function should only be called on the main thread.

See Also