d2/db6/Application_8cpp_source.html

#include <format>


#include <BS_thread_pool.hpp>

#include <entt/signal/dispatcher.hpp>

#include <mimalloc.h>

#include <SDL3/SDL.h>

#include <sol/sol.hpp>


#include "galaxy/core/Config.hpp"

#include "galaxy/core/Window.hpp"

#include "galaxy/core/Settings.hpp"

#include "galaxy/fs/VirtualFileSystem.hpp"

#include "galaxy/logging/ConsoleSink.hpp"

#include "galaxy/logging/FileSink.hpp"

#include "galaxy/logging/Log.hpp"

#include "galaxy/lua/Lua.hpp"

#include "galaxy/platform/Platform.hpp"

#include "galaxy/time/Time.hpp"


#include "Application.hpp"


using namespace std::chrono_literals;


namespace galaxy

{


    App::App(const std::string& config_file)

    {

        SDL_SetMemoryFunctions(&mi_malloc, &mi_calloc, &mi_realloc, &mi_free);


        setup_logging();

        setup_async();

        setup_config(config_file);

        setup_platform();

        setup_fs();

        setup_window();

        setup_events();

        // setup_nuklear();

        // setup_loader();

        // setup_meta();

        // setup_services();

        setup_scripting();


        // Load game assets.

        // core::entt::locator<core::Loader>::ref().load_all();

    }


    App::~App()

    {

        entt::locator<VirtualFileSystem>::reset();

        entt::locator<Config>::reset();

        entt::locator<BS::light_thread_pool>::reset();


        GALAXY_LOG(GALAXY_INFO, "Application closed.");

        entt::locator<Log>::reset();


        SDL_Quit();

    }


    /*void App::load()

    {

        const auto path = Settings::root_dir() / Settings::asset_pack();


        auto& sm = entt::locator<scene::SceneManager>::value();

        sm.load_app(path.string());

    }*/


    void App::run()

    {

        // https://stackoverflow.com/a/59446610

        // We dont need 't' or 'alpha/render' sections.


        auto& window     = entt::locator<Window>::value();

        auto& dispatcher = entt::locator<entt::dispatcher>::value();

        // auto& manager    = entt::locator<scene::SceneManager>::value();


        // The expression dt/1s simply converts the double-based chrono seconds

        // into a double so it can participate in the physics computation.

        constexpr const auto dt = std::chrono::duration<long long, std::ratio<1, 60>> {1};

        time::dt(dt / 1.0s);


        using clock      = std::chrono::steady_clock;

        using duration   = decltype(clock::duration {} + dt);

        using time_point = std::chrono::time_point<clock, duration>;


        duration   accum = 0s;

        time_point prev  = clock::now();

        time_point now   = clock::now();


        auto     updates = 0u;

        auto     frames  = 0u;

        duration perf    = 0s;


        while (window.is_open())

        {

            now          = clock::now();

            auto elapsed = now - prev;


            // 250ms is the limit put in place on the frame time to cope with the spiral of death.

            // It doesn't have to be 250ms exactly but it should be sufficiently high enough to deal with spikes in load.

            if (elapsed > 250ms)

            {

                elapsed = 250ms;

            }


            prev   = now;

            accum += elapsed;


            while (accum >= dt)

            {

                perf  += dt;

                accum -= dt;


                // nui.begin_input();

                window.process_events(dispatcher);

                // nui.end_input();

                // manager.update();


                updates++;

            }


            // graphics::renderer::begin();

            // manager.render();

            // graphics::renderer::end();


            frames++;


            if (perf >= 1s)

            {

                window.append_title(std::format("{0} | UPS: {1}, FPS: {2}", Settings::title(), updates, frames));


                frames  = 0;

                updates = 0;

                perf    = 0s;

            }

        }

    }


    void App::setup_logging()

    {

        platform::configure_terminal();

        if (!std::filesystem::exists(Settings::log_dir()))

        {

            std::filesystem::create_directory(Settings::log_dir());

        }

        entt::locator<Log>::emplace();


        const auto path = std::format("{0}{1}{2}", Settings::log_dir(), std::format("{0:%d-%m-%Y-[%H-%M]}", time::now()), ".log");

        GALAXY_ADD_SINK(FileSink, path);


        GALAXY_ADD_SINK(ConsoleSink);

        GALAXY_LOG(GALAXY_INFO, "App started.");

    }


    void App::setup_async()

    {

        // Configure threadpool.

        // Use half of available cores minus 2 for audio and main thread.

        const auto system_cores = std::thread::hardware_concurrency();

        if (system_cores < 4)

        {

            GALAXY_LOG(GALAXY_WARN, "Total cores are less than 4, this is not optimal.");

        }


        const auto cores = static_cast<int>(std::floor(system_cores / 2.0) - 2);

        entt::locator<BS::light_thread_pool>::emplace(cores);

    }


    void App::setup_config(std::string_view config_file)

    {

        auto& config = entt::locator<Config>::emplace(config_file);

        Settings::set_config_to_default();

        Settings::set_settings_from_config();

    }


    void App::setup_platform()

    {

        platform::seed_random();


        platform::set_metadata(SDL_PROP_APP_METADATA_NAME_STRING, Settings::title().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_VERSION_STRING, Settings::version().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_IDENTIFIER_STRING, Settings::identifier().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_CREATOR_STRING, Settings::creator().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_COPYRIGHT_STRING, Settings::copyright().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_URL_STRING, Settings::website().c_str());

        platform::set_metadata(SDL_PROP_APP_METADATA_TYPE_STRING, "game");


        platform::set_hint(SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED, "1");

        platform::set_hint(SDL_HINT_ASSERT, "break");

        platform::set_hint(SDL_HINT_AUDIO_CATEGORY, "playback");

        platform::set_hint(SDL_HINT_AUDIO_CHANNELS, "2");

        platform::set_hint(SDL_HINT_AUDIO_INCLUDE_MONITORS, "0");

        platform::set_hint(SDL_HINT_AUTO_UPDATE_JOYSTICKS, "1");

        platform::set_hint(SDL_HINT_AUTO_UPDATE_SENSORS, "1");

        platform::set_hint(SDL_HINT_DEBUG_LOGGING, "1");

        platform::set_hint(SDL_HINT_ENABLE_SCREEN_KEYBOARD, "0");

        platform::set_hint(SDL_HINT_EVENT_LOGGING, "0");

        platform::set_hint(SDL_HINT_FRAMEBUFFER_ACCELERATION, "opengl");

        platform::set_hint(SDL_HINT_GAMECONTROLLER_SENSOR_FUSION, "1");

        platform::set_hint(SDL_HINT_GPU_DRIVER, "vulkan");

        platform::set_hint(SDL_HINT_HIDAPI_ENUMERATE_ONLY_CONTROLLERS, "1");

        platform::set_hint(SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS, "0");

        platform::set_hint(SDL_HINT_JOYSTICK_DIRECTINPUT, "1");

        platform::set_hint(SDL_HINT_TV_REMOTE_AS_JOYSTICK, "1");

        // platform::set_hint(SDL_HINT_LOG_BACKENDS, "1");

        platform::set_hint(SDL_HINT_MOUSE_AUTO_CAPTURE, "0");

        platform::set_hint(SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH, "1");

        platform::set_hint(SDL_HINT_MOUSE_RELATIVE_MODE_CENTER, "0");

        platform::set_hint(SDL_HINT_MOUSE_TOUCH_EVENTS, "1");

        platform::set_hint(SDL_HINT_PEN_MOUSE_EVENTS, "1");

        platform::set_hint(SDL_HINT_PEN_TOUCH_EVENTS, "1");

        platform::set_hint(SDL_HINT_QUIT_ON_LAST_WINDOW_CLOSE, "1");

        platform::set_hint(SDL_HINT_RENDER_DRIVER, "opengl");

        platform::set_hint(SDL_HINT_RENDER_GPU_DEBUG, "0");

        platform::set_hint(SDL_HINT_RENDER_GPU_LOW_POWER, "0");

        platform::set_hint(SDL_HINT_TOUCH_MOUSE_EVENTS, "1");

        platform::set_hint(SDL_HINT_TRACKPAD_IS_TOUCH_ONLY, "0");

        platform::set_hint(SDL_HINT_THREAD_FORCE_REALTIME_TIME_CRITICAL, "0");

        platform::set_hint(SDL_HINT_XINPUT_ENABLED, "1");

        platform::set_hint(SDL_HINT_VIDEO_ALLOW_SCREENSAVER, "0");

        platform::set_hint(SDL_HINT_VIDEO_DUMMY_SAVE_FRAMES, "0");

        platform::set_hint(SDL_HINT_VIDEO_MATCH_EXCLUSIVE_MODE_ON_MOVE, "1");

        platform::set_hint(SDL_HINT_VIDEO_MINIMIZE_ON_FOCUS_LOSS, "0");

        platform::set_hint(SDL_HINT_VIDEO_OFFSCREEN_SAVE_FRAMES, "0");

        platform::set_hint(SDL_HINT_VIDEO_SYNC_WINDOW_OPERATIONS, "0");

        platform::set_hint(SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN, "1");

        platform::set_hint(SDL_HINT_WINDOWS_CLOSE_ON_ALT_F4, "1");

        platform::set_hint(SDL_HINT_WINDOWS_ENABLE_MENU_MNEMONICS, "0");

        platform::set_hint(SDL_HINT_WINDOWS_GAMEINPUT, "1");

        platform::set_hint(SDL_HINT_WINDOWS_RAW_KEYBOARD, "0");

        // platform::set_hint(SDL_HINT_IME_IMPLEMENTED_UI, "0");


        const auto vsync = Settings::vsync() ? "1" : "0";

        platform::set_hint(SDL_HINT_RENDER_VSYNC, vsync);


        const auto audio_freq = std::to_string(Settings::audio_freq());

        platform::set_hint(SDL_HINT_AUDIO_FREQUENCY, audio_freq.c_str());


        if (!SDL_Init(SDL_INIT_VIDEO | SDL_INIT_AUDIO | SDL_INIT_JOYSTICK | SDL_INIT_GAMEPAD | SDL_INIT_EVENTS | SDL_INIT_HAPTIC | SDL_INIT_SENSOR))

        {

            GALAXY_LOG(GALAXY_FATAL, SDL_GetError());

        }

    }


    void App::setup_fs()

    {

        entt::locator<VirtualFileSystem>::emplace();

    }


    void App::setup_window()

    {

        auto& window = entt::locator<Window>::emplace();


        window.set_icon(Settings::window_icon());

        window.show();

    }


    void App::setup_events()

    {

        entt::locator<entt::dispatcher>::emplace();

    }


    // void App::setup_nuklear()

    //{

    // }


    // void App::setup_loader()

    //{

    //  // entt::locator<Loader>::make();

    // }


    // void App::setup_meta()

    //{

    //  auto& sf = entt::locator<meta::SystemFactory>::emplace();

    //  auto& ef = entt::locator<meta::EntityFactory>::emplace();


    //  ef.register_component<components::Tag>("Tag");

    //  /*

    //  em.register_component<components::Animated>("Animated");

    //  em.register_component<components::Circle>("Circle");

    //  em.register_component<components::Ellipse>("Ellipse");

    //  em.register_component<components::Point>("Point");

    //  em.register_component<components::Polygon>("Polygon");

    //  em.register_component<components::Polyline>("Polyline");

    //  em.register_component<components::RigidBody>("RigidBody");

    //  em.register_component<components::Script>("Script");

    //  em.register_component<components::Sprite>("Sprite");

    //  em.register_component<components::Text>("Text");

    //  em.register_component<components::TileMap>("TileMap");

    //  em.register_component<components::Transform>("Transform");

    //  em.register_component<flags::DenySerialization>("DenySerialization");

    //  em.register_component<flags::Disabled>("Disabled");


    //  em.register_dependencies<components::Animated, components::Sprite>();

    //  em.register_dependencies<components::Circle, components::Transform>();

    //  em.register_dependencies<components::Ellipse, components::Transform>();

    //  em.register_dependencies<components::Point, components::Transform>();

    //  em.register_dependencies<components::Polygon, components::Transform>();

    //  em.register_dependencies<components::Polyline, components::Transform>();

    //  em.register_dependencies<components::RigidBody, components::Transform>();

    //  em.register_dependencies<components::Sprite, components::Transform>();

    //  em.register_dependencies<components::Text, components::Transform>();

    //  */

    //}


    // void App::setup_services()

    //{

    //  // entt::locator<media::SoundEngine>::make(listener_count);

    //  // entt::locator<media::MusicEngine>::make(listener_count);

    //  // entt::locator<media::VoiceEngine>::make(listener_count);

    //  // entt::locator<resource::SoundCache>::make();

    //  // entt::locator<resource::MusicCache>::make();

    //  // entt::locator<resource::VoiceCache>::make();

    //  // entt::locator<resource::VideoCache>::make();

    //  // entt::locator<resource::Animations>::make();

    //  // entt::locator<resource::Shaders>::make();

    //  // entt::locator<resource::Fonts>::make();

    //  // entt::locator<resource::Textures>::make();

    //  // entt::locator<resource::Prefabs>::make();

    //  // entt::locator<resource::Scripts>::make();

    //  entt::locator<scene::SceneManager>::emplace();

    // }


    void App::setup_scripting()

    {

        auto& lua = entt::locator<sol::state>::emplace();

        lua.open_libraries(sol::lib::base, sol::lib::package, sol::lib::coroutine, sol::lib::string, sol::lib::os, sol::lib::math, sol::lib::table, sol::lib::io, sol::lib::utf8);


        //

        // Add external libraries to Lua.

        // Inject all configured galaxy into Lua.

        // Add engine services to lua.

        //

        Lua::inject();

    }


} // namespace galaxy

Application.hpp

Config.hpp

ConsoleSink.hpp

FileSink.hpp

Log.hpp

GALAXY_ADD_SINK
#define GALAXY_ADD_SINK(sink,...)
Definition Log.hpp:27

GALAXY_INFO
#define GALAXY_INFO
Log.hpp galaxy.
Definition Log.hpp:22

GALAXY_LOG
#define GALAXY_LOG(level, msg,...)
Definition Log.hpp:28

GALAXY_WARN
#define GALAXY_WARN
Definition Log.hpp:23

GALAXY_FATAL
#define GALAXY_FATAL
Definition Log.hpp:25

Lua.hpp

Platform.hpp

Settings.hpp

Time.hpp

VirtualFileSystem.hpp

galaxy::App::setup_config
void setup_config(std::string_view config_file)
Definition Application.cpp:175

galaxy::App::run
void run()
Loads the default appdata file.
Definition Application.cpp:74

galaxy::App::App
App(const std::string &config_file="config.json")
Default constructor.
Definition Application.cpp:33

galaxy::App::setup_fs
void setup_fs()
Definition Application.cpp:251

galaxy::App::setup_logging
void setup_logging()
Definition Application.cpp:145

galaxy::App::setup_async
void setup_async()
Definition Application.cpp:161

galaxy::App::setup_events
void setup_events()
Definition Application.cpp:264

galaxy::App::setup_scripting
void setup_scripting()
Definition Application.cpp:330

galaxy::App::setup_platform
void setup_platform()
Definition Application.cpp:182

galaxy::App::setup_window
void setup_window()
Definition Application.cpp:256

galaxy::App::~App
~App()
Destructor.
Definition Application.cpp:54

galaxy::ConsoleSink
Logs a message to the console.
Definition ConsoleSink.hpp:19

galaxy::FileSink
Definition FileSink.hpp:18

galaxy::Lua::inject
static void inject() noexcept
Inject everything into Lua.
Definition Lua.cpp:12

Window.hpp

galaxy::platform::seed_random
void seed_random() noexcept
Seed the cstdlib rng algos.
Definition Platform.cpp:20

galaxy::platform::set_metadata
void set_metadata(const char *type, const char *value) noexcept
Sets metadata.
Definition Platform.cpp:25

galaxy::platform::set_hint
void set_hint(const char *hint, const char *value) noexcept
Sets SDL hints.
Definition Platform.cpp:30

galaxy::time::dt
double dt() noexcept
Get galaxy delta time.
Definition Time.cpp:26

galaxy::time::now
auto now() noexcept -> std::chrono::local_time< std::chrono::system_clock::duration >
Current local time.
Definition Time.cpp:16

galaxy
Animated.cpp galaxy.
Definition Animated.cpp:16

galaxy::Settings::window_icon
static auto window_icon() noexcept -> const std::string &
Window icon file in vfs.
Definition Settings.cpp:126

galaxy::Settings::log_dir
static auto log_dir() noexcept -> const std::string &
Current root directory of application, unless it has been changed.
Definition Settings.cpp:211

galaxy::Settings::copyright
static auto copyright() noexcept -> const std::string &
Copyright message.
Definition Settings.cpp:201

galaxy::Settings::vsync
static auto vsync() noexcept -> bool
Vsync control.
Definition Settings.cpp:141

galaxy::Settings::set_settings_from_config
static auto set_settings_from_config() -> void
Set all our settings using the provided config file.
Definition Settings.cpp:70

galaxy::Settings::identifier
static auto identifier() noexcept -> const std::string &
Game identifier i.e. com.galaxy.app.
Definition Settings.cpp:191

galaxy::Settings::title
static auto title() noexcept -> const std::string &
Game title.
Definition Settings.cpp:181

galaxy::Settings::version
static auto version() noexcept -> const std::string &
Game semver.
Definition Settings.cpp:186

galaxy::Settings::audio_freq
static auto audio_freq() noexcept -> int
Set audio frequency to use with SDL.
Definition Settings.cpp:176

galaxy::Settings::website
static auto website() noexcept -> const std::string &
Website URL.
Definition Settings.cpp:206

galaxy::Settings::set_config_to_default
static auto set_config_to_default() -> void
Restore all config settings to default.
Definition Settings.cpp:22

galaxy::Settings::creator
static auto creator() noexcept -> const std::string &
Owner.
Definition Settings.cpp:196