devela::_dep::sdl3::sys::render

Function SDL_RenderDebugText

pub unsafe extern "C" fn SDL_RenderDebugText(
    renderer: *mut SDL_Renderer,
    x: f32,
    y: f32,
    str: *const i8,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Draw debug text to an SDL_Renderer.

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().

§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.

§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