sf::PostFX

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 PostFX &Copy)
 Copy constructor.
 ~PostFX ()
 Destructor.
bool LoadFromFile (const std::string &Filename)
 Load the effect from a file.
bool LoadFromMemory (const std::string &Effect)
 Load the effect from a text in memory.
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.
PostFX & operator= (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 SetPosition (float Left, float Top)
 Set the position of the object.
void SetScaleX (float Scale)
 Set the horizontal scale of the object.
void SetScaleY (float Scale)
 Set the vertical scale 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.
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for 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 Color & GetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
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 (const RenderWindow &Window) const
 /see sfDrawable::Render

Detailed Description

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

Definition at line 44 of file PostFX.hpp.

Constructor & Destructor Documentation

sf::PostFX::PostFX (  ) 

Default constructor.

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

Copy constructor.

Parameters:
Copy : Instance to copy

sf::PostFX::~PostFX (  ) 

Destructor.

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

bool sf::PostFX::LoadFromMemory ( const std::string &  Effect  ) 

Load the effect from a text in memory.

Parameters:
Effect : String containing the effect code
Returns:
True on success

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

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

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

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

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)

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

Assignment operator.

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

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

Tell whether or not the system supports post-effects.

Returns:
True if the system can use post-effects

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

/see sfDrawable::Render

Implements sf::Drawable.

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

Set the left position of the object.

Parameters:
Left : New left coordinate

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

Set the top position of the object.

Parameters:
Top : New top coordinate

void sf::Drawable::SetPosition ( float  Left,
float  Top 
) [inherited]

Set the position of the object.

Parameters:
Left : New left coordinate
Top : New top coordinate

void sf::Drawable::SetScaleX ( float  Scale  )  [inherited]

Set the horizontal scale of the object.

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

void sf::Drawable::SetScaleY ( float  Scale  )  [inherited]

Set the vertical scale of the object.

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

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)

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

Set the orientation of the object.

Parameters:
Rotation : Angle of rotation, in degrees

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

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

The default rotation center is (0, 0)

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

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

Set the color of the object.

The default color is white

Parameters:
Col : New color

void sf::Drawable::SetBlendMode ( Blend::Mode  Mode  )  [inherited]

Set the blending mode for the object.

The default blend mode is Blend::Alpha

Parameters:
Mode : New blending mode

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

Get the left position of the object.

Returns:
Current left position

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

Get the top position of the object.

Returns:
Current top position

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

Get the horizontal scale of the object.

Returns:
Current X scale factor (always positive)

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

Get the vertical scale of the object.

Returns:
Current Y scale factor (always positive)

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

Get the orientation of the object.

Returns:
Current rotation, in degrees

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

Get the color of the object.

Returns:
Current color

Blend::Mode sf::Drawable::GetBlendMode (  )  const [inherited]

Get the current blending mode.

Returns:
Current blending mode

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

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)

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

Rotate the object.

Parameters:
Angle : Angle of rotation, in degrees

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