ttfRenderTextShadedWrapped function

Pointer<SdlSurface> ttfRenderTextShadedWrapped(Pointer<TtfFont> font, String? text, int length, SdlColor fg, SdlColor bg, int wrapWidth,)

Render word-wrapped UTF-8 text at high quality to a new 8-bit surface.

This function will allocate a new 8-bit, palettized surface. The surface's 0 pixel will be the specified background color, while other pixels have varying degrees of the foreground color. This function returns the new surface, or NULL if there was an error.

Text is wrapped to multiple lines on line endings and on word boundaries if it extends beyond wrap_width in pixels.

If wrap_width is 0, this function will only wrap on newline characters.

You can render at other quality levels with TTF_RenderText_Solid_Wrapped, TTF_RenderText_Blended_Wrapped, and TTF_RenderText_LCD_Wrapped.

\param font the font to render with. \param text text to render, in UTF-8 encoding. \param length the length of the text, in bytes, or 0 for null terminated text. \param fg the foreground color for the text. \param bg the background color for the text. \param wrap_width the maximum width of the text surface or 0 to wrap on newline characters. \returns a new 8-bit, palettized surface, or NULL if there was an error.

\threadsafety This function should be called on the thread that created the font.

\since This function is available since SDL_ttf 3.0.0.

\sa TTF_RenderText_Blended_Wrapped \sa TTF_RenderText_LCD_Wrapped \sa TTF_RenderText_Shaded \sa TTF_RenderText_Solid_Wrapped

extern SDL_DECLSPEC SDL_Surface * SDLCALL TTF_RenderText_Shaded_Wrapped(TTF_Font *font, const char *text, size_t length, SDL_Color fg, SDL_Color bg, int wrap_width)

Implementation

Pointer<SdlSurface> ttfRenderTextShadedWrapped(Pointer<TtfFont> font,
    String? text, int length, SdlColor fg, SdlColor bg, int wrapWidth) {
  final ttfRenderTextShadedWrappedLookupFunction = libSdl3Ttf.lookupFunction<
      Pointer<SdlSurface> Function(Pointer<TtfFont> font, Pointer<Utf8> text,
          Uint32 length, SdlColor fg, SdlColor bg, Int32 wrapWidth),
      Pointer<SdlSurface> Function(
          Pointer<TtfFont> font,
          Pointer<Utf8> text,
          int length,
          SdlColor fg,
          SdlColor bg,
          int wrapWidth)>('TTF_RenderText_Shaded_Wrapped');
  final textPointer = text != null ? text.toNativeUtf8() : nullptr;
  final result = ttfRenderTextShadedWrappedLookupFunction(
      font, textPointer, length, fg, bg, wrapWidth);
  calloc.free(textPointer);
  return result;
}