Struct Engine::InitConfig

Nested Relationships

This struct is a nested type of Class Engine.

Struct Documentation

struct InitConfig

Configuration values that are set for startup and cannot be modified afterwards.

Public Members

std::string initialRequestedBackend

The requested backend to try to initialize first, overriding the default setting.

std::string preferredWindowProvider

The preferred windowing provider to use.

The available options are:

  • win32 Windows API (Windows only)

  • cocoa Cocoa (MacOS only)

  • x11 X11 via XCB (Linux only)

  • wayland Wayland (Linux only)

Note

If the provider requested is not available or this string is empty, default behavior will be used

bool suppressConsoleLogging

Whether or not to suppress console logging output.

bool suppressFileLogging

Whether or not to suppress file logging output.

ClientIdentity clientID

ID of the client application. This should be in reverse-domain format with a PascalCase final segment (e.g. com.example.MyGame), but this is not enforced.

bool startFrameProcessorWithGfxSystem

Whether to start the frame processor with the graphics system or to start it when the engine starts running.

This is set to false by default, which is best for games. However, other users may want to continue rendering without an active gameloop, thus this option exists.