redhand::engine_config class

This struct specifies all the properties of the game engine.

Contents

Public functions

auto doesMatchVersion(unsigned int major, unsigned int minor, unsigned int patch) -> bool
check if the the version of the engine matches the given version
auto versionIsGreaterThan(unsigned int major, unsigned int minor, unsigned int patch) -> bool
check if the version of the engine is greater or equal the given value
auto versionIsGreaterThan(std::string version) -> bool
check if the version of the engine is greater or equal the given value

Public variables

int OPENGL_VERSION_MINOR
The oldest version of OpenGL which may be used.
int OPENGL_PROFILE
The profile OpenGL should run in (should be redhand::OPENGL_CORE_PROFILE (0x00032001) )
int SAMPLES
Specifies the desired number of samples to use for multisampling.
bool RESIZABLE
true if window should be resizable false if not (will be ignored in fullscreen or not decorated)
int OPENGL_FORWARD_COMPAT
specifies whether the OpenGL context should be forward-compatible, i.e. one where all functionality deprecated in the requested version of OpenGL is removed.
unsigned int window_width
the width of the window
unsigned int window_height
the heigth of the window
std::string title
the window title
unsigned int redhand_version_major
the current redhand major version X.y.z
unsigned int redhand_version_minor
the current redhand minor version x.Y.z
unsigned int redhand_version_patch
the current redhand pacht version x.y.Z

Function documentation

bool redhand::engine_config::doesMatchVersion(unsigned int major, unsigned int minor, unsigned int patch)

check if the the version of the engine matches the given version

Parameters
major the major version number X.y.z
minor the minor version number x.Y.z
patch the patch version number x.y.Z
Returns true the version match

bool redhand::engine_config::versionIsGreaterThan(unsigned int major, unsigned int minor, unsigned int patch)

check if the version of the engine is greater or equal the given value

Parameters
major the major version number X.y.z
minor the minor version number x.Y.z
patch the patch version number x.y.Z
Returns true the version of the engine is greater or equal to the given version

bool redhand::engine_config::versionIsGreaterThan(std::string version)

check if the version of the engine is greater or equal the given value

Parameters
version the version in the format x.y.z
Returns true the version of the engine is greater or equal to the given version

Variable documentation

int redhand::engine_config::SAMPLES

Specifies the desired number of samples to use for multisampling.

Zero disables multisampling. A value of (redhand::DONT_CARE (-1) ) means the application has no preference.