Rendering

All rendering related functionality. More...

Classes
class	PostEffect
	A fullscreen shader effect. More...
class	RenderMeshExample
	An example scene object which renders a mesh. More...
class	RenderObjectExample
	An example scene object which renders using a callback. More...
class	RenderShapeExample
	An example scene object which renders a DTS. More...
Modules
	Font
	Various helpers for working with fonts from script.
	GFX
	The low level graphics interface to the engine.
	Lighting
	The script functionality related to the lighting systems and lights.
	Render Binning
	The render sorting and batching system.
Enumerations
enum	PFXRenderTime {   PFXBeforeBin,   PFXAfterBin,   PFXAfterDiffuse,   PFXEndOfFrame,   PFXTexGenOnDemand }
	When to process this effect during the frame. More...
enum	PFXTargetClear {   PFXTargetClear_None,   PFXTargetClear_OnCreate,   PFXTargetClear_OnDraw }
	Describes when the target texture should be cleared. More...
Functions
void	addGlobalShaderMacro (string name, string value=NULL)
	Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded.
void	beginSampling (location,[backend])
	Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name.
void	enableSamples (pattern,[state])
	Enable sampling for all keys that match the given name pattern. Slashes are treated as separators.
int	getActiveDDSFiles ()
	Returns the count of active DDSs files in memory.
String	getBitmapInfo (string filename)
	Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found.
void	initDisplayDeviceInfo ()
	Initializes variables that track device and vendor information/IDs.
void	playJournalToVideo (string journalFile, string videoFile=NULL, string encoder="THEORA", float framerate=30.0f, Point2I resolution=Point2I(0, 0))
	Load a journal file and capture it video.
void	removeGlobalShaderMacro (string name)
	Removes an existing global macro by name.
void	startVideoCapture (GuiCanvas canvas, string filename, string encoder="THEORA", float framerate=30.0f, Point2I resolution=Point2I(0, 0))
	Begins a video capture session.
void	stopSampling ()
	Stops the rendering sampler.
void	stopVideoCapture ()
	Stops the video capture session.
Variables
bool	$pref::imposter::canShadow
	User preference which toggles shadows from imposters. Defaults to true.
float	$pref::TS::detailAdjust
	User perference for scaling the TSShape level of detail. The smaller the value the closer the camera must get to see the highest LOD. This setting can have a huge impact on performance in mesh heavy scenes. The default value is 1.
bool	$Scene::disableTerrainOcclusion
	Used to disable the somewhat expensive terrain occlusion testing.
bool	$Scene::disableZoneCulling
	If true, zone culling will be disabled and the scene contents will only be culled against the root frustum.
int	$TSControl::frameCount
	The number of frames that have been rendered since this control was created.
int	$pref::Reflect::frameLimitMS
	ReflectionManager tries not to spend more than this amount of time updating reflections per frame.
int	$Sampler::frequency
	Samples taken every nth frame.
bool	$Scene::lockCull
	Debug tool which locks the frustum culling to the current camera location.
int	$pref::TS::maxInstancingVerts
	Enables mesh instancing on non-skin meshes that have less that this count of verts. The default value is 200. Higher values can degrade performance.
int	$Scene::maxOccludersPerZone
	Maximum number of occluders that will be concurrently allowed into the scene culling state of any given zone.
float	$Scene::occluderMinHeightPercentage
	TODO.
float	$Scene::occluderMinWidthPercentage
	TODO.
float	$pref::Reflect::refractTexScale
	RefractTex has dimensions equal to the active render target scaled in both x and y by this float.
bool	$Scene::renderBoundingBoxes
	If true, the bounding boxes of objects will be displayed.
int	$pref::TS::skipLoadDLs
	User perference which causes TSShapes to skip loading higher lods. This potentialy reduces the GPU resources and materials generated as well as limits the LODs rendered. The default value is 0.
int	$pref::TS::skipRenderDLs
	User perference which causes TSShapes to skip rendering higher lods. This will reduce the number of draw calls and triangles rendered and improve rendering performance when proper LODs have been created for your models. The default value is 0.
float	$pref::TS::smallestVisiblePixelSize
	User perference which sets the smallest pixel size at which TSShapes will skip rendering. This will force all shapes to stop rendering when they get smaller than this size. The default value is -1 which disables it.
float	$pref::windEffectRadius
	Radius to affect the wind.

---

Detailed Description

All rendering related functionality.

---

Enumeration Type Documentation

enum PFXRenderTime

When to process this effect during the frame.

Enumerator:

PFXBeforeBin	Before a RenderInstManager bin.
PFXAfterBin	After a RenderInstManager bin.
PFXAfterDiffuse	After the diffuse rendering pass.
PFXEndOfFrame	When the end of the frame is reached.
PFXTexGenOnDemand	This PostEffect is not processed by the manager. It will generate its texture when it is requested.

enum PFXTargetClear

Describes when the target texture should be cleared.

Enumerator:

PFXTargetClear_None	Never clear the PostEffect target.
PFXTargetClear_OnCreate	Clear once on create.
PFXTargetClear_OnDraw	Clear before every draw.

---

Function Documentation

void addGlobalShaderMacro	(	string	name,
		string	value = NULL
	)

Adds a global shader macro which will be merged with the script defined macros on every shader. The macro will replace the value of an existing macro of the same name. For the new macro to take effect all the shaders in the system need to be reloaded.

See also:

resetLightManager, removeGlobalShaderMacro

void beginSampling

(

location

)

Takes a string informing the backend where to store sample data and optionally a name of the specific logging backend to use. The default is the CSV backend. In most cases, the logging store will be a file name.

Example:

beginSampling( "mysamples.csv" );

void enableSamples

(

pattern

)

Enable sampling for all keys that match the given name pattern. Slashes are treated as separators.

int getActiveDDSFiles

(

)

Returns the count of active DDSs files in memory.

String getBitmapInfo

(

string

filename

)

Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found.

void initDisplayDeviceInfo

(

)

Initializes variables that track device and vendor information/IDs.

void playJournalToVideo	(	string	journalFile,
		string	videoFile = NULL,
		string	encoder = "THEORA",
		float	framerate = 30.0f,
		Point2I	resolution = Point2I(0, 0)
	)

Load a journal file and capture it video.

void removeGlobalShaderMacro

(

string

name

)

Removes an existing global macro by name.

See also:

addGlobalShaderMacro

void startVideoCapture	(	GuiCanvas	canvas,
		string	filename,
		string	encoder = "THEORA",
		float	framerate = 30.0f,
		Point2I	resolution = Point2I(0, 0)
	)

Begins a video capture session.

See also:

stopVideoCapture

void stopSampling

(

)

Stops the rendering sampler.

void stopVideoCapture

(

)

Stops the video capture session.

See also:

startVideoCapture

---

Variable Documentation

bool $pref::imposter::canShadow

User preference which toggles shadows from imposters. Defaults to true.

float $pref::TS::detailAdjust

User perference for scaling the TSShape level of detail. The smaller the value the closer the camera must get to see the highest LOD. This setting can have a huge impact on performance in mesh heavy scenes. The default value is 1.

bool $Scene::disableTerrainOcclusion

Used to disable the somewhat expensive terrain occlusion testing.

bool $Scene::disableZoneCulling

If true, zone culling will be disabled and the scene contents will only be culled against the root frustum.

int $TSControl::frameCount

The number of frames that have been rendered since this control was created.

int $pref::Reflect::frameLimitMS

ReflectionManager tries not to spend more than this amount of time updating reflections per frame.

int $Sampler::frequency

Samples taken every nth frame.

bool $Scene::lockCull

Debug tool which locks the frustum culling to the current camera location.

int $pref::TS::maxInstancingVerts

Enables mesh instancing on non-skin meshes that have less that this count of verts. The default value is 200. Higher values can degrade performance.

int $Scene::maxOccludersPerZone

Maximum number of occluders that will be concurrently allowed into the scene culling state of any given zone.

float $Scene::occluderMinHeightPercentage

TODO.

float $Scene::occluderMinWidthPercentage

TODO.

float $pref::Reflect::refractTexScale

RefractTex has dimensions equal to the active render target scaled in both x and y by this float.

bool $Scene::renderBoundingBoxes

If true, the bounding boxes of objects will be displayed.

int $pref::TS::skipLoadDLs

User perference which causes TSShapes to skip loading higher lods. This potentialy reduces the GPU resources and materials generated as well as limits the LODs rendered. The default value is 0.

See also:

$pref::TS::skipRenderDLs

int $pref::TS::skipRenderDLs

User perference which causes TSShapes to skip rendering higher lods. This will reduce the number of draw calls and triangles rendered and improve rendering performance when proper LODs have been created for your models. The default value is 0.

See also:

$pref::TS::skipLoadDLs

float $pref::TS::smallestVisiblePixelSize

User perference which sets the smallest pixel size at which TSShapes will skip rendering. This will force all shapes to stop rendering when they get smaller than this size. The default value is -1 which disables it.

float $pref::windEffectRadius

Radius to affect the wind.