Function EnableProfilerUI

engine/profiler/src/profiler.cpp:463–484

enables or disables the on-screen profiler ui * Creates and shows or hides and destroys the on-sceen profiler ui * * The profiler is a real-time tool that shows the numbers of milliseconds spent * in each scope per frame as well as counters. The profiler is very useful for * tracking down performance and resource problems. * * @name profiler.enable_ui * @param enabled [type:boolean] true t

 * ```
 */
static int EnableProfilerUI(lua_State* L)
{
    DM_LUA_STACK_CHECK(L, 0);

    if (!lua_isboolean(L, 1))
    {
        return DM_LUA_ERROR("Invalid parameter, expected a boolean but got a %s", lua_typename(L, lua_type(L, 1)))
    }

    bool enabled = lua_toboolean(L, 1);

    if (enabled && !gRenderProfile)
    {
        gRenderProfile = dmProfileRender::NewRenderProfile(gUpdateFrequency);
    }
    else if (!enabled)
    {
        DeleteProfilerUI();
    }

    return 0;
}

/*# sets the the on-screen profiler ui mode
 * Set the on-screen profile mode - run, pause, record or show peak frame