nCine 2026.08.r1-e9a2342
A cross-platform 2D game engine
Loading...
Searching...
No Matches
ncine::AppConfiguration Class Reference

The class storing initialization settings for an nCine application. More...

#include <AppConfiguration.h>

Collaboration diagram for ncine::AppConfiguration:

Classes

struct  Audio
 Audio related configuration. More...
 
struct  Features
 Feature switches. More...
 
struct  Graphics
 Graphics related configuration. More...
 
struct  JobSystem
 Job system related configuration. More...
 
struct  Logging
 Logging related configuration. More...
 
struct  Window
 Window related configuration. More...
 

Public Member Functions

 AppConfiguration ()
 Default constructor setting the defaults.
 
const nctl::StringdataPath () const
 
nctl::StringdataPath ()
 
int argc () const
 
const char * argv (int index) const
 

Public Attributes

Logging logging
 
Window window
 
Graphics graphics
 
Audio audio
 
JobSystem jobSystem
 
Features features
 
const float profileTextUpdateTime
 

Friends

class PCApplication
 
class AndroidApplication
 

Detailed Description

The class storing initialization settings for an nCine application.

Member Function Documentation

◆ argc()

int ncine::AppConfiguration::argc ( ) const
inline
Returns
The number of arguments passed on the command line

◆ argv()

const char * ncine::AppConfiguration::argv ( int  index) const
Returns
The selected argument from the ones passed on the command line

◆ dataPath() [1/2]

nctl::String & ncine::AppConfiguration::dataPath ( )
Returns
The path for the application to load data from

Allows to set the value of the static field FileSystem::dataPath_.

◆ dataPath() [2/2]

const nctl::String & ncine::AppConfiguration::dataPath ( ) const
Returns
The constant path for the application to load data from

Member Data Documentation

◆ profileTextUpdateTime

const float ncine::AppConfiguration::profileTextUpdateTime
Returns
The update time in seconds for the profile text nodes
Note
It can only be changed at compile time

The documentation for this class was generated from the following files: