sfPostFX Class Reference

sfPostFX is used to apply a post effect to a window More...

#include <PostFX.hpp>

Inheritance diagram for sfPostFX:

sfDrawable List of all members.

Public Member Functions

 sfPostFX ()
 Default constructor.
 sfPostFX (const std::string &Filename)
 Construct the post-fx from an effect file.
 sfPostFX (const sfPostFX &Copy)
 Copy constructor.
 ~sfPostFX ()
 Destructor.
bool LoadFromFile (const std::string &Filename)
 Load the effect from a file.
void SetParameter (const std::string &Name, float X)
 Change a parameter of the effect (1 float).
void SetParameter (const std::string &Name, float X, float Y)
 Change a parameter of the effect (2 floats).
void SetParameter (const std::string &Name, float X, float Y, float Z)
 Change a parameter of the effect (3 floats).
void SetParameter (const std::string &Name, float X, float Y, float Z, float W)
 Change a parameter of the effect (4 floats).
void SetTexture (const std::string &Name, sfImage *Image)
 Set a texture parameter.
sfPostFXoperator= (const sfPostFX &Other)
 Assignment operator.
void SetLeft (float Left)
 Set the left position of the object.
void SetTop (float Top)
 Set the top position of the object.
void SetScale (float Scale)
 Set the uniform scale of the object.
void SetRotation (float Rotation)
 Set the orientation of the object.
void SetRotationCenter (float X, float Y)
 Set the center of rotation, in coordinates relative to the object.
void SetColor (const sfColor &Color)
 Set the color of the object.
float GetLeft () const
 Get the left position of the object.
float GetTop () const
 Get the top position of the object.
float GetScale () const
 Get the uniform scale of the object.
float GetRotation () const
 Get the orientation of the object.
const sfColorGetColor () const
 Get the color of the object.
void Move (float OffsetX, float OffsetY)
 Move the object.
void Scale (float Factor)
 Scale the object.
void Rotate (float Angle)
 Rotate the object.

Static Public Member Functions

static bool CanUsePostFX ()
 Tell whether or not the system supports post-effects.

Protected Member Functions

virtual void Render (sfRenderWindow &Window)
 /see sfDrawable::Render

Detailed Description

sfPostFX is used to apply a post effect to a window

Definition at line 41 of file PostFX.hpp.


Constructor & Destructor Documentation

sfPostFX::sfPostFX (  ) 

Default constructor.

Definition at line 42 of file PostFX.cpp.

sfPostFX::sfPostFX ( const std::string &  Filename  ) 

Construct the post-fx from an effect file.

Parameters:
Filename : Path of the effect file to load

Definition at line 52 of file PostFX.cpp.

sfPostFX::sfPostFX ( const sfPostFX Copy  ) 

Copy constructor.

Parameters:
Copy : Instance to copy

Definition at line 62 of file PostFX.cpp.

sfPostFX::~sfPostFX (  ) 

Destructor.

Definition at line 77 of file PostFX.cpp.


Member Function Documentation

bool sfPostFX::LoadFromFile ( const std::string &  Filename  ) 

Load the effect from a file.

Parameters:
Filename : Path of the effect file to load
Returns:
True on success

Definition at line 86 of file PostFX.cpp.

void sfPostFX::SetParameter ( const std::string &  Name,
float  X 
)

Change a parameter of the effect (1 float).

Parameters:
Name : Parameter name in the effect
X : Value to assign

Definition at line 101 of file PostFX.cpp.

void sfPostFX::SetParameter ( const std::string &  Name,
float  X,
float  Y 
)

Change a parameter of the effect (2 floats).

Parameters:
Name : Parameter name in the effect
X,Y : Values to assign

Definition at line 124 of file PostFX.cpp.

void sfPostFX::SetParameter ( const std::string &  Name,
float  X,
float  Y,
float  Z 
)

Change a parameter of the effect (3 floats).

Parameters:
Name : Parameter name in the effect
X,Y,Z : Values to assign

Definition at line 147 of file PostFX.cpp.

void sfPostFX::SetParameter ( const std::string &  Name,
float  X,
float  Y,
float  Z,
float  W 
)

Change a parameter of the effect (4 floats).

Parameters:
Name : Parameter name in the effect
X,Y,Z,W : Values to assign

Definition at line 170 of file PostFX.cpp.

void sfPostFX::SetTexture ( const std::string &  Name,
sfImage Image 
)

Set a texture parameter.

Parameters:
Name : Texture name in the effect
Image : Image to set (pass NULL to use content of current framebuffer)

Definition at line 193 of file PostFX.cpp.

sfPostFX & sfPostFX::operator= ( const sfPostFX Other  ) 

Assignment operator.

Parameters:
Other : Instance to assign
Returns:
Reference to the post-effect

Definition at line 203 of file PostFX.cpp.

bool sfPostFX::CanUsePostFX (  )  [static]

Tell whether or not the system supports post-effects.

Returns:
True if the system can use post-effects

Definition at line 219 of file PostFX.cpp.

void sfPostFX::Render ( sfRenderWindow Window  )  [protected, virtual]

/see sfDrawable::Render

Implements sfDrawable.

Definition at line 231 of file PostFX.cpp.

void sfDrawable::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left position

Definition at line 60 of file Drawable.cpp.

void sfDrawable::SetTop ( float  Top  )  [inherited]

Set the top position of the object.

Parameters:
Top : New top position

Definition at line 69 of file Drawable.cpp.

void sfDrawable::SetScale ( float  Scale  )  [inherited]

Set the uniform scale of the object.

Parameters:
Scale : New scale (must be strictly positive)

Definition at line 78 of file Drawable.cpp.

void sfDrawable::SetRotation ( float  Rotation  )  [inherited]

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

Definition at line 88 of file Drawable.cpp.

void sfDrawable::SetRotationCenter ( float  X,
float  Y 
) [inherited]

Set the center of rotation, in coordinates relative to the object.

Parameters:
X : X coordinate of the center of rotation
Y : Y coordinate of the center of rotation

Definition at line 98 of file Drawable.cpp.

void sfDrawable::SetColor ( const sfColor Color  )  [inherited]

Set the color of the object.

Parameters:
Color : New color

Definition at line 108 of file Drawable.cpp.

float sfDrawable::GetLeft (  )  const [inherited]

Get the left position of the object.

Returns:
Current left position

Definition at line 117 of file Drawable.cpp.

float sfDrawable::GetTop (  )  const [inherited]

Get the top position of the object.

Returns:
Current top position

Definition at line 126 of file Drawable.cpp.

float sfDrawable::GetScale (  )  const [inherited]

Get the uniform scale of the object.

Returns:
Current scale position (always positive)

Definition at line 135 of file Drawable.cpp.

float sfDrawable::GetRotation (  )  const [inherited]

Get the orientation of the object.

Returns:
Current rotation, in degrees

Definition at line 144 of file Drawable.cpp.

const sfColor & sfDrawable::GetColor (  )  const [inherited]

Get the color of the object.

Returns:
Current color

Definition at line 153 of file Drawable.cpp.

void sfDrawable::Move ( float  OffsetX,
float  OffsetY 
) [inherited]

Move the object.

Parameters:
OffsetX : Offset on the X axis
OffsetY : Offset on the Y axis

Definition at line 162 of file Drawable.cpp.

void sfDrawable::Scale ( float  Factor  )  [inherited]

Scale the object.

Parameters:
Factor : Scaling factor (must be strictly positive)

Definition at line 172 of file Drawable.cpp.

void sfDrawable::Rotate ( float  Angle  )  [inherited]

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

Definition at line 182 of file Drawable.cpp.


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