CYB::Engine::Parameters Class Reference

Compilation configuration variables. More...

#include <CYBEngineParameters.hpp>

Public Types
enum	: unsigned long long {   VERSION_MAJOR = 3, VERSION_MINOR = 0, VERSION_REVISION = 0, COPYRIGHT_YEAR = 2016,   ENGINE_HEAP_INITIAL_COMMIT_SIZE = API::ByteConverters::Megabytes(5), LOGGER_HEAP_INITIAL_COMMIT_SIZE = API::ByteConverters::Megabytes(1), HEAP_RESERVATION_SIZE = API::ByteConverters::Terabytes(1) / 4, LOGGER_HEAP_RETRY_COUNT = 2 }
	Various engine constants. More...

Static Public Member Functions
static API::EngineInformation	CreateEngineInformation (void) noexcept
	Creates the correct CYB::API::EngineInformation struct. More...

Static Public Attributes
static const char *const	FTempPathName
	The directory in the temp folder to use.

Detailed Description

Compilation configuration variables.

Definition at line 7 of file CYBEngineParameters.hpp.

Member Enumeration Documentation

anonymous enum : unsigned long long

Various engine constants.

Enumerator
VERSION_MAJOR	The major engine version.
VERSION_MINOR	The minor engine version.
VERSION_REVISION	The current engine revision.
COPYRIGHT_YEAR	The engine's copyright year.
ENGINE_HEAP_INITIAL_COMMIT_SIZE	The inital amount of memory to be commited by the engine heap.
LOGGER_HEAP_INITIAL_COMMIT_SIZE	The inital amount of memory to be commited by the Logger heap.
HEAP_RESERVATION_SIZE	The amount of address space reserved by CYB::Engine::Heaps.
LOGGER_HEAP_RETRY_COUNT	The number of times to try and log again after a failed allocation before giving up.

Definition at line 10 of file CYBEngineParameters.hpp.

                 : unsigned long long {
                VERSION_MAJOR = 3,  
                VERSION_MINOR = 0,  
                VERSION_REVISION = 0,   
                COPYRIGHT_YEAR = 2016,  

                ENGINE_HEAP_INITIAL_COMMIT_SIZE = API::ByteConverters::Megabytes(5),    
                LOGGER_HEAP_INITIAL_COMMIT_SIZE = API::ByteConverters::Megabytes(1),    

                HEAP_RESERVATION_SIZE = API::ByteConverters::Terabytes(1) / 4,  

                LOGGER_HEAP_RETRY_COUNT = 2,    
            };

Member Function Documentation

CYB::API::EngineInformation CYB::Engine::Parameters::CreateEngineInformation ( void  )

staticnoexcept

Creates the correct CYB::API::EngineInformation struct.

Returns

A populated CYB::API::EngineInformation

Thread Safety

This function require no thread safety

Definition at line 6 of file CYBEngineParameters.cpp.

                                                                                  {
    return{
        u8"CyberEngine Mark III",
        u8"Copyright Dextraspace Entertainment",
        COPYRIGHT_YEAR,
        VERSION_MAJOR,
        VERSION_MINOR,
        VERSION_REVISION,
        __DATE__,
        __TIME__ " EST",
    };
}

---

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

• Engine/Engine/Core/CYBEngineParameters.hpp
• Engine/Engine/Core/CYBEngineParameters.cpp

---

Generated by   1.8.6