API reference
Preparing search index…

ImGui.ImDrawList_AddTextImFontPtrEx

Append text to the draw list with explicit font and size control.

ImDrawList handle on which this method operates.

Font used for drawing; null selects the draw list's shared current font, not necessarily the default font.

Text size in pixels; 0 uses the draw list shared current font size, even when an explicit font is supplied.

Position in absolute screen coordinates, in pixels.

Packed ImU32 RGBA color; alpha controls opacity.

UTF-8 text. With omitted/null text_end, strings are encoded; NUL-terminated nonempty byte views are used directly, other views are copied and NUL-terminated. With an explicit end, pass a Uint8Array: its bytes are read directly and need no NUL terminator.

Exclusive endpoint view, not a length or another string. Explicit begin/end must share one backing buffer and satisfy begin.byteOffset <= end.byteOffset <= begin.byteOffset + begin.byteLength. An empty end view is valid; neither view needs NUL termination. Omitted/null end uses ordinary NUL-terminated UTF-8 conversion.

Maximum text width in pixels before wrapping; nonpositive values disable wrapping.

Optional Float32Array [minX,minY,maxX,maxY] screen rectangle for per-glyph CPU clipping. Pass Float32Array storage, not a JS scalar; native access uses the supplied backing memory.

  • Append text to the draw list with explicit font and size control.

    Parameters

    self

    ImDrawList handle on which this method operates.

    font
    null | ImFont

    Font used for drawing; null selects the draw list's shared current font, not necessarily the default font.

    font_size
    number

    Text size in pixels; 0 uses the draw list shared current font size, even when an explicit font is supplied.

    pos

    Position in absolute screen coordinates, in pixels.

    col
    number

    Packed ImU32 RGBA color; alpha controls opacity.

    text_begin
    string | Uint8Array

    UTF-8 text. With omitted/null text_end, strings are encoded; NUL-terminated nonempty byte views are used directly, other views are copied and NUL-terminated. With an explicit end, pass a Uint8Array: its bytes are read directly and need no NUL terminator.

    text_endOptional
    null

    Exclusive endpoint view, not a length or another string. Explicit begin/end must share one backing buffer and satisfy begin.byteOffset <= end.byteOffset <= begin.byteOffset + begin.byteLength. An empty end view is valid; neither view needs NUL termination. Omitted/null end uses ordinary NUL-terminated UTF-8 conversion.

    wrap_widthOptional
    number

    Maximum text width in pixels before wrapping; nonpositive values disable wrapping.

    cpu_fine_clip_rectOptional
    null | Float32Array

    Optional Float32Array [minX,minY,maxX,maxY] screen rectangle for per-glyph CPU clipping. Pass Float32Array storage, not a JS scalar; native access uses the supplied backing memory.

    Returns

    void
    Source & inheritance
  • Append text to the draw list with explicit font and size control.

    Parameters

    self

    ImDrawList handle on which this method operates.

    font
    null | ImFont

    Font used for drawing; null selects the draw list's shared current font, not necessarily the default font.

    font_size
    number

    Text size in pixels; 0 uses the draw list shared current font size, even when an explicit font is supplied.

    pos

    Position in absolute screen coordinates, in pixels.

    col
    number

    Packed ImU32 RGBA color; alpha controls opacity.

    text_begin
    Uint8Array

    UTF-8 text. With omitted/null text_end, strings are encoded; NUL-terminated nonempty byte views are used directly, other views are copied and NUL-terminated. With an explicit end, pass a Uint8Array: its bytes are read directly and need no NUL terminator.

    text_end
    Uint8Array

    Exclusive endpoint view, not a length or another string. Explicit begin/end must share one backing buffer and satisfy begin.byteOffset <= end.byteOffset <= begin.byteOffset + begin.byteLength. An empty end view is valid; neither view needs NUL termination. Omitted/null end uses ordinary NUL-terminated UTF-8 conversion.

    wrap_widthOptional
    number

    Maximum text width in pixels before wrapping; nonpositive values disable wrapping.

    cpu_fine_clip_rectOptional
    null | Float32Array

    Optional Float32Array [minX,minY,maxX,maxY] screen rectangle for per-glyph CPU clipping. Pass Float32Array storage, not a JS scalar; native access uses the supplied backing memory.

    Returns

    void
    Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0