Function GetTextMetrics

engine/gamesys/src/gamesys/scripts/script_resource.cpp:3523–3563

gets the text metrics for a font * * Gets the text metrics from a font * * @name resource.get_text_metrics * @param url [type:hash] the font to get the (unscaled) metrics from * @param text [type:string] text to measure * @param [options] [type:table] A table containing parameters for the text. Supported entries: * * `width` * : [type:number] The width of the text field. Not used if `lin

 * ```
 */
static int GetTextMetrics(lua_State* L)
{
    int top = lua_gettop(L);

    dmhash_t path_hash = dmScript::CheckHashOrString(L, 1);

    size_t len = 0;
    const char* text = luaL_checklstring(L, 2, &len);

    dmGameSystem::FontResource* font = (dmGameSystem::FontResource*)CheckResource(L, g_ResourceModule.m_Factory, path_hash, "fontc");;

    bool line_break = false;
    float leading = 1.0f;
    float tracking = 0.0f;
    float width = 100000.0f;
    if (top >= 3)
    {
        int table_index = 3;
        luaL_checktype(L, table_index, LUA_TTABLE); // Make sure it's actually a table
        width = (float)CheckTableNumber(L, table_index, "width", width);
        leading = (float)CheckTableNumber(L, table_index, "leading", leading);
        tracking = (float)CheckTableNumber(L, table_index, "tracking", tracking);
        line_break = CheckTableBoolean(L, table_index, "line_break", line_break);
    }

    dmRender::HFontMap font_map = dmGameSystem::ResFontGetHandle(font);

    TextLayoutSettings settings = {0};
    settings.m_Width = width;
    settings.m_LineBreak = line_break;
    settings.m_Leading = leading;
    settings.m_Tracking = tracking;
    // legacy options for glyph bank fonts
    settings.m_Monospace = dmRender::GetFontMapMonospaced(font_map);
    settings.m_Padding = dmRender::GetFontMapPadding(font_map);

    dmRender::TextMetrics metrics;
    dmRender::GetTextMetrics(font_map, text, &settings, &metrics);
    PushTextMetricsTable(L, &metrics);
    return 1;
}

static const luaL_reg Module_methods[] =
{