DEKI/ENGINE docs
Deki 0.19.0
Modular C++ 2D engine for embedded displays and desktop
Loading...
Searching...
No Matches
ProjectSettings.h File Reference

Classes

struct  Deki::ProjectSettings::FileHeader
struct  Deki::ProjectSettings::DisplaySettings
struct  Deki::ProjectSettings::RuntimeSettings

Namespaces

namespace  Deki
namespace  Deki::ProjectSettings

Functions

bool Deki::ProjectSettings::Load (const uint8_t *data, size_t size)
 Reads project settings from the bytes of a project_data.bin.
int32_t Deki::ProjectSettings::GetTargetFPS ()
 Target frame rate, 0 for no limit.
Storage::Location Deki::ProjectSettings::GetAssetStorage ()
 Whether this build's assets are on internal or external storage.
const char * Deki::ProjectSettings::GetStartupScene ()
 Startup scene path, empty when not set.
const char * Deki::ProjectSettings::GetRenderPipeline ()
 Renderer name, such as "standard2d"; "standard2d" when not set.
int Deki::ProjectSettings::GetPassCount ()
 Number of render passes, 0 when not set.
const char * Deki::ProjectSettings::GetPassName (int index)
 Name of render pass index (such as "clip2d"), or "" when out of range.
bool Deki::ProjectSettings::LoadFromFile (const char *path=nullptr)
 Loads project settings from path, or from kFilename when it is nullptr.
bool Deki::ProjectSettings::ReadPackageSettingBool (const char *section, const char *key, bool &out)
 Reads one package setting from the last Load().
bool Deki::ProjectSettings::ReadPackageSettingInt32 (const char *section, const char *key, int32_t &out)
bool Deki::ProjectSettings::ReadPackageSettingFloat (const char *section, const char *key, float &out)
std::vector< uint8_t > Deki::ProjectSettings::Write (Storage::Location assetStorage, int32_t targetFPS=0, const char *startupScene=nullptr, const char *rendererName=nullptr, const char *const *passNames=nullptr, int passCount=0)
 Builds a project_data.bin image (editor only).

Variables

constexpr const char * Deki::ProjectSettings::kFilename = "F:/project_data.bin"
constexpr const char * Deki::ProjectSettings::kExportFilename = "project_data.bin"
constexpr uint32_t Deki::ProjectSettings::kMagic = 0x444B5052
constexpr uint16_t Deki::ProjectSettings::kVersion = 7
constexpr uint16_t Deki::ProjectSettings::kFlagAssetsExternal = 1u << 0
constexpr size_t Deki::ProjectSettings::kMaxFileSize = 16384