Deki 1.3.0
Modular C++ 2D engine for embedded displays and desktop
Loading...
Searching...
No Matches
ProjectSettings.h File Reference

Classes

struct  ProjectSettings::FileHeader
 Binary file header for project settings. More...
struct  ProjectSettings::DisplaySettings
 Display/rendering settings. More...
struct  ProjectSettings::RuntimeSettings
 Runtime settings (version 3+). More...
struct  ProjectSettings::PipelineConfig

Namespaces

namespace  ProjectSettings
 Runtime project settings loaded from dproject.bin.

Functions

bool ProjectSettings::Load (const uint8_t *data, size_t size)
 Load project settings from binary file.
int32_t ProjectSettings::GetTargetFPS ()
 Get the target FPS from loaded project settings.
const char * ProjectSettings::GetStartupScene ()
 Get the startup scene path from loaded project settings.
const char * ProjectSettings::GetRenderPipeline ()
 Get the render pipeline renderer name (version 4+).
int ProjectSettings::GetPassCount ()
 Get the number of render passes in the pipeline (version 4+).
const char * ProjectSettings::GetPassName (int index)
 Get the name of a render pass by index (version 4+).
bool ProjectSettings::LoadFromFile (const char *path=nullptr)
 Load project settings from filesystem.
bool ProjectSettings::ReadPackageSettingBool (const char *section, const char *key, bool &out)
 Runtime lookup of one package setting from the last Load().
bool ProjectSettings::ReadPackageSettingInt32 (const char *section, const char *key, int32_t &out)
bool ProjectSettings::ReadPackageSettingFloat (const char *section, const char *key, float &out)
std::vector< uint8_t > ProjectSettings::Write (int32_t displayWidth, int32_t displayHeight, uint8_t colorFormat, int32_t targetFPS=0, const char *startupScene=nullptr, const char *rendererName=nullptr, const char *const *passNames=nullptr, int passCount=0)
 Serialize project settings to a dproject.bin image (editor only).

Variables

constexpr const char * ProjectSettings::FILENAME = "F:/dproject.bin"
constexpr const char * ProjectSettings::EXPORT_FILENAME = "dproject.bin"
constexpr uint32_t ProjectSettings::MAGIC = 0x444B5052
constexpr uint16_t ProjectSettings::VERSION = 5
constexpr size_t ProjectSettings::MAX_FILE_SIZE = 16384
static constexpr int ProjectSettings::MAX_PIPELINE_NAME = 32
 Render pipeline configuration (version 4+).
static constexpr int ProjectSettings::MAX_PASSES = 8