"No one can be told what GeeXLab is, you have to see it for yourself!"

"Stop Playing Games and Start Making Them! With GeeXLab, your are on your way!"


Quick Links
What is GeeXLab
Download GeeXLab
GeeXLab Requirements
Online Help
Articles and Tutorials
Samples Screenshots
Videos

GeeXLab Changelog

XML Ref. Guide
Scripting Ref. Guide
Code Samples

Purchase GeeXLab
GeeXLab SDK

Shader Library

Follow GeeXLab's News
GeeXLab news, articles, tutorials and demos @ Geeks3D.com
GeeXLab @ Twitter GeeXLab RSS Feed

Subscribe to GeeXLab news by email

[ Back to Geeks3D.com ]

GeeXLab

GeeXLab

Laboratory for Real Time 3D Programming (prototyping and demos)
OpenGL, Lua, Python, GLSL,
PhysX and more...

Reference Guide
Host-API Lua / Python



Back to Homepage
Back to Developer's Guide Index

HYP_PostProcessing Library


Description
Post processing library

Number of functions: 21

HYP_PostProcessing.GetId

Description
Returns the post processing id from the name.

Languages: Lua

Parameters
  • name [STRING]: post processing name (declared in XML node)

    Return Values
  • id [INTEGER]: post processing id

    Code sample :

    ppId = HYP_PostProcessing.GetId("PP01")


    HYP_PostProcessing.SetState

    Description
    Sets the state (enabled or disabled) of the post processing.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • state [INTEGER]: state (0 or 1)

    Code sample :

    HYP_PostProcessing.SetState(ppId, 0)


    HYP_PostProcessing.GetEffectId

    Description
    Returns the id of a post processing effect.

    Languages: Lua

    Parameters
  • name [STRING]: effect name (declared in XML node)
  • ppId [INTEGER]: post processing id

    Return Values
  • id [INTEGER]: effect id

    Code sample :

    effectId = HYP_PostProcessing.GetEffectId("effect01", ppId)


    HYP_PostProcessing.SetEffectState

    Description
    Sets the state (enabled or disabled) of a post processing effect.

    Languages: Lua

    Parameters
  • id [INTEGER]: effect id
  • state [INTEGER]: state (0 or 1)

    Code sample :

    HYP_PostProcessing.SetEffectState(effectId, 0)


    HYP_PostProcessing.GetPhaseId

    Description
    Returns the id of a post processing effect phase.

    Languages: Lua

    Parameters
  • name [STRING]: phase name (declared in XML node)
  • effectId [INTEGER]: effect id

    Return Values
  • id [INTEGER]: phase id

    Code sample :

    phaseId = HYP_PostProcessing.GetPhaseId("phase01", effectId)


    HYP_PostProcessing.SetPhaseState

    Description
    Sets the state (enabled or disabled) of a post processing effect phase.

    Languages: Lua

    Parameters
  • id [INTEGER]: phase id
  • state [INTEGER]: state (0 or 1)

    Code sample :

    HYP_PostProcessing.SetPhaseState(phaseId, 0)


    HYP_PostProcessing.GetStepId

    Description
    Returns the id of a post processing effect phase step.

    Languages: Lua

    Parameters
  • name [STRING]: step name (declared in XML node)
  • phaseId [INTEGER]: phase id

    Return Values
  • id [INTEGER]: step id

    Code sample :

    stepId = HYP_PostProcessing.GetStepId("step01", phaseId)


    HYP_PostProcessing.SetStepState

    Description
    Sets the state (enabled or disabled) of a post processing effect phase step.

    Languages: Lua

    Parameters
  • id [INTEGER]: step id
  • state [INTEGER]: state (0 or 1)

    Code sample :

    HYP_PostProcessing.SetStepState(stepId, 0)


    HYP_PostProcessing.Create

    Description
    Creates a post processing object.

    Languages: Lua

    Return Values
  • id [INTEGER]: post processing id

    Code sample :

    id = HYP_PostProcessing.Create()


    HYP_PostProcessing.Destroy

    Description
    Destroys a post processing object.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id

    Code sample :

    HYP_PostProcessing.Destroy(id)


    HYP_PostProcessing.AddEffect

    Description
    Creates and adds an effect to an existing post processing object.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id

    Return Values
  • effectId [INTEGER]: effect id

    Code sample :

    effectId = HYP_PostProcessing.AddEffect(id)


    HYP_PostProcessing.RemoveEffect

    Description
    Removes and destroys an effect from an existing post processing object.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id

    Code sample :

    HYP_PostProcessing.RemoveEffect(id, effectId)


    HYP_PostProcessing.EffectAddPhase

    Description
    Creates and adds a phase to a post-processing effect.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id

    Return Values
  • phaseId [INTEGER]: phase id

    Code sample :

    phaseId = HYP_PostProcessing.EffectAddPhase(id, effectId)


    HYP_PostProcessing.EffectRemovePhase

    Description
    Removes and destroys a phase from a post-processing effect.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id

    Code sample :

    HYP_PostProcessing.EffectRemovePhase(id, effectId, phaseId)


    HYP_PostProcessing.EffectPhaseAddStep

    Description
    Creates and adds a step to a post-processing effect phase.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id

    Return Values
  • stepId [INTEGER]: step id

    Code sample :

    stepId = HYP_PostProcessing.EffectPhaseAddStep(id, effectId, phaseId)


    HYP_PostProcessing.EffectPhaseRemoveStep

    Description
    Removes and destroys a step of a post-processing effect phase.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id

    Code sample :

    HYP_PostProcessing.EffectPhaseRemoveStep(id, effectId, phaseId, stepId)


    HYP_PostProcessing.EffectPhaseStepSetGpuProgram

    Description
    Sets the GPU program for a step.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id
  • gpuShaderId [INTEGER]: gpu program id

    Code sample :

    HYP_PostProcessing.EffectPhaseStepSetGpuProgram(id, effectId, phaseId, stepId, gpuShaderId)


    HYP_PostProcessing.EffectPhaseStepSetRenderTarget

    Description
    Sets the render target for a step.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id
  • rtId [INTEGER]: render target id. If == 0, the render target is the normal framebuffer.

    Code sample :

    HYP_PostProcessing.EffectPhaseStepSetRenderTarget(id, effectId, phaseId, stepId, rtId)


    HYP_PostProcessing.EffectPhaseStepAddTexture

    Description
    Adds a texture source for a step GPU shader.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id

    Return Values
  • texId [INTEGER]: source texture id.

    Code sample :

    texId = HYP_PostProcessing.EffectPhaseStepAddTexture(id, effectId, phaseId, stepId)


    HYP_PostProcessing.EffectPhaseStepRemoveTexture

    Description
    Removes a texture source from a step.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id
  • texId [INTEGER]: source texture id.

    Code sample :

    HYP_PostProcessing.EffectPhaseStepRemoveTexture(id, effectId, phaseId, stepId, texId)


    HYP_PostProcessing.EffectPhaseStepTextureSetRenderTextureSource

    Description
    Sets the parameters of a step source texture.

    Languages: Lua

    Parameters
  • id [INTEGER]: post processing id
  • effectId [INTEGER]: effect id
  • phaseId [INTEGER]: phase id
  • stepId [INTEGER]: step id
  • texId [INTEGER]: source texture id.
  • rtId [INTEGER]: source texture param: render target id.
  • rtType [INTEGER]: source texture param: render target texture type: COLOR (0) or DEPTH (1).
  • rtIndex [INTEGER]: source texture param: render target texture index. A render texture may have several texture (color, depth, ...). This index specifies a texture of a render texture object.

    Code sample :

    HYP_PostProcessing.EffectPhaseStepTextureSetRenderTextureSource(id, effectId, phaseId, stepId, texId, rtId, rtType, rtIndex)




  • Random Projects

    Gaussian Blur PostFX
    Gaussian Blur PostFX

    Thermal Vision PostFX
    Thermal Vision PostFX

    Depth Buffer Visualization
    Depth Buffer Visualization


    Random Code Samples

    Model Cloning
    Model Cloning

    Draw Line
    Draw Line

    Texture viewer
    Texture viewer



    (C)2009-2010 Geeks3D.com