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

#include <PostFX.hpp>

Inheritance diagram for sf::PostFX:

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	SetPosition (float X, float Y)
	Set the position of the object (take 2 values)

void	SetPosition (const Vector2f &Position)
	Set the position of the object (take a 2D vector)

void	SetX (float X)
	Set the X position of the object.

void	SetY (float Y)
	Set the Y position of the object.

void	SetScale (float ScaleX, float ScaleY)
	Set the scale of the object (take 2 values)

void	SetScale (const Vector2f &Scale)
	Set the scale of the object (take a 2D vector)

void	SetScaleX (float FactorX)
	Set the X scale factor of the object.

void	SetScaleY (float FactorY)
	Set the Y scale factor of the object.

void	SetCenter (float CenterX, float CenterY)
	Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

void	SetCenter (const Vector2f &Center)
	Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

void	SetRotation (float Rotation)
	Set the orientation of 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.

const Vector2f &	GetPosition () const
	Get the position of the object.

const Vector2f &	GetScale () const
	Get the current scale of the object.

const Vector2f &	GetCenter () const
	Get the center 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 of a given offset (take 2 values)

void	Move (const Vector2f &Offset)
	Move the object of a given offset (take a 2D vector)

void	Scale (float FactorX, float FactorY)
	Scale the object (take 2 values)

void	Scale (const Vector2f &Factor)
	Scale the object (take a 2D vector)

void	Rotate (float Angle)
	Rotate the object.

sf::Vector2f	TransformToLocal (const sf::Vector2f &Point) const
	Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point)

sf::Vector2f	TransformToGlobal (const sf::Vector2f &Point) const
	Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point)

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

Protected Member Functions
virtual void	Render (RenderTarget &Target) const
	/see Drawable::Render

const Matrix3 &	GetMatrix () const
	Get the transform matrix of the drawable.

const Matrix3 &	GetInverseMatrix () const
	Get the inverse transform matrix of the drawable.

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.

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

Copy constructor.

Parameters

Copy	: Instance to copy

sf::PostFX::~PostFX ( )

Destructor.

Member Function Documentation

static bool sf::PostFX::CanUsePostFX ( )

static

Tell whether or not the system supports post-effects.

Returns: True if the system can use post-effects

Blend::Mode sf::Drawable::GetBlendMode ( ) const

inherited

Get the current blending mode.

Returns: Current blending mode

const Vector2f& sf::Drawable::GetCenter ( ) const

inherited

Get the center of the object.

Returns: Current position of the center

const Color& sf::Drawable::GetColor ( ) const

inherited

Get the color of the object.

Returns: Current color

const Matrix3& sf::Drawable::GetInverseMatrix ( ) const

protectedinherited

Get the inverse transform matrix of the drawable.

Returns: Inverse transform matrix

const Matrix3& sf::Drawable::GetMatrix ( ) const

protectedinherited

Get the transform matrix of the drawable.

Returns: Transform matrix

const Vector2f& sf::Drawable::GetPosition ( ) const

inherited

Get the position of the object.

Returns: Current position

float sf::Drawable::GetRotation ( ) const

inherited

Get the orientation of the object.

Rotation is always in the range [0, 360]

Returns: Current rotation, in degrees

const Vector2f& sf::Drawable::GetScale ( ) const

inherited

Get the current scale of the object.

Returns: Current scale factor (always positive)

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::Drawable::Move	(	float	OffsetX,
		float	OffsetY
	)

inherited

Move the object of a given offset (take 2 values)

Parameters

OffsetX	: X offset
OffsetY	: Y offset

void sf::Drawable::Move ( const Vector2f & Offset )

inherited

Move the object of a given offset (take a 2D vector)

Parameters

Offset : Amount of units to move the object of

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

Assignment operator.

Parameters

Other : Instance to assign

Returns: Reference to the post-effect

virtual void sf::PostFX::Render ( RenderTarget & Target ) const

protectedvirtual

/see Drawable::Render

Implements sf::Drawable.

void sf::Drawable::Rotate ( float Angle )

inherited

Rotate the object.

Parameters

Angle : Angle of rotation, in degrees

void sf::Drawable::Scale	(	float	FactorX,
		float	FactorY
	)

inherited

Scale the object (take 2 values)

Parameters

FactorX	: Scaling factor on X (must be strictly positive)
FactorY	: Scaling factor on Y (must be strictly positive)

void sf::Drawable::Scale ( const Vector2f & Factor )

inherited

Scale the object (take a 2D vector)

Parameters

Factor : Scaling factors (both values must be strictly positive)

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

void sf::Drawable::SetCenter	(	float	CenterX,
		float	CenterY
	)

inherited

Set the center of the object, in coordinates relative to the top-left of the object (take 2 values).

The default center is (0, 0)

Parameters

CenterX	: X coordinate of the center
CenterY	: Y coordinate of the center

void sf::Drawable::SetCenter ( const Vector2f & Center )

inherited

Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector).

The default center is (0, 0)

Parameters

Center : New center

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::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::Drawable::SetPosition	(	float	X,
		float	Y
	)

inherited

Set the position of the object (take 2 values)

Parameters

X	: New X coordinate
Y	: New Y coordinate

void sf::Drawable::SetPosition ( const Vector2f & Position )

inherited

Set the position of the object (take a 2D vector)

Parameters

Position : New position

void sf::Drawable::SetRotation ( float Rotation )

inherited

Set the orientation of the object.

Parameters

Rotation : Angle of rotation, in degrees

void sf::Drawable::SetScale	(	float	ScaleX,
		float	ScaleY
	)

inherited

Set the scale of the object (take 2 values)

Parameters

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

void sf::Drawable::SetScale ( const Vector2f & Scale )

inherited

Set the scale of the object (take a 2D vector)

Parameters

Scale : New scale (both values must be strictly positive)

void sf::Drawable::SetScaleX ( float FactorX )

inherited

Set the X scale factor of the object.

Parameters

X	: New X scale factor

void sf::Drawable::SetScaleY ( float FactorY )

inherited

Set the Y scale factor of the object.

Parameters

Y	: New Y scale factor

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)

void sf::Drawable::SetX ( float X )

inherited

Set the X position of the object.

Parameters

X	: New X coordinate

void sf::Drawable::SetY ( float Y )

inherited

Set the Y position of the object.

Parameters

Y	: New Y coordinate

sf::Vector2f sf::Drawable::TransformToGlobal ( const sf::Vector2f & Point ) const

inherited

Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point)

Parameters

Point : Point to transform

Returns: Transformed point

sf::Vector2f sf::Drawable::TransformToLocal ( const sf::Vector2f & Point ) const

inherited

Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point)

Parameters

Point : Point to transform

Returns: Transformed point

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

PostFX.hpp

Documentation of SFML 1.6

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation