documentation.HELP! SFML v1.6 Documentation

SFML - Simple and Fast Multimedia Library

SFML v1.6

previous page next page

sf::PostFX Class Reference

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

#include <PostFX.hpp>

Inheritance diagram for sf::PostFX:

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	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.

Definition at line 43 of file PostFX.cpp.

sf::PostFX::PostFX

(

const PostFX &

Copy

)

Copy constructor.

Parameters:

Copy

: Instance to copy

Definition at line 54 of file PostFX.cpp.

sf::PostFX::~PostFX

(

)

Destructor.

Definition at line 73 of file PostFX.cpp.

---

Member Function Documentation

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 265 of file PostFX.cpp.

Blend::Mode sf::Drawable::GetBlendMode

(

)

const [inherited]

Get the current blending mode.

Returns:

Current blending mode

Definition at line 258 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetCenter

(

)

const [inherited]

Get the center of the object.

Returns:

Current position of the center

Definition at line 231 of file Drawable.cpp.

const Color & sf::Drawable::GetColor

(

)

const [inherited]

Get the color of the object.

Returns:

Current color

Definition at line 249 of file Drawable.cpp.

const Matrix3 & sf::Drawable::GetInverseMatrix

(

)

const [protected, inherited]

Get the inverse transform matrix of the drawable.

Returns:

Inverse transform matrix

Definition at line 350 of file Drawable.cpp.

const Matrix3 & sf::Drawable::GetMatrix

(

)

const [protected, inherited]

Get the transform matrix of the drawable.

Returns:

Transform matrix

Definition at line 334 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetPosition

(

)

const [inherited]

Get the position of the object.

Returns:

Current position

Definition at line 213 of file Drawable.cpp.

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

Definition at line 240 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetScale

(

)

const [inherited]

Get the current scale of the object.

Returns:

Current scale factor (always positive)

Definition at line 222 of file Drawable.cpp.

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 89 of file PostFX.cpp.

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

Definition at line 112 of file PostFX.cpp.

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

Definition at line 278 of file Drawable.cpp.

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

Definition at line 268 of file Drawable.cpp.

PostFX & sf::PostFX::operator=

(

const PostFX &

Other

)

Assignment operator.

Parameters:

Other

: Instance to assign

Returns:

Reference to the post-effect

Definition at line 249 of file PostFX.cpp.

void sf::PostFX::Render

(

RenderTarget &

Target

)

const [protected, virtual]

/see Drawable::Render

Implements sf::Drawable.

Definition at line 280 of file PostFX.cpp.

void sf::Drawable::Rotate

(

float

Angle

)

[inherited]

Rotate the object.

Parameters:

Angle

: Angle of rotation, in degrees

Definition at line 306 of file Drawable.cpp.

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)

Definition at line 297 of file Drawable.cpp.

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)

Definition at line 287 of file Drawable.cpp.

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

The default blend mode is Blend::Alpha

Definition at line 204 of file Drawable.cpp.

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).

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

The default center is (0, 0)

Definition at line 171 of file Drawable.cpp.

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).

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

The default center is (0, 0)

Definition at line 157 of file Drawable.cpp.

void sf::Drawable::SetColor

(

const Color &

Col

)

[inherited]

Set the color of the object.

The default color is white

Parameters:

Col

: New color

The default color is white

Definition at line 194 of file Drawable.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 199 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 176 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 153 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 130 of file PostFX.cpp.

void sf::Drawable::SetPosition

(

const Vector2f &

Position

)

[inherited]

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

Parameters:

Position

: New position

Definition at line 75 of file Drawable.cpp.

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

Definition at line 65 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 180 of file Drawable.cpp.

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)

Definition at line 117 of file Drawable.cpp.

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)

Definition at line 107 of file Drawable.cpp.

void sf::Drawable::SetScaleX

(

float

FactorX

)

[inherited]

Set the X scale factor of the object.

Parameters:

X

: New X scale factor

Definition at line 127 of file Drawable.cpp.

void sf::Drawable::SetScaleY

(

float

FactorY

)

[inherited]

Set the Y scale factor of the object.

Parameters:

Y

: New Y scale factor

Definition at line 141 of file Drawable.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 222 of file PostFX.cpp.

void sf::Drawable::SetX

(

float

X

)

[inherited]

Set the X position of the object.

Parameters:

X

: New X coordinate

Definition at line 85 of file Drawable.cpp.

void sf::Drawable::SetY

(

float

Y

)

[inherited]

Set the Y position of the object.

Parameters:

Y

: New Y coordinate

Definition at line 96 of file Drawable.cpp.

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).

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

Definition at line 325 of file Drawable.cpp.

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).

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

Definition at line 316 of file Drawable.cpp.

---

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

• PostFX.hpp
• PostFX.cpp

 ::  Copyright © 2007-2008 Laurent Gomila, all rights reserved  ::  Documentation generated by doxygen 1.5.2  :: 

previous page start next page

Menu

• Homepage

Table of contents

• Main Page
• Class List
  • sf::AudioResource
  • sf::Clock
  • sf::Color
  • sf::Context
  • sf::Drawable
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Font
  • sf::Ftp
  • sf::Ftp::Ftp::DirectoryResponse
  • sf::Ftp::Ftp::ListingResponse
  • sf::Ftp::Ftp::Response
  • sf::Glyph
  • sf::Http
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::Image
  • sf::Input
  • sf::IPAddress
  • sf::Listener
  • sf::Lock
  • sf::Matrix3
  • sf::Music
  • sf::Mutex
  • sf::NonCopyable
  • sf::Packet
  • sf::PostFX
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
  • sf::RenderWindow
  • sf::Resource< T >
  • sf::ResourcePtr< T >
  • sf::Selector< Type >
  • sf::SelectorBase
  • sf::Shape
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::Sound
  • sf::SoundBuffer
  • sf::SoundBufferRecorder
  • sf::SoundRecorder
  • sf::SoundStream
  • sf::SoundStream::SoundStream::Chunk
  • sf::Sprite
  • sf::String
  • sf::Thread
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::Window
  • sf::WindowListener
  • sf::WindowSettings
• Class Hierarchy
  • sf::AudioResource
    • sf::Sound
      • sf::SoundStream
        • sf::Music
    • sf::SoundBuffer
  • sf::Clock
  • sf::Color
  • sf::Drawable
    • sf::PostFX
    • sf::Shape
    • sf::Sprite
    • sf::String
  • sf::Event
  • sf::Event::Event::JoyButtonEvent
  • sf::Event::Event::JoyMoveEvent
  • sf::Event::Event::KeyEvent
  • sf::Event::Event::MouseButtonEvent
  • sf::Event::Event::MouseMoveEvent
  • sf::Event::Event::MouseWheelEvent
  • sf::Event::Event::SizeEvent
  • sf::Event::Event::TextEvent
  • sf::Ftp::Ftp::Response
    • sf::Ftp::Ftp::DirectoryResponse
    • sf::Ftp::Ftp::ListingResponse
  • sf::Glyph
  • sf::Http::Http::Request
  • sf::Http::Http::Response
  • sf::IPAddress
  • sf::Listener
  • sf::Matrix3
  • sf::NonCopyable
    • sf::Context
    • sf::Ftp
    • sf::Http
    • sf::Input
    • sf::Lock
    • sf::Mutex
    • sf::Thread
      • sf::SoundRecorder
        • sf::SoundBufferRecorder
      • sf::SoundStream
    • sf::Window
      • sf::RenderWindow
  • sf::Packet
  • sf::Randomizer
  • sf::Rect< T >
  • sf::RenderTarget
    • sf::RenderWindow
  • sf::Resource< T >
  • sf::Resource< Font >
    • sf::Font
  • sf::Resource< Image >
    • sf::Image
  • sf::Resource< SoundBuffer >
    • sf::SoundBuffer
  • sf::ResourcePtr< T >
  • sf::SelectorBase
    • sf::Selector< Type >
  • sf::SocketHelper
  • sf::SocketTCP
  • sf::SocketUDP
  • sf::SoundStream::SoundStream::Chunk
  • sf::Unicode
  • sf::Unicode::Unicode::Text
  • sf::Vector2< T >
  • sf::Vector3< T >
  • sf::VideoMode
  • sf::View
  • sf::WindowListener
    • sf::Input
    • sf::Window
  • sf::WindowSettings
• Class Members
• Namespace List
  • sf::Blend
  • sf::Joy
  • sf::Key
  • sf::Mouse
  • sf::Style
• Namespace Members
• File List
  • Arial.hpp
  • Audio.hpp
  • AudioDevice.cpp
  • AudioDevice.hpp
  • AudioResource.cpp
  • AudioResource.hpp
  • Clock.cpp
  • Clock.hpp
  • Color.cpp
  • Color.hpp
  • Config.hpp
  • Context.cpp
  • Context.hpp
  • Doxygen.hpp
  • Drawable.cpp
  • Drawable.hpp
  • Event.hpp
  • Font.cpp
  • Font.hpp
  • FontLoader.cpp
  • FontLoader.hpp
  • Ftp.cpp
  • Ftp.hpp
  • Glyph.hpp
  • Graphics.hpp
  • GraphicsContext.cpp
  • GraphicsContext.hpp
  • Http.cpp
  • Http.hpp
  • Image.cpp
  • Image.hpp
  • ImageLoader.cpp
  • ImageLoader.hpp
  • Input.cpp
  • Input.hpp
  • IPAddress.cpp
  • IPAddress.hpp
  • Cocoa/Joystick.cpp
  • Template for new ports/Joystick.cpp
  • Win32/Joystick.cpp
  • Cocoa/Joystick.hpp
  • Joystick.hpp
  • Template for new ports/Joystick.hpp
  • Win32/Joystick.hpp
  • Listener.cpp
  • Listener.hpp
  • Lock.cpp
  • Lock.hpp
  • Matrix3.cpp
  • Matrix3.hpp
  • Matrix3.inl
  • Music.cpp
  • Music.hpp
  • Mutex.cpp
  • Mutex.hpp
  • Win32/Mutex.hpp
  • Network.hpp
  • NonCopyable.hpp
  • OpenAL.hpp
  • OpenGL.hpp
  • Packet.cpp
  • Packet.hpp
  • Platform.cpp
  • Platform.hpp
  • Win32/Platform.hpp
  • PostFX.cpp
  • PostFX.hpp
  • Randomizer.cpp
  • Randomizer.hpp
  • Rect.hpp
  • Rect.inl
  • RenderTarget.cpp
  • RenderTarget.hpp
  • RenderWindow.cpp
  • RenderWindow.hpp
  • Resource.hpp
  • Resource.inl
  • ResourcePtr.inl
  • Selector.hpp
  • Selector.inl
  • SelectorBase.cpp
  • SelectorBase.hpp
  • SFML_Main.cpp
  • Shape.cpp
  • Shape.hpp
  • Sleep.cpp
  • Sleep.hpp
  • SocketHelper.cpp
  • SocketHelper.hpp
  • Win32/SocketHelper.hpp
  • Sockets.hpp
  • SocketTCP.cpp
  • SocketTCP.hpp
  • SocketUDP.cpp
  • SocketUDP.hpp
  • Sound.cpp
  • Sound.hpp
  • SoundBuffer.cpp
  • SoundBuffer.hpp
  • SoundBufferRecorder.cpp
  • SoundBufferRecorder.hpp
  • SoundFile.cpp
  • SoundFile.hpp
  • SoundFileDefault.cpp
  • SoundFileDefault.hpp
  • SoundFileOgg.cpp
  • SoundFileOgg.hpp
  • SoundRecorder.cpp
  • SoundRecorder.hpp
  • SoundStream.cpp
  • SoundStream.hpp
  • Sprite.cpp
  • Sprite.hpp
  • String.cpp
  • String.hpp
  • System.hpp
  • Thread.cpp
  • Thread.hpp
  • Win32/Thread.hpp
  • Unicode.cpp
  • Unicode.hpp
  • Unicode.inl
  • Vector2.hpp
  • Vector2.inl
  • Vector3.hpp
  • Vector3.inl
  • VideoMode.cpp
  • VideoMode.hpp
  • Cocoa/VideoModeSupport.cpp
  • Template for new ports/VideoModeSupport.cpp
  • Win32/VideoModeSupport.cpp
  • Cocoa/VideoModeSupport.hpp
  • Template for new ports/VideoModeSupport.hpp
  • VideoModeSupport.hpp
  • Win32/VideoModeSupport.hpp
  • View.cpp
  • View.hpp
  • Window.cpp
  • Window/Window.hpp
  • Window.hpp
  • WindowHandle.hpp
  • WindowImpl.cpp
  • WindowImpl.hpp
  • WindowImplCocoa.hpp
  • WindowImplWin32.cpp
  • WindowImplWin32.hpp
  • WindowImplXXX.cpp
  • WindowImplXXX.hpp
  • WindowListener.hpp
  • WindowSettings.hpp
  • WindowStyle.hpp

Get in touch

Submit feedback about this site to:

• [email protected]

© documentation.help. Design: rehmann.co.