Mondschein Engine  0.3.0
Static Public Member Functions | List of all members
mondschein::Engine Class Reference

This static provides general control and communications. More...

#include <types.h>

Static Public Member Functions

static void init (display::Visual_p _v)
 Internally initialize a visual. More...
 
static void init (renderer::Context_p _c)
 Internally initialize a context. More...
 
static void make_current (display::Visual_p _v, renderer::Context_p _c)
 (Re-)define the current rendering visual and context More...
 
static bool is_current (display::Visual_p _v)
 Check for current visual. More...
 
static bool is_current (renderer::Context_p _c)
 Check for current context. More...
 

Detailed Description

This static provides general control and communications.

The Engine class is a static class (it cannot be instantiated) providing functionality for the Mondschein Engine to communicate with itself.

Definition at line 874 of file types.h.

Member Function Documentation

void Engine::init ( display::Visual_p  _v)
static

Internally initialize a visual.

Parameters
_vthe rendering visual DEVELOPER FUNCTION

This function should not be used explicitely. It registers a rendering visual as current after initialization.

Definition at line 32 of file engine.cpp.

void Engine::init ( renderer::Context_p  _c)
static

Internally initialize a context.

Parameters
_cthe rendering context DEVELOPER FUNCTION

This function should not be used explicitely. It registers a rendering context as current after initialization.

Definition at line 38 of file engine.cpp.

bool Engine::is_current ( display::Visual_p  _v)
static

Check for current visual.

Parameters
_vthe rendering visual
Returns
true if _v is current, false otherwise

This function checks whether or not _v is the current rendering visual and retrns the result.
Checking for current visual is often done automatically by the Mondschein Engine to avoid memory leaks and undefined behaviour but the Mondschein never makes a visual current explicitely.

Definition at line 53 of file engine.cpp.

bool Engine::is_current ( renderer::Context_p  _c)
static

Check for current context.

Parameters
_cthe rendering context
Returns
true if _c is current, false otherwise

This function checks whether or not _v is the current rendering context and retrns the result.
Checking for current context is often done automatically by the Mondschein Engine to avoid memory leaks and undefined behaviour but the Mondschein never makes a context current explicitely.

Definition at line 59 of file engine.cpp.

void Engine::make_current ( display::Visual_p  _v,
renderer::Context_p  _c 
)
static

(Re-)define the current rendering visual and context

Parameters
_vthe rendering visual
_cthe rendering context

This function make _v and _c current, that means all subsequent rendering operations go into _v and _c.

Definition at line 44 of file engine.cpp.


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