Bottle 2D - Lua API 1.0.0
All you need to create games using bottle2D.
Public Member Functions | Static Public Member Functions

PostFX Class Reference

A post effect is like a texture shader. More...

#include <header.hpp>

Inheritance diagram for PostFX:
Drawable Object

List of all members.

Public Member Functions

PostFX Clone ()
 Create a clone of the object and return an handler to the clone.
PostFX CloneToGroup (Group newParent)
 Create a clone of the object, change the parent and return an handler to the clone.
bool LoadFromFile (string Filename)
nil SetParameter (string Name, number X)
 Add a parameter named name to the PostFX.
nil SetParameter (string Name, number X, number Y)
 Add a Vector2 parameter named name to the PostFX.
nil SetParameter (string Name, number X, number Y, number Z)
 Add a Vector3 parameter named name to the PostFX.
nil SetParameter (string Name, number X, number Y, number Z, number W)
 Add a Vector4 parameter named name to the PostFX.
nil SetTexture (string Name, Texture Texture)
 Add a Texture parameter named name to the PostFX.

Static Public Member Functions

static bool CanUsePostFX ()
 Return true if the current system can use PostFX.

Detailed Description

A post effect is like a texture shader.

It is used to add effects to the final image (add blur, fade, colorize, lens effects...). The language used is defined by SFML. You should use Group::CreatePostFX to create a PostFX object.


Member Function Documentation

static bool PostFX::CanUsePostFX ( ) [static]

Return true if the current system can use PostFX.

PostFX PostFX::Clone ( )

Create a clone of the object and return an handler to the clone.

Reimplemented from Object.

PostFX PostFX::CloneToGroup ( Group  newParent)

Create a clone of the object, change the parent and return an handler to the clone.

Reimplemented from Object.

bool PostFX::LoadFromFile ( string  Filename)
nil PostFX::SetParameter ( string  Name,
number  X,
number  Y,
number  Z 
)

Add a Vector3 parameter named name to the PostFX.

nil PostFX::SetParameter ( string  Name,
number  X,
number  Y 
)

Add a Vector2 parameter named name to the PostFX.

nil PostFX::SetParameter ( string  Name,
number  X 
)

Add a parameter named name to the PostFX.

nil PostFX::SetParameter ( string  Name,
number  X,
number  Y,
number  Z,
number  W 
)

Add a Vector4 parameter named name to the PostFX.

nil PostFX::SetTexture ( string  Name,
Texture  Texture 
)

Add a Texture parameter named name to the PostFX.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables