CyberEngineMkIII
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Private Attributes | List of all members
CYB::API::Interop::Context Class Reference

Class which is used as an API for the engine. More...

#include <Context.hpp>

Inheritance diagram for CYB::API::Interop::Context:
Inheritance graph
[legend]
Collaboration diagram for CYB::API::Interop::Context:
Collaboration graph
[legend]

Public Member Functions

 Context (const Context &)=delete
 See Default Constructors and Destructor.
 

Static Public Member Functions

static ContextGetContext (void) noexcept
 Get the API's Context. More...
 

Public Attributes

AllocatorFAllocator
 The Allocator.
 
LoggerFLogger
 The Logger.
 

Protected Member Functions

 Context (Allocator &AAllocator, Logger &ALogger) noexcept
 Setup the context. More...
 

Static Private Attributes

static ContextFContext
 The context reference for the unit. This is not used inside the engine.
 

Detailed Description

Class which is used as an API for the engine.

Definition at line 7 of file Context.hpp.

Constructor & Destructor Documentation

CYB::API::Interop::Context::Context ( Allocator AAllocator,
Logger ALogger 
)
protectednoexcept

Setup the context.

Parameters
AAllocatorThe Allocator
ALoggerThe Logger
Thread Safety
This function requires no thread safety

Member Function Documentation

CYB::API::Interop::Context & CYB::API::Interop::Context::GetContext ( void  )
staticnoexcept

Get the API's Context.

Returns
The API Context
Thread Safety
This function requires no thread safety

Definition at line 35 of file CYBInterop.cpp.

35  {
36  return Core().CurrentContext();
37 }
Context & CurrentContext(void) noexcept
Get the current Context.
Definition: CYBCore.cpp:57
Engine::Core & Core(void) noexcept
Retrieve the Core singleton.
Definition: CYBCore.cpp:69

Here is the call graph for this function:

Here is the caller graph for this function:


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