(This function is part of SDL_rtf, a separate library from SDL.)

RTF_Render

Render the RTF document to a rectangle in an SDL_Renderer.

Header File

Defined in <SDL3_rtf/SDL_rtf.h>

Syntax

void RTF_Render(RTF_Context *ctx, SDL_Rect *rect, int yOffset);

Function Parameters

RTF_Context * ctx the RTF context render to.
SDL_Rect * rect the area to render text into.
int yOffset offset up (and clip) by this many pixels.

Remarks

Rendering is done through the SDL_Renderer specified in RTF_CreateContext.

The text is reflowed to match the width of the rectangle.

The rendering is offset up (and clipped) by yOffset pixels.

Version

This function is available since SDL_rtf 3.0.0.

CategoryAPI, CategoryAPIFunction