DEKI/ENGINE docs
Deki 0.19.0
Modular C++ 2D engine for embedded displays and desktop
Loading...
Searching...
No Matches
Project settings

Every settings section a project can have under settings/, and who defines it. The key in the file is the property name.

Section Defined by Properties
Core engine 2
Units engine 3
Rendering deki-rendering 4

Engine sections

Core settings

Project settings section Core (CoreProjectSettings).

Category: Settings · Type: Deki::CoreProjectSettings

Property Type Default Constraints Description
capFps bool true Cap play-mode FPS at the target frame rate below. Disable to let the game run at the editor's refresh rate (typically 60 Hz with vsync).
targetFps int32 60 1 to 240 Target frame rate (FPS) when capping is enabled. The game tries to hit this rate; if the hardware can't keep up it runs slower. Ignored when 'Cap FPS' is off.

Units settings

Project settings section Units (UnitProjectSettings).

Category: Settings · Type: Deki::UnitProjectSettings

Property Type Default Constraints Description
inspectorUnit enum "Pixels" Pixels, Meters Inspector display preference. Pixels: physical-quantity fields show as px / px/s / px/s². Meters: same fields show as m / m/s / m/s². Internal storage is always meters either way.
pixelsPerMeter float 16 1 to 1024 World scale: how many framebuffer pixels render one meter of world space. Drives inspector px<->m conversion and the default zoom of new cameras (CameraComponent::pixelsPerMeter sentinel).
temperatureUnit enum "Celsius" Celsius, Fahrenheit Temperature scale shown in the inspector. Storage is always degrees Celsius; this only changes what you read and type.

Package sections are documented on each package's own site, linked above.