nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper Class Reference

Wraps the nkGraphics::CompositorManager and offers functions for use in scripting. More...

Static Public Member Functions
static void	updateEnvironment (nkScripts::Environment *env)
static nkScripts::OutputValue	createOrRetrieve (const nkScripts::DataStack &stack)
static nkScripts::OutputValue	get (const nkScripts::DataStack &stack)
static nkScripts::OutputValue	rename (const nkScripts::DataStack &stack)
static nkScripts::OutputValue	erase (const nkScripts::DataStack &stack)

Detailed Description

Wraps the nkGraphics::CompositorManager and offers functions for use in scripting.

Member Function Documentation

updateEnvironment()

static void nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper::updateEnvironment ( nkScripts::Environment *  env )

static

Updates a given environment and set it up to use all functions wrapped by this wrapper.

Parameters

env	The environment to set up.

createOrRetrieve()

static nkScripts::OutputValue nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper::createOrRetrieve ( const nkScripts::DataStack &  stack )

static

Wrapper function for nkGraphics::CompositorManager::createOrRetrieve().

local c = nkGraphics.CompositorManager.createOrRetrieve("Hey") ;

Parameters

stack

The parameter stack.

Returns

The output value, as a nkGraphics::Compositor.

get()

static nkScripts::OutputValue nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper::get ( const nkScripts::DataStack &  stack )

static

Wrapper function for nkGraphics::CompositorManager::get().

local c = nkGraphics.CompositorManager.get("Hey") ;

Parameters

stack

The parameter stack.

Returns

The output value, as a nkGraphics::Compositor.

rename()

static nkScripts::OutputValue nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper::rename ( const nkScripts::DataStack &  stack )

static

Wrapper function for nkGraphics::CompositorManager::rename().

local c = nkGraphics.CompositorManager.rename("Hey", "Hello") ;

Parameters

stack

The parameter stack.

Returns

The output value, empty.

erase()

static nkScripts::OutputValue nkAstraeus::nkGraphicsWrap::CompositorManagerWrapper::erase ( const nkScripts::DataStack &  stack )

static

Wrapper function for nkGraphics::CompositorManager::erase().

local c = nkGraphics.CompositorManager.erase("Hey") ;

Parameters

stack

The parameter stack.

Returns

The output value, empty.

---

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

• Documentation/Headers/NilkinsAstraeus/Scripts/nkGraphicsWrap/Compositors/CompositorManagerWrapper.h