ttfRenderUnicodeLcdWrapped function

Pointer<SdlSurface> ttfRenderUnicodeLcdWrapped(Pointer<TtfFont> font, Pointer<Uint16> text, SdlColor fg, SdlColor bg, int wrapLength,)

Render word-wrapped UCS-2 text at LCD subpixel quality to a new ARGB surface.

This function will allocate a new 32-bit, ARGB surface, and render alpha-blended text using FreeType's LCD subpixel rendering. 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 wrapLength in pixels.

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

Please note that this function is named "Unicode" but currently expects UCS-2 encoding (16 bits per codepoint). This does not give you access to large Unicode values, such as emoji glyphs. These codepoints are accessible through the UTF-8 version of this function.

You can render at other quality levels with TTF_RenderUNICODE_Solid_Wrapped, TTF_RenderUNICODE_Shaded_Wrapped, and TTF_RenderUNICODE_Blended_Wrapped.

\param font the font to render with. \param text text to render, in UCS-2 encoding. \param fg the foreground color for the text. \param bg the background color for the text. \returns a new 32-bit, ARGB surface, or NULL if there was an error.

\since This function is available since SDL_ttf 2.20.0.

\sa TTF_RenderUTF8_LCD_Wrapped

extern DECLSPEC SDL_Surface * SDLCALL TTF_RenderUNICODE_LCD_Wrapped(TTF_Font *font, const Uint16 *text, SDL_Color fg, SDL_Color bg, Uint32 wrapLength)

Implementation

Pointer<SdlSurface> ttfRenderUnicodeLcdWrapped(Pointer<TtfFont> font,
    Pointer<Uint16> text, SdlColor fg, SdlColor bg, int wrapLength) {
  final ttfRenderUnicodeLcdWrappedLookupFunction = libSdl2Ttf.lookupFunction<
      Pointer<SdlSurface> Function(Pointer<TtfFont> font, Pointer<Uint16> text,
          SdlColor fg, SdlColor bg, Uint32 wrapLength),
      Pointer<SdlSurface> Function(
          Pointer<TtfFont> font,
          Pointer<Uint16> text,
          SdlColor fg,
          SdlColor bg,
          int wrapLength)>('TTF_RenderUNICODE_LCD_Wrapped');
  return ttfRenderUnicodeLcdWrappedLookupFunction(
      font, text, fg, bg, wrapLength);
}