Namespaces
namespace	Glsl
	Namespace with GLSL types.

namespace	priv

namespace	Style

Classes
class	AlResource
	Base class for classes that require an OpenAL context. More...

class	BlendMode
	Blending modes for drawing. More...

class	CircleShape
	Specialized shape representing a circle. More...

class	Clipboard
	Give access to the system clipboard. More...

class	Clock
	Utility class that measures the elapsed time. More...

class	Color
	Utility class for manipulating RGBA colors. More...

class	Context
	Class holding a valid drawing context. More...

class	ContextSettings
	Structure defining the settings of the OpenGL context attached to a window. More...

class	ConvexShape
	Specialized shape representing a convex polygon. More...

class	Cursor
	Cursor defines the appearance of a system cursor. More...

class	Drawable
	Abstract base class for objects that can be drawn to a render target. More...

class	Event
	Defines a system event and its parameters. More...

class	FileInputStream
	Implementation of input stream based on a file. More...

class	Font
	Class for loading and manipulating character fonts. More...

class	Ftp
	A FTP client. More...

class	GlResource
	Base class for classes that require an OpenGL context. More...

class	Glyph
	Structure describing a glyph. More...

class	Http
	A HTTP client. More...

class	Image
	Class for loading, manipulating and saving images. More...

class	InputSoundFile
	Provide read access to sound files. More...

class	InputStream
	Abstract class for custom file input streams. More...

class	IpAddress
	Encapsulate an IPv4 network address. More...

class	Joystick
	Give access to the real-time state of the joysticks. More...

class	Keyboard
	Give access to the real-time state of the keyboard. More...

class	Listener
	The audio listener is the point in the scene from where all the sounds are heard. More...

class	Lock
	Automatic wrapper for locking and unlocking mutexes. More...

class	MemoryInputStream
	Implementation of input stream based on a memory chunk. More...

class	Mouse
	Give access to the real-time state of the mouse. More...

class	Music
	Streamed music played from an audio file. More...

class	Mutex
	Blocks concurrent access to shared resources from multiple threads. More...

class	NonCopyable
	Utility class that makes any derived class non-copyable. More...

class	OutputSoundFile
	Provide write access to sound files. More...

class	Packet
	Utility class to build blocks of data to transfer over the network. More...

class	Rect
	Utility class for manipulating 2D axis aligned rectangles. More...

class	RectangleShape
	Specialized shape representing a rectangle. More...

class	RenderStates
	Define the states used for drawing to a RenderTarget. More...

class	RenderTarget
	Base class for all render targets (window, texture, ...) More...

class	RenderTexture
	Target for off-screen 2D rendering into a texture. More...

class	RenderWindow
	Window that can serve as a target for 2D drawing. More...

class	Sensor
	Give access to the real-time state of the sensors. More...

class	Shader
	Shader class (vertex, geometry and fragment) More...

class	Shape
	Base class for textured shapes with outline. More...

class	Socket
	Base class for all the socket types. More...

class	SocketSelector
	Multiplexer that allows to read from multiple sockets. More...

class	Sound
	Regular sound that can be played in the audio environment. More...

class	SoundBuffer
	Storage for audio samples defining a sound. More...

class	SoundBufferRecorder
	Specialized SoundRecorder which stores the captured audio data into a sound buffer. More...

class	SoundFileFactory
	Manages and instantiates sound file readers and writers. More...

class	SoundFileReader
	Abstract base class for sound file decoding. More...

class	SoundFileWriter
	Abstract base class for sound file encoding. More...

class	SoundRecorder
	Abstract base class for capturing sound data. More...

class	SoundSource
	Base class defining a sound's properties. More...

class	SoundStream
	Abstract base class for streamed audio sources. More...

class	Sprite
	Drawable representation of a texture, with its own transformations, color, etc. More...

class	String
	Utility string class that automatically handles conversions between types and encodings. More...

class	TcpListener
	Socket that listens to new TCP connections. More...

class	TcpSocket
	Specialized socket using the TCP protocol. More...

class	Text
	Graphical text that can be drawn to a render target. More...

class	Texture
	Image living on the graphics card that can be used for drawing. More...

class	Thread
	Utility class to manipulate threads. More...

class	ThreadLocal
	Defines variables with thread-local storage. More...

class	ThreadLocalPtr
	Pointer to a thread-local variable. More...

class	Time
	Represents a time value. More...

class	Touch
	Give access to the real-time state of the touches. More...

class	Transform
	Define a 3x3 transform matrix. More...

class	Transformable
	Decomposed transform defined by a position, a rotation and a scale. More...

class	UdpSocket
	Specialized socket using the UDP protocol. More...

class	Utf
	Utility class providing generic functions for UTF conversions. More...

class	Utf< 16 >
	Specialization of the Utf template for UTF-16. More...

class	Utf< 32 >
	Specialization of the Utf template for UTF-32. More...

class	Utf< 8 >
	Specialization of the Utf template for UTF-8. More...

class	Vector2
	Utility template class for manipulating 2-dimensional vectors. More...

class	Vector3
	Utility template class for manipulating 3-dimensional vectors. More...

class	Vertex
	Define a point with color and texture coordinates. More...

class	VertexArray
	Define a set of one or more 2D primitives. More...

class	VertexBuffer
	Vertex buffer storage for one or more 2D primitives. More...

class	VideoMode
	VideoMode defines a video mode (width, height, bpp) More...

class	View
	2D camera that defines what region is shown on screen More...

class	Window
	Window that serves as a target for OpenGL rendering. More...

Typedefs
typedef signed char	Int8

typedef unsigned char	Uint8

typedef signed short	Int16

typedef unsigned short	Uint16

typedef signed int	Int32

typedef unsigned int	Uint32

typedef signed long long	Int64

typedef unsigned long long	Uint64

typedef Rect< int >	IntRect

typedef Rect< float >	FloatRect

typedef int	SocketHandle

typedef Utf< 8 >	Utf8

typedef Utf< 16 >	Utf16

typedef Utf< 32 >	Utf32

typedef Vector2< int >	Vector2i

typedef Vector2< unsigned int >	Vector2u

typedef Vector2< float >	Vector2f

typedef Vector3< int >	Vector3i

typedef Vector3< float >	Vector3f

typedef void(*	GlFunctionPointer) ()

typedef void(*	ContextDestroyCallback) (void *)

Enumerations
enum	PrimitiveType { Points , Lines , LineStrip , Triangles , TriangleStrip , TriangleFan , Quads , LinesStrip = LineStrip , TrianglesStrip = TriangleStrip , TrianglesFan = TriangleFan }
	Types of primitives that a sf::VertexArray can render. More...

Functions
SFML_NETWORK_API bool	operator== (const IpAddress &left, const IpAddress &right)
	Overload of == operator to compare two IP addresses. More...

SFML_NETWORK_API bool	operator!= (const IpAddress &left, const IpAddress &right)
	Overload of != operator to compare two IP addresses. More...

SFML_NETWORK_API bool	operator< (const IpAddress &left, const IpAddress &right)
	Overload of < operator to compare two IP addresses. More...

SFML_NETWORK_API bool	operator> (const IpAddress &left, const IpAddress &right)
	Overload of > operator to compare two IP addresses. More...

SFML_NETWORK_API bool	operator<= (const IpAddress &left, const IpAddress &right)
	Overload of <= operator to compare two IP addresses. More...

SFML_NETWORK_API bool	operator>= (const IpAddress &left, const IpAddress &right)
	Overload of >= operator to compare two IP addresses. More...

SFML_NETWORK_API std::istream &	operator>> (std::istream &stream, IpAddress &address)
	Overload of >> operator to extract an IP address from an input stream. More...

SFML_NETWORK_API std::ostream &	operator<< (std::ostream &stream, const IpAddress &address)
	Overload of << operator to print an IP address to an output stream. More...

SFML_SYSTEM_API std::ostream &	err ()
	Standard stream used by SFML to output warnings and errors. More...

SFML_SYSTEM_API ANativeActivity *	getNativeActivity ()
	Return a pointer to the Android native activity. More...

void SFML_SYSTEM_API	sleep (Time duration)
	Make the current thread sleep for a given duration. More...

Variables
SFML_GRAPHICS_API const BlendMode	BlendAlpha
	Blend source and dest according to dest alpha. More...

SFML_GRAPHICS_API const BlendMode	BlendAdd
	Add source to dest. More...

SFML_GRAPHICS_API const BlendMode	BlendMultiply
	Multiply source and dest. More...

SFML_GRAPHICS_API const BlendMode	BlendNone
	Overwrite dest with source. More...

Typedef Documentation

◆ ContextDestroyCallback

typedef void(* sf::ContextDestroyCallback) (void *)

Definition at line 40 of file GlResource.hpp.

◆ FloatRect

typedef Rect<float> sf::FloatRect

Definition at line 197 of file Rect.hpp.

◆ GlFunctionPointer

typedef void(* sf::GlFunctionPointer) ()

Definition at line 44 of file Context.hpp.

◆ Int16

typedef signed short sf::Int16

Definition at line 217 of file Config.hpp.

◆ Int32

typedef signed int sf::Int32

Definition at line 221 of file Config.hpp.

◆ Int64

typedef signed long long sf::Int64

Definition at line 229 of file Config.hpp.

◆ Int8

typedef signed char sf::Int8

Definition at line 213 of file Config.hpp.

◆ IntRect

typedef Rect<int> sf::IntRect

Definition at line 196 of file Rect.hpp.

◆ SocketHandle

typedef int sf::SocketHandle

Definition at line 50 of file SocketHandle.hpp.

◆ Uint16

typedef unsigned short sf::Uint16

Definition at line 218 of file Config.hpp.

◆ Uint32

typedef unsigned int sf::Uint32

Definition at line 222 of file Config.hpp.

◆ Uint64

typedef unsigned long long sf::Uint64

Definition at line 230 of file Config.hpp.

◆ Uint8

typedef unsigned char sf::Uint8

Definition at line 214 of file Config.hpp.

◆ Utf16

typedef Utf<16> sf::Utf16

Definition at line 735 of file Utf.hpp.

◆ Utf32

typedef Utf<32> sf::Utf32

Definition at line 736 of file Utf.hpp.

◆ Utf8

typedef Utf<8> sf::Utf8

Definition at line 734 of file Utf.hpp.

◆ Vector2f

typedef Vector2<float> sf::Vector2f

Definition at line 255 of file Vector2.hpp.

◆ Vector2i

typedef Vector2<int> sf::Vector2i

Definition at line 253 of file Vector2.hpp.

◆ Vector2u

typedef Vector2<unsigned int> sf::Vector2u

Definition at line 254 of file Vector2.hpp.

◆ Vector3f

typedef Vector3<float> sf::Vector3f

Definition at line 256 of file Vector3.hpp.

◆ Vector3i

typedef Vector3<int> sf::Vector3i

Definition at line 255 of file Vector3.hpp.

Function Documentation

◆ operator!=()

SFML_NETWORK_API bool sf::operator!=	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of != operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if both addresses are different

◆ operator<()

SFML_NETWORK_API bool sf::operator<	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of < operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if left is lesser than right

◆ operator<<()

SFML_NETWORK_API std::ostream & sf::operator<<	(	std::ostream &	stream,
		const IpAddress &	address
	)

Overload of << operator to print an IP address to an output stream.

Parameters

stream	Output stream
address	IP address to print

Returns: Reference to the output stream

◆ operator<=()

SFML_NETWORK_API bool sf::operator<=	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of <= operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if left is lesser or equal than right

◆ operator==()

SFML_NETWORK_API bool sf::operator==	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of == operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if both addresses are equal

◆ operator>()

SFML_NETWORK_API bool sf::operator>	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of > operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if left is greater than right

◆ operator>=()

SFML_NETWORK_API bool sf::operator>=	(	const IpAddress &	left,
		const IpAddress &	right
	)

Overload of >= operator to compare two IP addresses.

Parameters

left	Left operand (a IP address)
right	Right operand (a IP address)

Returns: True if left is greater or equal than right

◆ operator>>()

SFML_NETWORK_API std::istream & sf::operator>>	(	std::istream &	stream,
		IpAddress &	address
	)

Overload of >> operator to extract an IP address from an input stream.

Parameters

stream	Input stream
address	IP address to extract

Returns: Reference to the input stream

Variable Documentation

◆ BlendAdd

SFML_GRAPHICS_API const BlendMode sf::BlendAdd

extern

Add source to dest.

◆ BlendAlpha

SFML_GRAPHICS_API const BlendMode sf::BlendAlpha

extern

Blend source and dest according to dest alpha.

◆ BlendMultiply

SFML_GRAPHICS_API const BlendMode sf::BlendMultiply

extern

Multiply source and dest.

◆ BlendNone

SFML_GRAPHICS_API const BlendMode sf::BlendNone

extern

Overwrite dest with source.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ ContextDestroyCallback

◆ FloatRect

◆ GlFunctionPointer

◆ Int16

◆ Int32

◆ Int64

◆ Int8

◆ IntRect

◆ SocketHandle

◆ Uint16

◆ Uint32

◆ Uint64

◆ Uint8

◆ Utf16

◆ Utf32

◆ Utf8

◆ Vector2f

◆ Vector2i

◆ Vector2u

◆ Vector3f

◆ Vector3i

Function Documentation

◆ operator!=()

◆ operator<()

◆ operator<<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator>>()

Variable Documentation

◆ BlendAdd

◆ BlendAlpha

◆ BlendMultiply

◆ BlendNone