Namespaces
namespace	Blend
	Enumerate the blending modes for drawable objects.
namespace	Joy
	Definition of joystick axis for joystick events.
namespace	Key
	Definition of key codes for keyboard events.
namespace	Mouse
	Definition of button codes for mouse events.
namespace	Socket
namespace	Style
	Enumeration of window creation styles.

Classes
class	AudioResource
	Abstract base class for every class that owns a device-dependant resource – allow them to initialize / shutdown even when the audio context is not created. More...
class	Clock
	Clock is an utility class for manipulating time. More...
class	Color
	Color is an utility class for manipulating 32-bits RGBA colors. More...
class	Context
	Class wrapping an OpenGL context. More...
class	Drawable
	Abstract base class for every object that can be drawn into a render window. More...
class	Event
	Event defines a system event and its parameters. More...
class	Font
	Font is the low-level class for loading and manipulating character fonts. More...
class	Ftp
	This class provides methods for manipulating the FTP protocol (described in RFC 959). More...
class	Glyph
	Structure describing a glyph (a visual character). More...
class	Http
	This class provides methods for manipulating the HTTP protocol (described in RFC 1945). More...
class	Image
	Image is the low-level class for loading and manipulating images. More...
class	Input
	Input handles real-time input from keyboard and mouse. More...
class	IPAddress
	IPAddress provides easy manipulation of IP v4 addresses. More...
class	Listener
	Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. More...
class	Lock
	Lock is an exception-safe automatic wrapper for locking and unlocking mutexes. More...
class	Matrix3
	Utility class to manipulate 3x3 matrices representing 2D transformations. More...
class	Music
	Music defines a big sound played using streaming, so usually what we call a music :). More...
class	Mutex
	Mutex defines a mutex (MUTual EXclusion) object, that allows a thread to lock critical instructions to avoid simultaneous access with other threads. More...
struct	NonCopyable
	Utility base class to easily declare non-copyable classes. More...
class	Packet
	Packet wraps data to send / to receive through the network. More...
class	PostFX
	PostFX is used to apply a post effect to a window. More...
class	Randomizer
	Randomizer is an utility class for generating pseudo-random numbers. More...
class	Rect
	Rect is an utility class for manipulating rectangles. More...
class	RenderTarget
	Base class for all render targets (window, image, ...). More...
class	RenderWindow
	Simple wrapper for sf::Window that allows easy 2D rendering. More...
class	Resource
	Base class for every resource that needs to notify dependent classes about its destruction. More...
class	ResourcePtr
	Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. More...
class	Selector
	Selector allow reading from multiple sockets without blocking. More...
class	SelectorBase
	Private base class for selectors. More...
class	Shape
	Shape defines a drawable convex shape ; it also defines helper functions to draw simple shapes like lines, rectangles, circles, etc. More...
class	SocketHelper
	This class defines helper functions to do all the non-portable socket stuff. More...
class	SocketTCP
	SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower). More...
class	SocketUDP
	SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety). More...
class	Sound
	Sound defines the properties of a sound such as position, volume, pitch, etc. More...
class	SoundBuffer
	SoundBuffer is the low-level for loading and manipulating sound buffers. More...
class	SoundBufferRecorder
	Specialized SoundRecorder which saves the captured audio data into a sound buffer. More...
class	SoundRecorder
	SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class. More...
class	SoundStream
	SoundStream is a streamed sound, ie samples are acquired while the sound is playing. More...
class	Sprite
	Sprite defines a sprite : texture, transformations, color, and draw on screen. More...
class	String
	String defines a graphical 2D text, that can be drawn on screen. More...
class	Thread
	Thread defines an easy way to manipulate a thread. More...
class	Unicode
	Provides utility functions to convert from and to any unicode and ASCII encoding. More...
class	Vector2
	Vector2 is an utility class for manipulating 2 dimensional vectors. More...
class	Vector3
	Vector3 is an utility class for manipulating 3 dimensional vectors. More...
class	VideoMode
	VideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device. More...
class	View
	This class defines a view (position, size, etc.) ; you can consider it as a 2D camera. More...
class	Window
	Window is a rendering window ; it can create a new window or connect to an existing one. More...
class	WindowListener
	Base class for classes that want to receive events from a window (for internal use only). More...
struct	WindowSettings
	Structure defining the creation settings of windows. More...

Typedefs
typedef Rect< int >	IntRect
typedef Rect< float >	FloatRect
typedef Selector< SocketUDP >	SelectorUDP
typedef Selector< SocketTCP >	SelectorTCP
typedef Vector2< int >	Vector2i
typedef Vector2< float >	Vector2f
typedef Vector3< int >	Vector3i
typedef Vector3< float >	Vector3f

Functions
Color	operator+ (const Color &Color1, const Color &Color2)
	Operator + overload to add two colors.
Color	operator* (const Color &Color1, const Color &Color2)
	Operator * overload to modulate two colors.
std::istream &	operator>> (std::istream &Stream, IPAddress &Address)
	Operator >> overload to extract an address from an input stream.
std::ostream &	operator<< (std::ostream &Stream, const IPAddress &Address)
	Operator << overload to print an address to an output stream.
void	Sleep (float Duration)
	Make the current thread sleep for a given time.
template<typename T>
Vector2< T >	operator- (const Vector2< T > &V)
	Operator - overload ; returns the opposite of a vector.
template<typename T>
Vector2< T > &	operator+= (Vector2< T > &V1, const Vector2< T > &V2)
	Operator += overload ; add two vectors and assign to the first op.
template<typename T>
Vector2< T > &	operator-= (Vector2< T > &V1, const Vector2< T > &V2)
	Operator -= overload ; subtract two vectors and assign to the first op.
template<typename T>
Vector2< T >	operator+ (const Vector2< T > &V1, const Vector2< T > &V2)
	Operator + overload ; adds two vectors.
template<typename T>
Vector2< T >	operator- (const Vector2< T > &V1, const Vector2< T > &V2)
	Operator - overload ; subtracts two vectors.
template<typename T>
Vector2< T >	operator* (const Vector2< T > &V, T X)
	Operator * overload ; multiply a vector by a scalar value.
template<typename T>
Vector2< T >	operator* (T X, const Vector2< T > &V)
	Operator * overload ; multiply a scalar value by a vector.
template<typename T>
Vector2< T > &	operator*= (Vector2< T > &V, T X)
	Operator *= overload ; multiply-assign a vector by a scalar value.
template<typename T>
Vector2< T >	operator/ (const Vector2< T > &V, T X)
	Operator / overload ; divide a vector by a scalar value.
template<typename T>
Vector2< T > &	operator/= (Vector2< T > &V, T X)
	Operator /= overload ; divide-assign a vector by a scalar value.
template<typename T>
bool	operator== (const Vector2< T > &V1, const Vector2< T > &V2)
	Operator == overload ; compares the equality of two vectors.
template<typename T>
bool	operator!= (const Vector2< T > &V1, const Vector2< T > &V2)
	Operator != overload ; compares the difference of two vectors.
template<typename T>
Vector3< T >	operator- (const Vector3< T > &V)
	Operator - overload ; returns the opposite of a vector.
template<typename T>
Vector3< T > &	operator+= (Vector3< T > &V1, const Vector3< T > &V2)
	Operator += overload ; add two vectors and assign to the first op.
template<typename T>
Vector3< T > &	operator-= (Vector3< T > &V1, const Vector3< T > &V2)
	Operator -= overload ; subtract two vectors and assign to the first op.
template<typename T>
Vector3< T >	operator+ (const Vector3< T > &V1, const Vector3< T > &V2)
	Operator + overload ; adds two vectors.
template<typename T>
Vector3< T >	operator- (const Vector3< T > &V1, const Vector3< T > &V2)
	Operator - overload ; subtracts two vectors.
template<typename T>
Vector3< T >	operator* (const Vector3< T > &V, T X)
	Operator * overload ; multiply a vector by a scalar value.
template<typename T>
Vector3< T >	operator* (T X, const Vector3< T > &V)
	Operator * overload ; multiply a scalar value by a vector.
template<typename T>
Vector3< T > &	operator*= (Vector3< T > &V, T X)
	Operator *= overload ; multiply-assign a vector by a scalar value.
template<typename T>
Vector3< T >	operator/ (const Vector3< T > &V, T X)
	Operator / overload ; divide a vector by a scalar value.
template<typename T>
Vector3< T > &	operator/= (Vector3< T > &V, T X)
	Operator /= overload ; divide-assign a vector by a scalar value.
template<typename T>
bool	operator== (const Vector3< T > &V1, const Vector3< T > &V2)
	Operator == overload ; compares the equality of two vectors.
template<typename T>
bool	operator!= (const Vector3< T > &V1, const Vector3< T > &V2)
	Operator != overload ; compares the difference of two vectors.

Typedef Documentation

◆ FloatRect

typedef Rect<float> sf::FloatRect

Definition at line 122 of file Rect.hpp.

◆ IntRect

typedef Rect<int> sf::IntRect

Definition at line 121 of file Rect.hpp.

◆ SelectorTCP

typedef Selector<SocketTCP> sf::SelectorTCP

Definition at line 111 of file Selector.hpp.

◆ SelectorUDP

typedef Selector<SocketUDP> sf::SelectorUDP

Definition at line 110 of file Selector.hpp.

◆ Vector2f

typedef Vector2<float> sf::Vector2f

Definition at line 210 of file Vector2.hpp.

◆ Vector2i

typedef Vector2<int> sf::Vector2i

Definition at line 209 of file Vector2.hpp.

◆ Vector3f

typedef Vector3<float> sf::Vector3f

Definition at line 212 of file Vector3.hpp.

◆ Vector3i

typedef Vector3<int> sf::Vector3i

Definition at line 211 of file Vector3.hpp.

Function Documentation

◆ operator!=() [1/2]

template<typename T>

bool sf::operator!=	(	const Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator != overload ; compares the difference of two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: True if V1 is different than V2

◆ operator!=() [2/2]

template<typename T>

bool sf::operator!=	(	const Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator != overload ; compares the difference of two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: True if V1 is different than V2

◆ operator*() [1/5]

Color sf::operator*	(	const Color &	Color1,
		const Color &	Color2 )

Operator * overload to modulate two colors.

Parameters

Color1	: First color
Color2	: Second color

Returns: Component-wise multiplication of the two colors

◆ operator*() [2/5]

template<typename T>

Vector2< T > sf::operator*	(	const Vector2< T > &	V,
		T	X )

Operator * overload ; multiply a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V * X

◆ operator*() [3/5]

template<typename T>

Vector3< T > sf::operator*	(	const Vector3< T > &	V,
		T	X )

Operator * overload ; multiply a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V * X

◆ operator*() [4/5]

template<typename T>

Vector2< T > sf::operator*	(	T	X,
		const Vector2< T > &	V )

Operator * overload ; multiply a scalar value by a vector.

Parameters

X	: Scalar value
V	: Vector

Returns: X * V

◆ operator*() [5/5]

template<typename T>

Vector3< T > sf::operator*	(	T	X,
		const Vector3< T > &	V )

Operator * overload ; multiply a scalar value by a vector.

Parameters

X	: Scalar value
V	: Vector

Returns: X * V

◆ operator*=() [1/2]

template<typename T>

Vector2< T > & sf::operator*=	(	Vector2< T > &	V,
		T	X )

Operator *= overload ; multiply-assign a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V * X

◆ operator*=() [2/2]

template<typename T>

Vector3< T > & sf::operator*=	(	Vector3< T > &	V,
		T	X )

Operator *= overload ; multiply-assign a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V * X

◆ operator+() [1/3]

Color sf::operator+	(	const Color &	Color1,
		const Color &	Color2 )

Operator + overload to add two colors.

Parameters

Color1	: First color
Color2	: Second color

Returns: Component-wise saturated addition of the two colors

◆ operator+() [2/3]

template<typename T>

Vector2< T > sf::operator+	(	const Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator + overload ; adds two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 + V2

◆ operator+() [3/3]

template<typename T>

Vector3< T > sf::operator+	(	const Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator + overload ; adds two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 + V2

◆ operator+=() [1/2]

template<typename T>

Vector2< T > & sf::operator+=	(	Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator += overload ; add two vectors and assign to the first op.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 + V2

◆ operator+=() [2/2]

template<typename T>

Vector3< T > & sf::operator+=	(	Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator += overload ; add two vectors and assign to the first op.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 + V2

◆ operator-() [1/4]

template<typename T>

Vector2< T > sf::operator- ( const Vector2< T > & V )

Operator - overload ; returns the opposite of a vector.

Parameters

V	: Vector to negate

Returns: -V

◆ operator-() [2/4]

template<typename T>

Vector2< T > sf::operator-	(	const Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator - overload ; subtracts two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 - V2

◆ operator-() [3/4]

template<typename T>

Vector3< T > sf::operator- ( const Vector3< T > & V )

Operator - overload ; returns the opposite of a vector.

Parameters

V	: Vector to negate

Returns: -V

◆ operator-() [4/4]

template<typename T>

Vector3< T > sf::operator-	(	const Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator - overload ; subtracts two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 - V2

◆ operator-=() [1/2]

template<typename T>

Vector2< T > & sf::operator-=	(	Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator -= overload ; subtract two vectors and assign to the first op.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 - V2

◆ operator-=() [2/2]

template<typename T>

Vector3< T > & sf::operator-=	(	Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator -= overload ; subtract two vectors and assign to the first op.

Parameters

V1	: First vector
V2	: Second vector

Returns: V1 - V2

◆ operator/() [1/2]

template<typename T>

Vector2< T > sf::operator/	(	const Vector2< T > &	V,
		T	X )

Operator / overload ; divide a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V / X

◆ operator/() [2/2]

template<typename T>

Vector3< T > sf::operator/	(	const Vector3< T > &	V,
		T	X )

Operator / overload ; divide a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V / X

◆ operator/=() [1/2]

template<typename T>

Vector2< T > & sf::operator/=	(	Vector2< T > &	V,
		T	X )

Operator /= overload ; divide-assign a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V / X

◆ operator/=() [2/2]

template<typename T>

Vector3< T > & sf::operator/=	(	Vector3< T > &	V,
		T	X )

Operator /= overload ; divide-assign a vector by a scalar value.

Parameters

V	: Vector
X	: Scalar value

Returns: V / X

◆ operator<<()

std::ostream & sf::operator<<	(	std::ostream &	Stream,
		const IPAddress &	Address )

Operator << overload to print an address to an output stream.

Parameters

Stream	: Output stream
Address	: Address to print

Returns: Reference to the output stream

◆ operator==() [1/2]

template<typename T>

bool sf::operator==	(	const Vector2< T > &	V1,
		const Vector2< T > &	V2 )

Operator == overload ; compares the equality of two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: True if V1 is equal to V2

◆ operator==() [2/2]

template<typename T>

bool sf::operator==	(	const Vector3< T > &	V1,
		const Vector3< T > &	V2 )

Operator == overload ; compares the equality of two vectors.

Parameters

V1	: First vector
V2	: Second vector

Returns: True if V1 is equal to V2

◆ operator>>()

std::istream & sf::operator>>	(	std::istream &	Stream,
		IPAddress &	Address )

Operator >> overload to extract an address from an input stream.

Parameters

Stream	: Input stream
Address	: Address to extract

Returns: Reference to the input stream

◆ Sleep()

void sf::Sleep ( float Duration )

Make the current thread sleep for a given time.

Parameters

Duration : Time to sleep, in seconds (must be >= 0)

Namespaces

Classes

Typedefs

Functions

Typedef Documentation

◆ FloatRect

◆ IntRect

◆ SelectorTCP

◆ SelectorUDP

◆ Vector2f

◆ Vector2i

◆ Vector3f

◆ Vector3i

Function Documentation

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*() [1/5]

◆ operator*() [2/5]

◆ operator*() [3/5]

◆ operator*() [4/5]

◆ operator*() [5/5]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/3]

◆ operator+() [2/3]

◆ operator+() [3/3]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/4]

◆ operator-() [2/4]

◆ operator-() [3/4]

◆ operator-() [4/4]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<<()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>>()

◆ Sleep()