render Class Reference

#include <LUA_API_Render.h>

Public Member Functions
void render	setFullscreen (int)
	Set fullscreen. More...
void render	setVSync (int)
	Set Vsync. More...
void render	setQuality ()
	Set renderer quality. More...
void render	setResolution ()
	Set renderer resolution. More...
void render	setRenderer ()
	Set renderer. More...
void render	setFSAA ()
	Set FSAA. More...
void render	setShowStats ()
	Set show statistics. More...
void render	getPossibleResolutions ()
	Get possible resolutions. More...
void render	getPossibleFSAA ()
	Get possible FSAA. More...
void render	getPossibleRenderers ()
	Get possible renderers. More...
void render	getResolution ()
	Get resolution. More...
void render	getQuality ()
	Get quality. More...
void render	getShowStats ()
	Get show statistics. More...
void render	getFSAA ()
	Get FSAA. More...
void render	getRenderer ()
	Get renderer. More...
void render	getVsync ()
	Get vsync. More...
void render	getFullScreen ()
	Get fullscreen. More...
void render	setShowDefaultGUI ()
	Set show default GUI. More...
void render	getShowDefaultGUI ()
	Get show default GUI. More...
void render	getDefaultGUI_ID ()
	Get default GUI ID. More...

Detailed Description

This area covers render functions. Set or get various render propertie.
Use as render.function()
The render functions are used to control the display, restart the renderer to apply settings.
Control features like fsaa, vsync etc... all from lua. Great for option screens.

For more information on how these functions can be used please visit the User Manual - http://www.aurasoft-skyline.co.uk

Member Function Documentation

void render render::getDefaultGUI_ID

(

)

Get default GUI ID.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    defguiID = render.getDefaultGUI_ID();
end

void render render::getFSAA

(

)

Get FSAA.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    currFSAA = render.getFSAA();
end

void render render::getFullScreen

(

)

Get fullscreen.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    fullscr = render.getFullScreen();
end

void render render::getPossibleFSAA

(

)

Get possible FSAA.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    possFSAA = render.getPossibleFSAA();
end

void render render::getPossibleRenderers

(

)

Get possible renderers.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    possRenders = render.getPossibleRenderers();
end

void render render::getPossibleResolutions

(

)

Get possible resolutions.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    possRes = render.getPossibleResolutions();
end

void render render::getQuality

(

)

Get quality.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    currQual = render.getQuality();
end

void render render::getRenderer

(

)

Get renderer.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    currRender = render.getRenderer();
end

void render render::getResolution

(

)

Get resolution.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    currRes = render.getResolution();
end

void render render::getShowDefaultGUI

(

)

Get show default GUI.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
     defGUI = render.getShowDefaultGUI();
end

void render render::getShowStats

(

)

Get show statistics.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    rendStats = render.getShowStats();
end

void render render::getVsync

(

)

Get vsync.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    vsync = render.getVsync();
end

void render render::setFSAA

(

)

Set FSAA.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setFSAA(1);
end

void render render::setFullscreen

(

int

)

Set fullscreen.

Parameters

property

: 1 is on 0 is off

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setFullscreen( 1 );
end

void render render::setQuality

(

)

Set renderer quality.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setQuality(quality);
end

void render render::setRenderer

(

)

Set renderer.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setRenderer();
end

void render render::setResolution

(

)

Set renderer resolution.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setResolution(resolution);
end

void render render::setShowDefaultGUI

(

)

Set show default GUI.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setShowDefaultGUI("mainGUI");
end

void render render::setShowStats

(

)

Set show statistics.

Parameters

property

:

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setShowStats(1);
end

void render render::setVSync

(

int

)

Set Vsync.

Parameters

property

: 1 is on 0 is off

Here is a Small Example of how to use this function:

function onInit(objID)
    render.setVSync( 1 );
end

---

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

• LUA_API_Render.h