CYB::API::Platform Class Reference

Strong typing for Platform::Identifier. More...

#include <OSDeclaration.hpp>

Public Types
enum	Identifier : unsigned int {   ALL = 0xFFFFFFFF, POSIX = 1, LINUX = 3, OSX = 5,   WINDOWS = 2 }
	A bitmask platform identifier. Should be preferred over the macros whenever possible. More...

Static Public Member Functions
static constexpr Identifier	Current (void)
	Get the current Platform being compiled on. More...
static constexpr bool	IsDebug (void)
	Get if the current compilation is a debug compilation. More...
static constexpr bool	IsTest (void)
	Get if the current compilation is a test compilation. More...

Detailed Description

Strong typing for Platform::Identifier.

Definition at line 28 of file OSDeclaration.hpp.

Member Enumeration Documentation

enum CYB::API::Platform::Identifier : unsigned int

A bitmask platform identifier. Should be preferred over the macros whenever possible.

Enumerator
ALL	All platforms.
POSIX	Posix platforms.
LINUX	Linux platforms.
OSX	OSX platforms.
WINDOWS	Win32 platforms.

Definition at line 31 of file OSDeclaration.hpp.

                            : unsigned int {
                ALL = 0xFFFFFFFF,   
                POSIX = 1,  
                LINUX = 3,  
                OSX = 5,    
                WINDOWS = 2,    
            };

Member Function Documentation

static constexpr Identifier CYB::API::Platform::Current ( void  )

static

Get the current Platform being compiled on.

Returns

The Identifier for the current Platform

static constexpr bool CYB::API::Platform::IsDebug ( void  )

static

Get if the current compilation is a debug compilation.

Returns

true if the current compilation is a debug compilation, false otherwise

static constexpr bool CYB::API::Platform::IsTest ( void  )

static

Get if the current compilation is a test compilation.

Returns

true if the current compilation is a test compilation, false otherwise

---

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

• Engine/API/Declarations/OSDeclaration.hpp