API reference
Preparing search index…

ImGui.CalcTextSizeEx

Measure text with the current font, optional wrapping, and optional hidden ID suffixes.

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.

Whether text after ## is excluded from size measurement.

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

Measured text extent: copied pixel dimensions {x: width, y: height}.

  • Measure text with the current font, optional wrapping, and optional hidden ID suffixes.

    Parameters

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

    hide_text_after_double_hashOptional
    boolean

    Whether text after ## is excluded from size measurement.

    wrap_widthOptional
    number

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

    Returns

    Measured text extent: copied pixel dimensions {x: width, y: height}.

    Source & inheritance
  • Measure text with the current font, optional wrapping, and optional hidden ID suffixes.

    Parameters

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

    hide_text_after_double_hashOptional
    boolean

    Whether text after ## is excluded from size measurement.

    wrap_widthOptional
    number

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

    Returns

    Measured text extent: copied pixel dimensions {x: width, y: height}.

    Source & inheritance

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