Xors3d Engine
Post-effects

Functions

BBDECL void BBCALL xClearPostEffectConstants (PostEffect *postEffect)
 Delete all user defined constants from effect.
BBDECL void BBCALL xDeletePostEffectConstant (PostEffect *postEffect, const char *name)
 Delete user defined constant from effect.
BBDECL void BBCALL xFreePostEffect (PostEffect *postEffect)
 Frees loaded post-effect.
BBDECL PostEffect *BBCALL xLoadPostEffect (const char *path)
 Loads new post-effect from file and returns it's handle.
BBDECL void BBCALL xRenderPostEffects ()
 Renders all post-effects sequence.
BBDECL void BBCALL xSetPostEffect (int index, PostEffect *postEffect, const char *technique="MainTechnique")
 Adds post-effect in sequence to post-processing.
BBDECL void BBCALL xSetPostEffectBool (PostEffect *postEffect, const char *name, bool value)
 Adds user defined boolean constant to effect.
BBDECL void BBCALL xSetPostEffectFloat (PostEffect *postEffect, const char *name, float value)
 Adds user defined float constant to effect.
BBDECL void BBCALL xSetPostEffectInt (PostEffect *postEffect, const char *name, int value)
 Adds user defined integer constant to effect.
BBDECL void BBCALL xSetPostEffectTexture (PostEffect *postEffect, const char *name, Texture *texture, int frame=0)
 Adds user defined texture constant to effect.
BBDECL void BBCALL xSetPostEffectVector (PostEffect *postEffect, const char *name, float x, float y, float z, float w=1.0f)
 Adds user defined vector constant to effect.

Function Documentation

BBDECL PostEffect* BBCALL xLoadPostEffect ( const char *  path)

Loads new post-effect from file and returns it's handle.

Parameters:
pathPath to effect file
BBDECL void BBCALL xFreePostEffect ( PostEffect *  postEffect)

Frees loaded post-effect.

This commands automaticaly delete post-effect from effects sequence

Parameters:
postEffectPost-effect handle
BBDECL void BBCALL xSetPostEffect ( int  index,
PostEffect *  postEffect,
const char *  technique = "MainTechnique" 
)

Adds post-effect in sequence to post-processing.

Post-effects applies in index order

Parameters:
indexPost-effect index
postEffectPost-effect handle
techniquePost-effect technique to apply
BBDECL void BBCALL xRenderPostEffects ( )

Renders all post-effects sequence.

BBDECL void BBCALL xSetPostEffectInt ( PostEffect *  postEffect,
const char *  name,
int  value 
)

Adds user defined integer constant to effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
valueConstant value
BBDECL void BBCALL xSetPostEffectFloat ( PostEffect *  postEffect,
const char *  name,
float  value 
)

Adds user defined float constant to effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
valueConstant value
BBDECL void BBCALL xSetPostEffectBool ( PostEffect *  postEffect,
const char *  name,
bool  value 
)

Adds user defined boolean constant to effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
valueConstant value
BBDECL void BBCALL xSetPostEffectVector ( PostEffect *  postEffect,
const char *  name,
float  x,
float  y,
float  z,
float  w = 1.0f 
)

Adds user defined vector constant to effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
xVector's x-component
yVector's y-component
zVector's z-component
wVector's w-component
BBDECL void BBCALL xSetPostEffectTexture ( PostEffect *  postEffect,
const char *  name,
Texture *  texture,
int  frame = 0 
)

Adds user defined texture constant to effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
textureTexture handle
frameTexture frame
BBDECL void BBCALL xDeletePostEffectConstant ( PostEffect *  postEffect,
const char *  name 
)

Delete user defined constant from effect.

Parameters:
postEffectPost-effect handle
namePost-effect constant name
BBDECL void BBCALL xClearPostEffectConstants ( PostEffect *  postEffect)

Delete all user defined constants from effect.

Parameters:
postEffectPost-effect handle