AppConfiguration class
#include <nCine/AppConfiguration.h>
Initialization settings for an nCine application.
Populated in IAppEventHandler::
Public static variables
-
static std::
int32_t WindowPositionIgnore constexpr - Specifies uninitialized window position coordinate.
Constructors, destructors, conversion operators
Public functions
- auto GetDataPath() const -> const String&
- Returns path for the application to load data from.
- auto GetDataPath() -> String&
- auto IsGlCoreProfile() const -> bool
- Returns
trueif the OpenGL profile is going to be core. - auto IsGlForwardCompatible() const -> bool
- Returns
trueif the OpenGL context is going to be forward compatible. -
auto GetGlMajorVersion() const -> std::
uint32_t - Returns major version number of the OpenGL context.
-
auto GetGlMinorVersion() const -> std::
uint32_t - Returns minor version number of the OpenGL context.
-
auto GetArgc() const -> std::
size_t - Returns number of arguments passed on the command-line.
-
auto GetArgv(std::
size_t index) const -> const StringView - Returns selected argument from the ones passed on the command-line.
Public variables
- Vector2i Resolution
- The screen resolution.
- Vector2i WindowPosition
- Window position coordinates in the virtual screen made of all the connected monitors.
-
std::
uint32_t FrameLimit - Maximum number of frames to render per second or 0 for no limit.
- float FrameTimerLogInterval
- Interval for frame timer accumulation average and log.
- bool Fullscreen
- Whether the screen is going to be in fullscreen mode.
- bool Resizable
- Whether the window is going to be resizable.
- bool WindowScaling
- Whether the window size is automatically scaled by the display factor.
- bool UseBufferMapping
- Whether mapping is used to update OpenGL buffers.
- bool UseBufferStorage
- Whether persistently mapped buffer storage is used for streaming buffers, if the device supports it.
-
std::
uint32_t FixedBatchSize - Fixed size of render commands to be collected for batching, overriding what the device asks for.
- String ShaderCachePath
- Path for the binary shaders cache (or empty to disable binary shader cache).
- String WindowTitle
- Window title.
- String WindowIconFilename
- Window icon filename.
-
std::
uint32_t VboSize - Maximum size in bytes for each VBO collecting geometry data.
-
std::
uint32_t IboSize - Maximum size in bytes for each IBO collecting index data.
-
std::
uint32_t VaoPoolSize - Maximum size for the pool of VAOs.
-
std::
uint32_t RenderCommandPoolSize - Initial size for the pool of render commands.
- bool WithDebugOverlay
- Whether the debug overlay is enabled.
- bool WithAudio
- Whether the audio subsystem is enabled.
- bool WithGraphics
- Whether the graphics subsystem is enabled.
- bool WithThreads
- Whether the threading subsystem is enabled.
- bool WithScenegraph
- Whether the scenegraph based rendering is enabled.
- bool WithVSync
- Whether the vertical synchronization is enabled.
- bool WithGlDebugContext
- Whether the OpenGL debug context is enabled.
Function documentation
String& nCine:: AppConfiguration:: GetDataPath()
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Variable documentation
std:: uint32_t nCine:: AppConfiguration:: FixedBatchSize
Fixed size of render commands to be collected for batching, overriding what the device asks for.
0 lets the rendering backend decide - either from its uniform block budget, or from the IRhiCapabilities::IntValues::MaxBatchSize it publishes when the budget is not what limits it. Set this only to override that from the build (WITH_FIXED_BATCH_SIZE) or as a driver workaround.