sf::PostFX Class Reference

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

#include <PostFX.hpp>

Inheritance diagram for sf::PostFX:

sf::Drawable sf::VideoResource List of all members.

Public Member Functions

 PostFX ()
 Default constructor.
 PostFX (const std::string &Filename)
 Construct the post-fx from an effect file.
 PostFX (const PostFX &Copy)
 Copy constructor.
 ~PostFX ()
 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, Image *Texture)
 Set a texture parameter.
PostFXoperator= (const PostFX &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 ScaleX, float ScaleY)
 Set the 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 Color &Col)
 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 GetScaleX () const
 Get the horizontal scale of the object.
float GetScaleY () const
 Get the vertical scale of the object.
float GetRotation () const
 Get the orientation of the object.
const ColorGetColor () const
 Get the color of the object.
void Move (float OffsetX, float OffsetY)
 Move the object.
void Scale (float FactorX, float FactorY)
 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 (RenderWindow &Window)
 /see sfDrawable::Render

Detailed Description

PostFX is used to apply a post effect to a window.

Definition at line 43 of file PostFX.hpp.


Constructor & Destructor Documentation

sf::PostFX::PostFX (  ) 

Default constructor.

Definition at line 44 of file PostFX.cpp.

sf::PostFX::PostFX ( const std::string &  Filename  ) 

Construct the post-fx from an effect file.

Parameters:
Filename : Path of the effect file to load

Definition at line 54 of file PostFX.cpp.

sf::PostFX::PostFX ( const PostFX Copy  ) 

Copy constructor.

Parameters:
Copy : Instance to copy

Definition at line 64 of file PostFX.cpp.

sf::PostFX::~PostFX (  ) 

Destructor.

Definition at line 81 of file PostFX.cpp.


Member Function Documentation

bool sf::PostFX::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 90 of file PostFX.cpp.

void sf::PostFX::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 105 of file PostFX.cpp.

void sf::PostFX::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 128 of file PostFX.cpp.

void sf::PostFX::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 151 of file PostFX.cpp.

void sf::PostFX::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 174 of file PostFX.cpp.

void sf::PostFX::SetTexture ( const std::string &  Name,
Image Texture 
)

Set a texture parameter.

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

Definition at line 197 of file PostFX.cpp.

PostFX & sf::PostFX::operator= ( const PostFX Other  ) 

Assignment operator.

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

Definition at line 207 of file PostFX.cpp.

bool sf::PostFX::CanUsePostFX (  )  [static]

Tell whether or not the system supports post-effects.

Returns:
True if the system can use post-effects

Definition at line 223 of file PostFX.cpp.

void sf::PostFX::Render ( RenderWindow Window  )  [protected, virtual]

/see sfDrawable::Render

Implements sf::Drawable.

Definition at line 235 of file PostFX.cpp.

void sf::Drawable::SetLeft ( float  Left  )  [inherited]

Set the left position of the object.

Parameters:
Left : New left position

Definition at line 63 of file Drawable.cpp.

void sf::Drawable::SetTop ( float  Top  )  [inherited]

Set the top position of the object.

Parameters:
Top : New top position

Definition at line 72 of file Drawable.cpp.

void sf::Drawable::SetScale ( float  ScaleX,
float  ScaleY 
) [inherited]

Set the scale of the object.

Parameters:
ScaleX : New horizontal scale (must be strictly positive)
ScaleY : New vertical scale (must be strictly positive)

Definition at line 81 of file Drawable.cpp.

void sf::Drawable::SetRotation ( float  Rotation  )  [inherited]

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

Definition at line 91 of file Drawable.cpp.

void sf::Drawable::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 101 of file Drawable.cpp.

void sf::Drawable::SetColor ( const Color Col  )  [inherited]

Set the color of the object.

Parameters:
Col : New color

Definition at line 111 of file Drawable.cpp.

float sf::Drawable::GetLeft (  )  const [inherited]

Get the left position of the object.

Returns:
Current left position

Definition at line 120 of file Drawable.cpp.

float sf::Drawable::GetTop (  )  const [inherited]

Get the top position of the object.

Returns:
Current top position

Definition at line 129 of file Drawable.cpp.

float sf::Drawable::GetScaleX (  )  const [inherited]

Get the horizontal scale of the object.

Returns:
Current X scale factor (always positive)

Definition at line 138 of file Drawable.cpp.

float sf::Drawable::GetScaleY (  )  const [inherited]

Get the vertical scale of the object.

Returns:
Current Y scale factor (always positive)

Definition at line 147 of file Drawable.cpp.

float sf::Drawable::GetRotation (  )  const [inherited]

Get the orientation of the object.

Returns:
Current rotation, in degrees

Definition at line 156 of file Drawable.cpp.

const Color & sf::Drawable::GetColor (  )  const [inherited]

Get the color of the object.

Returns:
Current color

Definition at line 165 of file Drawable.cpp.

void sf::Drawable::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 174 of file Drawable.cpp.

void sf::Drawable::Scale ( float  FactorX,
float  FactorY 
) [inherited]

Scale the object.

Parameters:
FactorX : Horizontal scaling factor (must be strictly positive)
FactorY : Vertical scaling factor (must be strictly positive)

Definition at line 184 of file Drawable.cpp.

void sf::Drawable::Rotate ( float  Angle  )  [inherited]

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

Definition at line 194 of file Drawable.cpp.


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