diff --git a/SQCSim2021/external/sfml251-32/doc/html/AlResource_8hpp_source.html b/SQCSim2021/external/sfml251-32/doc/html/AlResource_8hpp_source.html
new file mode 100644
index 0000000..0a438f8
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/AlResource_8hpp_source.html
@@ -0,0 +1,58 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_ALRESOURCE_HPP 26 #define SFML_ALRESOURCE_HPP 31 #include <SFML/Audio/Export.hpp> 60 #endif // SFML_ALRESOURCE_HPP Base class for classes that require an OpenAL context.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_AUDIO_EXPORT_HPP 26 #define SFML_AUDIO_EXPORT_HPP 31 #include <SFML/Config.hpp> 37 #if defined(SFML_AUDIO_EXPORTS) 39 #define SFML_AUDIO_API SFML_API_EXPORT 43 #define SFML_AUDIO_API SFML_API_IMPORT 48 #endif // SFML_AUDIO_EXPORT_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_AUDIO_HPP 26 #define SFML_AUDIO_HPP 32 #include <SFML/System.hpp> 33 #include <SFML/Audio/InputSoundFile.hpp> 34 #include <SFML/Audio/Listener.hpp> 35 #include <SFML/Audio/Music.hpp> 36 #include <SFML/Audio/OutputSoundFile.hpp> 37 #include <SFML/Audio/Sound.hpp> 38 #include <SFML/Audio/SoundBuffer.hpp> 39 #include <SFML/Audio/SoundBufferRecorder.hpp> 40 #include <SFML/Audio/SoundFileFactory.hpp> 41 #include <SFML/Audio/SoundFileReader.hpp> 42 #include <SFML/Audio/SoundFileWriter.hpp> 43 #include <SFML/Audio/SoundRecorder.hpp> 44 #include <SFML/Audio/SoundSource.hpp> 45 #include <SFML/Audio/SoundStream.hpp> 48 #endif // SFML_AUDIO_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_BLENDMODE_HPP 26 #define SFML_BLENDMODE_HPP 31 #include <SFML/Graphics/Export.hpp> 95 BlendMode (Factor sourceFactor, Factor destinationFactor, Equation blendEquation = Add);
108 BlendMode (Factor colorSourceFactor, Factor colorDestinationFactor,
109 Equation colorBlendEquation, Factor alphaSourceFactor,
110 Factor alphaDestinationFactor, Equation alphaBlendEquation);
150 SFML_GRAPHICS_API
extern const BlendMode BlendAlpha;
151 SFML_GRAPHICS_API
extern const BlendMode BlendAdd;
152 SFML_GRAPHICS_API
extern const BlendMode BlendMultiply;
153 SFML_GRAPHICS_API
extern const BlendMode BlendNone;
158 #endif // SFML_BLENDMODE_HPP Equation colorEquation
Blending equation for the color channels.
+
(src.a, src.a, src.a, src.a)
+
Factor alphaSrcFactor
Source blending factor for the alpha channel.
+
+
(1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
+
Blending modes for drawing.
+
+
Factor colorSrcFactor
Source blending factor for the color channels.
+
Equation alphaEquation
Blending equation for the alpha channel.
+
Pixel = Src * SrcFactor - Dst * DstFactor.
+
Factor colorDstFactor
Destination blending factor for the color channels.
+
Pixel = Src * SrcFactor + Dst * DstFactor.
+
(dst.a, dst.a, dst.a, dst.a)
+
(1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
+
(1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
+
Equation
Enumeration of the blending equations.
+
+
Factor
Enumeration of the blending factors.
+
Factor alphaDstFactor
Destination blending factor for the alpha channel.
+
(dst.r, dst.g, dst.b, dst.a)
+
(src.r, src.g, src.b, src.a)
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CIRCLESHAPE_HPP 26 #define SFML_CIRCLESHAPE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Shape.hpp> 52 explicit CircleShape (
float radius = 0, std::size_t pointCount = 30);
62 void setRadius(
float radius);
72 float getRadius()
const ;
82 void setPointCount(std::size_t count);
92 virtual std::size_t getPointCount()
const ;
107 virtual Vector2f getPoint(std::size_t index)
const ;
115 std::size_t m_pointCount;
121 #endif // SFML_CIRCLESHAPE_HPP Base class for textured shapes with outline.
+
+
+
Specialized shape representing a circle.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CLIPBOARD_HPP 26 #define SFML_CLIPBOARD_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/String.hpp> 72 static void setString(
const String & text);
78 #endif // SFML_CLIPBOARD_HPP Give access to the system clipboard.
+
+
Utility string class that automatically handles conversions between types and encodings.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CLOCK_HPP 26 #define SFML_CLOCK_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/Time.hpp> 63 Time getElapsedTime()
const ;
87 #endif // SFML_CLOCK_HPP
+
+
Utility class that measures the elapsed time.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_COLOR_HPP 26 #define SFML_COLOR_HPP 31 #include <SFML/Graphics/Export.hpp> 62 Color (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha = 255);
70 explicit Color (Uint32 color);
78 Uint32 toInteger()
const ;
114 SFML_GRAPHICS_API
bool operator ==(
const Color & left,
const Color & right);
128 SFML_GRAPHICS_API
bool operator !=(
const Color & left,
const Color & right);
143 SFML_GRAPHICS_API
Color operator +(
const Color & left,
const Color & right);
158 SFML_GRAPHICS_API
Color operator -(
const Color & left,
const Color & right);
175 SFML_GRAPHICS_API
Color operator *(
const Color & left,
const Color & right);
230 #endif // SFML_COLOR_HPP static const Color Red
Red predefined color.
+
static const Color Green
Green predefined color.
+
+
Utility class for manipulating RGBA colors.
+
static const Color Magenta
Magenta predefined color.
+
+
static const Color Cyan
Cyan predefined color.
+
static const Color White
White predefined color.
+
static const Color Blue
Blue predefined color.
+
static const Color Yellow
Yellow predefined color.
+
static const Color Black
Black predefined color.
+
+
Uint8 a
Alpha (opacity) component.
+
static const Color Transparent
Transparent (black) predefined color.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CONFIG_HPP 26 #define SFML_CONFIG_HPP 32 #define SFML_VERSION_MAJOR 2 33 #define SFML_VERSION_MINOR 5 34 #define SFML_VERSION_PATCH 1 44 #define SFML_SYSTEM_WINDOWS 49 #elif defined(__APPLE__) && defined(__MACH__) 52 #include "TargetConditionals.h" 54 #if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR 57 #define SFML_SYSTEM_IOS 62 #define SFML_SYSTEM_MACOS 67 #error This Apple operating system is not supported by SFML library 71 #elif defined(__unix__) 74 #if defined(__ANDROID__) 77 #define SFML_SYSTEM_ANDROID 79 #elif defined(__linux__) 82 #define SFML_SYSTEM_LINUX 84 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) 87 #define SFML_SYSTEM_FREEBSD 89 #elif defined(__OpenBSD__) 92 #define SFML_SYSTEM_OPENBSD 97 #error This UNIX operating system is not supported by SFML library 104 #error This operating system is not supported by SFML library 122 #if !defined(SFML_STATIC) 124 #if defined(SFML_SYSTEM_WINDOWS) 127 #define SFML_API_EXPORT __declspec(dllexport) 128 #define SFML_API_IMPORT __declspec(dllimport) 133 #pragma warning(disable: 4251) 137 #else // Linux, FreeBSD, Mac OS X 143 #define SFML_API_EXPORT __attribute__ ((__visibility__ ("default"))) 144 #define SFML_API_IMPORT __attribute__ ((__visibility__ ("default"))) 149 #define SFML_API_EXPORT 150 #define SFML_API_IMPORT 159 #define SFML_API_EXPORT 160 #define SFML_API_IMPORT 176 #if defined(SFML_NO_DEPRECATED_WARNINGS) 179 #define SFML_DEPRECATED 181 #elif defined(_MSC_VER) 186 #define SFML_DEPRECATED __declspec(deprecated) 188 #elif defined(__GNUC__) 191 #define SFML_DEPRECATED __attribute__ ((deprecated)) 197 #pragma message("SFML_DEPRECATED is not supported for your compiler, please contact the SFML team") 198 #define SFML_DEPRECATED 213 typedef signed char Int8;
214 typedef unsigned char Uint8;
217 typedef signed short Int16;
218 typedef unsigned short Uint16;
221 typedef signed int Int32;
222 typedef unsigned int Uint32;
225 #if defined(_MSC_VER) 226 typedef signed __int64 Int64;
227 typedef unsigned __int64 Uint64;
229 typedef signed long long Int64;
230 typedef unsigned long long Uint64;
236 #endif // SFML_CONFIG_HPP
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CONTEXTSETTINGS_HPP 26 #define SFML_CONTEXTSETTINGS_HPP 28 #include <SFML/Config.hpp> 62 explicit ContextSettings (
unsigned int depth = 0,
unsigned int stencil = 0,
unsigned int antialiasing = 0,
unsigned int major = 1,
unsigned int minor = 1,
unsigned int attributes =
Default ,
bool sRgb =
false ) :
88 #endif // SFML_CONTEXTSETTINGS_HPP
+
Uint32 attributeFlags
The attribute flags to create the context with.
+
bool sRgbCapable
Whether the context framebuffer is sRGB capable.
+
Attribute
Enumeration of the context attribute flags.
+
+
Non-debug, compatibility context (this and the core attribute are mutually exclusive) ...
+
unsigned int depthBits
Bits of the depth buffer.
+
Structure defining the settings of the OpenGL context attached to a window.
+
+
ContextSettings(unsigned int depth=0, unsigned int stencil=0, unsigned int antialiasing=0, unsigned int major=1, unsigned int minor=1, unsigned int attributes=Default, bool sRgb=false)
Default constructor.
+
unsigned int majorVersion
Major number of the context version to create.
+
unsigned int antialiasingLevel
Level of antialiasing.
+
unsigned int stencilBits
Bits of the stencil buffer.
+
unsigned int minorVersion
Minor number of the context version to create.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CONTEXT_HPP 26 #define SFML_CONTEXT_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/Window/GlResource.hpp> 33 #include <SFML/Window/ContextSettings.hpp> 34 #include <SFML/System/NonCopyable.hpp> 44 typedef void (*GlFunctionPointer)();
78 bool setActive(
bool active);
100 static bool isExtensionAvailable(
const char * name);
110 static GlFunctionPointer getFunction(
const char * name);
122 static const Context * getActiveContext();
133 static Uint64 getActiveContextId();
153 priv::GlContext* m_context;
159 #endif // SFML_CONTEXT_HPP Class holding a valid drawing context.
+
Utility class that makes any derived class non-copyable.
+
Structure defining the settings of the OpenGL context attached to a window.
+
+
Base class for classes that require an OpenGL context.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CONVEXSHAPE_HPP 26 #define SFML_CONVEXSHAPE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Shape.hpp> 64 void setPointCount(std::size_t count);
74 virtual std::size_t getPointCount()
const ;
91 void setPoint(std::size_t index,
const Vector2f & point);
108 virtual Vector2f getPoint(std::size_t index)
const ;
115 std::vector<Vector2f> m_points;
121 #endif // SFML_CONVEXSHAPE_HPP Base class for textured shapes with outline.
+
Specialized shape representing a convex polygon.
+
+
Utility template class for manipulating 2-dimensional vectors.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_CURSOR_HPP 26 #define SFML_CURSOR_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 33 #include <SFML/System/Vector2.hpp> 160 bool loadFromSystem(Type type);
175 const priv::CursorImpl& getImpl()
const ;
182 priv::CursorImpl* m_impl;
188 #endif // SFML_CURSOR_HPP
+
+
Window that serves as a target for OpenGL rendering.
+
Cursor defines the appearance of a system cursor.
+
Horizontal double arrow cursor.
+
+
+
Double arrow cursor going from top-left to bottom-right.
+
Double arrow cursor going from bottom-left to top-right.
+
I-beam, cursor when hovering over a field allowing text entry.
+
+
Type
Enumeration of the native system cursor types.
+
Combination of SizeHorizontal and SizeVertical.
+
Utility class that makes any derived class non-copyable.
+
+
+
+
Vertical double arrow cursor.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_DRAWABLE_HPP 26 #define SFML_DRAWABLE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/RenderStates.hpp> 75 #endif // SFML_DRAWABLE_HPP virtual ~Drawable()
Virtual destructor.
+
Define the states used for drawing to a RenderTarget.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/System/Export.hpp> 41 SFML_SYSTEM_API std::ostream&
err ();
46 #endif // SFML_ERR_HPP std::ostream & err()
Standard stream used by SFML to output warnings and errors.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_EVENT_HPP 26 #define SFML_EVENT_HPP 31 #include <SFML/Config.hpp> 32 #include <SFML/Window/Joystick.hpp> 33 #include <SFML/Window/Keyboard.hpp> 34 #include <SFML/Window/Mouse.hpp> 35 #include <SFML/Window/Sensor.hpp> 241 #endif // SFML_EVENT_HPP Keyboard::Key code
Code of the key that has been pressed.
+
+
A joystick button was pressed (data in event.joystickButton)
+
A joystick was disconnected (data in event.joystickConnect)
+
int y
Y position of the mouse pointer, relative to the top of the owner window.
+
The window lost the focus (no data)
+
+
+
The mouse cursor moved (data in event.mouseMove)
+
Keep last – the total number of event types.
+
Keyboard event parameters (KeyPressed, KeyReleased)
+
unsigned int joystickId
Index of the joystick (in range [0 .. Joystick::Count - 1])
+
A joystick was connected (data in event.joystickConnect)
+
A touch event ended (data in event.touch)
+
int y
Y position of the mouse pointer, relative to the top of the owner window.
+
Mouse move event parameters (MouseMoved)
+
A character was entered (data in event.text)
+
int x
X position of the touch, relative to the left of the owner window.
+
bool alt
Is the Alt key pressed?
+
unsigned int height
New height, in pixels.
+
KeyEvent key
Key event parameters (Event::KeyPressed, Event::KeyReleased)
+
The window gained the focus (no data)
+
float y
Current value of the sensor on Y axis.
+
Sensor event parameters (SensorChanged)
+
SensorEvent sensor
Sensor event parameters (Event::SensorChanged)
+
A touch event began (data in event.touch)
+
TextEvent text
Text event parameters (Event::TextEntered)
+
TouchEvent touch
Touch events parameters (Event::TouchBegan, Event::TouchMoved, Event::TouchEnded) ...
+
Axis
Axes supported by SFML joysticks.
+
+
A key was released (data in event.key)
+
The window was resized (data in event.size)
+
unsigned int width
New width, in pixels.
+
The window requested to be closed (no data)
+
MouseButtonEvent mouseButton
Mouse button event parameters (Event::MouseButtonPressed, Event::MouseButtonReleased) ...
+
The mouse cursor left the area of the window (no data)
+
int delta
Number of ticks the wheel has moved (positive is up, negative is down)
+
Touch events parameters (TouchBegan, TouchMoved, TouchEnded)
+
The mouse wheel was scrolled (data in event.mouseWheelScroll)
+
A mouse button was pressed (data in event.mouseButton)
+
+
The mouse wheel was scrolled (data in event.mouseWheel) (deprecated)
+
Joystick axis move event parameters (JoystickMoved)
+
JoystickMoveEvent joystickMove
Joystick move event parameters (Event::JoystickMoved)
+
+
Mouse wheel events parameters (MouseWheelMoved)
+
Joystick::Axis axis
Axis on which the joystick moved.
+
+
int y
Y position of the touch, relative to the top of the owner window.
+
+
+
bool shift
Is the Shift key pressed?
+
Defines a system event and its parameters.
+
+
Uint32 unicode
UTF-32 Unicode value of the character.
+
JoystickConnectEvent joystickConnect
Joystick (dis)connect event parameters (Event::JoystickConnected, Event::JoystickDisconnected) ...
+
MouseWheelEvent mouseWheel
Mouse wheel event parameters (Event::MouseWheelMoved) (deprecated)
+
The mouse cursor entered the area of the window (no data)
+
A key was pressed (data in event.key)
+
MouseWheelScrollEvent mouseWheelScroll
Mouse wheel event parameters (Event::MouseWheelScrolled)
+
+
bool system
Is the System key pressed?
+
int x
X position of the mouse pointer, relative to the left of the owner window.
+
EventType type
Type of the event.
+
+
bool control
Is the Control key pressed?
+
A mouse button was released (data in event.mouseButton)
+
Joystick connection events parameters (JoystickConnected, JoystickDisconnected)
+
+
MouseMoveEvent mouseMove
Mouse move event parameters (Event::MouseMoved)
+
+
The joystick moved along an axis (data in event.joystickMove)
+
unsigned int finger
Index of the finger in case of multi-touch events.
+
A joystick button was released (data in event.joystickButton)
+
unsigned int joystickId
Index of the joystick (in range [0 .. Joystick::Count - 1])
+
int x
X position of the mouse pointer, relative to the left of the owner window.
+
Text event parameters (TextEntered)
+
JoystickButtonEvent joystickButton
Joystick button event parameters (Event::JoystickButtonPressed, Event::JoystickButtonReleased) ...
+
float x
Current value of the sensor on X axis.
+
float position
New position on the axis (in range [-100 .. 100])
+
A touch moved (data in event.touch)
+
+
A sensor value changed (data in event.sensor)
+
Sensor::Type type
Type of the sensor.
+
SizeEvent size
Size event parameters (Event::Resized)
+
Size events parameters (Resized)
+
+
+
float z
Current value of the sensor on Z axis.
+
EventType
Enumeration of the different types of events.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_FILEINPUTSTREAM_HPP 26 #define SFML_FILEINPUTSTREAM_HPP 31 #include <SFML/Config.hpp> 32 #include <SFML/System/Export.hpp> 33 #include <SFML/System/InputStream.hpp> 34 #include <SFML/System/NonCopyable.hpp> 38 #ifdef SFML_SYSTEM_ANDROID 43 class SFML_SYSTEM_API ResourceStream;
78 bool open(
const std::string& filename);
92 virtual Int64 read(
void * data, Int64 size);
102 virtual Int64 seek(Int64 position);
110 virtual Int64 tell();
118 virtual Int64 getSize();
125 #ifdef SFML_SYSTEM_ANDROID 126 priv::ResourceStream* m_file;
135 #endif // SFML_FILEINPUTSTREAM_HPP
+
+
Utility class that makes any derived class non-copyable.
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Glyph.hpp> 33 #include <SFML/Graphics/Texture.hpp> 34 #include <SFML/Graphics/Rect.hpp> 35 #include <SFML/System/Vector2.hpp> 36 #include <SFML/System/String.hpp> 50 class SFML_GRAPHICS_API
Font 109 bool loadFromFile(
const std::string& filename);
130 bool loadFromMemory(
const void * data, std::size_t sizeInBytes);
160 const Info & getInfo()
const ;
180 const Glyph & getGlyph(Uint32 codePoint,
unsigned int characterSize,
bool bold,
float outlineThickness = 0)
const ;
198 float getKerning(Uint32 first, Uint32 second,
unsigned int characterSize)
const ;
211 float getLineSpacing(
unsigned int characterSize)
const ;
226 float getUnderlinePosition(
unsigned int characterSize)
const ;
240 float getUnderlineThickness(
unsigned int characterSize)
const ;
254 const Texture & getTexture(
unsigned int characterSize)
const ;
264 Font & operator =(
const Font & right);
274 Row(
unsigned int rowTop,
unsigned int rowHeight) : width(0), top(rowTop), height(rowHeight) {}
284 typedef std::map<Uint64, Glyph> GlyphTable;
296 unsigned int nextRow;
297 std::vector<Row> rows;
317 Glyph loadGlyph(Uint32 codePoint,
unsigned int characterSize,
bool bold,
float outlineThickness)
const ;
329 IntRect findGlyphRect(Page& page,
unsigned int width,
unsigned int height)
const ;
339 bool setCurrentSize(
unsigned int characterSize)
const ;
344 typedef std::map<unsigned int, Page> PageTable;
355 mutable PageTable m_pages;
356 mutable std::vector<Uint8> m_pixelBuffer;
357 #ifdef SFML_SYSTEM_ANDROID 365 #endif // SFML_FONT_HPP
+
Image living on the graphics card that can be used for drawing.
+
Structure describing a glyph.
+
+
Class for loading and manipulating character fonts.
+
std::string family
The font family.
+
Holds various information about a font.
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/TcpSocket.hpp> 33 #include <SFML/System/NonCopyable.hpp> 34 #include <SFML/System/Time.hpp> 78 RestartMarkerReply = 110,
79 ServiceReadySoon = 120,
80 DataConnectionAlreadyOpened = 125,
81 OpeningDataConnection = 150,
85 PointlessCommand = 202,
87 DirectoryStatus = 212,
92 ClosingConnection = 221,
93 DataConnectionOpened = 225,
94 ClosingDataConnection = 226,
95 EnteringPassiveMode = 227,
103 NeedAccountToLogIn = 332,
104 NeedInformation = 350,
108 ServiceUnavailable = 421,
109 DataConnectionUnavailable = 425,
110 TransferAborted = 426,
111 FileActionAborted = 450,
113 InsufficientStorageSpace = 452,
117 CommandUnknown = 500,
118 ParametersUnknown = 501,
119 CommandNotImplemented = 502,
120 BadCommandSequence = 503,
121 ParameterNotImplemented = 504,
123 NeedAccountToStore = 532,
124 FileUnavailable = 550,
125 PageTypeUnknown = 551,
126 NotEnoughMemory = 552,
127 FilenameNotAllowed = 553,
130 InvalidResponse = 1000,
131 ConnectionFailed = 1001,
132 ConnectionClosed = 1002,
146 explicit Response (Status code = InvalidResponse,
const std::string& message =
"" );
165 Status getStatus()
const ;
173 const std::string& getMessage()
const ;
181 std::string m_message;
206 const std::string& getDirectory()
const ;
213 std::string m_directory;
240 const std::vector<std::string>& getListing()
const ;
247 std::vector<std::string> m_listing;
316 Response login(
const std::string& name,
const std::string& password);
357 ListingResponse getDirectoryListing(
const std::string& directory =
"" );
371 Response changeDirectory(
const std::string& directory);
396 Response createDirectory(
const std::string& name);
413 Response deleteDirectory(
const std::string& name);
429 Response renameFile(
const std::string& file,
const std::string& newName);
446 Response deleteFile(
const std::string& name);
468 Response download(
const std::string& remoteFile,
const std::string& localPath,
TransferMode mode = Binary);
491 Response upload(
const std::string& localFile,
const std::string& remotePath,
TransferMode mode = Binary,
bool append =
false );
509 Response sendCommand(
const std::string& command,
const std::string& parameter =
"" );
531 friend class DataChannel;
537 std::string m_receiveBuffer;
543 #endif // SFML_FTP_HPP Specialization of FTP response returning a directory.
+
+
+
static const Time Zero
Predefined "zero" time value.
+
+
Encapsulate an IPv4 network address.
+
Specialization of FTP response returning a filename listing.
+
Utility class that makes any derived class non-copyable.
+
TransferMode
Enumeration of transfer modes.
+
Specialized socket using the TCP protocol.
+
Text mode using ASCII encoding.
+
Binary mode (file is transfered as a sequence of bytes)
+
+
Status
Status codes possibly returned by a FTP response.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_GLRESOURCE_HPP 26 #define SFML_GLRESOURCE_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 40 typedef void(*ContextDestroyCallback)(
void *);
73 static void registerContextDestroyCallback(ContextDestroyCallback callback,
void * arg);
99 #endif // SFML_GLRESOURCE_HPP RAII helper class to temporarily lock an available context for use.
+
Utility class that makes any derived class non-copyable.
+
+
Base class for classes that require an OpenGL context.
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Graphics/Transform.hpp> 32 #include <SFML/Graphics/Color.hpp> 33 #include <SFML/System/Vector2.hpp> 34 #include <SFML/System/Vector3.hpp> 42 template <std::
size_t Columns, std::
size_t Rows>
48 #include <SFML/Graphics/Glsl.inl> 110 typedef implementation-defined
Vec4 ;
124 typedef implementation-defined
Ivec4 ;
130 typedef implementation-defined
Bvec4 ;
155 typedef implementation-defined
Mat3 ;
181 typedef implementation-defined
Mat4 ;
183 #else // SFML_DOXYGEN 185 typedef priv::Vector4<float>
Vec4 ;
186 typedef priv::Vector4<int>
Ivec4 ;
187 typedef priv::Vector4<bool>
Bvec4 ;
188 typedef priv::Matrix<3, 3>
Mat3 ;
189 typedef priv::Matrix<4, 4>
Mat4 ;
191 #endif // SFML_DOXYGEN 196 #endif // SFML_GLSL_HPP implementation defined Bvec4
4D bool vector (bvec4 in GLSL)
+
Vector2< float > Vec2
2D float vector (vec2 in GLSL)
+
implementation defined Ivec4
4D int vector (ivec4 in GLSL)
+
Vector3< float > Vec3
3D float vector (vec3 in GLSL)
+
implementation defined Mat4
4x4 float matrix (mat4 in GLSL)
+
Vector3< bool > Bvec3
3D bool vector (bvec3 in GLSL)
+
Utility template class for manipulating 3-dimensional vectors.
+
implementation defined Vec4
4D float vector (vec4 in GLSL)
+
implementation defined Mat3
3x3 float matrix (mat3 in GLSL)
+
Vector2< bool > Bvec2
2D bool vector (bvec2 in GLSL)
+
Vector2< int > Ivec2
2D int vector (ivec2 in GLSL)
+
+
+
Vector3< int > Ivec3
3D int vector (ivec3 in GLSL)
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_GLYPH_HPP 26 #define SFML_GLYPH_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Rect.hpp> 62 #endif // SFML_GLYPH_HPP IntRect textureRect
Texture coordinates of the glyph inside the font's texture.
+
Glyph()
Default constructor.
+
float advance
Offset to move horizontally to the next character.
+
Structure describing a glyph.
+
FloatRect bounds
Bounding rectangle of the glyph, in coordinates relative to the baseline.
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
Headers.
+More...
+
#include <SFML/Config.hpp>
+
Go to the source code of this file.
+
+
+
Headers.
+
File containing SFML_DEFINE_DISCRETE_GPU_PREFERENCE
+
+
Definition in file GpuPreference.hpp .
+
+
+
◆
+
+
+
+
+
+ #define SFML_DEFINE_DISCRETE_GPU_PREFERENCE
+
+
+
+
+
A macro to encourage usage of the discrete GPU.
+
In order to inform the Nvidia/AMD driver that an SFML application could benefit from using the more powerful discrete GPU, special symbols have to be publicly exported from the final executable.
+
SFML defines a helper macro to easily do this.
+
Place SFML_DEFINE_DISCRETE_GPU_PREFERENCE in the global scope of a source file that will be linked into the final executable. Typically it is best to place it where the main function is also defined.
+
+
Definition at line 69 of file GpuPreference.hpp .
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Go to the documentation of this file. 25 #ifndef SFML_GPUPREFERENCE_HPP 26 #define SFML_GPUPREFERENCE_HPP 32 #include <SFML/Config.hpp> 61 #if defined(SFML_SYSTEM_WINDOWS) 63 #define SFML_DEFINE_DISCRETE_GPU_PREFERENCE \ 64 extern "C" __declspec(dllexport) unsigned long NvOptimusEnablement = 1; \ 65 extern "C" __declspec(dllexport) unsigned long AmdPowerXpressRequestHighPerformance = 1; 69 #define SFML_DEFINE_DISCRETE_GPU_PREFERENCE 74 #endif // SFML_GPUPREFERENCE_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_GRAPHICS_EXPORT_HPP 26 #define SFML_GRAPHICS_EXPORT_HPP 31 #include <SFML/Config.hpp> 37 #if defined(SFML_GRAPHICS_EXPORTS) 39 #define SFML_GRAPHICS_API SFML_API_EXPORT 43 #define SFML_GRAPHICS_API SFML_API_IMPORT 48 #endif // SFML_GRAPHICS_EXPORT_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_GRAPHICS_HPP 26 #define SFML_GRAPHICS_HPP 32 #include <SFML/Window.hpp> 33 #include <SFML/Graphics/BlendMode.hpp> 34 #include <SFML/Graphics/CircleShape.hpp> 35 #include <SFML/Graphics/Color.hpp> 36 #include <SFML/Graphics/ConvexShape.hpp> 37 #include <SFML/Graphics/Drawable.hpp> 38 #include <SFML/Graphics/Font.hpp> 39 #include <SFML/Graphics/Glyph.hpp> 40 #include <SFML/Graphics/Image.hpp> 41 #include <SFML/Graphics/PrimitiveType.hpp> 42 #include <SFML/Graphics/Rect.hpp> 43 #include <SFML/Graphics/RectangleShape.hpp> 44 #include <SFML/Graphics/RenderStates.hpp> 45 #include <SFML/Graphics/RenderTarget.hpp> 46 #include <SFML/Graphics/RenderTexture.hpp> 47 #include <SFML/Graphics/RenderWindow.hpp> 48 #include <SFML/Graphics/Shader.hpp> 49 #include <SFML/Graphics/Shape.hpp> 50 #include <SFML/Graphics/Sprite.hpp> 51 #include <SFML/Graphics/Text.hpp> 52 #include <SFML/Graphics/Texture.hpp> 53 #include <SFML/Graphics/Transform.hpp> 54 #include <SFML/Graphics/Transformable.hpp> 55 #include <SFML/Graphics/Vertex.hpp> 56 #include <SFML/Graphics/VertexArray.hpp> 57 #include <SFML/Graphics/VertexBuffer.hpp> 58 #include <SFML/Graphics/View.hpp> 61 #endif // SFML_GRAPHICS_HPP SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/IpAddress.hpp> 33 #include <SFML/Network/TcpSocket.hpp> 34 #include <SFML/System/NonCopyable.hpp> 35 #include <SFML/System/Time.hpp> 82 Request (
const std::string& uri =
"/" , Method method = Get,
const std::string& body =
"" );
97 void setField(
const std::string& field,
const std::string& value);
109 void setMethod(Method method);
121 void setUri(
const std::string& uri);
132 void setHttpVersion(
unsigned int major,
unsigned int minor);
144 void setBody(
const std::string& body);
159 std::string prepare()
const ;
171 bool hasField(
const std::string& field)
const ;
176 typedef std::map<std::string, std::string> FieldTable;
184 unsigned int m_majorVersion;
185 unsigned int m_minorVersion;
209 PartialContent = 206,
212 MultipleChoices = 300,
213 MovedPermanently = 301,
214 MovedTemporarily = 302,
222 RangeNotSatisfiable = 407,
225 InternalServerError = 500,
226 NotImplemented = 501,
228 ServiceNotAvailable = 503,
229 GatewayTimeout = 504,
230 VersionNotSupported = 505,
233 InvalidResponse = 1000,
234 ConnectionFailed = 1001
257 const std::string& getField(
const std::string& field)
const ;
270 Status getStatus()
const ;
280 unsigned int getMajorHttpVersion()
const ;
290 unsigned int getMinorHttpVersion()
const ;
304 const std::string& getBody()
const ;
319 void parse(
const std::string& data);
331 void parseFields(std::istream &in);
336 typedef std::map<std::string, std::string> FieldTable;
343 unsigned int m_majorVersion;
344 unsigned int m_minorVersion;
368 Http (
const std::string& host,
unsigned short port = 0);
385 void setHost(
const std::string& host,
unsigned short port = 0);
405 Response sendRequest(
const Request& request,
Time timeout =
Time::Zero );
414 std::string m_hostName;
415 unsigned short m_port;
421 #endif // SFML_HTTP_HPP Request in put mode, useful for a REST API.
+
+
+
+
+
static const Time Zero
Predefined "zero" time value.
+
Request in get mode, standard method to retrieve a page.
+
Status
Enumerate all the valid status codes for a response.
+
Encapsulate an IPv4 network address.
+
Utility class that makes any derived class non-copyable.
+
Method
Enumerate the available HTTP methods for a request.
+
Specialized socket using the TCP protocol.
+
Request a page's header only.
+
+
Request in post mode, usually to send data to a page.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_IMAGE_HPP 26 #define SFML_IMAGE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Color.hpp> 33 #include <SFML/Graphics/Rect.hpp> 72 void create(
unsigned int width,
unsigned int height,
const Color & color =
Color (0, 0, 0));
87 void create(
unsigned int width,
unsigned int height,
const Uint8* pixels);
104 bool loadFromFile(
const std::string& filename);
122 bool loadFromMemory(
const void * data, std::size_t size);
156 bool saveToFile(
const std::string& filename)
const ;
177 void createMaskFromColor(
const Color & color, Uint8 alpha = 0);
199 void copy(
const Image & source,
unsigned int destX,
unsigned int destY,
const IntRect & sourceRect =
IntRect (0, 0, 0, 0),
bool applyAlpha =
false );
215 void setPixel(
unsigned int x,
unsigned int y,
const Color & color);
232 Color getPixel(
unsigned int x,
unsigned int y)
const ;
247 const Uint8* getPixelsPtr()
const ;
253 void flipHorizontally();
259 void flipVertically();
267 std::vector<Uint8> m_pixels;
273 #endif // SFML_IMAGE_HPP
+
Utility class for manipulating RGBA colors.
+
+
+
+
Class for loading, manipulating and saving images.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_INPUTSOUNDFILE_HPP 26 #define SFML_INPUTSOUNDFILE_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 33 #include <SFML/System/Time.hpp> 41 class SoundFileReader;
74 bool openFromFile(
const std::string& filename);
88 bool openFromMemory(
const void * data, std::size_t sizeInBytes);
109 Uint64 getSampleCount()
const ;
117 unsigned int getChannelCount()
const ;
125 unsigned int getSampleRate()
const ;
136 Time getDuration()
const ;
144 Time getTimeOffset()
const ;
152 Uint64 getSampleOffset()
const ;
171 void seek(Uint64 sampleOffset);
185 void seek(
Time timeOffset);
196 Uint64 read(Int16* samples, Uint64 maxCount);
212 Uint64 m_sampleOffset;
213 Uint64 m_sampleCount;
214 unsigned int m_channelCount;
215 unsigned int m_sampleRate;
221 #endif // SFML_INPUTSOUNDFILE_HPP
+
+
+
Abstract base class for sound file decoding.
+
Utility class that makes any derived class non-copyable.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_INPUTSTREAM_HPP 26 #define SFML_INPUTSTREAM_HPP 31 #include <SFML/Config.hpp> 32 #include <SFML/System/Export.hpp> 63 virtual Int64 read(
void * data, Int64 size) = 0;
73 virtual Int64 seek(Int64 position) = 0;
81 virtual Int64 tell() = 0;
89 virtual Int64 getSize() = 0;
95 #endif // SFML_INPUTSTREAM_HPP
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_IPADDRESS_HPP 26 #define SFML_IPADDRESS_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/System/Time.hpp> 94 IpAddress (Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3);
123 std::string toString()
const ;
139 Uint32 toInteger()
const ;
191 friend SFML_NETWORK_API
bool operator <(
const IpAddress & left,
const IpAddress & right);
199 void resolve(
const std::string& address);
283 SFML_NETWORK_API std::istream& operator >>(std::istream& stream,
IpAddress & address);
294 SFML_NETWORK_API std::ostream& operator <<(std::ostream& stream,
const IpAddress & address);
299 #endif // SFML_IPADDRESS_HPP static const IpAddress None
Value representing an empty/invalid address.
+
static const IpAddress Any
Value representing any address (0.0.0.0)
+
+
static const Time Zero
Predefined "zero" time value.
+
Encapsulate an IPv4 network address.
+
+
static const IpAddress LocalHost
The "localhost" address (for connecting a computer to itself locally)
+
static const IpAddress Broadcast
The "broadcast" address (for sending UDP messages to everyone on a local network) ...
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_JOYSTICK_HPP 26 #define SFML_JOYSTICK_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/String.hpp> 93 static bool isConnected(
unsigned int joystick);
105 static unsigned int getButtonCount(
unsigned int joystick);
118 static bool hasAxis(
unsigned int joystick,
Axis axis);
131 static bool isButtonPressed(
unsigned int joystick,
unsigned int button);
144 static float getAxisPosition(
unsigned int joystick,
Axis axis);
165 static void update();
171 #endif // SFML_JOYSTICK_HPP
+
The X axis of the point-of-view hat.
+
Give access to the real-time state of the joysticks.
+
Axis
Axes supported by SFML joysticks.
+
unsigned int productId
Product identifier.
+
Structure holding a joystick's identification.
+
+
+
unsigned int vendorId
Manufacturer identifier.
+
+
String name
Name of the joystick.
+
+
+
Utility string class that automatically handles conversions between types and encodings.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_KEYBOARD_HPP 26 #define SFML_KEYBOARD_HPP 31 #include <SFML/Window/Export.hpp> 158 BackSpace = Backspace,
159 BackSlash = Backslash,
160 SemiColon = Semicolon,
172 static bool isKeyPressed(Key key);
187 static void setVirtualKeyboardVisible(
bool visible);
193 #endif // SFML_KEYBOARD_HPP
+
+
+
+
+
Keep last – the total number of keyboard keys.
+
+
+
+
+
+
+
Give access to the real-time state of the keyboard.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The left OS specific key: window (Windows and Linux), apple (MacOS X), ...
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The right OS specific key: window (Windows and Linux), apple (MacOS X), ...
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The - key (minus, usually from numpad)
+
+
+
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_LISTENER_HPP 26 #define SFML_LISTENER_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/System/Vector3.hpp> 58 static void setGlobalVolume(
float volume);
68 static float getGlobalVolume();
82 static void setPosition(
float x,
float y,
float z);
94 static void setPosition(
const Vector3f & position);
123 static void setDirection(
float x,
float y,
float z);
140 static void setDirection(
const Vector3f & direction);
169 static void setUpVector(
float x,
float y,
float z);
186 static void setUpVector(
const Vector3f & upVector);
202 #endif // SFML_LISTENER_HPP Utility template class for manipulating 3-dimensional vectors.
+
The audio listener is the point in the scene from where all the sounds are heard. ...
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 76 #endif // SFML_LOCK_HPP Blocks concurrent access to shared resources from multiple threads.
+
Utility class that makes any derived class non-copyable.
+
+
Automatic wrapper for locking and unlocking mutexes.
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Config.hpp> 34 #if defined(SFML_SYSTEM_IOS) 43 #endif // SFML_MAIN_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_MEMORYINPUTSTREAM_HPP 26 #define SFML_MEMORYINPUTSTREAM_HPP 31 #include <SFML/Config.hpp> 32 #include <SFML/System/InputStream.hpp> 33 #include <SFML/System/Export.hpp> 60 void open(
const void * data, std::size_t sizeInBytes);
74 virtual Int64 read(
void * data, Int64 size);
84 virtual Int64 seek(Int64 position);
100 virtual Int64 getSize();
115 #endif // SFML_MEMORYINPUTSTREAM_HPP
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_MOUSE_HPP 26 #define SFML_MOUSE_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/Vector2.hpp> 80 static bool isButtonPressed(Button button);
115 static void setPosition(
const Vector2i & position);
127 static void setPosition(
const Vector2i & position,
const Window & relativeTo);
133 #endif // SFML_MOUSE_HPP The vertical mouse wheel.
+
Window that serves as a target for OpenGL rendering.
+
The first extra mouse button.
+
Give access to the real-time state of the mouse.
+
The middle (wheel) mouse button.
+
+
+
+
+
+
Utility template class for manipulating 2-dimensional vectors.
+
The second extra mouse button.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_MUSIC_HPP 26 #define SFML_MUSIC_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/SoundStream.hpp> 33 #include <SFML/Audio/InputSoundFile.hpp> 34 #include <SFML/System/Mutex.hpp> 35 #include <SFML/System/Time.hpp> 120 bool openFromFile(
const std::string& filename);
143 bool openFromMemory(
const void * data, std::size_t sizeInBytes);
172 Time getDuration()
const ;
211 void setLoopPoints(
TimeSpan timePoints);
226 virtual bool onGetData(
Chunk & data);
234 virtual void onSeek(
Time timeOffset);
246 virtual Int64 onLoop();
264 Uint64 timeToSamples(
Time position)
const ;
274 Time samplesToTime(Uint64 samples)
const ;
280 std::vector<Int16> m_samples;
288 #endif // SFML_MUSIC_HPP Structure defining a chunk of audio data to stream.
+
Blocks concurrent access to shared resources from multiple threads.
+
Streamed music played from an audio file.
+
+
+
+
Abstract base class for streamed audio sources.
+
Span()
Default constructor.
+
T length
The length of the time range.
+
Structure defining a time range using the template type.
+
+
T offset
The beginning offset of the time range.
+
Span(T off, T len)
Initialization constructor.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_MUTEX_HPP 26 #define SFML_MUTEX_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 88 priv::MutexImpl* m_mutexImpl;
94 #endif // SFML_MUTEX_HPP Blocks concurrent access to shared resources from multiple threads.
+
Utility class that makes any derived class non-copyable.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_NATIVEACTIVITY_HPP 26 #define SFML_NATIVEACTIVITY_HPP 32 #include <SFML/System/Export.hpp> 35 #if !defined(SFML_SYSTEM_ANDROID) 36 #error NativeActivity.hpp: This header is Android only. 40 struct ANativeActivity;
62 #endif // SFML_NATIVEACTIVITY_HPP
+
ANativeActivity * getNativeActivity()
Return a pointer to the Android native activity.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_NETWORK_EXPORT_HPP 26 #define SFML_NETWORK_EXPORT_HPP 31 #include <SFML/Config.hpp> 37 #if defined(SFML_NETWORK_EXPORTS) 39 #define SFML_NETWORK_API SFML_API_EXPORT 43 #define SFML_NETWORK_API SFML_API_IMPORT 48 #endif // SFML_NETWORK_EXPORT_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_NETWORK_HPP 26 #define SFML_NETWORK_HPP 32 #include <SFML/System.hpp> 33 #include <SFML/Network/Ftp.hpp> 34 #include <SFML/Network/Http.hpp> 35 #include <SFML/Network/IpAddress.hpp> 36 #include <SFML/Network/Packet.hpp> 37 #include <SFML/Network/Socket.hpp> 38 #include <SFML/Network/SocketHandle.hpp> 39 #include <SFML/Network/SocketSelector.hpp> 40 #include <SFML/Network/TcpListener.hpp> 41 #include <SFML/Network/TcpSocket.hpp> 42 #include <SFML/Network/UdpSocket.hpp> 45 #endif // SFML_NETWORK_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_NONCOPYABLE_HPP 26 #define SFML_NONCOPYABLE_HPP 31 #include <SFML/System/Export.hpp> 95 #endif // SFML_NONCOPYABLE_HPP Utility class that makes any derived class non-copyable.
+
+
NonCopyable()
Default constructor.
+
~NonCopyable()
Default destructor.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_OPENGL_HPP 26 #define SFML_OPENGL_HPP 32 #include <SFML/Config.hpp> 39 #if defined(SFML_SYSTEM_WINDOWS) 48 #elif defined(SFML_SYSTEM_LINUX) || defined(SFML_SYSTEM_FREEBSD) || defined(SFML_SYSTEM_OPENBSD) 50 #if defined(SFML_OPENGL_ES) 52 #include <GLES/glext.h> 57 #elif defined(SFML_SYSTEM_MACOS) 59 #include <OpenGL/gl.h> 61 #elif defined (SFML_SYSTEM_IOS) 63 #include <OpenGLES/ES1/gl.h> 64 #include <OpenGLES/ES1/glext.h> 66 #elif defined (SFML_SYSTEM_ANDROID) 69 #include <GLES/glext.h> 72 #include <GLES2/gl2platform.h> 73 #include <GLES2/gl2ext.h> 78 #endif // SFML_OPENGL_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_OUTPUTSOUNDFILE_HPP 26 #define SFML_OUTPUTSOUNDFILE_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 38 class SoundFileWriter;
74 bool openFromFile(
const std::string& filename,
unsigned int sampleRate,
unsigned int channelCount);
83 void write(
const Int16* samples, Uint64 count);
102 #endif // SFML_OUTPUTSOUNDFILE_HPP Provide write access to sound files.
+
Utility class that makes any derived class non-copyable.
+
+
Abstract base class for sound file encoding.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_PACKET_HPP 26 #define SFML_PACKET_HPP 31 #include <SFML/Network/Export.hpp> 50 typedef bool (
Packet ::*BoolType)(std::size_t);
77 void append(
const void * data, std::size_t sizeInBytes);
102 const void * getData()
const ;
115 std::size_t getDataSize()
const ;
129 bool endOfPacket()
const ;
171 operator BoolType()
const ;
177 Packet & operator >>(
bool & data);
182 Packet & operator >>(Int8& data);
187 Packet & operator >>(Uint8& data);
192 Packet & operator >>(Int16& data);
197 Packet & operator >>(Uint16& data);
202 Packet & operator >>(Int32& data);
207 Packet & operator >>(Uint32& data);
212 Packet & operator >>(Int64& data);
217 Packet & operator >>(Uint64& data);
222 Packet & operator >>(
float & data);
227 Packet & operator >>(
double & data);
232 Packet & operator >>(
char * data);
237 Packet & operator >>(std::string& data);
242 Packet & operator >>(
wchar_t * data);
247 Packet & operator >>(std::wstring& data);
258 Packet & operator <<(
bool data);
263 Packet & operator <<(Int8 data);
268 Packet & operator <<(Uint8 data);
273 Packet & operator <<(Int16 data);
278 Packet & operator <<(Uint16 data);
283 Packet & operator <<(Int32 data);
288 Packet & operator <<(Uint32 data);
293 Packet & operator <<(Int64 data);
298 Packet & operator <<(Uint64 data);
303 Packet & operator <<(
float data);
308 Packet & operator <<(
double data);
313 Packet & operator <<(
const char * data);
318 Packet & operator <<(
const std::string& data);
323 Packet & operator <<(
const wchar_t * data);
328 Packet & operator <<(
const std::wstring& data);
358 virtual const void * onSend(std::size_t& size);
377 virtual void onReceive(
const void * data, std::size_t size);
385 bool operator ==(
const Packet & right)
const ;
386 bool operator !=(
const Packet & right)
const ;
398 bool checkSize(std::size_t size);
403 std::vector<char> m_data;
404 std::size_t m_readPos;
405 std::size_t m_sendPos;
412 #endif // SFML_PACKET_HPP Specialized socket using the UDP protocol.
+
Utility class to build blocks of data to transfer over the network.
+
Specialized socket using the TCP protocol.
+
+
Utility string class that automatically handles conversions between types and encodings.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_PRIMITIVETYPE_HPP 26 #define SFML_PRIMITIVETYPE_HPP 58 #endif // SFML_PRIMITIVETYPE_HPP PrimitiveType
Types of primitives that a sf::VertexArray can render.
+
+
List of individual triangles.
+
+
List of individual quads (deprecated, don't work with OpenGL ES)
+
List of individual points.
+
+
List of connected triangles, a point uses the two previous points to form a triangle.
+
List of individual lines.
+
+
List of connected triangles, a point uses the common center and the previous point to form a triangle...
+
List of connected lines, a point uses the previous point to form a line.
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/System/Vector2.hpp> 67 Rect (T rectLeft, T rectTop, T rectWidth, T rectHeight);
175 template <
typename T>
190 template <
typename T>
193 #include <SFML/Graphics/Rect.inl> 202 #endif // SFML_RECT_HPP bool contains(T x, T y) const
Check if a point is inside the rectangle's area.
+
T height
Height of the rectangle.
+
T width
Width of the rectangle.
+
Rect()
Default constructor.
+
Utility class for manipulating 2D axis aligned rectangles.
+
+
bool intersects(const Rect< T > &rectangle) const
Check the intersection between two rectangles.
+
Utility template class for manipulating 2-dimensional vectors.
+
T top
Top coordinate of the rectangle.
+
T left
Left coordinate of the rectangle.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_RECTANGLESHAPE_HPP 26 #define SFML_RECTANGLESHAPE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Shape.hpp> 80 virtual std::size_t getPointCount()
const ;
95 virtual Vector2f getPoint(std::size_t index)
const ;
108 #endif // SFML_RECTANGLESHAPE_HPP Base class for textured shapes with outline.
+
Specialized shape representing a rectangle.
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_RENDERSTATES_HPP 26 #define SFML_RENDERSTATES_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/BlendMode.hpp> 33 #include <SFML/Graphics/Transform.hpp> 124 #endif // SFML_RENDERSTATES_HPP const Shader * shader
Shader.
+
Image living on the graphics card that can be used for drawing.
+
const Texture * texture
Texture.
+
Define the states used for drawing to a RenderTarget.
+
BlendMode blendMode
Blending mode.
+
Transform transform
Transform.
+
Blending modes for drawing.
+
+
+
Shader class (vertex, geometry and fragment)
+
static const RenderStates Default
Special instance holding the default render states.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_RENDERTARGET_HPP 26 #define SFML_RENDERTARGET_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Color.hpp> 33 #include <SFML/Graphics/Rect.hpp> 34 #include <SFML/Graphics/View.hpp> 35 #include <SFML/Graphics/Transform.hpp> 36 #include <SFML/Graphics/BlendMode.hpp> 37 #include <SFML/Graphics/RenderStates.hpp> 38 #include <SFML/Graphics/PrimitiveType.hpp> 39 #include <SFML/Graphics/Vertex.hpp> 40 #include <SFML/System/NonCopyable.hpp> 71 void clear(
const Color & color =
Color (0, 0, 0, 255));
92 void setView(
const View & view);
102 const View & getView()
const ;
115 const View & getDefaultView()
const ;
248 void draw(
const Vertex * vertices, std::size_t vertexCount,
277 virtual Vector2u getSize()
const = 0;
299 virtual bool setActive(
bool active =
true );
367 void resetGLStates();
392 void applyCurrentView();
400 void applyBlendMode(
const BlendMode & mode);
408 void applyTransform(
const Transform & transform);
416 void applyTexture(
const Texture * texture);
424 void applyShader(
const Shader * shader);
433 void setupDraw(
bool useVertexCache,
const RenderStates & states);
443 void drawPrimitives(
PrimitiveType type, std::size_t firstVertex, std::size_t vertexCount);
459 enum {VertexCacheSize = 4};
465 Uint64 lastTextureId;
466 bool texCoordsArrayEnabled;
468 Vertex vertexCache[VertexCacheSize];
483 #endif // SFML_RENDERTARGET_HPP PrimitiveType
Types of primitives that a sf::VertexArray can render.
+
Image living on the graphics card that can be used for drawing.
+
Define the states used for drawing to a RenderTarget.
+
Utility class for manipulating RGBA colors.
+
2D camera that defines what region is shown on screen
+
Blending modes for drawing.
+
Vertex buffer storage for one or more 2D primitives.
+
+
Define a point with color and texture coordinates.
+
Utility class that makes any derived class non-copyable.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
+
Shader class (vertex, geometry and fragment)
+
static const RenderStates Default
Special instance holding the default render states.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_RENDERTEXTURE_HPP 26 #define SFML_RENDERTEXTURE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Texture.hpp> 33 #include <SFML/Graphics/RenderTarget.hpp> 34 #include <SFML/Window/ContextSettings.hpp> 41 class RenderTextureImpl;
89 SFML_DEPRECATED
bool create(
unsigned int width,
unsigned int height,
bool depthBuffer);
117 static unsigned int getMaximumAntialiasingLevel();
130 void setSmooth(
bool smooth);
140 bool isSmooth()
const ;
153 void setRepeated(
bool repeated);
163 bool isRepeated()
const ;
179 bool generateMipmap();
196 bool setActive(
bool active =
true );
234 const Texture & getTexture()
const ;
241 priv::RenderTextureImpl* m_impl;
248 #endif // SFML_RENDERTEXTURE_HPP Image living on the graphics card that can be used for drawing.
+
Target for off-screen 2D rendering into a texture.
+
Base class for all render targets (window, texture, ...)
+
Structure defining the settings of the OpenGL context attached to a window.
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_RENDERWINDOW_HPP 26 #define SFML_RENDERWINDOW_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/RenderTarget.hpp> 33 #include <SFML/Graphics/Image.hpp> 34 #include <SFML/Window/Window.hpp> 131 bool setActive(
bool active =
true );
158 SFML_DEPRECATED
Image capture()
const ;
170 virtual void onCreate();
179 virtual void onResize();
185 #endif // SFML_RENDERWINDOW_HPP
+
Window that serves as a target for OpenGL rendering.
+
Window that can serve as a target for 2D drawing.
+
Base class for all render targets (window, texture, ...)
+
Structure defining the settings of the OpenGL context attached to a window.
+
VideoMode defines a video mode (width, height, bpp)
+
+
+
Utility string class that automatically handles conversions between types and encodings.
+
platform specific WindowHandle
Define a low-level window handle type, specific to each platform.
+
Class for loading, manipulating and saving images.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SENSOR_HPP 26 #define SFML_SENSOR_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/Vector3.hpp> 33 #include <SFML/System/Time.hpp> 70 static bool isAvailable(Type sensor);
85 static void setEnabled(Type sensor,
bool enabled);
95 static Vector3f getValue(Type sensor);
101 #endif // SFML_SENSOR_HPP Give access to the real-time state of the sensors.
+
Measures the raw acceleration (m/s^2)
+
+
Utility template class for manipulating 3-dimensional vectors.
+
Measures the direction and intensity of device acceleration, independent of the gravity (m/s^2) ...
+
Measures the raw rotation rates (degrees/s)
+
Measures the ambient magnetic field (micro-teslas)
+
+
Measures the absolute 3D orientation (degrees)
+
Measures the direction and intensity of gravity, independent of device acceleration (m/s^2) ...
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SHADER_HPP 26 #define SFML_SHADER_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Glsl.hpp> 33 #include <SFML/Window/GlResource.hpp> 34 #include <SFML/System/NonCopyable.hpp> 35 #include <SFML/System/Vector2.hpp> 36 #include <SFML/System/Vector3.hpp> 119 bool loadFromFile(
const std::string& filename,
Type type);
140 bool loadFromFile(
const std::string& vertexShaderFilename,
const std::string& fragmentShaderFilename);
162 bool loadFromFile(
const std::string& vertexShaderFilename,
const std::string& geometryShaderFilename,
const std::string& fragmentShaderFilename);
182 bool loadFromMemory(
const std::string& shader,
Type type);
203 bool loadFromMemory(
const std::string& vertexShader,
const std::string& fragmentShader);
225 bool loadFromMemory(
const std::string& vertexShader,
const std::string& geometryShader,
const std::string& fragmentShader);
297 void setUniform(
const std::string& name,
float x);
306 void setUniform(
const std::string& name,
const Glsl::Vec2 & vector);
315 void setUniform(
const std::string& name,
const Glsl::Vec3 & vector);
333 void setUniform(
const std::string& name,
const Glsl::Vec4 & vector);
342 void setUniform(
const std::string& name,
int x);
351 void setUniform(
const std::string& name,
const Glsl::Ivec2 & vector);
360 void setUniform(
const std::string& name,
const Glsl::Ivec3 & vector);
377 void setUniform(
const std::string& name,
const Glsl::Ivec4 & vector);
386 void setUniform(
const std::string& name,
bool x);
395 void setUniform(
const std::string& name,
const Glsl::Bvec2 & vector);
404 void setUniform(
const std::string& name,
const Glsl::Bvec3 & vector);
413 void setUniform(
const std::string& name,
const Glsl::Bvec4 & vector);
422 void setUniform(
const std::string& name,
const Glsl::Mat3 & matrix);
431 void setUniform(
const std::string& name,
const Glsl::Mat4 & matrix);
463 void setUniform(
const std::string& name,
const Texture & texture);
496 void setUniformArray(
const std::string& name,
const float * scalarArray, std::size_t length);
506 void setUniformArray(
const std::string& name,
const Glsl::Vec2 * vectorArray, std::size_t length);
516 void setUniformArray(
const std::string& name,
const Glsl::Vec3 * vectorArray, std::size_t length);
526 void setUniformArray(
const std::string& name,
const Glsl::Vec4 * vectorArray, std::size_t length);
536 void setUniformArray(
const std::string& name,
const Glsl::Mat3 * matrixArray, std::size_t length);
546 void setUniformArray(
const std::string& name,
const Glsl::Mat4 * matrixArray, std::size_t length);
554 SFML_DEPRECATED
void setParameter(
const std::string& name,
float x);
562 SFML_DEPRECATED
void setParameter(
const std::string& name,
float x,
float y);
570 SFML_DEPRECATED
void setParameter(
const std::string& name,
float x,
float y,
float z);
578 SFML_DEPRECATED
void setParameter(
const std::string& name,
float x,
float y,
float z,
float w);
586 SFML_DEPRECATED
void setParameter(
const std::string& name,
const Vector2f & vector);
594 SFML_DEPRECATED
void setParameter(
const std::string& name,
const Vector3f & vector);
602 SFML_DEPRECATED
void setParameter(
const std::string& name,
const Color & color);
610 SFML_DEPRECATED
void setParameter(
const std::string& name,
const Transform & transform);
618 SFML_DEPRECATED
void setParameter(
const std::string& name,
const Texture & texture);
638 unsigned int getNativeHandle()
const ;
661 static void bind(
const Shader * shader);
673 static bool isAvailable();
692 static bool isGeometryAvailable();
709 bool compile(
const char * vertexShaderCode,
const char * geometryShaderCode,
const char * fragmentShaderCode);
718 void bindTextures()
const ;
728 int getUniformLocation(
const std::string& name);
737 struct UniformBinder;
742 typedef std::map<int, const Texture*> TextureTable;
743 typedef std::map<std::string, int> UniformTable;
748 unsigned int m_shaderProgram;
749 int m_currentTexture;
750 TextureTable m_textures;
751 UniformTable m_uniforms;
757 #endif // SFML_SHADER_HPP implementation defined Bvec4
4D bool vector (bvec4 in GLSL)
+
+
Image living on the graphics card that can be used for drawing.
+
implementation defined Ivec4
4D int vector (ivec4 in GLSL)
+
implementation defined Mat4
4x4 float matrix (mat4 in GLSL)
+
Utility class for manipulating RGBA colors.
+
Utility template class for manipulating 3-dimensional vectors.
+
implementation defined Vec4
4D float vector (vec4 in GLSL)
+
implementation defined Mat3
3x3 float matrix (mat3 in GLSL)
+
+
Special type that can be passed to setUniform(), and that represents the texture of the object being ...
+
+
Utility class that makes any derived class non-copyable.
+
static CurrentTextureType CurrentTexture
Represents the texture of the object being drawn.
+
+
+
+
Shader class (vertex, geometry and fragment)
+
Base class for classes that require an OpenGL context.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SHAPE_HPP 26 #define SFML_SHAPE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Drawable.hpp> 33 #include <SFML/Graphics/Transformable.hpp> 34 #include <SFML/Graphics/VertexArray.hpp> 35 #include <SFML/System/Vector2.hpp> 74 void setTexture(
const Texture * texture,
bool resetRect =
false );
88 void setTextureRect(
const IntRect & rect);
105 void setFillColor(
const Color & color);
117 void setOutlineColor(
const Color & color);
132 void setOutlineThickness(
float thickness);
146 const Texture * getTexture()
const ;
156 const IntRect & getTextureRect()
const ;
166 const Color & getFillColor()
const ;
176 const Color & getOutlineColor()
const ;
186 float getOutlineThickness()
const ;
196 virtual std::size_t getPointCount()
const = 0;
213 virtual Vector2f getPoint(std::size_t index)
const = 0;
283 void updateFillColors();
289 void updateTexCoords();
295 void updateOutline();
301 void updateOutlineColors();
311 Color m_outlineColor;
312 float m_outlineThickness;
322 #endif // SFML_SHAPE_HPP Base class for textured shapes with outline.
+
Image living on the graphics card that can be used for drawing.
+
Define the states used for drawing to a RenderTarget.
+
Utility class for manipulating RGBA colors.
+
Define a set of one or more 2D primitives.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SLEEP_HPP 26 #define SFML_SLEEP_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/Time.hpp> 47 void SFML_SYSTEM_API
sleep (Time duration);
52 #endif // SFML_SLEEP_HPP
+
void sleep(Time duration)
Make the current thread sleep for a given duration.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOCKETHANDLE_HPP 26 #define SFML_SOCKETHANDLE_HPP 31 #include <SFML/Config.hpp> 33 #if defined(SFML_SYSTEM_WINDOWS) 44 #if defined(SFML_SYSTEM_WINDOWS) 46 typedef UINT_PTR SocketHandle;
50 typedef int SocketHandle;
57 #endif // SFML_SOCKETHANDLE_HPP
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOCKETSELECTOR_HPP 26 #define SFML_SOCKETSELECTOR_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/System/Time.hpp> 93 void remove (
Socket & socket);
142 bool isReady(
Socket & socket)
const ;
156 struct SocketSelectorImpl;
161 SocketSelectorImpl* m_impl;
167 #endif // SFML_SOCKETSELECTOR_HPP
+
static const Time Zero
Predefined "zero" time value.
+
Base class for all the socket types.
+
Multiplexer that allows to read from multiple sockets.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOCKET_HPP 26 #define SFML_SOCKET_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/SocketHandle.hpp> 33 #include <SFML/System/NonCopyable.hpp> 96 void setBlocking(
bool blocking);
106 bool isBlocking()
const ;
140 SocketHandle getHandle()
const ;
159 void create(SocketHandle handle);
177 SocketHandle m_socket;
184 #endif // SFML_SOCKET_HPP The socket sent a part of the data.
+
The socket has sent / received the data.
+
Status
Status codes that may be returned by socket functions.
+
The socket is not ready to send / receive data yet.
+
Base class for all the socket types.
+
Multiplexer that allows to read from multiple sockets.
+
Utility class that makes any derived class non-copyable.
+
+
+
Type
Types of protocols that the socket can use.
+
The TCP socket has been disconnected.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDBUFFERRECORDER_HPP 26 #define SFML_SOUNDBUFFERRECORDER_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/SoundBuffer.hpp> 33 #include <SFML/Audio/SoundRecorder.hpp> 75 virtual bool onStart();
86 virtual bool onProcessSamples(
const Int16* samples, std::size_t sampleCount);
92 virtual void onStop();
99 std::vector<Int16> m_samples;
105 #endif // SFML_SOUNDBUFFERRECORDER_HPP Specialized SoundRecorder which stores the captured audio data into a sound buffer.
+
Abstract base class for capturing sound data.
+
Storage for audio samples defining a sound.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDBUFFER_HPP 26 #define SFML_SOUNDBUFFER_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/AlResource.hpp> 33 #include <SFML/System/Time.hpp> 86 bool loadFromFile(
const std::string& filename);
102 bool loadFromMemory(
const void * data, std::size_t sizeInBytes);
135 bool loadFromSamples(
const Int16* samples, Uint64 sampleCount,
unsigned int channelCount,
unsigned int sampleRate);
150 bool saveToFile(
const std::string& filename)
const ;
164 const Int16* getSamples()
const ;
177 Uint64 getSampleCount()
const ;
191 unsigned int getSampleRate()
const ;
204 unsigned int getChannelCount()
const ;
214 Time getDuration()
const ;
249 bool update(
unsigned int channelCount,
unsigned int sampleRate);
257 void attachSound(
Sound * sound)
const ;
265 void detachSound(
Sound * sound)
const ;
270 typedef std::set<Sound*> SoundList;
275 unsigned int m_buffer;
276 std::vector<Int16> m_samples;
278 mutable SoundList m_sounds;
284 #endif // SFML_SOUNDBUFFER_HPP
+
Base class for classes that require an OpenAL context.
+
+
+
Regular sound that can be played in the audio environment.
+
Storage for audio samples defining a sound.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDFILEFACTORY_HPP 26 #define SFML_SOUNDFILEFACTORY_HPP 31 #include <SFML/Audio/Export.hpp> 39 class SoundFileReader;
40 class SoundFileWriter;
57 static void registerReader();
66 static void unregisterReader();
75 static void registerWriter();
84 static void unregisterWriter();
98 static SoundFileReader * createReaderFromFilename(
const std::string& filename);
113 static SoundFileReader * createReaderFromMemory(
const void * data, std::size_t sizeInBytes);
139 static SoundFileWriter * createWriterFromFilename(
const std::string& filename);
151 typedef std::vector<ReaderFactory> ReaderFactoryArray;
155 bool (*check)(
const std::string&);
158 typedef std::vector<WriterFactory> WriterFactoryArray;
163 static ReaderFactoryArray s_readers;
164 static WriterFactoryArray s_writers;
169 #include <SFML/Audio/SoundFileFactory.inl> 171 #endif // SFML_SOUNDFILEFACTORY_HPP
+
Abstract base class for sound file decoding.
+
+
Abstract base class for sound file encoding.
+
Manages and instantiates sound file readers and writers.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDFILEREADER_HPP 26 #define SFML_SOUNDFILEREADER_HPP 31 #include <SFML/Audio/Export.hpp> 77 virtual bool open(
InputStream & stream, Info& info) = 0;
92 virtual void seek(Uint64 sampleOffset) = 0;
103 virtual Uint64 read(Int16* samples, Uint64 maxCount) = 0;
109 #endif // SFML_SOUNDFILEREADER_HPP
+
unsigned int sampleRate
Samples rate of the sound, in samples per second.
+
Abstract base class for sound file decoding.
+
unsigned int channelCount
Number of channels of the sound.
+
Structure holding the audio properties of a sound file.
+
Uint64 sampleCount
Total number of samples in the file.
+
+
virtual ~SoundFileReader()
Virtual destructor.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDFILEWRITER_HPP 26 #define SFML_SOUNDFILEWRITER_HPP 31 #include <SFML/Audio/Export.hpp> 61 virtual bool open(
const std::string& filename,
unsigned int sampleRate,
unsigned int channelCount) = 0;
70 virtual void write(
const Int16* samples, Uint64 count) = 0;
76 #endif // SFML_SOUNDFILEWRITER_HPP virtual ~SoundFileWriter()
Virtual destructor.
+
+
Abstract base class for sound file encoding.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDRECORDER_HPP 26 #define SFML_SOUNDRECORDER_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/AlResource.hpp> 33 #include <SFML/System/Thread.hpp> 34 #include <SFML/System/Time.hpp> 77 bool start(
unsigned int sampleRate = 44100);
97 unsigned int getSampleRate()
const ;
108 static std::vector<std::string> getAvailableDevices();
120 static std::string getDefaultDevice();
137 bool setDevice(
const std::string& name);
145 const std::string& getDevice()
const ;
160 void setChannelCount(
unsigned int channelCount);
173 unsigned int getChannelCount()
const ;
186 static bool isAvailable();
214 void setProcessingInterval(
Time interval);
227 virtual bool onStart();
243 virtual bool onProcessSamples(
const Int16* samples, std::size_t sampleCount) = 0;
254 virtual void onStop();
275 void processCapturedSamples();
289 std::vector<Int16> m_samples;
290 unsigned int m_sampleRate;
291 Time m_processingInterval;
293 std::string m_deviceName;
294 unsigned int m_channelCount;
300 #endif // SFML_SOUNDRECORDER_HPP Base class for classes that require an OpenAL context.
+
+
Abstract base class for capturing sound data.
+
+
Utility class to manipulate threads.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDSOURCE_HPP 26 #define SFML_SOUNDSOURCE_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/AlResource.hpp> 33 #include <SFML/System/Vector3.hpp> 85 void setPitch(
float pitch);
98 void setVolume(
float volume);
114 void setPosition(
float x,
float y,
float z);
128 void setPosition(
const Vector3f & position);
144 void setRelativeToListener(
bool relative);
161 void setMinDistance(
float distance);
180 void setAttenuation(
float attenuation);
190 float getPitch()
const ;
200 float getVolume()
const ;
221 bool isRelativeToListener()
const ;
231 float getMinDistance()
const ;
241 float getAttenuation()
const ;
263 virtual void play() = 0;
274 virtual void pause() = 0;
286 virtual void stop() = 0;
294 virtual Status getStatus()
const ;
315 #endif // SFML_SOUNDSOURCE_HPP Base class for classes that require an OpenAL context.
+
+
Utility template class for manipulating 3-dimensional vectors.
+
+
unsigned int m_source
OpenAL source identifier.
+
+
Status
Enumeration of the sound source states.
+
Base class defining a sound's properties.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUNDSTREAM_HPP 26 #define SFML_SOUNDSTREAM_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/SoundSource.hpp> 33 #include <SFML/System/Thread.hpp> 34 #include <SFML/System/Time.hpp> 35 #include <SFML/System/Mutex.hpp> 110 unsigned int getChannelCount()
const ;
121 unsigned int getSampleRate()
const ;
129 Status getStatus()
const ;
144 void setPlayingOffset(
Time timeOffset);
154 Time getPlayingOffset()
const ;
169 void setLoop(
bool loop);
179 bool getLoop()
const ;
210 void initialize(
unsigned int channelCount,
unsigned int sampleRate);
229 virtual bool onGetData(Chunk& data) = 0;
240 virtual void onSeek(
Time timeOffset) = 0;
252 virtual Int64 onLoop();
279 bool fillAndPushBuffer(
unsigned int bufferNum,
bool immediateLoop =
false );
310 mutable Mutex m_threadMutex;
311 Status m_threadStartState;
313 unsigned int m_buffers[BufferCount];
314 unsigned int m_channelCount;
315 unsigned int m_sampleRate;
318 Uint64 m_samplesProcessed;
319 Int64 m_bufferSeeks[BufferCount];
325 #endif // SFML_SOUNDSTREAM_HPP Structure defining a chunk of audio data to stream.
+
+
const Int16 * samples
Pointer to the audio samples.
+
Abstract base class for streamed audio sources.
+
std::size_t sampleCount
Number of samples pointed by Samples.
+
+
Base class defining a sound's properties.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SOUND_HPP 26 #define SFML_SOUND_HPP 31 #include <SFML/Audio/Export.hpp> 32 #include <SFML/Audio/SoundSource.hpp> 33 #include <SFML/System/Time.hpp> 141 void setLoop(
bool loop);
156 void setPlayingOffset(
Time timeOffset);
174 bool getLoop()
const ;
184 Time getPlayingOffset()
const ;
226 #endif // SFML_SOUND_HPP
+
Regular sound that can be played in the audio environment.
+
Storage for audio samples defining a sound.
+
+
Status
Enumeration of the sound source states.
+
Base class defining a sound's properties.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SPRITE_HPP 26 #define SFML_SPRITE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Drawable.hpp> 33 #include <SFML/Graphics/Transformable.hpp> 34 #include <SFML/Graphics/Vertex.hpp> 35 #include <SFML/Graphics/Rect.hpp> 99 void setTexture(
const Texture & texture,
bool resetRect =
false );
113 void setTextureRect(
const IntRect & rectangle);
128 void setColor(
const Color & color);
142 const Texture * getTexture()
const ;
152 const IntRect & getTextureRect()
const ;
162 const Color & getColor()
const ;
207 void updatePositions();
213 void updateTexCoords();
226 #endif // SFML_SPRITE_HPP Image living on the graphics card that can be used for drawing.
+
Define the states used for drawing to a RenderTarget.
+
Utility class for manipulating RGBA colors.
+
Define a point with color and texture coordinates.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
Drawable representation of a texture, with its own transformations, color, etc.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_STRING_HPP 26 #define SFML_STRING_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/Utf.hpp> 52 typedef std::basic_string<Uint32>::iterator
Iterator ;
78 String (
char ansiChar,
const std::locale& locale = std::locale());
106 String (
const char * ansiString,
const std::locale& locale = std::locale());
118 String (
const std::string& ansiString,
const std::locale& locale = std::locale());
126 String (
const wchar_t * wideString);
134 String (
const std::wstring& wideString);
142 String (
const Uint32* utf32String);
150 String (
const std::basic_string<Uint32>& utf32String);
171 template <
typename T>
172 static String fromUtf8(T begin, T end);
185 template <
typename T>
186 static String fromUtf16(T begin, T end);
203 template <
typename T>
204 static String fromUtf32(T begin, T end);
221 operator std::string()
const ;
236 operator std::wstring()
const ;
253 std::string toAnsiString(
const std::locale& locale = std::locale())
const ;
266 std::wstring toWideString()
const ;
276 std::basic_string<Uint8> toUtf8()
const ;
286 std::basic_string<Uint16> toUtf16()
const ;
299 std::basic_string<Uint32> toUtf32()
const ;
332 Uint32 operator [](std::size_t index)
const ;
345 Uint32& operator [](std::size_t index);
365 std::size_t getSize()
const ;
375 bool isEmpty()
const ;
387 void erase(std::size_t position, std::size_t count = 1);
399 void insert(std::size_t position,
const String & str);
413 std::size_t find(
const String & str, std::size_t start = 0)
const ;
427 void replace(std::size_t position, std::size_t length,
const String & replaceWith);
439 void replace(
const String & searchFor,
const String & replaceWith);
456 String substring(std::size_t position, std::size_t length = InvalidPos)
const ;
469 const Uint32* getData()
const ;
521 friend SFML_SYSTEM_API
bool operator ==(
const String & left,
const String & right);
522 friend SFML_SYSTEM_API
bool operator <(
const String & left,
const String & right);
527 std::basic_string<Uint32> m_string;
540 SFML_SYSTEM_API
bool operator ==(
const String & left,
const String & right);
552 SFML_SYSTEM_API
bool operator !=(
const String & left,
const String & right);
564 SFML_SYSTEM_API
bool operator <(
const String & left,
const String & right);
576 SFML_SYSTEM_API
bool operator >(
const String & left,
const String & right);
588 SFML_SYSTEM_API
bool operator <=(
const String & left,
const String & right);
600 SFML_SYSTEM_API
bool operator >=(
const String & left,
const String & right);
614 #include <SFML/System/String.inl> 619 #endif // SFML_STRING_HPP std::basic_string< Uint32 >::iterator Iterator
Iterator type.
+
static const std::size_t InvalidPos
Represents an invalid position in the string.
+
std::basic_string< Uint32 >::const_iterator ConstIterator
Read-only iterator type.
+
+
Utility string class that automatically handles conversions between types and encodings.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SYSTEM_EXPORT_HPP 26 #define SFML_SYSTEM_EXPORT_HPP 31 #include <SFML/Config.hpp> 37 #if defined(SFML_SYSTEM_EXPORTS) 39 #define SFML_SYSTEM_API SFML_API_EXPORT 43 #define SFML_SYSTEM_API SFML_API_IMPORT 48 #endif // SFML_SYSTEM_EXPORT_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SYSTEM_HPP 26 #define SFML_SYSTEM_HPP 32 #include <SFML/Config.hpp> 33 #include <SFML/System/Clock.hpp> 34 #include <SFML/System/Err.hpp> 35 #include <SFML/System/FileInputStream.hpp> 36 #include <SFML/System/InputStream.hpp> 37 #include <SFML/System/Lock.hpp> 38 #include <SFML/System/MemoryInputStream.hpp> 39 #include <SFML/System/Mutex.hpp> 40 #include <SFML/System/NonCopyable.hpp> 41 #include <SFML/System/Sleep.hpp> 42 #include <SFML/System/String.hpp> 43 #include <SFML/System/Thread.hpp> 44 #include <SFML/System/ThreadLocal.hpp> 45 #include <SFML/System/ThreadLocalPtr.hpp> 46 #include <SFML/System/Time.hpp> 47 #include <SFML/System/Utf.hpp> 48 #include <SFML/System/Vector2.hpp> 49 #include <SFML/System/Vector3.hpp> 51 #endif // SFML_SYSTEM_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TCPLISTENER_HPP 26 #define SFML_TCPLISTENER_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/Socket.hpp> 33 #include <SFML/Network/IpAddress.hpp> 65 unsigned short getLocalPort()
const ;
118 #endif // SFML_TCPLISTENER_HPP static const IpAddress Any
Value representing any address (0.0.0.0)
+
Status
Status codes that may be returned by socket functions.
+
Base class for all the socket types.
+
Encapsulate an IPv4 network address.
+
Specialized socket using the TCP protocol.
+
Socket that listens to new TCP connections.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TCPSOCKET_HPP 26 #define SFML_TCPSOCKET_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/Socket.hpp> 33 #include <SFML/System/Time.hpp> 66 unsigned short getLocalPort()
const ;
92 unsigned short getRemotePort()
const ;
141 Status send(
const void * data, std::size_t size);
157 Status send(
const void * data, std::size_t size, std::size_t& sent);
175 Status receive(
void * data, std::size_t size, std::size_t& received);
224 std::size_t SizeReceived;
225 std::vector<char> Data;
231 PendingPacket m_pendingPacket;
237 #endif // SFML_TCPSOCKET_HPP
+
static const Time Zero
Predefined "zero" time value.
+
Status
Status codes that may be returned by socket functions.
+
Base class for all the socket types.
+
Encapsulate an IPv4 network address.
+
Utility class to build blocks of data to transfer over the network.
+
Specialized socket using the TCP protocol.
+
Socket that listens to new TCP connections.
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Drawable.hpp> 33 #include <SFML/Graphics/Transformable.hpp> 34 #include <SFML/Graphics/Font.hpp> 35 #include <SFML/Graphics/Rect.hpp> 36 #include <SFML/Graphics/VertexArray.hpp> 37 #include <SFML/System/String.hpp> 62 StrikeThrough = 1 << 3
88 Text (
const String &
string ,
const Font & font,
unsigned int characterSize = 30);
109 void setString(
const String &
string );
126 void setFont(
const Font & font);
145 void setCharacterSize(
unsigned int size);
159 void setLineSpacing(
float spacingFactor);
178 void setLetterSpacing(
float spacingFactor);
192 void setStyle(Uint32 style);
210 SFML_DEPRECATED
void setColor(
const Color & color);
224 void setFillColor(
const Color & color);
236 void setOutlineColor(
const Color & color);
251 void setOutlineThickness(
float thickness);
270 const String & getString()
const ;
284 const Font * getFont()
const ;
294 unsigned int getCharacterSize()
const ;
304 float getLetterSpacing()
const ;
314 float getLineSpacing()
const ;
324 Uint32 getStyle()
const ;
338 SFML_DEPRECATED
const Color & getColor()
const ;
348 const Color & getFillColor()
const ;
358 const Color & getOutlineColor()
const ;
368 float getOutlineThickness()
const ;
385 Vector2f findCharacterPos(std::size_t index)
const ;
433 void ensureGeometryUpdate()
const ;
440 unsigned int m_characterSize;
441 float m_letterSpacingFactor;
442 float m_lineSpacingFactor;
445 Color m_outlineColor;
446 float m_outlineThickness;
450 mutable bool m_geometryNeedUpdate;
451 mutable Uint64 m_fontTextureId;
457 #endif // SFML_TEXT_HPP Define the states used for drawing to a RenderTarget.
+
Utility class for manipulating RGBA colors.
+
Style
Enumeration of the string drawing styles.
+
Define a set of one or more 2D primitives.
+
Graphical text that can be drawn to a render target.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
Class for loading and manipulating character fonts.
+
+
+
Utility string class that automatically handles conversions between types and encodings.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TEXTURE_HPP 26 #define SFML_TEXTURE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Image.hpp> 33 #include <SFML/Window/GlResource.hpp> 97 bool create(
unsigned int width,
unsigned int height);
128 bool loadFromFile(
const std::string& filename,
const IntRect & area =
IntRect ());
160 bool loadFromMemory(
const void * data, std::size_t size,
const IntRect & area =
IntRect ());
238 Image copyToImage()
const ;
256 void update(
const Uint8* pixels);
278 void update(
const Uint8* pixels,
unsigned int width,
unsigned int height,
unsigned int x,
unsigned int y);
298 void update(
const Texture & texture);
315 void update(
const Texture & texture,
unsigned int x,
unsigned int y);
335 void update(
const Image & image);
352 void update(
const Image & image,
unsigned int x,
unsigned int y);
372 void update(
const Window & window);
389 void update(
const Window & window,
unsigned int x,
unsigned int y);
405 void setSmooth(
bool smooth);
415 bool isSmooth()
const ;
440 void setSrgb(
bool sRgb);
474 void setRepeated(
bool repeated);
484 bool isRepeated()
const ;
509 bool generateMipmap();
539 unsigned int getNativeHandle()
const ;
572 static void bind(
const Texture * texture, CoordinateType coordinateType = Normalized);
584 static unsigned int getMaximumSize();
605 static unsigned int getValidSize(
unsigned int size);
614 void invalidateMipmap();
621 unsigned int m_texture;
625 mutable bool m_pixelsFlipped;
626 bool m_fboAttachment;
634 #endif // SFML_TEXTURE_HPP Window that serves as a target for OpenGL rendering.
+
+
Image living on the graphics card that can be used for drawing.
+
CoordinateType
Types of texture coordinates that can be used for rendering.
+
Target for off-screen 2D rendering into a texture.
+
Graphical text that can be drawn to a render target.
+
Base class for all render targets (window, texture, ...)
+
Texture coordinates in range [0 .. 1].
+
+
+
+
Base class for classes that require an OpenGL context.
+
Class for loading, manipulating and saving images.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_THREADLOCALPTR_HPP 26 #define SFML_THREADLOCALPTR_HPP 31 #include <SFML/System/ThreadLocal.hpp> 107 #include <SFML/System/ThreadLocalPtr.inl> 110 #endif // SFML_THREADLOCALPTR_HPP Pointer to a thread-local variable.
+
ThreadLocalPtr(T *value=NULL)
Default constructor.
+
ThreadLocalPtr< T > & operator=(T *value)
Assignment operator for a raw pointer parameter.
+
T & operator*() const
Overload of unary operator *.
+
+
T * operator->() const
Overload of operator ->
+
Defines variables with thread-local storage.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_THREADLOCAL_HPP 26 #define SFML_THREADLOCAL_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 40 class ThreadLocalImpl;
71 void setValue(
void * value);
79 void * getValue()
const ;
86 priv::ThreadLocalImpl* m_impl;
92 #endif // SFML_THREADLOCAL_HPP Utility class that makes any derived class non-copyable.
+
+
Defines variables with thread-local storage.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_THREAD_HPP 26 #define SFML_THREAD_HPP 31 #include <SFML/System/Export.hpp> 32 #include <SFML/System/NonCopyable.hpp> 102 template <
typename F,
typename A>
103 Thread (F
function , A argument);
125 template <
typename C>
126 Thread (
void (C::*
function )(), C*
object );
176 friend class priv::ThreadImpl;
189 priv::ThreadImpl* m_impl;
190 priv::ThreadFunc* m_entryPoint;
193 #include <SFML/System/Thread.inl> 197 #endif // SFML_THREAD_HPP Utility class that makes any derived class non-copyable.
+
+
Utility class to manipulate threads.
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/System/Export.hpp> 60 float asSeconds()
const ;
70 Int32 asMilliseconds()
const ;
80 Int64 asMicroseconds()
const ;
89 friend SFML_SYSTEM_API
Time seconds(
float );
90 friend SFML_SYSTEM_API
Time milliseconds(Int32);
91 friend SFML_SYSTEM_API
Time microseconds(Int64);
102 explicit Time (Int64 microseconds);
109 Int64 m_microseconds;
123 SFML_SYSTEM_API
Time seconds(
float amount);
136 SFML_SYSTEM_API
Time milliseconds(Int32 amount);
149 SFML_SYSTEM_API
Time microseconds(Int64 amount);
161 SFML_SYSTEM_API
bool operator ==(
Time left,
Time right);
173 SFML_SYSTEM_API
bool operator !=(
Time left,
Time right);
185 SFML_SYSTEM_API
bool operator <(
Time left,
Time right);
197 SFML_SYSTEM_API
bool operator >(
Time left,
Time right);
209 SFML_SYSTEM_API
bool operator <=(
Time left,
Time right);
221 SFML_SYSTEM_API
bool operator >=(
Time left,
Time right);
232 SFML_SYSTEM_API
Time operator -(
Time right);
256 SFML_SYSTEM_API
Time & operator +=(
Time & left,
Time right);
280 SFML_SYSTEM_API
Time & operator -=(
Time & left,
Time right);
292 SFML_SYSTEM_API
Time operator *(
Time left,
float right);
304 SFML_SYSTEM_API
Time operator *(
Time left, Int64 right);
316 SFML_SYSTEM_API
Time operator *(
float left,
Time right);
328 SFML_SYSTEM_API
Time operator *(Int64 left,
Time right);
340 SFML_SYSTEM_API
Time & operator *=(
Time & left,
float right);
352 SFML_SYSTEM_API
Time & operator *=(
Time & left, Int64 right);
364 SFML_SYSTEM_API
Time operator /(
Time left,
float right);
376 SFML_SYSTEM_API
Time operator /(
Time left, Int64 right);
388 SFML_SYSTEM_API
Time & operator /=(
Time & left,
float right);
400 SFML_SYSTEM_API
Time & operator /=(
Time & left, Int64 right);
412 SFML_SYSTEM_API
float operator /(
Time left,
Time right);
436 SFML_SYSTEM_API
Time & operator %=(
Time & left,
Time right);
441 #endif // SFML_TIME_HPP
+
static const Time Zero
Predefined "zero" time value.
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TOUCH_HPP 26 #define SFML_TOUCH_HPP 31 #include <SFML/Window/Export.hpp> 32 #include <SFML/System/Vector2.hpp> 55 static bool isDown(
unsigned int finger);
68 static Vector2i getPosition(
unsigned int finger);
82 static Vector2i getPosition(
unsigned int finger,
const Window & relativeTo);
88 #endif // SFML_TOUCH_HPP Give access to the real-time state of the touches.
+
Window that serves as a target for OpenGL rendering.
+
+
Utility template class for manipulating 2-dimensional vectors.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TRANSFORM_HPP 26 #define SFML_TRANSFORM_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Rect.hpp> 33 #include <SFML/System/Vector2.hpp> 68 Transform (
float a00,
float a01,
float a02,
69 float a10,
float a11,
float a12,
70 float a20,
float a21,
float a22);
87 const float * getMatrix()
const ;
109 Vector2f transformPoint(
float x,
float y)
const ;
233 Transform & rotate(
float angle,
float centerX,
float centerY);
278 Transform & scale(
float scaleX,
float scaleY);
305 Transform & scale(
float scaleX,
float scaleY,
float centerX,
float centerY);
438 #endif // SFML_TRANSFORM_HPP
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_TRANSFORMABLE_HPP 26 #define SFML_TRANSFORMABLE_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Transform.hpp> 70 void setPosition(
float x,
float y);
84 void setPosition(
const Vector2f & position);
98 void setRotation(
float angle);
113 void setScale(
float factorX,
float factorY);
127 void setScale(
const Vector2f & factors);
145 void setOrigin(
float x,
float y);
162 void setOrigin(
const Vector2f & origin);
172 const Vector2f & getPosition()
const ;
184 float getRotation()
const ;
223 void move(
float offsetX,
float offsetY);
255 void rotate(
float angle);
274 void scale(
float factorX,
float factorY);
312 const Transform & getInverseTransform()
const ;
324 mutable bool m_transformNeedUpdate;
326 mutable bool m_inverseTransformNeedUpdate;
332 #endif // SFML_TRANSFORMABLE_HPP
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_UDPSOCKET_HPP 26 #define SFML_UDPSOCKET_HPP 31 #include <SFML/Network/Export.hpp> 32 #include <SFML/Network/Socket.hpp> 33 #include <SFML/Network/IpAddress.hpp> 54 MaxDatagramSize = 65507
74 unsigned short getLocalPort()
const ;
131 Status send(
const void * data, std::size_t size,
const IpAddress & remoteAddress,
unsigned short remotePort);
154 Status receive(
void * data, std::size_t size, std::size_t& received,
IpAddress & remoteAddress,
unsigned short & remotePort);
172 Status send(
Packet & packet,
const IpAddress & remoteAddress,
unsigned short remotePort);
189 Status receive(
Packet & packet,
IpAddress & remoteAddress,
unsigned short & remotePort);
196 std::vector<char> m_buffer;
202 #endif // SFML_UDPSOCKET_HPP static const IpAddress Any
Value representing any address (0.0.0.0)
+
Specialized socket using the UDP protocol.
+
Base class for all the socket types.
+
Encapsulate an IPv4 network address.
+
Utility class to build blocks of data to transfer over the network.
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Config.hpp> 40 template <
unsigned int N>
66 template <
typename In>
67 static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
82 template <
typename Out>
83 static Out encode(Uint32 input, Out output, Uint8 replacement = 0);
97 template <
typename In>
98 static In next(In begin, In end);
113 template <
typename In>
114 static std::size_t count(In begin, In end);
130 template <
typename In,
typename Out>
131 static Out fromAnsi(In begin, In end, Out output,
const std::locale& locale = std::locale());
143 template <
typename In,
typename Out>
144 static Out fromWide(In begin, In end, Out output);
156 template <
typename In,
typename Out>
157 static Out fromLatin1(In begin, In end, Out output);
174 template <
typename In,
typename Out>
175 static Out toAnsi(In begin, In end, Out output,
char replacement = 0,
const std::locale& locale = std::locale());
188 template <
typename In,
typename Out>
189 static Out toWide(In begin, In end, Out output,
wchar_t replacement = 0);
202 template <
typename In,
typename Out>
203 static Out toLatin1(In begin, In end, Out output,
char replacement = 0);
220 template <
typename In,
typename Out>
221 static Out toUtf8(In begin, In end, Out output);
233 template <
typename In,
typename Out>
234 static Out toUtf16(In begin, In end, Out output);
246 template <
typename In,
typename Out>
247 static Out toUtf32(In begin, In end, Out output);
273 template <
typename In>
274 static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
289 template <
typename Out>
290 static Out encode(Uint32 input, Out output, Uint16 replacement = 0);
304 template <
typename In>
305 static In next(In begin, In end);
320 template <
typename In>
321 static std::size_t count(In begin, In end);
337 template <
typename In,
typename Out>
338 static Out fromAnsi(In begin, In end, Out output,
const std::locale& locale = std::locale());
350 template <
typename In,
typename Out>
351 static Out fromWide(In begin, In end, Out output);
363 template <
typename In,
typename Out>
364 static Out fromLatin1(In begin, In end, Out output);
381 template <
typename In,
typename Out>
382 static Out toAnsi(In begin, In end, Out output,
char replacement = 0,
const std::locale& locale = std::locale());
395 template <
typename In,
typename Out>
396 static Out toWide(In begin, In end, Out output,
wchar_t replacement = 0);
409 template <
typename In,
typename Out>
410 static Out toLatin1(In begin, In end, Out output,
char replacement = 0);
422 template <
typename In,
typename Out>
423 static Out toUtf8(In begin, In end, Out output);
440 template <
typename In,
typename Out>
441 static Out toUtf16(In begin, In end, Out output);
453 template <
typename In,
typename Out>
454 static Out toUtf32(In begin, In end, Out output);
481 template <
typename In>
482 static In decode(In begin, In end, Uint32& output, Uint32 replacement = 0);
498 template <
typename Out>
499 static Out encode(Uint32 input, Out output, Uint32 replacement = 0);
513 template <
typename In>
514 static In next(In begin, In end);
528 template <
typename In>
529 static std::size_t count(In begin, In end);
545 template <
typename In,
typename Out>
546 static Out fromAnsi(In begin, In end, Out output,
const std::locale& locale = std::locale());
558 template <
typename In,
typename Out>
559 static Out fromWide(In begin, In end, Out output);
571 template <
typename In,
typename Out>
572 static Out fromLatin1(In begin, In end, Out output);
589 template <
typename In,
typename Out>
590 static Out toAnsi(In begin, In end, Out output,
char replacement = 0,
const std::locale& locale = std::locale());
603 template <
typename In,
typename Out>
604 static Out toWide(In begin, In end, Out output,
wchar_t replacement = 0);
617 template <
typename In,
typename Out>
618 static Out toLatin1(In begin, In end, Out output,
char replacement = 0);
630 template <
typename In,
typename Out>
631 static Out toUtf8(In begin, In end, Out output);
643 template <
typename In,
typename Out>
644 static Out toUtf16(In begin, In end, Out output);
661 template <
typename In,
typename Out>
662 static Out toUtf32(In begin, In end, Out output);
677 template <
typename In>
678 static Uint32 decodeAnsi(In input,
const std::locale& locale = std::locale());
692 template <
typename In>
693 static Uint32 decodeWide(In input);
710 template <
typename Out>
711 static Out encodeAnsi(Uint32 codepoint, Out output,
char replacement = 0,
const std::locale& locale = std::locale());
727 template <
typename Out>
728 static Out encodeWide(Uint32 codepoint, Out output,
wchar_t replacement = 0);
731 #include <SFML/System/Utf.inl> 741 #endif // SFML_UTF_HPP Utility class providing generic functions for UTF conversions.
+
Specialization of the Utf template for UTF-16.
+
Specialization of the Utf template for UTF-32.
+
+
Specialization of the Utf template for UTF-8.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VECTOR2_HPP 26 #define SFML_VECTOR2_HPP 104 template <
typename T>
120 template <
typename T>
133 template <
typename T>
146 template <
typename T>
159 template <
typename T>
172 template <
typename T>
188 template <
typename T>
201 template <
typename T>
217 template <
typename T>
232 template <
typename T>
247 template <
typename T>
250 #include <SFML/System/Vector2.inl> 260 #endif // SFML_VECTOR2_HPP T y
Y coordinate of the vector.
+
Vector2()
Default constructor.
+
T x
X coordinate of the vector.
+
+
Utility template class for manipulating 2-dimensional vectors.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VECTOR3_HPP 26 #define SFML_VECTOR3_HPP 106 template <
typename T>
122 template <
typename T>
135 template <
typename T>
148 template <
typename T>
161 template <
typename T>
174 template <
typename T>
190 template <
typename T>
203 template <
typename T>
219 template <
typename T>
234 template <
typename T>
249 template <
typename T>
252 #include <SFML/System/Vector3.inl> 261 #endif // SFML_VECTOR3_HPP Utility template class for manipulating 3-dimensional vectors.
+
T z
Z coordinate of the vector.
+
T x
X coordinate of the vector.
+
+
Vector3()
Default constructor.
+
T y
Y coordinate of the vector.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VERTEXARRAY_HPP 26 #define SFML_VERTEXARRAY_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Vertex.hpp> 33 #include <SFML/Graphics/PrimitiveType.hpp> 34 #include <SFML/Graphics/Rect.hpp> 35 #include <SFML/Graphics/Drawable.hpp> 72 std::size_t getVertexCount()
const ;
88 Vertex & operator [](std::size_t index);
104 const Vertex & operator [](std::size_t index)
const ;
129 void resize(std::size_t vertexCount);
137 void append(
const Vertex & vertex);
190 std::vector<Vertex> m_vertices;
197 #endif // SFML_VERTEXARRAY_HPP PrimitiveType
Types of primitives that a sf::VertexArray can render.
+
Define the states used for drawing to a RenderTarget.
+
Define a set of one or more 2D primitives.
+
Define a point with color and texture coordinates.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VERTEXBUFFER_HPP 26 #define SFML_VERTEXBUFFER_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/PrimitiveType.hpp> 33 #include <SFML/Graphics/Drawable.hpp> 34 #include <SFML/Window/GlResource.hpp> 137 bool create(std::size_t vertexCount);
145 std::size_t getVertexCount()
const ;
165 bool update(
const Vertex * vertices);
198 bool update(
const Vertex * vertices, std::size_t vertexCount,
unsigned int offset);
238 unsigned int getNativeHandle()
const ;
276 void setUsage(Usage usage);
284 Usage getUsage()
const ;
319 static bool isAvailable();
337 unsigned int m_buffer;
346 #endif // SFML_VERTEXBUFFER_HPP PrimitiveType
Types of primitives that a sf::VertexArray can render.
+
Define the states used for drawing to a RenderTarget.
+
Vertex buffer storage for one or more 2D primitives.
+
Occasionally changing data.
+
Define a point with color and texture coordinates.
+
Base class for all render targets (window, texture, ...)
+
Abstract base class for objects that can be drawn to a render target.
+
+
+
Constantly changing data.
+
Base class for classes that require an OpenGL context.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VERTEX_HPP 26 #define SFML_VERTEX_HPP 31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Color.hpp> 33 #include <SFML/System/Vector2.hpp> 105 #endif // SFML_VERTEX_HPP Vector2f position
2D position of the vertex
+
Color color
Color of the vertex.
+
Utility class for manipulating RGBA colors.
+
Vector2f texCoords
Coordinates of the texture's pixel to map to the vertex.
+
Define a point with color and texture coordinates.
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_VIDEOMODE_HPP 26 #define SFML_VIDEOMODE_HPP 31 #include <SFML/Window/Export.hpp> 61 VideoMode (
unsigned int modeWidth,
unsigned int modeHeight,
unsigned int modeBitsPerPixel = 32);
85 static const std::vector<VideoMode>& getFullscreenModes();
182 #endif // SFML_VIDEOMODE_HPP unsigned int bitsPerPixel
Video mode pixel depth, in bits per pixels.
+
unsigned int width
Video mode width, in pixels.
+
VideoMode defines a video mode (width, height, bpp)
+
unsigned int height
Video mode height, in pixels.
+
+
SFML - Simple and Fast Multimedia Library
+
+
31 #include <SFML/Graphics/Export.hpp> 32 #include <SFML/Graphics/Rect.hpp> 33 #include <SFML/Graphics/Transform.hpp> 34 #include <SFML/System/Vector2.hpp> 43 class SFML_GRAPHICS_API
View 81 void setCenter(
float x,
float y);
91 void setCenter(
const Vector2f & center);
102 void setSize(
float width,
float height);
124 void setRotation(
float angle);
141 void setViewport(
const FloatRect & viewport);
183 float getRotation()
const ;
204 void move(
float offsetX,
float offsetY);
224 void rotate(
float angle);
241 void zoom(
float factor);
265 const Transform & getInverseTransform()
const ;
278 mutable bool m_transformUpdated;
279 mutable bool m_invTransformUpdated;
285 #endif // SFML_VIEW_HPP 2D camera that defines what region is shown on screen
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_WINDOWHANDLE_HPP 26 #define SFML_WINDOWHANDLE_HPP 31 #include <SFML/Config.hpp> 34 #if defined(SFML_SYSTEM_WINDOWS) 40 #if defined(SFML_SYSTEM_WINDOWS) 45 #elif defined(SFML_SYSTEM_LINUX) || defined(SFML_SYSTEM_FREEBSD) || defined(SFML_SYSTEM_OPENBSD) 50 #elif defined(SFML_SYSTEM_MACOS) 55 #elif defined(SFML_SYSTEM_IOS) 60 #elif defined(SFML_SYSTEM_ANDROID) 65 #elif defined(SFML_DOXYGEN) 75 #endif // SFML_WINDOWHANDLE_HPP
+
platform specific WindowHandle
Define a low-level window handle type, specific to each platform.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_WINDOWSTYLE_HPP 26 #define SFML_WINDOWSTYLE_HPP 53 #endif // SFML_WINDOWSTYLE_HPP No border / title bar (this flag and all others are mutually exclusive)
+
+
Title bar + fixed border.
+
Title bar + close button.
+
Fullscreen mode (this flag and all others are mutually exclusive)
+
+
Title bar + resizable border + maximize button.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_WINDOW_EXPORT_HPP 26 #define SFML_WINDOW_EXPORT_HPP 31 #include <SFML/Config.hpp> 37 #if defined(SFML_WINDOW_EXPORTS) 39 #define SFML_WINDOW_API SFML_API_EXPORT 43 #define SFML_WINDOW_API SFML_API_IMPORT 48 #endif // SFML_WINDOW_EXPORT_HPP SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_WINDOW_HPP 26 #define SFML_WINDOW_HPP 31 #include <SFML/Window/ContextSettings.hpp> 32 #include <SFML/Window/Cursor.hpp> 33 #include <SFML/Window/Export.hpp> 34 #include <SFML/Window/GlResource.hpp> 35 #include <SFML/Window/VideoMode.hpp> 36 #include <SFML/Window/WindowHandle.hpp> 37 #include <SFML/Window/WindowStyle.hpp> 38 #include <SFML/System/Clock.hpp> 39 #include <SFML/System/NonCopyable.hpp> 40 #include <SFML/System/String.hpp> 41 #include <SFML/System/Vector2.hpp> 212 bool pollEvent(
Event & event);
239 bool waitEvent(
Event & event);
263 void setPosition(
const Vector2i & position);
296 void setTitle(
const String & title);
315 void setIcon(
unsigned int width,
unsigned int height,
const Uint8* pixels);
325 void setVisible(
bool visible);
340 void setVerticalSyncEnabled(
bool enabled);
350 void setMouseCursorVisible(
bool visible);
363 void setMouseCursorGrabbed(
bool grabbed);
382 void setMouseCursor(
const Cursor & cursor);
396 void setKeyRepeatEnabled(
bool enabled);
413 void setFramerateLimit(
unsigned int limit);
426 void setJoystickThreshold(
float threshold);
444 bool setActive(
bool active =
true )
const ;
473 bool hasFocus()
const ;
509 virtual void onCreate();
518 virtual void onResize();
534 bool filterEvent(
const Event & event);
545 priv::WindowImpl* m_impl;
546 priv::GlContext* m_context;
548 Time m_frameTimeLimit;
555 #endif // SFML_WINDOW_HPP
+
Window that serves as a target for OpenGL rendering.
+
+
Cursor defines the appearance of a system cursor.
+
Defines a system event and its parameters.
+
Utility class that makes any derived class non-copyable.
+
Structure defining the settings of the OpenGL context attached to a window.
+
VideoMode defines a video mode (width, height, bpp)
+
+
Utility template class for manipulating 2-dimensional vectors.
+
Base class for classes that require an OpenGL context.
+
Utility string class that automatically handles conversions between types and encodings.
+
platform specific WindowHandle
Define a low-level window handle type, specific to each platform.
+
Utility class that measures the elapsed time.
+
SFML - Simple and Fast Multimedia Library
+
+
25 #ifndef SFML_SFML_WINDOW_HPP 26 #define SFML_SFML_WINDOW_HPP 32 #include <SFML/System.hpp> 33 #include <SFML/Window/Clipboard.hpp> 34 #include <SFML/Window/Context.hpp> 35 #include <SFML/Window/ContextSettings.hpp> 36 #include <SFML/Window/Cursor.hpp> 37 #include <SFML/Window/Event.hpp> 38 #include <SFML/Window/Joystick.hpp> 39 #include <SFML/Window/Keyboard.hpp> 40 #include <SFML/Window/Mouse.hpp> 41 #include <SFML/Window/Sensor.hpp> 42 #include <SFML/Window/Touch.hpp> 43 #include <SFML/Window/VideoMode.hpp> 44 #include <SFML/Window/Window.hpp> 45 #include <SFML/Window/WindowHandle.hpp> 46 #include <SFML/Window/WindowStyle.hpp> 50 #endif // SFML_SFML_WINDOW_HPP SFML - Simple and Fast Multimedia Library
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 1 2 3 ]
+ ▼ N sf C AlResource Base class for classes that require an OpenAL context C BlendMode Blending modes for drawing C CircleShape Specialized shape representing a circle C Clipboard Give access to the system clipboard C Clock Utility class that measures the elapsed time C Color Utility class for manipulating RGBA colors C Context Class holding a valid drawing context C ContextSettings Structure defining the settings of the OpenGL context attached to a window C ConvexShape Specialized shape representing a convex polygon C Cursor Cursor defines the appearance of a system cursor C Drawable Abstract base class for objects that can be drawn to a render target ▶ C Event Defines a system event and its parameters C JoystickButtonEvent Joystick buttons events parameters (JoystickButtonPressed, JoystickButtonReleased) C JoystickConnectEvent Joystick connection events parameters (JoystickConnected, JoystickDisconnected) C JoystickMoveEvent Joystick axis move event parameters (JoystickMoved) C KeyEvent Keyboard event parameters (KeyPressed, KeyReleased) C MouseButtonEvent Mouse buttons events parameters (MouseButtonPressed, MouseButtonReleased) C MouseMoveEvent Mouse move event parameters (MouseMoved) C MouseWheelEvent Mouse wheel events parameters (MouseWheelMoved) C MouseWheelScrollEvent Mouse wheel events parameters (MouseWheelScrolled) C SensorEvent Sensor event parameters (SensorChanged) C SizeEvent Size events parameters (Resized) C TextEvent Text event parameters (TextEntered) C TouchEvent Touch events parameters (TouchBegan, TouchMoved, TouchEnded) C FileInputStream Implementation of input stream based on a file ▶ C Font Class for loading and manipulating character fonts C Info Holds various information about a font ▶ C Ftp A FTP client C DirectoryResponse Specialization of FTP response returning a directory C ListingResponse Specialization of FTP response returning a filename listing C Response Define a FTP response ▶ C GlResource Base class for classes that require an OpenGL context C TransientContextLock RAII helper class to temporarily lock an available context for use C Glyph Structure describing a glyph ▶ C Http A HTTP client C Request Define a HTTP request C Response Define a HTTP response C Image Class for loading, manipulating and saving images C InputSoundFile Provide read access to sound files C InputStream Abstract class for custom file input streams C IpAddress Encapsulate an IPv4 network address ▶ C Joystick Give access to the real-time state of the joysticks C Identification Structure holding a joystick's identification C Keyboard Give access to the real-time state of the keyboard C Listener The audio listener is the point in the scene from where all the sounds are heard C Lock Automatic wrapper for locking and unlocking mutexes C MemoryInputStream Implementation of input stream based on a memory chunk C Mouse Give access to the real-time state of the mouse ▶ C Music Streamed music played from an audio file C Span Structure defining a time range using the template type C Mutex Blocks concurrent access to shared resources from multiple threads C NonCopyable Utility class that makes any derived class non-copyable C OutputSoundFile Provide write access to sound files C Packet Utility class to build blocks of data to transfer over the network C Rect Utility class for manipulating 2D axis aligned rectangles C RectangleShape Specialized shape representing a rectangle C RenderStates Define the states used for drawing to a RenderTarget C RenderTarget Base class for all render targets (window, texture, ...) C RenderTexture Target for off-screen 2D rendering into a texture C RenderWindow Window that can serve as a target for 2D drawing C Sensor Give access to the real-time state of the sensors ▶ C Shader Shader class (vertex, geometry and fragment) C CurrentTextureType Special type that can be passed to setUniform() , and that represents the texture of the object being drawn C Shape Base class for textured shapes with outline C Socket Base class for all the socket types C SocketSelector Multiplexer that allows to read from multiple sockets C Sound Regular sound that can be played in the audio environment C SoundBuffer Storage for audio samples defining a sound C SoundBufferRecorder Specialized SoundRecorder which stores the captured audio data into a sound buffer C SoundFileFactory Manages and instantiates sound file readers and writers ▶ C SoundFileReader Abstract base class for sound file decoding C Info Structure holding the audio properties of a sound file C SoundFileWriter Abstract base class for sound file encoding C SoundRecorder Abstract base class for capturing sound data C SoundSource Base class defining a sound's properties ▶ C SoundStream Abstract base class for streamed audio sources C Chunk Structure defining a chunk of audio data to stream C Sprite Drawable representation of a texture, with its own transformations, color, etc C String Utility string class that automatically handles conversions between types and encodings C TcpListener Socket that listens to new TCP connections C TcpSocket Specialized socket using the TCP protocol C Text Graphical text that can be drawn to a render target C Texture Image living on the graphics card that can be used for drawing C Thread Utility class to manipulate threads C ThreadLocal Defines variables with thread-local storage C ThreadLocalPtr Pointer to a thread-local variable C Time Represents a time value C Touch Give access to the real-time state of the touches C Transform Define a 3x3 transform matrix C Transformable Decomposed transform defined by a position, a rotation and a scale C UdpSocket Specialized socket using the UDP protocol C Utf Utility class providing generic functions for UTF conversions C Utf< 16 > Specialization of the Utf template for UTF-16 C Utf< 32 > Specialization of the Utf template for UTF-32 C Utf< 8 > Specialization of the Utf template for UTF-8 C Vector2 Utility template class for manipulating 2-dimensional vectors C Vector3 Utility template class for manipulating 3-dimensional vectors C Vertex Define a point with color and texture coordinates C VertexArray Define a set of one or more 2D primitives C VertexBuffer Vertex buffer storage for one or more 2D primitives C VideoMode VideoMode defines a video mode (width, height, bpp) C View 2D camera that defines what region is shown on screen C Window Window that serves as a target for OpenGL rendering
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::AlResource , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base class for classes that require an OpenAL context.
+ More...
+
+
#include <AlResource.hpp >
+
+
+
+
+
+
+
+
+
+
Base class for classes that require an OpenAL context.
+
This class is for internal use only, it must be the base of every class that requires a valid OpenAL context in order to work.
+
+
Definition at line 40 of file AlResource.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::AlResource::AlResource
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::AlResource::~AlResource
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::CircleShape , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized shape representing a circle.
+ More...
+
+
#include <CircleShape.hpp >
+
+
+
+
+
+
+
+
+void update () Recompute the internal geometry of the shape. More...
+
+
Specialized shape representing a circle.
+
This class inherits all the functions of sf::Transformable (position, rotation, scale, bounds, ...) as well as the functions of sf::Shape (outline, color, texture, ...).
+
Usage example:
Since the graphics card can't draw perfect circles, we have to fake them with multiple triangles connected to each other. The "points count" property of sf::CircleShape defines how many of these triangles to use, and therefore defines the quality of the circle.
+
The number of points can also be used for another purpose; with small numbers you can create any regular polygon shape: equilateral triangle, square, pentagon, hexagon, ...
+
See also sf::Shape , sf::RectangleShape , sf::ConvexShape
+
+
Definition at line 41 of file CircleShape.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::CircleShape::CircleShape
+ (
+ float
+ radius = 0,
+
+ std::size_t
+ pointCount = 30
+
+ )
+
+
+
+
+explicit
+
+
+
+
+
Default constructor.
+
Parameters
+
+ radius Radius of the circle pointCount Number of points composing the circle
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getFillColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the fill color of the shape.
+
Returns Fill color of the shape
+
See also setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getGlobalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the global (non-minimal) bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the shape in the global 2D world's coordinate system.
+
This function does not necessarily return the minimal bounding rectangle. It merely ensures that the returned rectangle covers all the vertices (but possibly more). This allows for a fast approximation of the bounds as a first check; you may want to use more precise checks on top of that.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getLocalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getOutlineColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline color of the shape.
+
Returns Outline color of the shape
+
See also setOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Shape::getOutlineThickness
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline thickness of the shape.
+
Returns Outline thickness of the shape
+
See also setOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2f sf::CircleShape::getPoint
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get a point of the circle.
+
The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account. The result is undefined if index is out of the valid range.
+
Parameters
+
+
+
+
Returns index-th point of the shape
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual std::size_t sf::CircleShape::getPointCount
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the number of points of the circle.
+
Returns Number of points of the circle
+
See also setPointCount
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::CircleShape::getRadius
+ (
+ )
+ const
+
+
+
+
+
Get the radius of the circle.
+
Returns Radius of the circle
+
See also setRadius
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Texture * sf::Shape::getTexture
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the source texture of the shape.
+
If the shape has no source texture, a NULL pointer is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.
+
Returns Pointer to the shape's texture
+
See also setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const IntRect & sf::Shape::getTextureRect
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the sub-rectangle of the texture displayed by the shape.
+
Returns Texture rectangle of the shape
+
See also setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setFillColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the fill color of the shape.
+
This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sf::Color::Transparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.
+
Parameters
+
+ color New color of the shape
+
+
+
See also getFillColor , setOutlineColor
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the outline color of the shape.
+
By default, the shape's outline color is opaque white.
+
Parameters
+
+ color New outline color of the shape
+
+
+
See also getOutlineColor , setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineThickness
+ (
+ float
+ thickness )
+
+
+
+
+inherited
+
+
+
+
+
Set the thickness of the shape's outline.
+
Note that negative values are allowed (so that the outline expands towards the center of the shape), and using zero disables the outline. By default, the outline thickness is 0.
+
Parameters
+
+ thickness New outline thickness
+
+
+
See also getOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::CircleShape::setPointCount
+ (
+ std::size_t
+ count )
+
+
+
+
+
Set the number of points of the circle.
+
Parameters
+
+ count New number of points of the circle
+
+
+
See also getPointCount
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::CircleShape::setRadius
+ (
+ float
+ radius )
+
+
+
+
+
Set the radius of the circle.
+
Parameters
+
+ radius New radius of the circle
+
+
+
See also getRadius
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTexture
+ (
+ const Texture *
+ texture ,
+
+ bool
+ resetRect = false
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Change the source texture of the shape.
+
The texture argument refers to a texture that must exist as long as the shape uses it. Indeed, the shape doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the shape tries to use it, the behavior is undefined. texture can be NULL to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.
+
Parameters
+
+ texture New texture resetRect Should the texture rect be reset to the size of the new texture?
+
+
+
See also getTexture , setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTextureRect
+ (
+ const IntRect &
+ rect )
+
+
+
+
+inherited
+
+
+
+
+
Set the sub-rectangle of the texture that the shape will display.
+
The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.
+
Parameters
+
+ rect Rectangle defining the region of the texture to display
+
+
+
See also getTextureRect , setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::update
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Recompute the internal geometry of the shape.
+
This function must be called by the derived class everytime the shape's points change (i.e. the result of either getPointCount or getPoint is different).
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Clipboard , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the system clipboard.
+ More...
+
+
#include <Clipboard.hpp >
+
+
+
Give access to the system clipboard.
+
sf::Clipboard provides an interface for getting and setting the contents of the system clipboard.
+
It is important to note that due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.
+
Usage example:
while (window.pollEvent(event))
{
window.close();
{
}
}
See also sf::String , sf::Event
+
+
Definition at line 41 of file Clipboard.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ static String sf::Clipboard::getString
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the content of the clipboard as string data.
+
This function returns the content of the clipboard as a string. If the clipboard does not contain string it returns an empty sf::String object.
+
Returns Clipboard contents as sf::String object
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Clipboard::setString
+ (
+ const String &
+ text )
+
+
+
+
+static
+
+
+
+
+
Set the content of the clipboard as string data.
+
This function sets the content of the clipboard as a string.
+
Warning Due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.
+
Parameters
+
+ text sf::String containing the data to be sent to the clipboard
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Clock , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class that measures the elapsed time.
+ More...
+
+
#include <Clock.hpp >
+
+
+
Utility class that measures the elapsed time.
+
sf::Clock is a lightweight class for measuring time.
+
Its provides the most precise time that the underlying OS can achieve (generally microseconds or nanoseconds). It also ensures monotonicity, which means that the returned time can never go backward, even if the system time is changed.
+
Usage example:
The sf::Time value returned by the clock can then be converted to a number of seconds, milliseconds or even microseconds.
+
See also sf::Time
+
+
Definition at line 41 of file Clock.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Clock::Clock
+ (
+ )
+
+
+
+
+
Default constructor.
+
The clock starts automatically after being constructed.
+
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::Clock::getElapsedTime (
+ )
+ const
+
+
+
+
+
Get the elapsed time.
+
This function returns the time elapsed since the last call to restart() (or the construction of the instance if restart() has not been called).
+
Returns Time elapsed
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::Clock::restart (
+ )
+
+
+
+
+
Restart the clock.
+
This function puts the time counter back to zero. It also returns the time elapsed since the clock was started.
+
Returns Time elapsed
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Color , including all inherited members.
+
+ a sf::Color b sf::Color Black sf::Color static Blue sf::Color static Color ()sf::Color Color (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255)sf::Color Color (Uint32 color)sf::Color explicit Cyan sf::Color static g sf::Color Green sf::Color static Magenta sf::Color static operator!= (const Color &left, const Color &right)sf::Color related operator* (const Color &left, const Color &right)sf::Color related operator*= (Color &left, const Color &right)sf::Color related operator+ (const Color &left, const Color &right)sf::Color related operator+= (Color &left, const Color &right)sf::Color related operator- (const Color &left, const Color &right)sf::Color related operator-= (Color &left, const Color &right)sf::Color related operator== (const Color &left, const Color &right)sf::Color related r sf::Color Red sf::Color static toInteger () constsf::Color Transparent sf::Color static White sf::Color static Yellow sf::Color static
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class for manipulating RGBA colors.
+ More...
+
+
#include <Color.hpp >
+
+ Color () Default constructor. More... Color (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha=255) Construct the color from its 4 RGBA components. More... Color (Uint32 color) Construct the color from 32-bit unsigned integer. More... Uint32 toInteger () const Retrieve the color as a 32-bit unsigned integer. More...
+Uint8 r Red component. More... Uint8 g Green component. More... Uint8 b Blue component. More... Uint8 a Alpha (opacity) component. More...
+
+
Utility class for manipulating RGBA colors.
+
sf::Color is a simple color class composed of 4 components:
+
+Red
+Green
+Blue
+Alpha (opacity)
+
+
Each component is a public member, an unsigned integer in the range [0, 255]. Thus, colors can be constructed and manipulated very easily:
+
color.r = 0;
color.b = 128;
The fourth component of colors, named "alpha", represents the opacity of the color. A color with an alpha value of 255 will be fully opaque, while an alpha value of 0 will make a color fully transparent, whatever the value of the other components is.
+
The most common colors are already defined as static variables:
Colors can also be added and modulated (multiplied) using the overloaded operators + and *.
+
+
Definition at line 40 of file Color.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::Color::Color
+ (
+ )
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ sf::Color::Color
+ (
+ Uint8
+ red ,
+
+ Uint8
+ green ,
+
+ Uint8
+ blue ,
+
+ Uint8
+ alpha = 255
+
+ )
+
+
+
+
+
Construct the color from its 4 RGBA components.
+
Parameters
+
+ red Red component (in the range [0, 255]) green Green component (in the range [0, 255]) blue Blue component (in the range [0, 255]) alpha Alpha (opacity) component (in the range [0, 255])
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ sf::Color::Color
+ (
+ Uint32
+ color )
+
+
+
+
+explicit
+
+
+
+
+
Construct the color from 32-bit unsigned integer.
+
Parameters
+
+ color Number containing the RGBA components (in that order)
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ Uint32 sf::Color::toInteger
+ (
+ )
+ const
+
+
+
+
+
Retrieve the color as a 32-bit unsigned integer.
+
Returns Color represented as a 32-bit unsigned integer
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ const Color &
+ left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the != operator.
+
This operator compares two colors and check if they are different.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns True if colors are different, false if they are equal
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color operator* (
+ const Color &
+ left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary * operator.
+
This operator returns the component-wise multiplication (also called "modulation") of two colors. Components are then divided by 255 so that the result is still in the range [0, 255].
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Result of left * right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color & operator*= (
+ Color & left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary *= operator.
+
This operator returns the component-wise multiplication (also called "modulation") of two colors, and assigns the result to the left operand. Components are then divided by 255 so that the result is still in the range [0, 255].
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color operator+ (
+ const Color &
+ left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary + operator.
+
This operator returns the component-wise sum of two colors. Components that exceed 255 are clamped to 255.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Result of left + right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color & operator+= (
+ Color & left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary += operator.
+
This operator computes the component-wise sum of two colors, and assigns the result to the left operand. Components that exceed 255 are clamped to 255.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color operator- (
+ const Color &
+ left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary - operator.
+
This operator returns the component-wise subtraction of two colors. Components below 0 are clamped to 0.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Result of left - right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Color & operator-= (
+ Color & left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the binary -= operator.
+
This operator computes the component-wise subtraction of two colors, and assigns the result to the left operand. Components below 0 are clamped to 0.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ const Color &
+ left ,
+
+ const Color &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the == operator.
+
This operator compares two colors and check if they are equal.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns True if colors are equal, false if they are different
+
+
+
+
+
+
+
+
+
+
+
+ Uint8 sf::Color::a
+
+
+
+
+
Alpha (opacity) component.
+
+
Definition at line 99 of file Color.hpp .
+
+
+
+
+
+
+
+
+
+
+ Uint8 sf::Color::b
+
+
+
+
+
Blue component.
+
+
Definition at line 98 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Black
+
+
+
+
+static
+
+
+
+
+
Black predefined color.
+
+
Definition at line 83 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Blue
+
+
+
+
+static
+
+
+
+
+
Blue predefined color.
+
+
Definition at line 87 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Cyan
+
+
+
+
+static
+
+
+
+
+
Cyan predefined color.
+
+
Definition at line 90 of file Color.hpp .
+
+
+
+
+
+
+
+
+
+
+ Uint8 sf::Color::g
+
+
+
+
+
Green component.
+
+
Definition at line 97 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Green
+
+
+
+
+static
+
+
+
+
+
Green predefined color.
+
+
Definition at line 86 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Magenta
+
+
+
+
+static
+
+
+
+
+
Magenta predefined color.
+
+
Definition at line 89 of file Color.hpp .
+
+
+
+
+
+
+
+
+
+
+ Uint8 sf::Color::r
+
+
+
+
+
Red component.
+
+
Definition at line 96 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Red
+
+
+
+
+static
+
+
+
+
+
Red predefined color.
+
+
Definition at line 85 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Transparent
+
+
+
+
+static
+
+
+
+
+
Transparent (black) predefined color.
+
+
Definition at line 91 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::White
+
+
+
+
+static
+
+
+
+
+
White predefined color.
+
+
Definition at line 84 of file Color.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color sf::Color::Yellow
+
+
+
+
+static
+
+
+
+
+
Yellow predefined color.
+
+
Definition at line 88 of file Color.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Context , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Class holding a valid drawing context.
+ More...
+
+
#include <Context.hpp >
+
+
+
+
+
+
+
+
+
+
Class holding a valid drawing context.
+
If you need to make OpenGL calls without having an active window (like in a thread), you can use an instance of this class to get a valid context.
+
Having a valid context is necessary for every OpenGL call.
+
Note that a context is only active in its current thread, if you create a new thread it will have no valid context by default.
+
To use a sf::Context instance, just construct it and let it live as long as you need a valid context. No explicit activation is needed, all it has to do is to exist. Its destructor will take care of deactivating and freeing all the attached resources.
+
Usage example:
void threadFunction(void *)
{
glClear(GL_DEPTH_BUFFER_BIT);
}
+
Definition at line 50 of file Context.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Context::Context
+ (
+ )
+
+
+
+
+
Default constructor.
+
The constructor creates and activates the context
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Context::~Context
+ (
+ )
+
+
+
+
+
Destructor.
+
The destructor deactivates and destroys the context
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Context::Context
+ (
+ const ContextSettings &
+ settings ,
+
+ unsigned int
+ width ,
+
+ unsigned int
+ height
+
+ )
+
+
+
+
+
Construct a in-memory context.
+
This constructor is for internal use, you don't need to bother with it.
+
Parameters
+
+ settings Creation parameters width Back buffer width height Back buffer height
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const Context * sf::Context::getActiveContext
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the currently active context.
+
This function will only return sf::Context objects. Contexts created e.g. by RenderTargets or for internal use will not be returned by this function.
+
Returns The currently active context or NULL if none is active
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Uint64 sf::Context::getActiveContextId
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the currently active context's ID.
+
The context ID is used to identify contexts when managing unshareable OpenGL resources.
+
Returns The active context's ID or 0 if no context is currently active
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static GlFunctionPointer sf::Context::getFunction
+ (
+ const char *
+ name )
+
+
+
+
+static
+
+
+
+
+
Get the address of an OpenGL function.
+
Parameters
+
+ name Name of the function to get the address of
+
+
+
Returns Address of the OpenGL function, 0 on failure
+
+
+
+
+
◆
+
+
+
+
+
Get the settings of the context.
+
Note that these settings may be different than the ones passed to the constructor; they are indeed adjusted if the original settings are not directly supported by the system.
+
Returns Structure containing the settings
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Context::isExtensionAvailable
+ (
+ const char *
+ name )
+
+
+
+
+static
+
+
+
+
+
Check whether a given OpenGL extension is available.
+
Parameters
+
+ name Name of the extension to check for
+
+
+
Returns True if available, false if unavailable
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Context::setActive
+ (
+ bool
+ active )
+
+
+
+
+
Activate or deactivate explicitly the context.
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True on success, false on failure
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::ConvexShape , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized shape representing a convex polygon.
+ More...
+
+
#include <ConvexShape.hpp >
+
+
+
+
+
+
+
+
+void update () Recompute the internal geometry of the shape. More...
+
+
Specialized shape representing a convex polygon.
+
This class inherits all the functions of sf::Transformable (position, rotation, scale, bounds, ...) as well as the functions of sf::Shape (outline, color, texture, ...).
+
It is important to keep in mind that a convex shape must always be... convex, otherwise it may not be drawn correctly. Moreover, the points must be defined in order; using a random order would result in an incorrect shape.
+
Usage example:
See also sf::Shape , sf::RectangleShape , sf::CircleShape
+
+
Definition at line 42 of file ConvexShape.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::ConvexShape::ConvexShape
+ (
+ std::size_t
+ pointCount = 0)
+
+
+
+
+explicit
+
+
+
+
+
Default constructor.
+
Parameters
+
+ pointCount Number of points of the polygon
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getFillColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the fill color of the shape.
+
Returns Fill color of the shape
+
See also setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getGlobalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the global (non-minimal) bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the shape in the global 2D world's coordinate system.
+
This function does not necessarily return the minimal bounding rectangle. It merely ensures that the returned rectangle covers all the vertices (but possibly more). This allows for a fast approximation of the bounds as a first check; you may want to use more precise checks on top of that.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getLocalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getOutlineColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline color of the shape.
+
Returns Outline color of the shape
+
See also setOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Shape::getOutlineThickness
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline thickness of the shape.
+
Returns Outline thickness of the shape
+
See also setOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2f sf::ConvexShape::getPoint
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the position of a point.
+
The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account. The result is undefined if index is out of the valid range.
+
Parameters
+
+
+
+
Returns Position of the index-th point of the polygon
+
See also setPoint
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual std::size_t sf::ConvexShape::getPointCount
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the number of points of the polygon.
+
Returns Number of points of the polygon
+
See also setPointCount
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Texture * sf::Shape::getTexture
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the source texture of the shape.
+
If the shape has no source texture, a NULL pointer is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.
+
Returns Pointer to the shape's texture
+
See also setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const IntRect & sf::Shape::getTextureRect
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the sub-rectangle of the texture displayed by the shape.
+
Returns Texture rectangle of the shape
+
See also setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setFillColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the fill color of the shape.
+
This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sf::Color::Transparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.
+
Parameters
+
+ color New color of the shape
+
+
+
See also getFillColor , setOutlineColor
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the outline color of the shape.
+
By default, the shape's outline color is opaque white.
+
Parameters
+
+ color New outline color of the shape
+
+
+
See also getOutlineColor , setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineThickness
+ (
+ float
+ thickness )
+
+
+
+
+inherited
+
+
+
+
+
Set the thickness of the shape's outline.
+
Note that negative values are allowed (so that the outline expands towards the center of the shape), and using zero disables the outline. By default, the outline thickness is 0.
+
Parameters
+
+ thickness New outline thickness
+
+
+
See also getOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::ConvexShape::setPoint
+ (
+ std::size_t
+ index ,
+
+ const Vector2f &
+ point
+
+ )
+
+
+
+
+
Set the position of a point.
+
Don't forget that the polygon must remain convex, and the points need to stay ordered! setPointCount must be called first in order to set the total number of points. The result is undefined if index is out of the valid range.
+
Parameters
+
+ index Index of the point to change, in range [0 .. getPointCount() - 1] point New position of the point
+
+
+
See also getPoint
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::ConvexShape::setPointCount
+ (
+ std::size_t
+ count )
+
+
+
+
+
Set the number of points of the polygon.
+
count must be greater than 2 to define a valid shape.
+
Parameters
+
+ count New number of points of the polygon
+
+
+
See also getPointCount
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTexture
+ (
+ const Texture *
+ texture ,
+
+ bool
+ resetRect = false
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Change the source texture of the shape.
+
The texture argument refers to a texture that must exist as long as the shape uses it. Indeed, the shape doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the shape tries to use it, the behavior is undefined. texture can be NULL to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.
+
Parameters
+
+ texture New texture resetRect Should the texture rect be reset to the size of the new texture?
+
+
+
See also getTexture , setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTextureRect
+ (
+ const IntRect &
+ rect )
+
+
+
+
+inherited
+
+
+
+
+
Set the sub-rectangle of the texture that the shape will display.
+
The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.
+
Parameters
+
+ rect Rectangle defining the region of the texture to display
+
+
+
See also getTextureRect , setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::update
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Recompute the internal geometry of the shape.
+
This function must be called by the derived class everytime the shape's points change (i.e. the result of either getPointCount or getPoint is different).
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Cursor , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Cursor defines the appearance of a system cursor.
+ More...
+
+
#include <Cursor.hpp >
+
+
+
+
+
+
+
+
+enum Type { Arrow ,
+ArrowWait ,
+Wait ,
+Text ,
+Hand ,
+SizeHorizontal ,
+SizeVertical ,
+SizeTopLeftBottomRight ,
+SizeBottomLeftTopRight ,
+SizeAll ,
+Cross ,
+Help ,
+NotAllowed
+ Enumeration of the native system cursor types. More...
+
+
Cursor defines the appearance of a system cursor.
+
Warning Features related to Cursor are not supported on iOS and Android.
+
This class abstracts the operating system resources associated with either a native system cursor or a custom cursor.
+
After loading the cursor the graphical appearance with either loadFromPixels() or loadFromSystem() , the cursor can be changed with sf::Window::setMouseCursor() .
+
The behaviour is undefined if the cursor is destroyed while in use by the window.
+
Usage example:
See also sf::Window::setMouseCursor
+
+
Definition at line 46 of file Cursor.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the native system cursor types.
+
Refer to the following table to determine which cursor is available on which platform.
+
+
+These cursor types are undocumented so may not be available on all versions, but have been tested on 10.13
+
+
+Enumerator Arrow cursor (default)
+Busy arrow cursor.
+Busy cursor.
+I-beam, cursor when hovering over a field allowing text entry.
+Pointing hand cursor.
+Horizontal double arrow cursor.
+Vertical double arrow cursor.
+Double arrow cursor going from top-left to bottom-right.
+Double arrow cursor going from bottom-left to top-right.
+Combination of SizeHorizontal and SizeVertical.
+Crosshair cursor.
+Help cursor.
+Action not allowed cursor.
+
+
+
Definition at line 76 of file Cursor.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Cursor::Cursor
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor doesn't actually create the cursor; initially the new instance is invalid and must not be used until either loadFromPixels() or loadFromSystem() is called and successfully created a cursor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Cursor::~Cursor
+ (
+ )
+
+
+
+
+
Destructor.
+
This destructor releases the system resources associated with this cursor, if any.
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Cursor::loadFromPixels
+ (
+ const Uint8 *
+ pixels ,
+
+ Vector2u size ,
+
+ Vector2u hotspot
+
+ )
+
+
+
+
+
Create a cursor with the provided image.
+
pixels must be an array of width by height pixels in 32-bit RGBA format. If not, this will cause undefined behavior.
+
If pixels is null or either width or height are 0, the current cursor is left unchanged and the function will return false.
+
In addition to specifying the pixel data, you can also specify the location of the hotspot of the cursor. The hotspot is the pixel coordinate within the cursor image which will be located exactly where the mouse pointer position is. Any mouse actions that are performed will return the window/screen location of the hotspot.
+
Warning On Unix, the pixels are mapped into a monochrome bitmap: pixels with an alpha channel to 0 are transparent, black if the RGB channel are close to zero, and white otherwise.
+
Parameters
+
+ pixels Array of pixels of the image size Width and height of the image hotspot (x,y) location of the hotspot
+
+
+
Returns true if the cursor was successfully loaded; false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Cursor::loadFromSystem
+ (
+ Type type )
+
+
+
+
+
Create a native system cursor.
+
Refer to the list of cursor available on each system (see sf::Cursor::Type ) to know whether a given cursor is expected to load successfully or is not supported by the operating system.
+
Parameters
+
+ type Native system cursor type
+
+
+
Returns true if and only if the corresponding cursor is natively supported by the operating system; false otherwise
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Drawable , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract base class for objects that can be drawn to a render target.
+ More...
+
+
#include <Drawable.hpp >
+
+
+
+
+
+
+
+
+RenderTarget
+
+
Abstract base class for objects that can be drawn to a render target.
+
sf::Drawable is a very simple base class that allows objects of derived classes to be drawn to a sf::RenderTarget .
+
All you have to do in your derived class is to override the draw virtual function.
+
Note that inheriting from sf::Drawable is not mandatory, but it allows this nice syntax "window.draw(object)" rather than "object.draw(window)", which is more consistent with other SFML classes.
+
Example:
{
public :
...
private:
{
target.
draw (m_sprite, states);
target.
draw (m_vertices, states);
glBegin(GL_QUADS);
...
glEnd();
}
};
See also sf::RenderTarget
+
+
Definition at line 44 of file Drawable.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Drawable::~Drawable
+ (
+ )
+
+
+
+
+inline virtual
+
+
+
+
+
Virtual destructor.
+
+
Definition at line 52 of file Drawable.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::Drawable::draw
+ (
+ RenderTarget & target ,
+
+ RenderStates states
+
+ )
+ const
+
+
+
+
+protected pure virtual
+
+
+
+
+
Draw the object to a render target.
+
This is a pure virtual function that has to be implemented by the derived class to define how the drawable should be drawn.
+
Parameters
+
+ target Render target to draw to states Current render states
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Defines a system event and its parameters.
+ More...
+
+
#include <Event.hpp >
+
+enum EventType { Closed ,
+Resized ,
+LostFocus ,
+GainedFocus ,
+TextEntered ,
+KeyPressed ,
+KeyReleased ,
+MouseWheelMoved ,
+MouseWheelScrolled ,
+MouseButtonPressed ,
+MouseButtonReleased ,
+MouseMoved ,
+MouseEntered ,
+MouseLeft ,
+JoystickButtonPressed ,
+JoystickButtonReleased ,
+JoystickMoved ,
+JoystickConnected ,
+JoystickDisconnected ,
+TouchBegan ,
+TouchMoved ,
+TouchEnded ,
+SensorChanged ,
+Count
+ Enumeration of the different types of events. More...
+
+
Defines a system event and its parameters.
+
sf::Event holds all the informations about a system event that just happened.
+
Events are retrieved using the sf::Window::pollEvent and sf::Window::waitEvent functions.
+
A sf::Event instance contains the type of the event (mouse moved, key pressed, window closed, ...) as well as the details about this particular event. Please note that the event parameters are defined in a union, which means that only the member matching the type of the event will be properly filled; all other members will have undefined values and must not be read if the type of the event doesn't match. For example, if you received a KeyPressed event, then you must read the event.key member, all other members such as event.mouseMove or event.text will have undefined values.
+
Usage example:
+
Definition at line 44 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the different types of events.
+
+Enumerator The window requested to be closed (no data)
+The window was resized (data in event.size)
+The window lost the focus (no data)
+The window gained the focus (no data)
+A character was entered (data in event.text)
+A key was pressed (data in event.key)
+A key was released (data in event.key)
+The mouse wheel was scrolled (data in event.mouseWheel) (deprecated)
+The mouse wheel was scrolled (data in event.mouseWheelScroll)
+A mouse button was pressed (data in event.mouseButton)
+A mouse button was released (data in event.mouseButton)
+The mouse cursor moved (data in event.mouseMove)
+The mouse cursor entered the area of the window (no data)
+The mouse cursor left the area of the window (no data)
+A joystick button was pressed (data in event.joystickButton)
+A joystick button was released (data in event.joystickButton)
+The joystick moved along an axis (data in event.joystickMove)
+A joystick was connected (data in event.joystickConnect)
+A joystick was disconnected (data in event.joystickConnect)
+A touch event began (data in event.touch)
+A touch moved (data in event.touch)
+A touch event ended (data in event.touch)
+A sensor value changed (data in event.sensor)
+Keep last – the total number of event types.
+
+
+
Definition at line 187 of file Event.hpp .
+
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
Type of the event.
+
+
Definition at line 219 of file Event.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::FileInputStream , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Implementation of input stream based on a file.
+ More...
+
+
#include <FileInputStream.hpp >
+
+
+
+
+
+
+
+
+ FileInputStream () Default constructor. More... virtual ~FileInputStream () Default destructor. More... bool open (const std::string &filename) Open the stream from a file path. More... virtual Int64 read (void *data, Int64 size) Read data from the stream. More... virtual Int64 seek (Int64 position) Change the current reading position. More... virtual Int64 tell () Get the current reading position in the stream. More... virtual Int64 getSize () Return the size of the stream. More...
+
+
Implementation of input stream based on a file.
+
This class is a specialization of InputStream that reads from a file on disk.
+
It wraps a file in the common InputStream interface and therefore allows to use generic classes or functions that accept such a stream, with a file on disk as the data source.
+
In addition to the virtual functions inherited from InputStream , FileInputStream adds a function to specify the file to open.
+
SFML resource classes can usually be loaded directly from a filename, so this class shouldn't be useful to you unless you create your own algorithms that operate on an InputStream .
+
Usage example:
void process(InputStream& stream);
if (stream.open("some_file.dat" ))
process(stream);
InputStream , MemoryInputStream
+
+
Definition at line 55 of file FileInputStream.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::FileInputStream::FileInputStream
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::FileInputStream::~FileInputStream
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Default destructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::FileInputStream::getSize
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Return the size of the stream.
+
Returns The total number of bytes available in the stream, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::FileInputStream::open
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Open the stream from a file path.
+
Parameters
+
+ filename Name of the file to open
+
+
+
Returns True on success, false on error
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::FileInputStream::read
+ (
+ void *
+ data ,
+
+ Int64
+ size
+
+ )
+
+
+
+
+virtual
+
+
+
+
+
Read data from the stream.
+
After reading, the stream's reading position must be advanced by the amount of bytes read.
+
Parameters
+
+ data Buffer where to copy the read data size Desired number of bytes to read
+
+
+
Returns The number of bytes actually read, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::FileInputStream::seek
+ (
+ Int64
+ position )
+
+
+
+
+virtual
+
+
+
+
+
Change the current reading position.
+
Parameters
+
+ position The position to seek to, from the beginning
+
+
+
Returns The position actually sought to, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::FileInputStream::tell
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Get the current reading position in the stream.
+
Returns The current position, or -1 on error.
+
+
Implements sf::InputStream .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Font , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Class for loading and manipulating character fonts.
+ More...
+
+
#include <Font.hpp >
+
+struct Info Holds various information about a font. More...
+
+
Class for loading and manipulating character fonts.
+
Fonts can be loaded from a file, from memory or from a custom stream, and supports the most common types of fonts.
+
See the loadFromFile function for the complete list of supported formats.
+
Once it is loaded, a sf::Font instance provides three types of information about the font:
+Global metrics, such as the line spacing
+Per-glyph metrics, such as bounding box or kerning
+Pixel representation of glyphs
+
+
Fonts alone are not very useful: they hold the font data but cannot make anything useful of it. To do so you need to use the sf::Text class, which is able to properly output text with several options such as character size, style, color, position, rotation, etc. This separation allows more flexibility and better performances: indeed a sf::Font is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a sf::Text is a lightweight object which can combine the glyphs data and metrics of a sf::Font to display any text on a render target. Note that it is also possible to bind several sf::Text instances to the same sf::Font .
+
It is important to note that the sf::Text instance doesn't copy the font that it uses, it only keeps a reference to it. Thus, a sf::Font must not be destructed while it is used by a sf::Text (i.e. never write a function that uses a local sf::Font instance for creating a text).
+
Usage example:
Apart from loading font files, and passing them to instances of sf::Text , you should normally not have to deal directly with this class. However, it may be useful to access the font metrics or rasterized glyphs for advanced usage.
+
Note that if the font is a bitmap font, it is not scalable, thus not all requested sizes will be available to use. This needs to be taken into consideration when using sf::Text . If you need to display text of a certain size, make sure the corresponding bitmap font that supports that size is used.
+
See also sf::Text
+
+
Definition at line 50 of file Font.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Font::Font
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor defines an empty font
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Font::Font
+ (
+ const Font &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Font::~Font
+ (
+ )
+
+
+
+
+
Destructor.
+
Cleans up all the internal resources used by the font
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Glyph & sf::Font::getGlyph
+ (
+ Uint32
+ codePoint ,
+
+ unsigned int
+ characterSize ,
+
+ bool
+ bold ,
+
+ float
+ outlineThickness = 0
+
+ )
+ const
+
+
+
+
+
Retrieve a glyph of the font.
+
If the font is a bitmap font, not all character sizes might be available. If the glyph is not available at the requested size, an empty glyph is returned.
+
Be aware that using a negative value for the outline thickness will cause distorted rendering.
+
Parameters
+
+ codePoint Unicode code point of the character to get characterSize Reference character size bold Retrieve the bold version or the regular one? outlineThickness Thickness of outline (when != 0 the glyph will not be filled)
+
+
+
Returns The glyph corresponding to codePoint and characterSize
+
+
+
+
+
◆
+
+
+
+
+
+ const Info & sf::Font::getInfo
+ (
+ )
+ const
+
+
+
+
+
Get the font information.
+
Returns A structure that holds the font information
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Font::getKerning
+ (
+ Uint32
+ first ,
+
+ Uint32
+ second ,
+
+ unsigned int
+ characterSize
+
+ )
+ const
+
+
+
+
+
Get the kerning offset of two glyphs.
+
The kerning is an extra offset (negative) to apply between two glyphs when rendering them, to make the pair look more "natural". For example, the pair "AV" have a special kerning to make them closer than other characters. Most of the glyphs pairs have a kerning offset of zero, though.
+
Parameters
+
+ first Unicode code point of the first character second Unicode code point of the second character characterSize Reference character size
+
+
+
Returns Kerning value for first and second , in pixels
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Font::getLineSpacing
+ (
+ unsigned int
+ characterSize )
+ const
+
+
+
+
+
Get the line spacing.
+
Line spacing is the vertical offset to apply between two consecutive lines of text.
+
Parameters
+
+ characterSize Reference character size
+
+
+
Returns Line spacing, in pixels
+
+
+
+
+
◆
+
+
+
+
+
+ const Texture & sf::Font::getTexture
+ (
+ unsigned int
+ characterSize )
+ const
+
+
+
+
+
Retrieve the texture containing the loaded glyphs of a certain size.
+
The contents of the returned texture changes as more glyphs are requested, thus it is not very relevant. It is mainly used internally by sf::Text .
+
Parameters
+
+ characterSize Reference character size
+
+
+
Returns Texture containing the glyphs of the requested size
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Font::getUnderlinePosition
+ (
+ unsigned int
+ characterSize )
+ const
+
+
+
+
+
Get the position of the underline.
+
Underline position is the vertical offset to apply between the baseline and the underline.
+
Parameters
+
+ characterSize Reference character size
+
+
+
Returns Underline position, in pixels
+
See also getUnderlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Font::getUnderlineThickness
+ (
+ unsigned int
+ characterSize )
+ const
+
+
+
+
+
Get the thickness of the underline.
+
Underline thickness is the vertical size of the underline.
+
Parameters
+
+ characterSize Reference character size
+
+
+
Returns Underline thickness, in pixels
+
See also getUnderlinePosition
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Font::loadFromFile
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Load the font from a file.
+
The supported font formats are: TrueType, Type 1, CFF, OpenType, SFNT, X11 PCF, Windows FNT, BDF, PFR and Type 42. Note that this function knows nothing about the standard fonts installed on the user's system, thus you can't load them directly.
+
Warning SFML cannot preload all the font data in this function, so the file has to remain accessible until the sf::Font object loads a new font or is destroyed.
+
Parameters
+
+ filename Path of the font file to load
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromMemory , loadFromStream
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Font::loadFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Load the font from a file in memory.
+
The supported font formats are: TrueType, Type 1, CFF, OpenType, SFNT, X11 PCF, Windows FNT, BDF, PFR and Type 42.
+
Warning SFML cannot preload all the font data in this function, so the buffer pointed by data has to remain valid until the sf::Font object loads a new font or is destroyed.
+
Parameters
+
+ data Pointer to the file data in memory sizeInBytes Size of the data to load, in bytes
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromStream
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Font::loadFromStream
+ (
+ InputStream & stream )
+
+
+
+
+
Load the font from a custom stream.
+
The supported font formats are: TrueType, Type 1, CFF, OpenType, SFNT, X11 PCF, Windows FNT, BDF, PFR and Type 42. Warning: SFML cannot preload all the font data in this function, so the contents of stream have to remain valid as long as the font is used.
+
Warning SFML cannot preload all the font data in this function, so the stream has to remain accessible until the sf::Font object loads a new font or is destroyed.
+
Parameters
+
+ stream Source stream to read from
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+ Font & sf::Font::operator= (
+ const Font &
+ right )
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Ftp , including all inherited members.
+
+ Ascii enum valuesf::Ftp Binary enum valuesf::Ftp changeDirectory (const std::string &directory)sf::Ftp connect (const IpAddress &server, unsigned short port=21, Time timeout=Time::Zero)sf::Ftp createDirectory (const std::string &name)sf::Ftp DataChannel (defined in sf::Ftp )sf::Ftp friend deleteDirectory (const std::string &name)sf::Ftp deleteFile (const std::string &name)sf::Ftp disconnect ()sf::Ftp download (const std::string &remoteFile, const std::string &localPath, TransferMode mode=Binary)sf::Ftp Ebcdic enum valuesf::Ftp getDirectoryListing (const std::string &directory="")sf::Ftp getWorkingDirectory ()sf::Ftp keepAlive ()sf::Ftp login ()sf::Ftp login (const std::string &name, const std::string &password)sf::Ftp NonCopyable ()sf::NonCopyable inline private parentDirectory ()sf::Ftp renameFile (const std::string &file, const std::string &newName)sf::Ftp sendCommand (const std::string &command, const std::string ¶meter="")sf::Ftp TransferMode enum namesf::Ftp upload (const std::string &localFile, const std::string &remotePath, TransferMode mode=Binary, bool append=false)sf::Ftp ~Ftp ()sf::Ftp ~NonCopyable ()sf::NonCopyable inline private
SFML - Simple and Fast Multimedia Library
+
+
+
A FTP client.
+ More...
+
+
#include <Ftp.hpp >
+
+
+
+
+
+
+
+
+ ~Ftp () Destructor. More... Response connect (const IpAddress &server, unsigned short port=21, Time timeout=Time::Zero ) Connect to the specified FTP server. More... Response disconnect () Close the connection with the server. More... Response login () Log in using an anonymous account. More... Response login (const std::string &name, const std::string &password) Log in using a username and a password. More... Response keepAlive () Send a null command to keep the connection alive. More... DirectoryResponse getWorkingDirectory () Get the current working directory. More... ListingResponse getDirectoryListing (const std::string &directory="") Get the contents of the given directory. More... Response changeDirectory (const std::string &directory) Change the current working directory. More... Response parentDirectory () Go to the parent directory of the current one. More... Response createDirectory (const std::string &name) Create a new directory. More... Response deleteDirectory (const std::string &name) Remove an existing directory. More... Response renameFile (const std::string &file, const std::string &newName) Rename an existing file. More... Response deleteFile (const std::string &name) Remove an existing file. More... Response download (const std::string &remoteFile, const std::string &localPath, TransferMode mode=Binary ) Download a file from the server. More... Response upload (const std::string &localFile, const std::string &remotePath, TransferMode mode=Binary , bool append=false) Upload a file to the server. More... Response sendCommand (const std::string &command, const std::string ¶meter="") Send a command to the FTP server. More...
+DataChannel
+
+
A FTP client.
+
sf::Ftp is a very simple FTP client that allows you to communicate with a FTP server.
+
The FTP protocol allows you to manipulate a remote file system (list files, upload, download, create, remove, ...).
+
Using the FTP client consists of 4 parts:
+Connecting to the FTP server
+Logging in (either as a registered user or anonymously)
+Sending commands to the server
+Disconnecting (this part can be done implicitly by the destructor)
+
+
Every command returns a FTP response, which contains the status code as well as a message from the server. Some commands such as getWorkingDirectory() and getDirectoryListing() return additional data, and use a class derived from sf::Ftp::Response to provide this data. The most often used commands are directly provided as member functions, but it is also possible to use specific commands with the sendCommand() function.
+
Note that response statuses >= 1000 are not part of the FTP standard, they are generated by SFML when an internal error occurs.
+
All commands, especially upload and download, may take some time to complete. This is important to know if you don't want to block your application while the server is completing the task.
+
Usage example:
std::cout << "Connected" << std::endl;
response = ftp.
login (
"laurent" ,
"dF6Zm89D" );
std::cout << "Logged in" << std::endl;
std::cout <<
"Working directory: " << directory.
getDirectory () << std::endl;
std::cout << "Created new directory" << std::endl;
std::cout << "File uploaded" << std::endl;
std::cout <<
"Feature list:\n" << response.
getMessage () << std::endl;
+
Definition at line 47 of file Ftp.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of transfer modes.
+
+Enumerator Binary mode (file is transfered as a sequence of bytes)
+Text mode using ASCII encoding.
+Text mode using EBCDIC encoding.
+
+
+
Definition at line 55 of file Ftp.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Ftp::~Ftp
+ (
+ )
+
+
+
+
+
Destructor.
+
Automatically closes the connection with the server if it is still opened.
+
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::changeDirectory (
+ const std::string &
+ directory )
+
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::connect (
+ const IpAddress &
+ server ,
+
+ unsigned short
+ port = 21,
+
+ Time timeout = Time::Zero
+
+ )
+
+
+
+
+
Connect to the specified FTP server.
+
The port has a default value of 21, which is the standard port used by the FTP protocol. You shouldn't use a different value, unless you really know what you do. This function tries to connect to the server so it may take a while to complete, especially if the server is not reachable. To avoid blocking your application for too long, you can use a timeout. The default value, Time::Zero , means that the system timeout will be used (which is usually pretty long).
+
Parameters
+
+ server Name or address of the FTP server to connect to port Port used for the connection timeout Maximum time to wait
+
+
+
Returns Server response to the request
+
See also disconnect
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::createDirectory (
+ const std::string &
+ name )
+
+
+
+
+
Create a new directory.
+
The new directory is created as a child of the current working directory.
+
Parameters
+
+ name Name of the directory to create
+
+
+
Returns Server response to the request
+
See also deleteDirectory
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::deleteDirectory (
+ const std::string &
+ name )
+
+
+
+
+
Remove an existing directory.
+
The directory to remove must be relative to the current working directory. Use this function with caution, the directory will be removed permanently!
+
Parameters
+
+ name Name of the directory to remove
+
+
+
Returns Server response to the request
+
See also createDirectory
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::deleteFile (
+ const std::string &
+ name )
+
+
+
+
+
Remove an existing file.
+
The file name must be relative to the current working directory. Use this function with caution, the file will be removed permanently!
+
Parameters
+
+
+
+
Returns Server response to the request
+
See also renameFile
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::disconnect (
+ )
+
+
+
+
+
Close the connection with the server.
+
Returns Server response to the request
+
See also connect
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::download (
+ const std::string &
+ remoteFile ,
+
+ const std::string &
+ localPath ,
+
+ TransferMode mode = Binary
+
+ )
+
+
+
+
+
Download a file from the server.
+
The filename of the distant file is relative to the current working directory of the server, and the local destination path is relative to the current directory of your application. If a file with the same filename as the distant file already exists in the local destination path, it will be overwritten.
+
Parameters
+
+ remoteFile Filename of the distant file to download localPath The directory in which to put the file on the local computer mode Transfer mode
+
+
+
Returns Server response to the request
+
See also upload
+
+
+
+
+
◆
+
+
+
+
+
+ ListingResponse sf::Ftp::getDirectoryListing (
+ const std::string &
+ directory = "")
+
+
+
+
+
Get the contents of the given directory.
+
This function retrieves the sub-directories and files contained in the given directory. It is not recursive. The directory parameter is relative to the current working directory.
+
Parameters
+
+ directory Directory to list
+
+
+
Returns Server response to the request
+
See also getWorkingDirectory , changeDirectory , parentDirectory
+
+
+
+
+
◆
+
+
+
+
+
Get the current working directory.
+
The working directory is the root path for subsequent operations involving directories and/or filenames.
+
Returns Server response to the request
+
See also getDirectoryListing , changeDirectory , parentDirectory
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::keepAlive (
+ )
+
+
+
+
+
Send a null command to keep the connection alive.
+
This command is useful because the server may close the connection automatically if no command is sent.
+
Returns Server response to the request
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Response sf::Ftp::login (
+ )
+
+
+
+
+
Log in using an anonymous account.
+
Logging in is mandatory after connecting to the server. Users that are not logged in cannot perform any operation.
+
Returns Server response to the request
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Response sf::Ftp::login (
+ const std::string &
+ name ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
Log in using a username and a password.
+
Logging in is mandatory after connecting to the server. Users that are not logged in cannot perform any operation.
+
Parameters
+
+ name User name password Password
+
+
+
Returns Server response to the request
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::parentDirectory (
+ )
+
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::renameFile (
+ const std::string &
+ file ,
+
+ const std::string &
+ newName
+
+ )
+
+
+
+
+
Rename an existing file.
+
The filenames must be relative to the current working directory.
+
Parameters
+
+ file File to rename newName New name of the file
+
+
+
Returns Server response to the request
+
See also deleteFile
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::sendCommand (
+ const std::string &
+ command ,
+
+ const std::string &
+ parameter = ""
+
+ )
+
+
+
+
+
Send a command to the FTP server.
+
While the most often used commands are provided as member functions in the sf::Ftp class, this method can be used to send any FTP command to the server. If the command requires one or more parameters, they can be specified in parameter . If the server returns information, you can extract it from the response using Response::getMessage() .
+
Parameters
+
+ command Command to send parameter Command parameter
+
+
+
Returns Server response to the request
+
+
+
+
+
◆
+
+
+
+
+
+ Response sf::Ftp::upload (
+ const std::string &
+ localFile ,
+
+ const std::string &
+ remotePath ,
+
+ TransferMode mode = Binary
+
+ bool
+ append = false
+
+ )
+
+
+
+
+
Upload a file to the server.
+
The name of the local file is relative to the current working directory of your application, and the remote path is relative to the current directory of the FTP server.
+
The append parameter controls whether the remote file is appended to or overwritten if it already exists.
+
Parameters
+
+ localFile Path of the local file to upload remotePath The directory in which to put the file on the server mode Transfer mode append Pass true to append to or false to overwrite the remote file if it already exists
+
+
+
Returns Server response to the request
+
See also download
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Ftp::DirectoryResponse , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialization of FTP response returning a directory.
+ More...
+
+
#include <Ftp.hpp >
+
+
+
+
+
+
+
+
+enum Status { RestartMarkerReply = 110,
+ServiceReadySoon = 120,
+DataConnectionAlreadyOpened = 125,
+OpeningDataConnection = 150,
+Ok = 200,
+PointlessCommand = 202,
+SystemStatus = 211,
+DirectoryStatus = 212,
+FileStatus = 213,
+HelpMessage = 214,
+SystemType = 215,
+ServiceReady = 220,
+ClosingConnection = 221,
+DataConnectionOpened = 225,
+ClosingDataConnection = 226,
+EnteringPassiveMode = 227,
+LoggedIn = 230,
+FileActionOk = 250,
+DirectoryOk = 257,
+NeedPassword = 331,
+NeedAccountToLogIn = 332,
+NeedInformation = 350,
+ServiceUnavailable = 421,
+DataConnectionUnavailable = 425,
+TransferAborted = 426,
+FileActionAborted = 450,
+LocalError = 451,
+InsufficientStorageSpace = 452,
+CommandUnknown = 500,
+ParametersUnknown = 501,
+CommandNotImplemented = 502,
+BadCommandSequence = 503,
+ParameterNotImplemented = 504,
+NotLoggedIn = 530,
+NeedAccountToStore = 532,
+FileUnavailable = 550,
+PageTypeUnknown = 551,
+NotEnoughMemory = 552,
+FilenameNotAllowed = 553,
+InvalidResponse = 1000,
+ConnectionFailed = 1001,
+ConnectionClosed = 1002,
+InvalidFile = 1003
+ Status codes possibly returned by a FTP response. More...
+
+
Specialization of FTP response returning a directory.
+
+
Definition at line 188 of file Ftp.hpp .
+
+
+
◆
+
+
+
+
+
Status codes possibly returned by a FTP response.
+
+Enumerator Restart marker reply.
+Service ready in N minutes.
+Data connection already opened, transfer starting.
+File status ok, about to open data connection.
+Command ok.
+Command not implemented.
+System status, or system help reply.
+Directory status.
+File status.
+Help message.
+NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
+Service ready for new user.
+Service closing control connection.
+Data connection open, no transfer in progress.
+Closing data connection, requested file action successful.
+Entering passive mode.
+User logged in, proceed. Logged out if appropriate.
+Requested file action ok.
+PATHNAME created.
+User name ok, need password.
+Need account for login.
+Requested file action pending further information.
+Service not available, closing control connection.
+Can't open data connection.
+Connection closed, transfer aborted.
+Requested file action not taken.
+Requested action aborted, local error in processing.
+Requested action not taken; insufficient storage space in system, file unavailable.
+Syntax error, command unrecognized.
+Syntax error in parameters or arguments.
+Command not implemented.
+Bad sequence of commands.
+Command not implemented for that parameter.
+Not logged in.
+Need account for storing files.
+Requested action not taken, file unavailable.
+Requested action aborted, page type unknown.
+Requested file action aborted, exceeded storage allocation.
+Requested action not taken, file name not allowed.
+Not part of the FTP standard, generated by SFML when a received response cannot be parsed.
+Not part of the FTP standard, generated by SFML when the low-level socket connection with the server fails.
+Not part of the FTP standard, generated by SFML when the low-level socket connection is unexpectedly closed.
+Not part of the FTP standard, generated by SFML when a local file cannot be read or written.
+
+
+
Definition at line 74 of file Ftp.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Ftp::DirectoryResponse::DirectoryResponse
+ (
+ const Response &
+ response )
+
+
+
+
+
Default constructor.
+
Parameters
+
+ response Source response
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& sf::Ftp::DirectoryResponse::getDirectory
+ (
+ )
+ const
+
+
+
+
+
Get the directory returned in the response.
+
Returns Directory name
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const std::string& sf::Ftp::Response::getMessage
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the full message contained in the response.
+
Returns The response message
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Status sf::Ftp::Response::getStatus (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the status code of the response.
+
Returns Status code
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Ftp::Response::isOk
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Check if the status code means a success.
+
This function is defined for convenience, it is equivalent to testing if the status code is < 400.
+
Returns True if the status is a success, false if it is a failure
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Ftp::ListingResponse , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialization of FTP response returning a filename listing.
+ More...
+
+
#include <Ftp.hpp >
+
+
+
+
+
+
+
+
+enum Status { RestartMarkerReply = 110,
+ServiceReadySoon = 120,
+DataConnectionAlreadyOpened = 125,
+OpeningDataConnection = 150,
+Ok = 200,
+PointlessCommand = 202,
+SystemStatus = 211,
+DirectoryStatus = 212,
+FileStatus = 213,
+HelpMessage = 214,
+SystemType = 215,
+ServiceReady = 220,
+ClosingConnection = 221,
+DataConnectionOpened = 225,
+ClosingDataConnection = 226,
+EnteringPassiveMode = 227,
+LoggedIn = 230,
+FileActionOk = 250,
+DirectoryOk = 257,
+NeedPassword = 331,
+NeedAccountToLogIn = 332,
+NeedInformation = 350,
+ServiceUnavailable = 421,
+DataConnectionUnavailable = 425,
+TransferAborted = 426,
+FileActionAborted = 450,
+LocalError = 451,
+InsufficientStorageSpace = 452,
+CommandUnknown = 500,
+ParametersUnknown = 501,
+CommandNotImplemented = 502,
+BadCommandSequence = 503,
+ParameterNotImplemented = 504,
+NotLoggedIn = 530,
+NeedAccountToStore = 532,
+FileUnavailable = 550,
+PageTypeUnknown = 551,
+NotEnoughMemory = 552,
+FilenameNotAllowed = 553,
+InvalidResponse = 1000,
+ConnectionFailed = 1001,
+ConnectionClosed = 1002,
+InvalidFile = 1003
+ Status codes possibly returned by a FTP response. More...
+
+
Specialization of FTP response returning a filename listing.
+
+
Definition at line 221 of file Ftp.hpp .
+
+
+
◆
+
+
+
+
+
Status codes possibly returned by a FTP response.
+
+Enumerator Restart marker reply.
+Service ready in N minutes.
+Data connection already opened, transfer starting.
+File status ok, about to open data connection.
+Command ok.
+Command not implemented.
+System status, or system help reply.
+Directory status.
+File status.
+Help message.
+NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
+Service ready for new user.
+Service closing control connection.
+Data connection open, no transfer in progress.
+Closing data connection, requested file action successful.
+Entering passive mode.
+User logged in, proceed. Logged out if appropriate.
+Requested file action ok.
+PATHNAME created.
+User name ok, need password.
+Need account for login.
+Requested file action pending further information.
+Service not available, closing control connection.
+Can't open data connection.
+Connection closed, transfer aborted.
+Requested file action not taken.
+Requested action aborted, local error in processing.
+Requested action not taken; insufficient storage space in system, file unavailable.
+Syntax error, command unrecognized.
+Syntax error in parameters or arguments.
+Command not implemented.
+Bad sequence of commands.
+Command not implemented for that parameter.
+Not logged in.
+Need account for storing files.
+Requested action not taken, file unavailable.
+Requested action aborted, page type unknown.
+Requested file action aborted, exceeded storage allocation.
+Requested action not taken, file name not allowed.
+Not part of the FTP standard, generated by SFML when a received response cannot be parsed.
+Not part of the FTP standard, generated by SFML when the low-level socket connection with the server fails.
+Not part of the FTP standard, generated by SFML when the low-level socket connection is unexpectedly closed.
+Not part of the FTP standard, generated by SFML when a local file cannot be read or written.
+
+
+
Definition at line 74 of file Ftp.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Ftp::ListingResponse::ListingResponse
+ (
+ const Response &
+ response ,
+
+ const std::string &
+ data
+
+ )
+
+
+
+
+
Default constructor.
+
Parameters
+
+ response Source response data Data containing the raw listing
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::vector<std::string>& sf::Ftp::ListingResponse::getListing
+ (
+ )
+ const
+
+
+
+
+
Return the array of directory/file names.
+
Returns Array containing the requested listing
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const std::string& sf::Ftp::Response::getMessage
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the full message contained in the response.
+
Returns The response message
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Status sf::Ftp::Response::getStatus (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the status code of the response.
+
Returns Status code
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Ftp::Response::isOk
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Check if the status code means a success.
+
This function is defined for convenience, it is equivalent to testing if the status code is < 400.
+
Returns True if the status is a success, false if it is a failure
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Ftp::Response , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define a FTP response.
+ More...
+
+
#include <Ftp.hpp >
+
+
+
+
+
+
+
+
+enum Status { RestartMarkerReply = 110,
+ServiceReadySoon = 120,
+DataConnectionAlreadyOpened = 125,
+OpeningDataConnection = 150,
+Ok = 200,
+PointlessCommand = 202,
+SystemStatus = 211,
+DirectoryStatus = 212,
+FileStatus = 213,
+HelpMessage = 214,
+SystemType = 215,
+ServiceReady = 220,
+ClosingConnection = 221,
+DataConnectionOpened = 225,
+ClosingDataConnection = 226,
+EnteringPassiveMode = 227,
+LoggedIn = 230,
+FileActionOk = 250,
+DirectoryOk = 257,
+NeedPassword = 331,
+NeedAccountToLogIn = 332,
+NeedInformation = 350,
+ServiceUnavailable = 421,
+DataConnectionUnavailable = 425,
+TransferAborted = 426,
+FileActionAborted = 450,
+LocalError = 451,
+InsufficientStorageSpace = 452,
+CommandUnknown = 500,
+ParametersUnknown = 501,
+CommandNotImplemented = 502,
+BadCommandSequence = 503,
+ParameterNotImplemented = 504,
+NotLoggedIn = 530,
+NeedAccountToStore = 532,
+FileUnavailable = 550,
+PageTypeUnknown = 551,
+NotEnoughMemory = 552,
+FilenameNotAllowed = 553,
+InvalidResponse = 1000,
+ConnectionFailed = 1001,
+ConnectionClosed = 1002,
+InvalidFile = 1003
+ Status codes possibly returned by a FTP response. More...
+
+
Define a FTP response.
+
+
Definition at line 66 of file Ftp.hpp .
+
+
+
◆
+
+
+
+
+
Status codes possibly returned by a FTP response.
+
+Enumerator Restart marker reply.
+Service ready in N minutes.
+Data connection already opened, transfer starting.
+File status ok, about to open data connection.
+Command ok.
+Command not implemented.
+System status, or system help reply.
+Directory status.
+File status.
+Help message.
+NAME system type, where NAME is an official system name from the list in the Assigned Numbers document.
+Service ready for new user.
+Service closing control connection.
+Data connection open, no transfer in progress.
+Closing data connection, requested file action successful.
+Entering passive mode.
+User logged in, proceed. Logged out if appropriate.
+Requested file action ok.
+PATHNAME created.
+User name ok, need password.
+Need account for login.
+Requested file action pending further information.
+Service not available, closing control connection.
+Can't open data connection.
+Connection closed, transfer aborted.
+Requested file action not taken.
+Requested action aborted, local error in processing.
+Requested action not taken; insufficient storage space in system, file unavailable.
+Syntax error, command unrecognized.
+Syntax error in parameters or arguments.
+Command not implemented.
+Bad sequence of commands.
+Command not implemented for that parameter.
+Not logged in.
+Need account for storing files.
+Requested action not taken, file unavailable.
+Requested action aborted, page type unknown.
+Requested file action aborted, exceeded storage allocation.
+Requested action not taken, file name not allowed.
+Not part of the FTP standard, generated by SFML when a received response cannot be parsed.
+Not part of the FTP standard, generated by SFML when the low-level socket connection with the server fails.
+Not part of the FTP standard, generated by SFML when the low-level socket connection is unexpectedly closed.
+Not part of the FTP standard, generated by SFML when a local file cannot be read or written.
+
+
+
Definition at line 74 of file Ftp.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::Ftp::Response::Response
+ (
+ Status code = InvalidResponse
+
+ const std::string &
+ message = ""
+
+ )
+
+
+
+
+explicit
+
+
+
+
+
Default constructor.
+
This constructor is used by the FTP client to build the response.
+
Parameters
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& sf::Ftp::Response::getMessage
+ (
+ )
+ const
+
+
+
+
+
Get the full message contained in the response.
+
Returns The response message
+
+
+
+
+
◆
+
+
+
+
+
+ Status sf::Ftp::Response::getStatus (
+ )
+ const
+
+
+
+
+
Get the status code of the response.
+
Returns Status code
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Ftp::Response::isOk
+ (
+ )
+ const
+
+
+
+
+
Check if the status code means a success.
+
This function is defined for convenience, it is equivalent to testing if the status code is < 400.
+
Returns True if the status is a success, false if it is a failure
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::GlResource , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base class for classes that require an OpenGL context.
+ More...
+
+
#include <GlResource.hpp >
+
+
+
+
+
+
+
+
+
+
Base class for classes that require an OpenGL context.
+
This class is for internal use only, it must be the base of every class that requires a valid OpenGL context in order to work.
+
+
Definition at line 46 of file GlResource.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::GlResource::GlResource
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::GlResource::~GlResource
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::GlResource::registerContextDestroyCallback
+ (
+ ContextDestroyCallback
+ callback ,
+
+ void *
+ arg
+
+ )
+
+
+
+
+static protected
+
+
+
+
+
Register a function to be called when a context is destroyed.
+
This is used for internal purposes in order to properly clean up OpenGL resources that cannot be shared between contexts.
+
Parameters
+
+ callback Function to be called when a context is destroyed arg Argument to pass when calling the function
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::GlResource::TransientContextLock , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
RAII helper class to temporarily lock an available context for use.
+ More...
+
+
#include <GlResource.hpp >
+
+
+
+
+
+
+
+
+
+
RAII helper class to temporarily lock an available context for use.
+
+
Definition at line 79 of file GlResource.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::GlResource::TransientContextLock::TransientContextLock
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::GlResource::TransientContextLock::~TransientContextLock
+ (
+ )
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Glyph , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure describing a glyph.
+ More...
+
+
#include <Glyph.hpp >
+
+
+
Structure describing a glyph.
+
A glyph is the visual representation of a character.
+
The sf::Glyph structure provides the information needed to handle the glyph:
+its coordinates in the font's texture
+its bounding rectangle
+the offset to apply to get the starting position of the next glyph
+
+
See also sf::Font
+
+
Definition at line 41 of file Glyph.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::Glyph::Glyph
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
Default constructor.
+
+
Definition at line 49 of file Glyph.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Glyph::advance
+
+
+
+
+
Offset to move horizontally to the next character.
+
+
Definition at line 54 of file Glyph.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Bounding rectangle of the glyph, in coordinates relative to the baseline.
+
+
Definition at line 55 of file Glyph.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ IntRect sf::Glyph::textureRect
+
+
+
+
Texture coordinates of the glyph inside the font's texture.
+
+
Definition at line 56 of file Glyph.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Http , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
A HTTP client.
+ More...
+
+
#include <Http.hpp >
+
+
+
+
+
+
+
+
+
+
A HTTP client.
+
sf::Http is a very simple HTTP client that allows you to communicate with a web server.
+
You can retrieve web pages, send data to an interactive resource, download a remote file, etc. The HTTPS protocol is not supported.
+
The HTTP client is split into 3 classes:
+
sf::Http::Request builds the request that will be sent to the server. A request is made of:
+a method (what you want to do)
+a target URI (usually the name of the web page or file)
+one or more header fields (options that you can pass to the server)
+an optional body (for POST requests)
+
+
sf::Http::Response parse the response from the web server and provides getters to read them. The response contains:
+a status code
+header fields (that may be answers to the ones that you requested)
+a body, which contains the contents of the requested resource
+
+
sf::Http provides a simple function, SendRequest, to send a sf::Http::Request and return the corresponding sf::Http::Response from the server.
+
Usage example:
http.
setHost (
"http://www.sfml-dev.org" );
{
std::cout << response.
getBody () << std::endl;
}
else
{
std::cout << "Error " << status << std::endl;
}
+
Definition at line 46 of file Http.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Http::Http
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Http::Http
+ (
+ const std::string &
+ host ,
+
+ unsigned short
+ port = 0
+
+ )
+
+
+
+
+
Construct the HTTP client with the target host.
+
This is equivalent to calling setHost(host, port). The port has a default value of 0, which means that the HTTP client will use the right port according to the protocol used (80 for HTTP). You should leave it like this unless you really need a port other than the standard one, or use an unknown protocol.
+
Parameters
+
+ host Web server to connect to port Port to use for connection
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
Send a HTTP request and return the server's response.
+
You must have a valid host before sending a request (see setHost). Any missing mandatory header field in the request will be added with an appropriate value. Warning: this function waits for the server's response and may not return instantly; use a thread if you don't want to block your application, or use a timeout to limit the time to wait. A value of Time::Zero means that the client will use the system default timeout (which is usually pretty long).
+
Parameters
+
+ request Request to send timeout Maximum time to wait
+
+
+
Returns Server's response
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::setHost
+ (
+ const std::string &
+ host ,
+
+ unsigned short
+ port = 0
+
+ )
+
+
+
+
+
Set the target host.
+
This function just stores the host address and port, it doesn't actually connect to it until you send a request. The port has a default value of 0, which means that the HTTP client will use the right port according to the protocol used (80 for HTTP). You should leave it like this unless you really need a port other than the standard one, or use an unknown protocol.
+
Parameters
+
+ host Web server to connect to port Port to use for connection
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Http::Request , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define a HTTP request.
+ More...
+
+
#include <Http.hpp >
+
+ Request (const std::string &uri="/", Method method=Get , const std::string &body="") Default constructor. More... void setField (const std::string &field, const std::string &value) Set the value of a field. More... void setMethod (Method method) Set the request method. More... void setUri (const std::string &uri) Set the requested URI. More... void setHttpVersion (unsigned int major, unsigned int minor) Set the HTTP version for the request. More... void setBody (const std::string &body) Set the body of the request. More...
+
+
Define a HTTP request.
+
+
Definition at line 54 of file Http.hpp .
+
+
+
◆
+
+
+
+
+
Enumerate the available HTTP methods for a request.
+
+Enumerator Request in get mode, standard method to retrieve a page.
+Request in post mode, usually to send data to a page.
+Request a page's header only.
+Request in put mode, useful for a REST API.
+Request in delete mode, useful for a REST API.
+
+
+
Definition at line 62 of file Http.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Http::Request::Request
+ (
+ const std::string &
+ uri = "/",
+
+ Method method = Get
+
+ const std::string &
+ body = ""
+
+ )
+
+
+
+
+
Default constructor.
+
This constructor creates a GET request, with the root URI ("/") and an empty body.
+
Parameters
+
+ uri Target URI method Method to use for the request body Content of the request's body
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::Request::setBody
+ (
+ const std::string &
+ body )
+
+
+
+
+
Set the body of the request.
+
The body of a request is optional and only makes sense for POST requests. It is ignored for all other methods. The body is empty by default.
+
Parameters
+
+ body Content of the body
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::Request::setField
+ (
+ const std::string &
+ field ,
+
+ const std::string &
+ value
+
+ )
+
+
+
+
+
Set the value of a field.
+
The field is created if it doesn't exist. The name of the field is case-insensitive. By default, a request doesn't contain any field (but the mandatory fields are added later by the HTTP client when sending the request).
+
Parameters
+
+ field Name of the field to set value Value of the field
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::Request::setHttpVersion
+ (
+ unsigned int
+ major ,
+
+ unsigned int
+ minor
+
+ )
+
+
+
+
+
Set the HTTP version for the request.
+
The HTTP version is 1.0 by default.
+
Parameters
+
+ major Major HTTP version number minor Minor HTTP version number
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::Request::setMethod
+ (
+ Method method )
+
+
+
+
+
Set the request method.
+
See the Method enumeration for a complete list of all the availale methods. The method is Http::Request::Get by default.
+
Parameters
+
+ method Method to use for the request
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Http::Request::setUri
+ (
+ const std::string &
+ uri )
+
+
+
+
+
Set the requested URI.
+
The URI is the resource (usually a web page or a file) that you want to get or post. The URI is "/" (the root page) by default.
+
Parameters
+
+ uri URI to request, relative to the host
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Http::Response , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define a HTTP response.
+ More...
+
+
#include <Http.hpp >
+
+enum Status { Ok = 200,
+Created = 201,
+Accepted = 202,
+NoContent = 204,
+ResetContent = 205,
+PartialContent = 206,
+MultipleChoices = 300,
+MovedPermanently = 301,
+MovedTemporarily = 302,
+NotModified = 304,
+BadRequest = 400,
+Unauthorized = 401,
+Forbidden = 403,
+NotFound = 404,
+RangeNotSatisfiable = 407,
+InternalServerError = 500,
+NotImplemented = 501,
+BadGateway = 502,
+ServiceNotAvailable = 503,
+GatewayTimeout = 504,
+VersionNotSupported = 505,
+InvalidResponse = 1000,
+ConnectionFailed = 1001
+ Enumerate all the valid status codes for a response. More...
+
+
Define a HTTP response.
+
+
Definition at line 193 of file Http.hpp .
+
+
+
◆
+
+
+
+
+
Enumerate all the valid status codes for a response.
+
+Enumerator Most common code returned when operation was successful.
+The resource has successfully been created.
+The request has been accepted, but will be processed later by the server.
+The server didn't send any data in return.
+The server informs the client that it should clear the view (form) that caused the request to be sent.
+The server has sent a part of the resource, as a response to a partial GET request.
+The requested page can be accessed from several locations.
+The requested page has permanently moved to a new location.
+The requested page has temporarily moved to a new location.
+For conditional requests, means the requested page hasn't changed and doesn't need to be refreshed.
+The server couldn't understand the request (syntax error)
+The requested page needs an authentication to be accessed.
+The requested page cannot be accessed at all, even with authentication.
+The requested page doesn't exist.
+The server can't satisfy the partial GET request (with a "Range" header field)
+The server encountered an unexpected error.
+The server doesn't implement a requested feature.
+The gateway server has received an error from the source server.
+The server is temporarily unavailable (overloaded, in maintenance, ...)
+The gateway server couldn't receive a response from the source server.
+The server doesn't support the requested HTTP version.
+Response is not a valid HTTP one.
+Connection with server failed.
+
+
+
Definition at line 201 of file Http.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Http::Response::Response
+ (
+ )
+
+
+
+
+
Default constructor.
+
Constructs an empty response.
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& sf::Http::Response::getBody
+ (
+ )
+ const
+
+
+
+
+
Get the body of the response.
+
The body of a response may contain:
+the requested page (for GET requests)
+a response from the server (for POST requests)
+nothing (for HEAD requests)
+an error message (in case of an error)
+
+
Returns The response body
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& sf::Http::Response::getField
+ (
+ const std::string &
+ field )
+ const
+
+
+
+
+
Get the value of a field.
+
If the field field is not found in the response header, the empty string is returned. This function uses case-insensitive comparisons.
+
Parameters
+
+ field Name of the field to get
+
+
+
Returns Value of the field, or empty string if not found
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Http::Response::getMajorHttpVersion
+ (
+ )
+ const
+
+
+
+
+
Get the major HTTP version number of the response.
+
Returns Major HTTP version number
+
See also getMinorHttpVersion
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Http::Response::getMinorHttpVersion
+ (
+ )
+ const
+
+
+
+
+
Get the minor HTTP version number of the response.
+
Returns Minor HTTP version number
+
See also getMajorHttpVersion
+
+
+
+
+
◆
+
+
+
+
+
+ Status sf::Http::Response::getStatus (
+ )
+ const
+
+
+
+
+
Get the response status code.
+
The status code should be the first thing to be checked after receiving a response, it defines whether it is a success, a failure or anything else (see the Status enumeration).
+
Returns Status code of the response
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Image , including all inherited members.
+
+ copy (const Image &source, unsigned int destX, unsigned int destY, const IntRect &sourceRect=IntRect(0, 0, 0, 0), bool applyAlpha=false)sf::Image create (unsigned int width, unsigned int height, const Color &color=Color(0, 0, 0))sf::Image create (unsigned int width, unsigned int height, const Uint8 *pixels)sf::Image createMaskFromColor (const Color &color, Uint8 alpha=0)sf::Image flipHorizontally ()sf::Image flipVertically ()sf::Image getPixel (unsigned int x, unsigned int y) constsf::Image getPixelsPtr () constsf::Image getSize () constsf::Image Image ()sf::Image loadFromFile (const std::string &filename)sf::Image loadFromMemory (const void *data, std::size_t size)sf::Image loadFromStream (InputStream &stream)sf::Image saveToFile (const std::string &filename) constsf::Image setPixel (unsigned int x, unsigned int y, const Color &color)sf::Image ~Image ()sf::Image
SFML - Simple and Fast Multimedia Library
+
+
+
Class for loading, manipulating and saving images.
+ More...
+
+
#include <Image.hpp >
+
+ Image () Default constructor. More... ~Image () Destructor. More... void create (unsigned int width, unsigned int height, const Color &color=Color (0, 0, 0)) Create the image and fill it with a unique color. More... void create (unsigned int width, unsigned int height, const Uint8 *pixels) Create the image from an array of pixels. More... bool loadFromFile (const std::string &filename) Load the image from a file on disk. More... bool loadFromMemory (const void *data, std::size_t size) Load the image from a file in memory. More... bool loadFromStream (InputStream &stream) Load the image from a custom stream. More... bool saveToFile (const std::string &filename) const Save the image to a file on disk. More... Vector2u getSize () const Return the size (width and height) of the image. More... void createMaskFromColor (const Color &color, Uint8 alpha=0) Create a transparency mask from a specified color-key. More... void copy (const Image &source, unsigned int destX, unsigned int destY, const IntRect &sourceRect=IntRect (0, 0, 0, 0), bool applyAlpha=false) Copy pixels from another image onto this one. More... void setPixel (unsigned int x, unsigned int y, const Color &color) Change the color of a pixel. More... Color getPixel (unsigned int x, unsigned int y) const Get the color of a pixel. More... const Uint8 * getPixelsPtr () const Get a read-only pointer to the array of pixels. More... void flipHorizontally () Flip the image horizontally (left <-> right) More... void flipVertically () Flip the image vertically (top <-> bottom) More...
+
+
Class for loading, manipulating and saving images.
+
sf::Image is an abstraction to manipulate images as bidimensional arrays of pixels.
+
The class provides functions to load, read, write and save pixels, as well as many other useful functions.
+
sf::Image can handle a unique internal representation of pixels, which is RGBA 32 bits. This means that a pixel must be composed of 8 bits red, green, blue and alpha channels – just like a sf::Color . All the functions that return an array of pixels follow this rule, and all parameters that you pass to sf::Image functions (such as loadFromMemory) must use this representation as well.
+
A sf::Image can be copied, but it is a heavy resource and if possible you should always use [const] references to pass or return them to avoid useless copies.
+
Usage example:
return -1;
image.
copy (background, 10, 10);
return -1;
See also sf::Texture
+
+
Definition at line 46 of file Image.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Image::Image
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty image.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Image::~Image
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Image::copy
+ (
+ const Image &
+ source ,
+
+ unsigned int
+ destX ,
+
+ unsigned int
+ destY ,
+
+ const IntRect &
+ sourceRect = IntRect (0, 0, 0, 0)
+
+ bool
+ applyAlpha = false
+
+ )
+
+
+
+
+
Copy pixels from another image onto this one.
+
This function does a slow pixel copy and should not be used intensively. It can be used to prepare a complex static image from several others, but if you need this kind of feature in real-time you'd better use sf::RenderTexture .
+
If sourceRect is empty, the whole image is copied. If applyAlpha is set to true, the transparency of source pixels is applied. If it is false, the pixels are copied unchanged with their alpha value.
+
Parameters
+
+ source Source image to copy destX X coordinate of the destination position destY Y coordinate of the destination position sourceRect Sub-rectangle of the source image to copy applyAlpha Should the copy take into account the source transparency?
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Image::create
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ const Color &
+ color = Color (0, 0, 0)
+
+ )
+
+
+
+
+
Create the image and fill it with a unique color.
+
Parameters
+
+ width Width of the image height Height of the image color Fill color
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Image::create
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ const Uint8 *
+ pixels
+
+ )
+
+
+
+
+
Create the image from an array of pixels.
+
The pixel array is assumed to contain 32-bits RGBA pixels, and have the given width and height . If not, this is an undefined behavior. If pixels is null, an empty image is created.
+
Parameters
+
+ width Width of the image height Height of the image pixels Array of pixels to copy to the image
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Image::createMaskFromColor
+ (
+ const Color &
+ color ,
+
+ Uint8
+ alpha = 0
+
+ )
+
+
+
+
+
Create a transparency mask from a specified color-key.
+
This function sets the alpha value of every pixel matching the given color to alpha (0 by default), so that they become transparent.
+
Parameters
+
+ color Color to make transparent alpha Alpha value to assign to transparent pixels
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Image::flipHorizontally
+ (
+ )
+
+
+
+
+
Flip the image horizontally (left <-> right)
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Image::flipVertically
+ (
+ )
+
+
+
+
+
Flip the image vertically (top <-> bottom)
+
+
+
+
+
◆
+
+
+
+
+
+ Color sf::Image::getPixel (
+ unsigned int
+ x ,
+
+ unsigned int
+ y
+
+ )
+ const
+
+
+
+
+
Get the color of a pixel.
+
This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behavior.
+
Parameters
+
+ x X coordinate of pixel to get y Y coordinate of pixel to get
+
+
+
Returns Color of the pixel at coordinates (x, y)
+
See also setPixel
+
+
+
+
+
◆
+
+
+
+
+
+ const Uint8* sf::Image::getPixelsPtr
+ (
+ )
+ const
+
+
+
+
+
Get a read-only pointer to the array of pixels.
+
The returned value points to an array of RGBA pixels made of 8 bits integers components. The size of the array is width * height * 4 (getSize() .x * getSize() .y * 4). Warning: the returned pointer may become invalid if you modify the image, so you should never store it for too long. If the image is empty, a null pointer is returned.
+
Returns Read-only pointer to the array of pixels
+
+
+
+
+
◆
+
+
+
+
+
+ Vector2u sf::Image::getSize (
+ )
+ const
+
+
+
+
+
Return the size (width and height) of the image.
+
Returns Size of the image, in pixels
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Image::loadFromFile
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Load the image from a file on disk.
+
The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.
+
Parameters
+
+ filename Path of the image file to load
+
+
+
Returns True if loading was successful
+
See also loadFromMemory , loadFromStream , saveToFile
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Image::loadFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ size
+
+ )
+
+
+
+
+
Load the image from a file in memory.
+
The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.
+
Parameters
+
+ data Pointer to the file data in memory size Size of the data to load, in bytes
+
+
+
Returns True if loading was successful
+
See also loadFromFile , loadFromStream
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Image::loadFromStream
+ (
+ InputStream & stream )
+
+
+
+
+
Load the image from a custom stream.
+
The supported image formats are bmp, png, tga, jpg, gif, psd, hdr and pic. Some format options are not supported, like progressive jpeg. If this function fails, the image is left unchanged.
+
Parameters
+
+ stream Source stream to read from
+
+
+
Returns True if loading was successful
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Image::saveToFile
+ (
+ const std::string &
+ filename )
+ const
+
+
+
+
+
Save the image to a file on disk.
+
The format of the image is automatically deduced from the extension. The supported image formats are bmp, png, tga and jpg. The destination file is overwritten if it already exists. This function fails if the image is empty.
+
Parameters
+
+ filename Path of the file to save
+
+
+
Returns True if saving was successful
+
See also create , loadFromFile , loadFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Image::setPixel
+ (
+ unsigned int
+ x ,
+
+ unsigned int
+ y ,
+
+ const Color &
+ color
+
+ )
+
+
+
+
+
Change the color of a pixel.
+
This function doesn't check the validity of the pixel coordinates, using out-of-range values will result in an undefined behavior.
+
Parameters
+
+ x X coordinate of pixel to change y Y coordinate of pixel to change color New color of the pixel
+
+
+
See also getPixel
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::InputSoundFile , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Provide read access to sound files.
+ More...
+
+
#include <InputSoundFile.hpp >
+
+
+
+
+
+
+
+
+
+
Provide read access to sound files.
+
This class decodes audio samples from a sound file.
+
It is used internally by higher-level classes such as sf::SoundBuffer and sf::Music , but can also be useful if you want to process or analyze audio files without playing them, or if you want to implement your own version of sf::Music with more specific features.
+
Usage example:
;
std::cout <<
"sample rate: " << file.
getSampleRate () << std::endl;
sf::Int16 samples[1024];
sf::Uint64 count;
do
{
count = file.
read (samples, 1024);
}
while (count > 0);
See also sf::SoundFileReader , sf::OutputSoundFile
+
+
Definition at line 47 of file InputSoundFile.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::InputSoundFile::InputSoundFile
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::InputSoundFile::~InputSoundFile
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::InputSoundFile::getChannelCount
+ (
+ )
+ const
+
+
+
+
+
Get the number of channels used by the sound.
+
Returns Number of channels (1 = mono, 2 = stereo)
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::InputSoundFile::getDuration (
+ )
+ const
+
+
+
+
+
Get the total duration of the sound file.
+
This function is provided for convenience, the duration is deduced from the other sound file attributes.
+
Returns Duration of the sound file
+
+
+
+
+
◆
+
+
+
+
+
+ Uint64 sf::InputSoundFile::getSampleCount
+ (
+ )
+ const
+
+
+
+
+
Get the total number of audio samples in the file.
+
Returns Number of samples
+
+
+
+
+
◆
+
+
+
+
+
+ Uint64 sf::InputSoundFile::getSampleOffset
+ (
+ )
+ const
+
+
+
+
+
Get the read offset of the file in samples.
+
Returns Sample position
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::InputSoundFile::getSampleRate
+ (
+ )
+ const
+
+
+
+
+
Get the sample rate of the sound.
+
Returns Sample rate, in samples per second
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::InputSoundFile::getTimeOffset (
+ )
+ const
+
+
+
+
+
Get the read offset of the file in time.
+
Returns Time position
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::InputSoundFile::openFromFile
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Open a sound file from the disk for reading.
+
The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC. The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+
Parameters
+
+ filename Path of the sound file to load
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::InputSoundFile::openFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Open a sound file in memory for reading.
+
The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC. The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+
Parameters
+
+ data Pointer to the file data in memory sizeInBytes Size of the data to load, in bytes
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::InputSoundFile::openFromStream
+ (
+ InputStream & stream )
+
+
+
+
+
Open a sound file from a custom stream for reading.
+
The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC. The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+
Parameters
+
+ stream Source stream to read from
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+ Uint64 sf::InputSoundFile::read
+ (
+ Int16 *
+ samples ,
+
+ Uint64
+ maxCount
+
+ )
+
+
+
+
+
Read audio samples from the open file.
+
Parameters
+
+ samples Pointer to the sample array to fill maxCount Maximum number of samples to read
+
+
+
Returns Number of samples actually read (may be less than maxCount )
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::InputSoundFile::seek
+ (
+ Uint64
+ sampleOffset )
+
+
+
+
+
Change the current read position to the given sample offset.
+
This function takes a sample offset to provide maximum precision. If you need to jump to a given time, use the other overload.
+
The sample offset takes the channels into account. If you have a time offset instead, you can easily find the corresponding sample offset with the following formula: timeInSeconds * sampleRate * channelCount If the given offset exceeds to total number of samples, this function jumps to the end of the sound file.
+
Parameters
+
+ sampleOffset Index of the sample to jump to, relative to the beginning
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::InputSoundFile::seek
+ (
+ Time timeOffset )
+
+
+
+
+
Change the current read position to the given time offset.
+
Using a time offset is handy but imprecise. If you need an accurate result, consider using the overload which takes a sample offset.
+
If the given time exceeds to total duration, this function jumps to the end of the sound file.
+
Parameters
+
+ timeOffset Time to jump to, relative to the beginning
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::InputStream , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract class for custom file input streams.
+ More...
+
+
#include <InputStream.hpp >
+
+
+
+
+
+
+
+
+virtual ~InputStream () Virtual destructor. More... virtual Int64 read (void *data, Int64 size)=0 Read data from the stream. More... virtual Int64 seek (Int64 position)=0 Change the current reading position. More... virtual Int64 tell ()=0 Get the current reading position in the stream. More... virtual Int64 getSize ()=0 Return the size of the stream. More...
+
+
Abstract class for custom file input streams.
+
This class allows users to define their own file input sources from which SFML can load resources.
+
SFML resource classes like sf::Texture and sf::SoundBuffer provide loadFromFile and loadFromMemory functions, which read data from conventional sources. However, if you have data coming from a different source (over a network, embedded, encrypted, compressed, etc) you can derive your own class from sf::InputStream and load SFML resources with their loadFromStream function.
+
Usage example:
{
public :
ZipStream(std::string archive);
bool open(std::string filename);
Int64
read (
void * data, Int64 size);
Int64
seek (Int64 position);
private :
...
};
ZipStream stream("resources.zip" );
stream.open("images/img.png" );
ZipStream stream("resources.zip" );
stream.open("musics/msc.ogg" );
+
Definition at line 41 of file InputStream.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::InputStream::~InputStream
+ (
+ )
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::InputStream::getSize
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::InputStream::read
+ (
+ void *
+ data ,
+
+ Int64
+ size
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Read data from the stream.
+
After reading, the stream's reading position must be advanced by the amount of bytes read.
+
Parameters
+
+ data Buffer where to copy the read data size Desired number of bytes to read
+
+
+
Returns The number of bytes actually read, or -1 on error
+
+
Implemented in sf::FileInputStream , and sf::MemoryInputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::InputStream::seek
+ (
+ Int64
+ position )
+
+
+
+
+pure virtual
+
+
+
+
+
Change the current reading position.
+
Parameters
+
+ position The position to seek to, from the beginning
+
+
+
Returns The position actually sought to, or -1 on error
+
+
Implemented in sf::FileInputStream , and sf::MemoryInputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::InputStream::tell
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::IpAddress , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Encapsulate an IPv4 network address.
+ More...
+
+
#include <IpAddress.hpp >
+
+ IpAddress () Default constructor. More... IpAddress (const std::string &address) Construct the address from a string. More... IpAddress (const char *address) Construct the address from a string. More... IpAddress (Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3) Construct the address from 4 bytes. More... IpAddress (Uint32 address) Construct the address from a 32-bits integer. More... std::string toString () const Get a string representation of the address. More... Uint32 toInteger () const Get an integer representation of the address. More...
+
+
Encapsulate an IPv4 network address.
+
sf::IpAddress is a utility class for manipulating network addresses.
+
It provides a set a implicit constructors and conversion functions to easily build or transform an IP address from/to various representations.
+
Usage example:
Note that sf::IpAddress currently doesn't support IPv6 nor other types of network addresses.
+
+
Definition at line 44 of file IpAddress.hpp .
+
+
+
◆ [1/5]
+
+
+
+
+
+ sf::IpAddress::IpAddress
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor creates an empty (invalid) address
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ sf::IpAddress::IpAddress
+ (
+ const std::string &
+ address )
+
+
+
+
+
Construct the address from a string.
+
Here address can be either a decimal address (ex: "192.168.1.56") or a network name (ex: "localhost").
+
Parameters
+
+ address IP address or network name
+
+
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ sf::IpAddress::IpAddress
+ (
+ const char *
+ address )
+
+
+
+
+
Construct the address from a string.
+
Here address can be either a decimal address (ex: "192.168.1.56") or a network name (ex: "localhost"). This is equivalent to the constructor taking a std::string parameter, it is defined for convenience so that the implicit conversions from literal strings to IpAddress work.
+
Parameters
+
+ address IP address or network name
+
+
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ sf::IpAddress::IpAddress
+ (
+ Uint8
+ byte0 ,
+
+ Uint8
+ byte1 ,
+
+ Uint8
+ byte2 ,
+
+ Uint8
+ byte3
+
+ )
+
+
+
+
+
Construct the address from 4 bytes.
+
Calling IpAddress(a, b, c, d) is equivalent to calling IpAddress ("a.b.c.d"), but safer as it doesn't have to parse a string to get the address components.
+
Parameters
+
+ byte0 First byte of the address byte1 Second byte of the address byte2 Third byte of the address byte3 Fourth byte of the address
+
+
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+
+
+
+ sf::IpAddress::IpAddress
+ (
+ Uint32
+ address )
+
+
+
+
+explicit
+
+
+
+
+
Construct the address from a 32-bits integer.
+
This constructor uses the internal representation of the address directly. It should be used for optimization purposes, and only if you got that representation from IpAddress::toInteger() .
+
Parameters
+
+ address 4 bytes of the address packed into a 32-bits integer
+
+
+
See also toInteger
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static IpAddress sf::IpAddress::getLocalAddress
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the computer's local address.
+
The local address is the address of the computer from the LAN point of view, i.e. something like 192.168.1.56. It is meaningful only for communications over the local network. Unlike getPublicAddress, this function is fast and may be used safely anywhere.
+
Returns Local IP address of the computer
+
See also getPublicAddress
+
+
+
+
+
◆
+
+
+
+
+
Get the computer's public address.
+
The public address is the address of the computer from the internet point of view, i.e. something like 89.54.1.169. It is necessary for communications over the world wide web. The only way to get a public address is to ask it to a distant website; as a consequence, this function depends on both your network connection and the server, and may be very slow. You should use it as few as possible. Because this function depends on the network connection and on a distant server, you may use a time limit if you don't want your program to be possibly stuck waiting in case there is a problem; this limit is deactivated by default.
+
Parameters
+
+ timeout Maximum time to wait
+
+
+
Returns Public IP address of the computer
+
See also getLocalAddress
+
+
+
+
+
◆
+
+
+
+
+
+ Uint32 sf::IpAddress::toInteger
+ (
+ )
+ const
+
+
+
+
+
Get an integer representation of the address.
+
The returned number is the internal representation of the address, and should be used for optimization purposes only (like sending the address through a socket). The integer produced by this function can then be converted back to a sf::IpAddress with the proper constructor.
+
Returns 32-bits unsigned integer representation of the address
+
See also toString
+
+
+
+
+
◆
+
+
+
+
+
+ std::string sf::IpAddress::toString
+ (
+ )
+ const
+
+
+
+
+
Get a string representation of the address.
+
The returned string is the decimal representation of the IP address (like "192.168.1.56"), even if it was constructed from a host name.
+
Returns String representation of the address
+
See also toInteger
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<
+ (
+ const IpAddress &
+ left ,
+
+ const IpAddress &
+ right
+
+ )
+
+
+
+
+friend
+
+
+
+
+
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
+
+
+
+
+
+
◆
+
+
+
+
+
Value representing any address (0.0.0.0)
+
+
Definition at line 185 of file IpAddress.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const IpAddress sf::IpAddress::Broadcast
+
+
+
+
+static
+
+
+
+
+
The "broadcast" address (for sending UDP messages to everyone on a local network)
+
+
Definition at line 187 of file IpAddress.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const IpAddress sf::IpAddress::LocalHost
+
+
+
+
+static
+
+
+
+
+
The "localhost" address (for connecting a computer to itself locally)
+
+
Definition at line 186 of file IpAddress.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Value representing an empty/invalid address.
+
+
Definition at line 184 of file IpAddress.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Joystick , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the real-time state of the joysticks.
+ More...
+
+
#include <Joystick.hpp >
+
+
+
Give access to the real-time state of the joysticks.
+
sf::Joystick provides an interface to the state of the joysticks.
+
It only contains static functions, so it's not meant to be instantiated. Instead, each joystick is identified by an index that is passed to the functions of this class.
+
This class allows users to query the state of joysticks at any time and directly, without having to deal with a window and its events. Compared to the JoystickMoved, JoystickButtonPressed and JoystickButtonReleased events, sf::Joystick can retrieve the state of axes and buttons of joysticks at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of joysticks, even if they are moved, pressed or released when your window is out of focus and no event is triggered.
+
SFML supports:
+
Unlike the keyboard or mouse, the state of joysticks is sometimes not directly available (depending on the OS), therefore an update() function must be called in order to update the current state of joysticks. When you have a window with event handling, this is done automatically, you don't need to call anything. But if you have no window, or if you want to check joysticks state before creating one, you must call sf::Joystick::update explicitly.
+
Usage example:
See also sf::Keyboard , sf::Mouse
+
+
Definition at line 41 of file Joystick.hpp .
+
+
+
◆
+
+
+
+
+
Constants related to joysticks capabilities.
+
+Enumerator Maximum number of supported joysticks.
+Maximum number of supported buttons.
+Maximum number of supported axes.
+
+
+
Definition at line 49 of file Joystick.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Axes supported by SFML joysticks.
+
+Enumerator The X axis.
+The Y axis.
+The Z axis.
+The R axis.
+The U axis.
+The V axis.
+The X axis of the point-of-view hat.
+The Y axis of the point-of-view hat.
+
+
+
Definition at line 60 of file Joystick.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static float sf::Joystick::getAxisPosition
+ (
+ unsigned int
+ joystick ,
+
+ Axis axis
+
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current position of a joystick axis.
+
If the joystick is not connected, this function returns 0.
+
Parameters
+
+ joystick Index of the joystick axis Axis to check
+
+
+
Returns Current position of the axis, in range [-100 .. 100]
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static unsigned int sf::Joystick::getButtonCount
+ (
+ unsigned int
+ joystick )
+
+
+
+
+static
+
+
+
+
+
Return the number of buttons supported by a joystick.
+
If the joystick is not connected, this function returns 0.
+
Parameters
+
+ joystick Index of the joystick
+
+
+
Returns Number of buttons supported by the joystick
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Identification sf::Joystick::getIdentification
+ (
+ unsigned int
+ joystick )
+
+
+
+
+static
+
+
+
+
+
Get the joystick information.
+
Parameters
+
+ joystick Index of the joystick
+
+
+
Returns Structure containing joystick information.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Joystick::hasAxis
+ (
+ unsigned int
+ joystick ,
+
+ Axis axis
+
+ )
+
+
+
+
+static
+
+
+
+
+
Check if a joystick supports a given axis.
+
If the joystick is not connected, this function returns false.
+
Parameters
+
+ joystick Index of the joystick axis Axis to check
+
+
+
Returns True if the joystick supports the axis, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Joystick::isButtonPressed
+ (
+ unsigned int
+ joystick ,
+
+ unsigned int
+ button
+
+ )
+
+
+
+
+static
+
+
+
+
+
Check if a joystick button is pressed.
+
If the joystick is not connected, this function returns false.
+
Parameters
+
+ joystick Index of the joystick button Button to check
+
+
+
Returns True if the button is pressed, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Joystick::isConnected
+ (
+ unsigned int
+ joystick )
+
+
+
+
+static
+
+
+
+
+
Check if a joystick is connected.
+
Parameters
+
+ joystick Index of the joystick to check
+
+
+
Returns True if the joystick is connected, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Joystick::update
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Update the states of all joysticks.
+
This function is used internally by SFML, so you normally don't have to call it explicitly. However, you may need to call it if you have no window yet (or no window at all): in this case the joystick states are not updated automatically.
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Keyboard , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the real-time state of the keyboard.
+ More...
+
+
#include <Keyboard.hpp >
+
+enum Key { Unknown = -1,
+A = 0,
+B ,
+C ,
+D ,
+E ,
+F ,
+G ,
+H ,
+I ,
+J ,
+K ,
+L ,
+M ,
+N ,
+O ,
+P ,
+Q ,
+R ,
+S ,
+T ,
+U ,
+V ,
+W ,
+X ,
+Y ,
+Z ,
+Num0 ,
+Num1 ,
+Num2 ,
+Num3 ,
+Num4 ,
+Num5 ,
+Num6 ,
+Num7 ,
+Num8 ,
+Num9 ,
+Escape ,
+LControl ,
+LShift ,
+LAlt ,
+LSystem ,
+RControl ,
+RShift ,
+RAlt ,
+RSystem ,
+Menu ,
+LBracket ,
+RBracket ,
+Semicolon ,
+Comma ,
+Period ,
+Quote ,
+Slash ,
+Backslash ,
+Tilde ,
+Equal ,
+Hyphen ,
+Space ,
+Enter ,
+Backspace ,
+Tab ,
+PageUp ,
+PageDown ,
+End ,
+Home ,
+Insert ,
+Delete ,
+Add ,
+Subtract ,
+Multiply ,
+Divide ,
+Left ,
+Right ,
+Up ,
+Down ,
+Numpad0 ,
+Numpad1 ,
+Numpad2 ,
+Numpad3 ,
+Numpad4 ,
+Numpad5 ,
+Numpad6 ,
+Numpad7 ,
+Numpad8 ,
+Numpad9 ,
+F1 ,
+F2 ,
+F3 ,
+F4 ,
+F5 ,
+F6 ,
+F7 ,
+F8 ,
+F9 ,
+F10 ,
+F11 ,
+F12 ,
+F13 ,
+F14 ,
+F15 ,
+Pause ,
+KeyCount ,
+Dash = Hyphen,
+BackSpace = Backspace,
+BackSlash = Backslash,
+SemiColon = Semicolon,
+Return = Enter
+ Key codes. More...
+
+
Give access to the real-time state of the keyboard.
+
sf::Keyboard provides an interface to the state of the keyboard.
+
It only contains static functions (a single keyboard is assumed), so it's not meant to be instantiated.
+
This class allows users to query the keyboard state at any time and directly, without having to deal with a window and its events. Compared to the KeyPressed and KeyReleased events, sf::Keyboard can retrieve the state of a key at any time (you don't need to store and update a boolean on your side in order to know if a key is pressed or released), and you always get the real state of the keyboard, even if keys are pressed or released when your window is out of focus and no event is triggered.
+
Usage example:
See also sf::Joystick , sf::Mouse , sf::Touch
+
+
Definition at line 40 of file Keyboard.hpp .
+
+
+
◆
+
+
+
+
+
Key codes.
+
+Enumerator Unhandled key.
+The A key.
+The B key.
+The C key.
+The D key.
+The E key.
+The F key.
+The G key.
+The H key.
+The I key.
+The J key.
+The K key.
+The L key.
+The M key.
+The N key.
+The O key.
+The P key.
+The Q key.
+The R key.
+The S key.
+The T key.
+The U key.
+The V key.
+The W key.
+The X key.
+The Y key.
+The Z key.
+The 0 key.
+The 1 key.
+The 2 key.
+The 3 key.
+The 4 key.
+The 5 key.
+The 6 key.
+The 7 key.
+The 8 key.
+The 9 key.
+The Escape key.
+The left Control key.
+The left Shift key.
+The left Alt key.
+The left OS specific key: window (Windows and Linux), apple (MacOS X), ...
+The right Control key.
+The right Shift key.
+The right Alt key.
+The right OS specific key: window (Windows and Linux), apple (MacOS X), ...
+The Menu key.
+The [ key.
+The ] key.
+The ; key.
+The , key.
+The . key.
+The ' key.
+The / key.
+The \ key.
+The ~ key.
+The = key.
+The - key (hyphen)
+The Space key.
+The Enter/Return keys.
+The Backspace key.
+The Tabulation key.
+The Page up key.
+The Page down key.
+The End key.
+The Home key.
+The Insert key.
+The Delete key.
+The + key.
+The - key (minus, usually from numpad)
+The * key.
+The / key.
+Left arrow.
+Right arrow.
+Up arrow.
+Down arrow.
+The numpad 0 key.
+The numpad 1 key.
+The numpad 2 key.
+The numpad 3 key.
+The numpad 4 key.
+The numpad 5 key.
+The numpad 6 key.
+The numpad 7 key.
+The numpad 8 key.
+The numpad 9 key.
+The F1 key.
+The F2 key.
+The F3 key.
+The F4 key.
+The F5 key.
+The F6 key.
+The F7 key.
+The F8 key.
+The F9 key.
+The F10 key.
+The F11 key.
+The F12 key.
+The F13 key.
+The F14 key.
+The F15 key.
+The Pause key.
+Keep last – the total number of keyboard keys.
+Deprecated: Use Hyphen instead Deprecated: Use Backspace instead Deprecated: Use Backslash instead Deprecated: Use Semicolon instead Deprecated: Use Enter instead
+
+
Definition at line 48 of file Keyboard.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Keyboard::isKeyPressed
+ (
+ Key key )
+
+
+
+
+static
+
+
+
+
+
Check if a key is pressed.
+
Parameters
+
+
+
+
Returns True if the key is pressed, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Keyboard::setVirtualKeyboardVisible
+ (
+ bool
+ visible )
+
+
+
+
+static
+
+
+
+
+
Show or hide the virtual keyboard.
+
Warning: the virtual keyboard is not supported on all systems. It will typically be implemented on mobile OSes (Android, iOS) but not on desktop OSes (Windows, Linux, ...).
+
If the virtual keyboard is not available, this function does nothing.
+
Parameters
+
+ visible True to show, false to hide
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Listener , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
The audio listener is the point in the scene from where all the sounds are heard.
+ More...
+
+
#include <Listener.hpp >
+
+
+
The audio listener is the point in the scene from where all the sounds are heard.
+
The audio listener defines the global properties of the audio environment, it defines where and how sounds and musics are heard.
+
If sf::View is the eyes of the user, then sf::Listener is his ears (by the way, they are often linked together – same position, orientation, etc.).
+
sf::Listener is a simple interface, which allows to setup the listener in the 3D audio environment (position, direction and up vector), and to adjust the global volume.
+
Because the listener is unique in the scene, sf::Listener only contains static functions and doesn't have to be instantiated.
+
Usage example:
+
Definition at line 42 of file Listener.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Vector3f sf::Listener::getDirection
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current forward vector of the listener in the scene.
+
Returns Listener 's forward vector (not normalized)
+
See also setDirection
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static float sf::Listener::getGlobalVolume
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current value of the global volume.
+
Returns Current global volume, in the range [0, 100]
+
See also setGlobalVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Vector3f sf::Listener::getPosition
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current position of the listener in the scene.
+
Returns Listener 's position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Vector3f sf::Listener::getUpVector
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current upward vector of the listener in the scene.
+
Returns Listener 's upward vector (not normalized)
+
See also setUpVector
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setDirection
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+static
+
+
+
+
+
Set the forward vector of the listener in the scene.
+
The direction (also called "at vector") is the vector pointing forward from the listener's perspective. Together with the up vector, it defines the 3D orientation of the listener in the scene. The direction vector doesn't have to be normalized. The default listener's direction is (0, 0, -1).
+
Parameters
+
+ x X coordinate of the listener's direction y Y coordinate of the listener's direction z Z coordinate of the listener's direction
+
+
+
See also getDirection , setUpVector , setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setDirection
+ (
+ const Vector3f &
+ direction )
+
+
+
+
+static
+
+
+
+
+
Set the forward vector of the listener in the scene.
+
The direction (also called "at vector") is the vector pointing forward from the listener's perspective. Together with the up vector, it defines the 3D orientation of the listener in the scene. The direction vector doesn't have to be normalized. The default listener's direction is (0, 0, -1).
+
Parameters
+
+ direction New listener's direction
+
+
+
See also getDirection , setUpVector , setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Listener::setGlobalVolume
+ (
+ float
+ volume )
+
+
+
+
+static
+
+
+
+
+
Change the global volume of all the sounds and musics.
+
The volume is a number between 0 and 100; it is combined with the individual volume of each sound / music. The default value for the volume is 100 (maximum).
+
Parameters
+
+ volume New global volume, in the range [0, 100]
+
+
+
See also getGlobalVolume
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setPosition
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+static
+
+
+
+
+
Set the position of the listener in the scene.
+
The default listener's position is (0, 0, 0).
+
Parameters
+
+ x X coordinate of the listener's position y Y coordinate of the listener's position z Z coordinate of the listener's position
+
+
+
See also getPosition , setDirection
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setPosition
+ (
+ const Vector3f &
+ position )
+
+
+
+
+static
+
+
+
+
+
Set the position of the listener in the scene.
+
The default listener's position is (0, 0, 0).
+
Parameters
+
+ position New listener's position
+
+
+
See also getPosition , setDirection
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setUpVector
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+static
+
+
+
+
+
Set the upward vector of the listener in the scene.
+
The up vector is the vector that points upward from the listener's perspective. Together with the direction, it defines the 3D orientation of the listener in the scene. The up vector doesn't have to be normalized. The default listener's up vector is (0, 1, 0). It is usually not necessary to change it, especially in 2D scenarios.
+
Parameters
+
+ x X coordinate of the listener's up vector y Y coordinate of the listener's up vector z Z coordinate of the listener's up vector
+
+
+
See also getUpVector , setDirection , setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static void sf::Listener::setUpVector
+ (
+ const Vector3f &
+ upVector )
+
+
+
+
+static
+
+
+
+
+
Set the upward vector of the listener in the scene.
+
The up vector is the vector that points upward from the listener's perspective. Together with the direction, it defines the 3D orientation of the listener in the scene. The up vector doesn't have to be normalized. The default listener's up vector is (0, 1, 0). It is usually not necessary to change it, especially in 2D scenarios.
+
Parameters
+
+ upVector New listener's up vector
+
+
+
See also getUpVector , setDirection , setPosition
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Lock , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Automatic wrapper for locking and unlocking mutexes.
+ More...
+
+
#include <Lock.hpp >
+
+
+
+
+
+
+
+
+
+
Automatic wrapper for locking and unlocking mutexes.
+
sf::Lock is a RAII wrapper for sf::Mutex .
+
By unlocking it in its destructor, it ensures that the mutex will always be released when the current scope (most likely a function) ends. This is even more important when an exception or an early return statement can interrupt the execution flow of the function.
+
For maximum robustness, sf::Lock should always be used to lock/unlock a mutex.
+
Usage example:
void function ()
{
functionThatMayThrowAnException();
if (someCondition)
return ;
}
Because the mutex is not explicitly unlocked in the code, it may remain locked longer than needed. If the region of the code that needs to be protected by the mutex is not the entire function, a good practice is to create a smaller, inner scope so that the lock is limited to this part of the code.
+
void function ()
{
{
codeThatRequiresProtection();
}
codeThatDoesntCareAboutTheMutex();
}
Having a mutex locked longer than required is a bad practice which can lead to bad performances. Don't forget that when a mutex is locked, other threads may be waiting doing nothing until it is released.
+
See also sf::Mutex
+
+
Definition at line 43 of file Lock.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::Lock::Lock
+ (
+ Mutex & mutex )
+
+
+
+
+explicit
+
+
+
+
+
Construct the lock with a target mutex.
+
The mutex passed to sf::Lock is automatically locked.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Lock::~Lock
+ (
+ )
+
+
+
+
+
Destructor.
+
The destructor of sf::Lock automatically unlocks its mutex.
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::MemoryInputStream , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Implementation of input stream based on a memory chunk.
+ More...
+
+
#include <MemoryInputStream.hpp >
+
+
+
+
+
+
+
+
+ MemoryInputStream () Default constructor. More... void open (const void *data, std::size_t sizeInBytes) Open the stream from its data. More... virtual Int64 read (void *data, Int64 size) Read data from the stream. More... virtual Int64 seek (Int64 position) Change the current reading position. More... virtual Int64 tell () Get the current reading position in the stream. More... virtual Int64 getSize () Return the size of the stream. More...
+
+
Implementation of input stream based on a memory chunk.
+
This class is a specialization of InputStream that reads from data in memory.
+
It wraps a memory chunk in the common InputStream interface and therefore allows to use generic classes or functions that accept such a stream, with content already loaded in memory.
+
In addition to the virtual functions inherited from InputStream , MemoryInputStream adds a function to specify the pointer and size of the data in memory.
+
SFML resource classes can usually be loaded directly from memory, so this class shouldn't be useful to you unless you create your own algorithms that operate on an InputStream .
+
Usage example:
void process(InputStream& stream);
stream.open(thePtr, theSize);
process(stream);
InputStream , FileInputStream
+
+
Definition at line 43 of file MemoryInputStream.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::MemoryInputStream::MemoryInputStream
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::MemoryInputStream::getSize
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Return the size of the stream.
+
Returns The total number of bytes available in the stream, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::MemoryInputStream::open
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Open the stream from its data.
+
Parameters
+
+ data Pointer to the data in memory sizeInBytes Size of the data, in bytes
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::MemoryInputStream::read
+ (
+ void *
+ data ,
+
+ Int64
+ size
+
+ )
+
+
+
+
+virtual
+
+
+
+
+
Read data from the stream.
+
After reading, the stream's reading position must be advanced by the amount of bytes read.
+
Parameters
+
+ data Buffer where to copy the read data size Desired number of bytes to read
+
+
+
Returns The number of bytes actually read, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::MemoryInputStream::seek
+ (
+ Int64
+ position )
+
+
+
+
+virtual
+
+
+
+
+
Change the current reading position.
+
Parameters
+
+ position The position to seek to, from the beginning
+
+
+
Returns The position actually sought to, or -1 on error
+
+
Implements sf::InputStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::MemoryInputStream::tell
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Get the current reading position in the stream.
+
Returns The current position, or -1 on error.
+
+
Implements sf::InputStream .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Mouse , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the real-time state of the mouse.
+ More...
+
+
#include <Mouse.hpp >
+
+
+
Give access to the real-time state of the mouse.
+
sf::Mouse provides an interface to the state of the mouse.
+
It only contains static functions (a single mouse is assumed), so it's not meant to be instantiated.
+
This class allows users to query the mouse state at any time and directly, without having to deal with a window and its events. Compared to the MouseMoved, MouseButtonPressed and MouseButtonReleased events, sf::Mouse can retrieve the state of the cursor and the buttons at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of the mouse, even if it is moved, pressed or released when your window is out of focus and no event is triggered.
+
The setPosition and getPosition functions can be used to change or retrieve the current position of the mouse pointer. There are two versions: one that operates in global coordinates (relative to the desktop) and one that operates in window coordinates (relative to a specific window).
+
Usage example:
See also sf::Joystick , sf::Keyboard , sf::Touch
+
+
Definition at line 43 of file Mouse.hpp .
+
+
+
◆
+
+
+
+
+
Mouse buttons.
+
+Enumerator The left mouse button.
+The right mouse button.
+The middle (wheel) mouse button.
+The first extra mouse button.
+The second extra mouse button.
+Keep last – the total number of mouse buttons.
+
+
+
Definition at line 51 of file Mouse.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Mouse wheels.
+
+Enumerator The vertical mouse wheel.
+The horizontal mouse wheel.
+
+
+
Definition at line 66 of file Mouse.hpp .
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static Vector2i sf::Mouse::getPosition
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current position of the mouse in desktop coordinates.
+
This function returns the global position of the mouse cursor on the desktop.
+
Returns Current position of the mouse
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static Vector2i sf::Mouse::getPosition
+ (
+ const Window &
+ relativeTo )
+
+
+
+
+static
+
+
+
+
+
Get the current position of the mouse in window coordinates.
+
This function returns the current position of the mouse cursor, relative to the given window.
+
Parameters
+
+ relativeTo Reference window
+
+
+
Returns Current position of the mouse
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Mouse::isButtonPressed
+ (
+ Button button )
+
+
+
+
+static
+
+
+
+
+
Check if a mouse button is pressed.
+
Parameters
+
+ button Button to check
+
+
+
Returns True if the button is pressed, false otherwise
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static void sf::Mouse::setPosition
+ (
+ const Vector2i &
+ position )
+
+
+
+
+static
+
+
+
+
+
Set the current position of the mouse in desktop coordinates.
+
This function sets the global position of the mouse cursor on the desktop.
+
Parameters
+
+ position New position of the mouse
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static void sf::Mouse::setPosition
+ (
+ const Vector2i &
+ position ,
+
+ const Window &
+ relativeTo
+
+ )
+
+
+
+
+static
+
+
+
+
+
Set the current position of the mouse in window coordinates.
+
This function sets the current position of the mouse cursor, relative to the given window.
+
Parameters
+
+ position New position of the mouse relativeTo Reference window
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Music , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Streamed music played from an audio file.
+ More...
+
+
#include <Music.hpp >
+
+
+
+
+
+
+
+
+struct Span Structure defining a time range using the template type. More...
+virtual bool onGetData (Chunk &data) Request a new chunk of audio samples from the stream source. More... virtual void onSeek (Time timeOffset) Change the current playing position in the stream source. More... virtual Int64 onLoop () Change the current playing position in the stream source to the loop offset. More... void initialize (unsigned int channelCount, unsigned int sampleRate) Define the audio stream parameters. More...
+
+
Streamed music played from an audio file.
+
Musics are sounds that are streamed rather than completely loaded in memory.
+
This is especially useful for compressed musics that usually take hundreds of MB when they are uncompressed: by streaming it instead of loading it entirely, you avoid saturating the memory and have almost no loading delay. This implies that the underlying resource (file, stream or memory buffer) must remain valid for the lifetime of the sf::Music object.
+
Apart from that, a sf::Music has almost the same features as the sf::SoundBuffer / sf::Sound pair: you can play/pause/stop it, request its parameters (channels, sample rate), change the way it is played (pitch, volume, 3D position, ...), etc.
+
As a sound stream, a music is played in its own thread in order not to block the rest of the program. This means that you can leave the music alone after calling play() , it will manage itself very well.
+
Usage example:
See also sf::Sound , sf::SoundStream
+
+
Definition at line 48 of file Music.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+
+protected inherited
+
+
+
+
+Enumerator "Invalid" endSeeks value, telling us to continue uninterrupted
+
+
+
Definition at line 183 of file SoundStream.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of the sound source states.
+
+Enumerator Sound is not playing.
+Sound is paused.
+Sound is playing.
+
+
+
Definition at line 50 of file SoundSource.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Music::Music
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Music::~Music
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getAttenuation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundStream::getChannelCount
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Return the number of channels of the stream.
+
1 channel means a mono sound, 2 means stereo, etc.
+
Returns Number of channels
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::Music::getDuration (
+ )
+ const
+
+
+
+
+
Get the total duration of the music.
+
Returns Music duration
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundStream::getLoop
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether or not the stream is in loop mode.
+
Returns True if the stream is looping, false otherwise
+
See also setLoop
+
+
+
+
+
◆
+
+
+
+
+
+ TimeSpan sf::Music::getLoopPoints (
+ )
+ const
+
+
+
+
+
Get the positions of the of the sound's looping sequence.
+
Returns Loop Time position class.
+
Warning Since setLoopPoints() performs some adjustments on the provided values and rounds them to internal samples, a call to getLoopPoints() is not guaranteed to return the same times passed into a previous call to setLoopPoints() . However, it is guaranteed to return times that will map to the valid internal samples of this Music if they are later passed to setLoopPoints() .
+
See also setLoopPoints
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getMinDistance
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getPitch
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the pitch of the sound.
+
Returns Pitch of the sound
+
See also setPitch
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time sf::SoundStream::getPlayingOffset (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the current playing position of the stream.
+
Returns Current playing position, from the beginning of the stream
+
See also setPlayingOffset
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Vector3f sf::SoundSource::getPosition (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the 3D position of the sound in the audio scene.
+
Returns Position of the sound
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundStream::getSampleRate
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the stream sample rate of the stream.
+
The sample rate is the number of audio samples played per second. The higher, the better the quality.
+
Returns Sample rate, in number of samples per second
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Status sf::SoundStream::getStatus (
+ )
+ const
+
+
+
+
+virtual inherited
+
+
+
+
+
Get the current status of the stream (stopped, paused, playing)
+
Returns Current status
+
+
Reimplemented from sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getVolume
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the volume of the sound.
+
Returns Volume of the sound, in the range [0, 100]
+
See also setVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::initialize
+ (
+ unsigned int
+ channelCount ,
+
+ unsigned int
+ sampleRate
+
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Define the audio stream parameters.
+
This function must be called by derived classes as soon as they know the audio settings of the stream to play. Any attempt to manipulate the stream (play() , ...) before calling this function will fail. It can be called multiple times if the settings of the audio stream change, but only when the stream is stopped.
+
Parameters
+
+ channelCount Number of channels of the stream sampleRate Sample rate, in samples per second
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundSource::isRelativeToListener
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the sound's position is relative to the listener or is absolute.
+
Returns True if the position is relative, false if it's absolute
+
See also setRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::Music::onGetData
+ (
+ Chunk & data )
+
+
+
+
+protected virtual
+
+
+
+
+
Request a new chunk of audio samples from the stream source.
+
This function fills the chunk from the next samples to read from the audio file.
+
Parameters
+
+ data Chunk of data to fill
+
+
+
Returns True to continue playback, false to stop
+
+
Implements sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::Music::onLoop
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Change the current playing position in the stream source to the loop offset.
+
This is called by the underlying SoundStream whenever it needs us to reset the seek position for a loop. We then determine whether we are looping on a loop point or the end-of-file, perform the seek, and return the new position.
+
Returns The seek position after looping (or -1 if there's no loop)
+
+
Reimplemented from sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::Music::onSeek
+ (
+ Time timeOffset )
+
+
+
+
+protected virtual
+
+
+
+
+
Change the current playing position in the stream source.
+
Parameters
+
+ timeOffset New playing position, from the beginning of the music
+
+
+
+
Implements sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Music::openFromFile
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Open a music from an audio file.
+
This function doesn't start playing the music (call play() to do so). See the documentation of sf::InputSoundFile for the list of supported formats.
+
Warning Since the music is not loaded at once but rather streamed continuously, the file must remain accessible until the sf::Music object loads a new music or is destroyed.
+
Parameters
+
+ filename Path of the music file to open
+
+
+
Returns True if loading succeeded, false if it failed
+
See also openFromMemory , openFromStream
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Music::openFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Open a music from an audio file in memory.
+
This function doesn't start playing the music (call play() to do so). See the documentation of sf::InputSoundFile for the list of supported formats.
+
Warning Since the music is not loaded at once but rather streamed continuously, the data buffer must remain accessible until the sf::Music object loads a new music or is destroyed. That is, you can't deallocate the buffer right after calling this function.
+
Parameters
+
+ data Pointer to the file data in memory sizeInBytes Size of the data to load, in bytes
+
+
+
Returns True if loading succeeded, false if it failed
+
See also openFromFile , openFromStream
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Music::openFromStream
+ (
+ InputStream & stream )
+
+
+
+
+
Open a music from an audio file in a custom stream.
+
This function doesn't start playing the music (call play() to do so). See the documentation of sf::InputSoundFile for the list of supported formats.
+
Warning Since the music is not loaded at once but rather streamed continuously, the stream must remain accessible until the sf::Music object loads a new music or is destroyed.
+
Parameters
+
+ stream Source stream to read from
+
+
+
Returns True if loading succeeded, false if it failed
+
See also openFromFile , openFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::pause
+ (
+ )
+
+
+
+
+virtual inherited
+
+
+
+
+
Pause the audio stream.
+
This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.
+
See also play , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::play
+ (
+ )
+
+
+
+
+virtual inherited
+
+
+
+
+
Start or resume playing the audio stream.
+
This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing. This function uses its own thread so that it doesn't block the rest of the program while the stream is played.
+
See also pause , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setAttenuation
+ (
+ float
+ attenuation )
+
+
+
+
+inherited
+
+
+
+
+
Set the attenuation factor of the sound.
+
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.
+
Parameters
+
+ attenuation New attenuation factor of the sound
+
+
+
See also getAttenuation , setMinDistance
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::setLoop
+ (
+ bool
+ loop )
+
+
+
+
+inherited
+
+
+
+
+
Set whether or not the stream should loop after reaching the end.
+
If set, the stream will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for streams is false.
+
Parameters
+
+ loop True to play in loop, false to play once
+
+
+
See also getLoop
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Music::setLoopPoints
+ (
+ TimeSpan timePoints )
+
+
+
+
+
Sets the beginning and end of the sound's looping sequence using sf::Time .
+
Loop points allow one to specify a pair of positions such that, when the music is enabled for looping, it will seamlessly seek to the beginning whenever it encounters the end. Valid ranges for timePoints.offset and timePoints.length are [0, Dur) and (0, Dur-offset] respectively, where Dur is the value returned by getDuration() . Note that the EOF "loop point" from the end to the beginning of the stream is still honored, in case the caller seeks to a point after the end of the loop range. This function can be safely called at any point after a stream is opened, and will be applied to a playing sound without affecting the current playing offset.
+
Warning Setting the loop points while the stream's status is Paused will set its status to Stopped. The playing offset will be unaffected.
+
Parameters
+
+ timePoints The definition of the loop. Can be any time points within the sound's length
+
+
+
See also getLoopPoints
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setMinDistance
+ (
+ float
+ distance )
+
+
+
+
+inherited
+
+
+
+
+
Set the minimum distance of the sound.
+
The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head
+of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.
+
Parameters
+
+ distance New minimum distance of the sound
+
+
+
See also getMinDistance , setAttenuation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPitch
+ (
+ float
+ pitch )
+
+
+
+
+inherited
+
+
+
+
+
Set the pitch of the sound.
+
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.
+
Parameters
+
+ pitch New pitch to apply to the sound
+
+
+
See also getPitch
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::setPlayingOffset
+ (
+ Time timeOffset )
+
+
+
+
+inherited
+
+
+
+
+
Change the current playing position of the stream.
+
The playing position can be changed when the stream is either paused or playing. Changing the playing position when the stream is stopped has no effect, since playing the stream would reset its position.
+
Parameters
+
+ timeOffset New playing position, from the beginning of the stream
+
+
+
See also getPlayingOffset
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ x X coordinate of the position of the sound in the scene y Y coordinate of the position of the sound in the scene z Z coordinate of the position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ const Vector3f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ position Position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setRelativeToListener
+ (
+ bool
+ relative )
+
+
+
+
+inherited
+
+
+
+
+
Make the sound's position relative to the listener or absolute.
+
Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).
+
Parameters
+
+ relative True to set the position relative, false to set it absolute
+
+
+
See also isRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setVolume
+ (
+ float
+ volume )
+
+
+
+
+inherited
+
+
+
+
+
Set the volume of the sound.
+
The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
+
Parameters
+
+ volume Volume of the sound
+
+
+
See also getVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::stop
+ (
+ )
+
+
+
+
+virtual inherited
+
+
+
+
+
Stop playing the audio stream.
+
This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause() ).
+
See also play , pause
+
+
Implements sf::SoundSource .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundSource::m_source
+
+
+
+
+protected inherited
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Mutex , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Blocks concurrent access to shared resources from multiple threads.
+ More...
+
+
#include <Mutex.hpp >
+
+
+
+
+
+
+
+
+
+
Blocks concurrent access to shared resources from multiple threads.
+
Mutex stands for "MUTual EXclusion".
+
A mutex is a synchronization object, used when multiple threads are involved.
+
When you want to protect a part of the code from being accessed simultaneously by multiple threads, you typically use a mutex. When a thread is locked by a mutex, any other thread trying to lock it will be blocked until the mutex is released by the thread that locked it. This way, you can allow only one thread at a time to access a critical region of your code.
+
Usage example:
Database database;
void thread1()
{
database.write(...);
}
void thread2()
{
database.write(...);
}
Be very careful with mutexes. A bad usage can lead to bad problems, like deadlocks (two threads are waiting for each other and the application is globally stuck).
+
To make the usage of mutexes more robust, particularly in environments where exceptions can be thrown, you should use the helper class sf::Lock to lock/unlock mutexes.
+
SFML mutexes are recursive, which means that you can lock a mutex multiple times in the same thread without creating a deadlock. In this case, the first call to lock() behaves as usual, and the following ones have no effect. However, you must call unlock() exactly as many times as you called lock() . If you don't, the mutex won't be released.
+
See also sf::Lock
+
+
Definition at line 47 of file Mutex.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Mutex::Mutex
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Mutex::~Mutex
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Mutex::lock
+ (
+ )
+
+
+
+
+
Lock the mutex.
+
If the mutex is already locked in another thread, this call will block the execution until the mutex is released.
+
See also unlock
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Mutex::unlock
+ (
+ )
+
+
+
+
+
Unlock the mutex.
+
See also lock
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::NonCopyable , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class that makes any derived class non-copyable.
+ More...
+
+
#include <NonCopyable.hpp >
+
+
+
+
+
+
+
+
+
+
Utility class that makes any derived class non-copyable.
+
This class makes its instances non-copyable, by explicitly disabling its copy constructor and its assignment operator.
+
To create a non-copyable class, simply inherit from sf::NonCopyable .
+
The type of inheritance (public or private) doesn't matter, the copy constructor and assignment operator are declared private in sf::NonCopyable so they will end up being inaccessible in both cases. Thus you can use a shorter syntax for inheriting from it (see below).
+
Usage example:
Deciding whether the instances of a class can be copied or not is a very important design choice. You are strongly encouraged to think about it before writing a class, and to use sf::NonCopyable when necessary to prevent many potential future errors when using it. This is also a very important indication to users of your class.
+
+
Definition at line 41 of file NonCopyable.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::NonCopyable::NonCopyable
+ (
+ )
+
+
+
+
+inline protected
+
+
+
+
+
Default constructor.
+
Because this class has a copy constructor, the compiler will not automatically generate the default constructor. That's why we must define it explicitly.
+
+
Definition at line 53 of file NonCopyable.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::NonCopyable::~NonCopyable
+ (
+ )
+
+
+
+
+inline protected
+
+
+
+
+
Default destructor.
+
By declaring a protected destructor it's impossible to call delete on a pointer of sf::NonCopyable , thus preventing possible resource leaks.
+
+
Definition at line 63 of file NonCopyable.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::OutputSoundFile , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Provide write access to sound files.
+ More...
+
+
#include <OutputSoundFile.hpp >
+
+
+
+
+
+
+
+
+
+
Provide write access to sound files.
+
This class encodes audio samples to a sound file.
+
It is used internally by higher-level classes such as sf::SoundBuffer , but can also be useful if you want to create audio files from custom data sources, like generated audio samples.
+
Usage example:
;
while (...)
{
std::vector<sf::Int16> samples = ...;
file.
write (samples.data(), samples.size());
}
See also sf::SoundFileWriter , sf::InputSoundFile
+
+
Definition at line 44 of file OutputSoundFile.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::OutputSoundFile::OutputSoundFile
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::OutputSoundFile::~OutputSoundFile
+ (
+ )
+
+
+
+
+
Destructor.
+
Closes the file if it was still open.
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::OutputSoundFile::openFromFile
+ (
+ const std::string &
+ filename ,
+
+ unsigned int
+ sampleRate ,
+
+ unsigned int
+ channelCount
+
+ )
+
+
+
+
+
Open the sound file from the disk for writing.
+
The supported audio formats are: WAV, OGG/Vorbis, FLAC.
+
Parameters
+
+ filename Path of the sound file to write sampleRate Sample rate of the sound channelCount Number of channels in the sound
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::OutputSoundFile::write
+ (
+ const Int16 *
+ samples ,
+
+ Uint64
+ count
+
+ )
+
+
+
+
+
Write audio samples to the file.
+
Parameters
+
+ samples Pointer to the sample array to write count Number of samples to write
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Packet , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class to build blocks of data to transfer over the network.
+ More...
+
+
#include <Packet.hpp >
+
+ Packet () Default constructor. More... virtual ~Packet () Virtual destructor. More... void append (const void *data, std::size_t sizeInBytes) Append data to the end of the packet. More... void clear () Clear the packet. More... const void * getData () const Get a pointer to the data contained in the packet. More... std::size_t getDataSize () const Get the size of the data contained in the packet. More... bool endOfPacket () const Tell if the reading position has reached the end of the packet. More... operator BoolType () const Test the validity of the packet, for reading. More... Packet & operator>> (bool &data) Overload of operator >> to read data from the packet. More... Packet & operator>> (Int8 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Uint8 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Int16 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Uint16 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Int32 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Uint32 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Int64 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (Uint64 &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (float &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (double &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (char *data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (std::string &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (wchar_t *data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (std::wstring &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator>> (String &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (bool data) Overload of operator << to write data into the packet. More... Packet & operator<< (Int8 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Uint8 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Int16 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Uint16 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Int32 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Uint32 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Int64 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (Uint64 data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (float data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (double data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (const char *data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (const std::string &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (const wchar_t *data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (const std::wstring &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More... Packet & operator<< (const String &data) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
+virtual const void * onSend (std::size_t &size) Called before the packet is sent over the network. More... virtual void onReceive (const void *data, std::size_t size) Called after the packet is received over the network. More...
+TcpSocket UdpSocket
+
+
Utility class to build blocks of data to transfer over the network.
+
Packets provide a safe and easy way to serialize data, in order to send it over the network using sockets (sf::TcpSocket , sf::UdpSocket ).
+
Packets solve 2 fundamental problems that arise when transferring data over the network:
+data is interpreted correctly according to the endianness
+the bounds of the packet are preserved (one send == one receive)
+
+
The sf::Packet class provides both input and output modes. It is designed to follow the behavior of standard C++ streams, using operators >> and << to extract and insert data.
+
It is recommended to use only fixed-size types (like sf::Int32, etc.), to avoid possible differences between the sender and the receiver. Indeed, the native C++ types may have different sizes on two platforms and your data may be corrupted if that happens.
+
Usage example:
sf::Uint32 x = 24;
std::string s = "hello" ;
double d = 5.89;
packet << x << s << d;
socket.send(packet);
-----------------------------------------------------------------
socket.receive(packet);
sf::Uint32 x;
std::string s;
double d;
if (packet >> x >> s >> d)
{
}
Packets have built-in operator >> and << overloads for standard types:
+bool
+fixed-size integer types (sf::Int8/16/32, sf::Uint8/16/32)
+floating point numbers (float, double)
+string types (char*, wchar_t*, std::string, std::wstring, sf::String )
+
+
Like standard streams, it is also possible to define your own overloads of operators >> and << in order to handle your custom types.
+
struct MyStruct
{
float number;
sf::Int8 integer;
std::string str;
};
{
return packet << m.number << m.integer << m.str;
}
{
return packet >> m.number >> m.integer >> m.str;
}
Packets also provide an extra feature that allows to apply custom transformations to the data before it is sent, and after it is received. This is typically used to handle automatic compression or encryption of the data. This is achieved by inheriting from sf::Packet , and overriding the onSend and onReceive functions.
+
Here is an example:
{
virtual const void *
onSend (std::size_t& size)
{
return MySuperZipFunction(srcData, srcSize, &size);
}
virtual void onReceive (
const void * data, std::size_t size)
{
std::size_t dstSize;
const void * dstData = MySuperUnzipFunction(data, size, &dstSize);
}
};
ZipPacket packet;
packet << x << s << d;
...
See also sf::TcpSocket , sf::UdpSocket
+
+
Definition at line 47 of file Packet.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Packet::Packet
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty packet.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Packet::~Packet
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Virtual destructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Packet::append
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Append data to the end of the packet.
+
Parameters
+
+ data Pointer to the sequence of bytes to append sizeInBytes Number of bytes to append
+
+
+
See also clear
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Packet::clear
+ (
+ )
+
+
+
+
+
Clear the packet.
+
After calling Clear, the packet is empty.
+
See also append
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Packet::endOfPacket
+ (
+ )
+ const
+
+
+
+
+
Tell if the reading position has reached the end of the packet.
+
This function is useful to know if there is some data left to be read, without actually reading it.
+
Returns True if all data was read, false otherwise
+
See also operator bool
+
+
+
+
+
◆
+
+
+
+
+
+ const void* sf::Packet::getData
+ (
+ )
+ const
+
+
+
+
+
Get a pointer to the data contained in the packet.
+
Warning: the returned pointer may become invalid after you append data to the packet, therefore it should never be stored. The return pointer is NULL if the packet is empty.
+
Returns Pointer to the data
+
See also getDataSize
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::Packet::getDataSize
+ (
+ )
+ const
+
+
+
+
+
Get the size of the data contained in the packet.
+
This function returns the number of bytes pointed to by what getData returns.
+
Returns Data size, in bytes
+
See also getData
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::Packet::onReceive
+ (
+ const void *
+ data ,
+
+ std::size_t
+ size
+
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Called after the packet is received over the network.
+
This function can be defined by derived classes to transform the data after it is received; this can be used for decompression, decryption, etc. The function receives a pointer to the received data, and must fill the packet with the transformed bytes. The default implementation fills the packet directly without transforming the data.
+
Parameters
+
+ data Pointer to the received bytes size Number of bytes
+
+
+
See also onSend
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual const void* sf::Packet::onSend
+ (
+ std::size_t &
+ size )
+
+
+
+
+protected virtual
+
+
+
+
+
Called before the packet is sent over the network.
+
This function can be defined by derived classes to transform the data before it is sent; this can be used for compression, encryption, etc. The function must return a pointer to the modified data, as well as the number of bytes pointed. The default implementation provides the packet's data without transforming it.
+
Parameters
+
+ size Variable to fill with the size of data to send
+
+
+
Returns Pointer to the array of bytes to send
+
See also onReceive
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Packet::operator BoolType
+ (
+ )
+ const
+
+
+
+
+
Test the validity of the packet, for reading.
+
This operator allows to test the packet as a boolean variable, to check if a reading operation was successful.
+
A packet will be in an invalid state if it has no more data to read.
+
This behavior is the same as standard C++ streams.
+
Usage example:
float x;
packet >> x;
if (packet)
{
}
float x;
if (packet >> x)
{
}
Don't focus on the return type, it's equivalent to bool but it disallows unwanted implicit conversions to integer or pointer types.
+
Returns True if last data extraction from packet was successful
+
See also endOfPacket
+
+
+
+
+
◆ [1/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ bool
+ data )
+
+
+
+
+
Overload of operator << to write data into the packet.
+
+
+
+
+
◆ [2/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Int8
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [3/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Uint8
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [4/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Int16
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [5/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Uint16
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [6/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Int32
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [7/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Uint32
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [8/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Int64
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [9/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ Uint64
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [10/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ float
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [11/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ double
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [12/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ const char *
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [13/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ const std::string &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [14/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ const wchar_t *
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [15/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ const std::wstring &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [16/16]
+
+
+
+
+
+ Packet & sf::Packet::operator<< (
+ const String &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [1/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ bool &
+ data )
+
+
+
+
+
Overload of operator >> to read data from the packet.
+
+
+
+
+
◆ [2/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Int8 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [3/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Uint8 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [4/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Int16 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [5/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Uint16 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [6/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Int32 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [7/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Uint32 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [8/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Int64 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [9/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ Uint64 &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [10/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ float &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [11/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ double &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [12/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ char *
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [13/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ std::string &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [14/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ wchar_t *
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [15/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ std::wstring &
+ data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
+
◆ [16/16]
+
+
+
+
+
+ Packet & sf::Packet::operator>> (
+ String & data )
+
+
+
+
+
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Rect< T > , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class for manipulating 2D axis aligned rectangles.
+ More...
+
+
#include <Rect.hpp >
+
+ Rect () Default constructor. More... Rect (T rectLeft, T rectTop, T rectWidth, T rectHeight) Construct the rectangle from its coordinates. More... Rect (const Vector2 < T > &position, const Vector2 < T > &size) Construct the rectangle from position and size. More... template<typename U > Rect (const Rect < U > &rectangle) Construct the rectangle from another type of rectangle. More... bool contains (T x, T y) const Check if a point is inside the rectangle's area. More... bool contains (const Vector2 < T > &point) const Check if a point is inside the rectangle's area. More... bool intersects (const Rect < T > &rectangle) const Check the intersection between two rectangles. More... bool intersects (const Rect < T > &rectangle, Rect < T > &intersection) const Check the intersection between two rectangles. More...
+(Note that these are not member functions.)
+template<typename T > bool operator== (const Rect < T > &left , const Rect < T > &right) Overload of binary operator ==. More... template<typename T > bool operator!= (const Rect < T > &left , const Rect < T > &right) Overload of binary operator !=. More...
+
+
template<typename T>
+
+
Utility class for manipulating 2D axis aligned rectangles.
+
A rectangle is defined by its top-left corner and its size.
+
It is a very simple class defined for convenience, so its member variables (left, top, width and height) are public and can be accessed directly, just like the vector classes (Vector2 and Vector3 ).
+
To keep things simple, sf::Rect doesn't define functions to emulate the properties that are not directly members (such as right, bottom, center, etc.), it rather only provides intersection functions.
+
sf::Rect uses the usual rules for its boundaries:
+The left and top edges are included in the rectangle's area
+The right (left + width) and bottom (top + height) edges are excluded from the rectangle's area
+
+
This means that sf::IntRect(0, 0, 1, 1) and sf::IntRect(1, 1, 1, 1) don't intersect.
+
sf::Rect is a template and may be used with any numeric type, but for simplicity the instantiations used by SFML are typedef'd:
+sf::Rect<int> is sf::IntRect
+sf::Rect<float> is sf::FloatRect
+
+
So that you don't have to care about the template syntax.
+
Usage example:
bool b1 = r1.contains(3, 1);
bool b2 = r2.contains(3, 1);
+
Definition at line 42 of file Rect.hpp .
+
+
+
◆ [1/4]
+
+
+
+
+template<typename T>
+
+
+
+
Default constructor.
+
Creates an empty rectangle (it is equivalent to calling Rect(0, 0, 0, 0)).
+
+
+
+
+
◆ [2/4]
+
+
+
+
+template<typename T>
+
+
+ sf::Rect < T >::Rect (
+ T
+ rectLeft ,
+
+ T
+ rectTop ,
+
+ T
+ rectWidth ,
+
+ T
+ rectHeight
+
+ )
+
+
+
+
+
Construct the rectangle from its coordinates.
+
Be careful, the last two parameters are the width and height, not the right and bottom coordinates!
+
Parameters
+
+ rectLeft Left coordinate of the rectangle rectTop Top coordinate of the rectangle rectWidth Width of the rectangle rectHeight Height of the rectangle
+
+
+
+
+
+
+
◆ [3/4]
+
+
+
+
+template<typename T>
+
+
+
+
Construct the rectangle from position and size.
+
Be careful, the last parameter is the size, not the bottom-right corner!
+
Parameters
+
+ position Position of the top-left corner of the rectangle size Size of the rectangle
+
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+template<typename T>
+
+template<typename U >
+
+
+
+
Construct the rectangle from another type of rectangle.
+
This constructor doesn't replace the copy constructor, it's called only when U != T. A call to this constructor will fail to compile if U is not convertible to T.
+
Parameters
+
+ rectangle Rectangle to convert
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+ bool sf::Rect < T >::contains
+ (
+ T
+ x ,
+
+ T
+ y
+
+ )
+ const
+
+
+
+
+
Check if a point is inside the rectangle's area.
+
This check is non-inclusive. If the point lies on the edge of the rectangle, this function will return false.
+
Parameters
+
+ x X coordinate of the point to test y Y coordinate of the point to test
+
+
+
Returns True if the point is inside, false otherwise
+
See also intersects
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+ bool sf::Rect < T >::contains
+ (
+ const Vector2 < T > &
+ point )
+ const
+
+
+
+
+
Check if a point is inside the rectangle's area.
+
This check is non-inclusive. If the point lies on the edge of the rectangle, this function will return false.
+
Parameters
+
+
+
+
Returns True if the point is inside, false otherwise
+
See also intersects
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+ bool sf::Rect < T >::intersects
+ (
+ const Rect < T > &
+ rectangle )
+ const
+
+
+
+
+
Check the intersection between two rectangles.
+
Parameters
+
+ rectangle Rectangle to test
+
+
+
Returns True if rectangles overlap, false otherwise
+
See also contains
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+ bool sf::Rect < T >::intersects
+ (
+ const Rect < T > &
+ rectangle ,
+
+ Rect < T > & intersection
+
+ )
+ const
+
+
+
+
+
Check the intersection between two rectangles.
+
This overload returns the overlapped rectangle in the intersection parameter.
+
Parameters
+
+ rectangle Rectangle to test intersection Rectangle to be filled with the intersection
+
+
+
Returns True if rectangles overlap, false otherwise
+
See also contains
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator!=
+ (
+ const Rect < T > &
+ left ,
+
+ const Rect < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator !=.
+
This operator compares strict difference between two rectangles.
+
Parameters
+
+ left Left operand (a rectangle) right Right operand (a rectangle)
+
+
+
Returns True if left is not equal to right
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator==
+ (
+ const Rect < T > &
+ left ,
+
+ const Rect < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator ==.
+
This operator compares strict equality between two rectangles.
+
Parameters
+
+ left Left operand (a rectangle) right Right operand (a rectangle)
+
+
+
Returns True if left is equal to right
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Height of the rectangle.
+
+
Definition at line 160 of file Rect.hpp .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Left coordinate of the rectangle.
+
+
Definition at line 157 of file Rect.hpp .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Top coordinate of the rectangle.
+
+
Definition at line 158 of file Rect.hpp .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Width of the rectangle.
+
+
Definition at line 159 of file Rect.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::RectangleShape , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized shape representing a rectangle.
+ More...
+
+
#include <RectangleShape.hpp >
+
+
+
+
+
+
+
+
+void update () Recompute the internal geometry of the shape. More...
+
+
Specialized shape representing a rectangle.
+
This class inherits all the functions of sf::Transformable (position, rotation, scale, bounds, ...) as well as the functions of sf::Shape (outline, color, texture, ...).
+
Usage example:
...
window.draw(rectangle);
See also sf::Shape , sf::CircleShape , sf::ConvexShape
+
+
Definition at line 41 of file RectangleShape.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::RectangleShape::RectangleShape
+ (
+ const Vector2f &
+ size = Vector2f (0, 0))
+
+
+
+
+explicit
+
+
+
+
+
Default constructor.
+
Parameters
+
+ size Size of the rectangle
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getFillColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the fill color of the shape.
+
Returns Fill color of the shape
+
See also setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getGlobalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the global (non-minimal) bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the shape in the global 2D world's coordinate system.
+
This function does not necessarily return the minimal bounding rectangle. It merely ensures that the returned rectangle covers all the vertices (but possibly more). This allows for a fast approximation of the bounds as a first check; you may want to use more precise checks on top of that.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ FloatRect sf::Shape::getLocalBounds (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Color & sf::Shape::getOutlineColor
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline color of the shape.
+
Returns Outline color of the shape
+
See also setOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Shape::getOutlineThickness
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the outline thickness of the shape.
+
Returns Outline thickness of the shape
+
See also setOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2f sf::RectangleShape::getPoint
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get a point of the rectangle.
+
The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account. The result is undefined if index is out of the valid range.
+
Parameters
+
+ index Index of the point to get, in range [0 .. 3]
+
+
+
Returns index-th point of the shape
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual std::size_t sf::RectangleShape::getPointCount
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the number of points defining the shape.
+
Returns Number of points of the shape. For rectangle shapes, this number is always 4.
+
+
Implements sf::Shape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::RectangleShape::getSize
+ (
+ )
+ const
+
+
+
+
+
Get the size of the rectangle.
+
Returns Size of the rectangle
+
See also setSize
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Texture * sf::Shape::getTexture
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the source texture of the shape.
+
If the shape has no source texture, a NULL pointer is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.
+
Returns Pointer to the shape's texture
+
See also setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const IntRect & sf::Shape::getTextureRect
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the sub-rectangle of the texture displayed by the shape.
+
Returns Texture rectangle of the shape
+
See also setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setFillColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the fill color of the shape.
+
This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sf::Color::Transparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.
+
Parameters
+
+ color New color of the shape
+
+
+
See also getFillColor , setOutlineColor
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineColor
+ (
+ const Color &
+ color )
+
+
+
+
+inherited
+
+
+
+
+
Set the outline color of the shape.
+
By default, the shape's outline color is opaque white.
+
Parameters
+
+ color New outline color of the shape
+
+
+
See also getOutlineColor , setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setOutlineThickness
+ (
+ float
+ thickness )
+
+
+
+
+inherited
+
+
+
+
+
Set the thickness of the shape's outline.
+
Note that negative values are allowed (so that the outline expands towards the center of the shape), and using zero disables the outline. By default, the outline thickness is 0.
+
Parameters
+
+ thickness New outline thickness
+
+
+
See also getOutlineThickness
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RectangleShape::setSize
+ (
+ const Vector2f &
+ size )
+
+
+
+
+
Set the size of the rectangle.
+
Parameters
+
+ size New size of the rectangle
+
+
+
See also getSize
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTexture
+ (
+ const Texture *
+ texture ,
+
+ bool
+ resetRect = false
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Change the source texture of the shape.
+
The texture argument refers to a texture that must exist as long as the shape uses it. Indeed, the shape doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the shape tries to use it, the behavior is undefined. texture can be NULL to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.
+
Parameters
+
+ texture New texture resetRect Should the texture rect be reset to the size of the new texture?
+
+
+
See also getTexture , setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::setTextureRect
+ (
+ const IntRect &
+ rect )
+
+
+
+
+inherited
+
+
+
+
+
Set the sub-rectangle of the texture that the shape will display.
+
The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.
+
Parameters
+
+ rect Rectangle defining the region of the texture to display
+
+
+
See also getTextureRect , setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::update
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Recompute the internal geometry of the shape.
+
This function must be called by the derived class everytime the shape's points change (i.e. the result of either getPointCount or getPoint is different).
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::RenderStates , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define the states used for drawing to a RenderTarget .
+ More...
+
+
#include <RenderStates.hpp >
+
+
+
Define the states used for drawing to a RenderTarget .
+
There are four global states that can be applied to the drawn objects:
+
+the blend mode: how pixels of the object are blended with the background
+the transform: how the object is positioned/rotated/scaled
+the texture: what image is mapped to the object
+the shader: what custom effect is applied to the object
+
+
High-level objects such as sprites or text force some of these states when they are drawn. For example, a sprite will set its own texture, so that you don't have to care about it when drawing the sprite.
+
The transform is a special case: sprites, texts and shapes (and it's a good idea to do it with your own drawable classes too) combine their transform with the one that is passed in the RenderStates structure. So that you can use a "global" transform on top of each object's transform.
+
Most objects, especially high-level drawables, can be drawn directly without defining render states explicitly – the default set of states is ok in most cases.
If you want to use a single specific render state, for example a shader, you can pass it directly to the Draw function: sf::RenderStates has an implicit one-argument constructor for each state.
When you're inside the Draw function of a drawable object (inherited from sf::Drawable ), you can either pass the render states unmodified, or change some of them. For example, a transformable object will combine the current transform with its own transform. A sprite will set its texture. Etc.
+
See also sf::RenderTarget , sf::Drawable
+
+
Definition at line 45 of file RenderStates.hpp .
+
+
+
◆ [1/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ )
+
+
+
+
+
Default constructor.
+
Constructing a default set of render states is equivalent to using sf::RenderStates::Default . The default set defines:
+the BlendAlpha blend mode
+the identity transform
+a null texture
+a null shader
+
+
+
+
+
+
◆ [2/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ const BlendMode &
+ theBlendMode )
+
+
+
+
+
Construct a default set of render states with a custom blend mode.
+
Parameters
+
+ theBlendMode Blend mode to use
+
+
+
+
+
+
+
◆ [3/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ const Transform &
+ theTransform )
+
+
+
+
+
Construct a default set of render states with a custom transform.
+
Parameters
+
+
+
+
+
+
+
+
◆ [4/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ const Texture *
+ theTexture )
+
+
+
+
+
Construct a default set of render states with a custom texture.
+
Parameters
+
+
+
+
+
+
+
+
◆ [5/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ const Shader *
+ theShader )
+
+
+
+
+
Construct a default set of render states with a custom shader.
+
Parameters
+
+
+
+
+
+
+
+
◆ [6/6]
+
+
+
+
+
+ sf::RenderStates::RenderStates
+ (
+ const BlendMode &
+ theBlendMode ,
+
+ const Transform &
+ theTransform ,
+
+ const Texture *
+ theTexture ,
+
+ const Shader *
+ theShader
+
+ )
+
+
+
+
+
Construct a set of render states with all its attributes.
+
Parameters
+
+ theBlendMode Blend mode to use theTransform Transform to use theTexture Texture to use theShader Shader to use
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ BlendMode sf::RenderStates::blendMode
+
+
+
+
+
◆
+
+
+
+
+
Special instance holding the default render states.
+
+
Definition at line 110 of file RenderStates.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ const Shader * sf::RenderStates::shader
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Texture * sf::RenderStates::texture
+
+
+
+
+
+
◆
+
+
+
+
+
+ Transform sf::RenderStates::transform
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::RenderTarget , including all inherited members.
+
+ clear (const Color &color=Color(0, 0, 0, 255))sf::RenderTarget draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default)sf::RenderTarget getDefaultView () constsf::RenderTarget getSize () const =0sf::RenderTarget pure virtual getView () constsf::RenderTarget getViewport (const View &view) constsf::RenderTarget initialize ()sf::RenderTarget protected mapCoordsToPixel (const Vector2f &point) constsf::RenderTarget mapCoordsToPixel (const Vector2f &point, const View &view) constsf::RenderTarget mapPixelToCoords (const Vector2i &point) constsf::RenderTarget mapPixelToCoords (const Vector2i &point, const View &view) constsf::RenderTarget NonCopyable ()sf::NonCopyable inline private popGLStates ()sf::RenderTarget pushGLStates ()sf::RenderTarget RenderTarget ()sf::RenderTarget protected resetGLStates ()sf::RenderTarget setActive (bool active=true)sf::RenderTarget virtual setView (const View &view)sf::RenderTarget ~NonCopyable ()sf::NonCopyable inline private ~RenderTarget ()sf::RenderTarget virtual
SFML - Simple and Fast Multimedia Library
+
+
+
Base class for all render targets (window, texture, ...)
+ More...
+
+
#include <RenderTarget.hpp >
+
+
+
+
+
+
+
+
+virtual ~RenderTarget () Destructor. More... void clear (const Color &color=Color (0, 0, 0, 255)) Clear the entire target with a single color. More... void setView (const View &view) Change the current active view. More... const View & getView () const Get the view currently in use in the render target. More... const View & getDefaultView () const Get the default view of the render target. More... IntRect getViewport (const View &view) const Get the viewport of a view, applied to this render target. More... Vector2f mapPixelToCoords (const Vector2i &point) const Convert a point from target coordinates to world coordinates, using the current view. More... Vector2f mapPixelToCoords (const Vector2i &point, const View &view) const Convert a point from target coordinates to world coordinates. More... Vector2i mapCoordsToPixel (const Vector2f &point) const Convert a point from world coordinates to target coordinates, using the current view. More... Vector2i mapCoordsToPixel (const Vector2f &point, const View &view) const Convert a point from world coordinates to target coordinates. More... void draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default ) Draw a drawable object to the render target. More... void draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default ) Draw primitives defined by an array of vertices. More... void draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... void draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... virtual Vector2u getSize () const =0 Return the size of the rendering region of the target. More... virtual bool setActive (bool active=true) Activate or deactivate the render target for rendering. More... void pushGLStates () Save the current OpenGL render states and matrices. More... void popGLStates () Restore the previously saved OpenGL render states and matrices. More... void resetGLStates () Reset the internal OpenGL states so that the target is ready for drawing. More...
+
+
Base class for all render targets (window, texture, ...)
+
sf::RenderTarget defines the common behavior of all the 2D render targets usable in the graphics module.
+
It makes it possible to draw 2D entities like sprites, shapes, text without using any OpenGL command directly.
+
A sf::RenderTarget is also able to use views (sf::View ), which are a kind of 2D cameras. With views you can globally scroll, rotate or zoom everything that is drawn, without having to transform every single entity. See the documentation of sf::View for more details and sample pieces of code about this class.
+
On top of that, render targets are still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands. When doing so, make sure that OpenGL states are not messed up by calling the pushGLStates/popGLStates functions.
+
See also sf::RenderWindow , sf::RenderTexture , sf::View
+
+
Definition at line 52 of file RenderTarget.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::RenderTarget::~RenderTarget
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::RenderTarget::RenderTarget
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTarget::clear
+ (
+ const Color &
+ color = Color (0, 0, 0, 255))
+
+
+
+
+
Clear the entire target with a single color.
+
This function is usually called once every frame, to clear the previous contents of the target.
+
Parameters
+
+ color Fill color to use to clear the render target
+
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
Draw a drawable object to the render target.
+
Parameters
+
+ drawable Object to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
Draw primitives defined by an array of vertices.
+
Parameters
+
+ vertices Pointer to the vertices vertexCount Number of vertices in the array type Type of primitives to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer states Render states to use for drawing
+
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void sf::RenderTarget::draw
+ (
+ const VertexBuffer &
+ vertexBuffer ,
+
+ std::size_t
+ firstVertex ,
+
+ std::size_t
+ vertexCount ,
+
+ const RenderStates &
+ states = RenderStates::Default
+
+ )
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer firstVertex Index of the first vertex to render vertexCount Number of vertices to render states Render states to use for drawing
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const View & sf::RenderTarget::getDefaultView
+ (
+ )
+ const
+
+
+
+
+
Get the default view of the render target.
+
The default view has the initial size of the render target, and never changes after the target has been created.
+
Returns The default view of the render target
+
See also setView , getView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2u sf::RenderTarget::getSize
+ (
+ )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+ const View & sf::RenderTarget::getView
+ (
+ )
+ const
+
+
+
+
+
Get the view currently in use in the render target.
+
Returns The view object that is currently used
+
See also setView , getDefaultView
+
+
+
+
+
◆
+
+
+
+
+
+ IntRect sf::RenderTarget::getViewport (
+ const View &
+ view )
+ const
+
+
+
+
+
Get the viewport of a view, applied to this render target.
+
The viewport is defined in the view as a ratio, this function simply applies this ratio to the current dimensions of the render target to calculate the pixels rectangle that the viewport actually covers in the target.
+
Parameters
+
+ view The view for which we want to compute the viewport
+
+
+
Returns Viewport rectangle, expressed in pixels
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::initialize
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Performs the common initialization step after creation.
+
The derived classes must call this function after the target is created and ready for drawing.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point )
+ const
+
+
+
+
+
Convert a point from world coordinates to target coordinates, using the current view.
+
This function is an overload of the mapCoordsToPixel function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Point to convert
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+
Convert a point from world coordinates to target coordinates.
+
This function finds the pixel of the render target that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render target – if the view is translated by (140, 25).
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Point to convert view The view to use for converting the point
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point )
+ const
+
+
+
+
+
Convert a point from target coordinates to world coordinates, using the current view.
+
This function is an overload of the mapPixelToCoords function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Pixel to convert
+
+
+
Returns The converted point, in "world" coordinates
+
See also mapCoordsToPixel
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+
Convert a point from target coordinates to world coordinates.
+
This function finds the 2D position that matches the given pixel of the render target. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (10, 50) in your render target may map to the point (150, 75) in your 2D world – if the view is translated by (140, 25).
+
For render-windows, this function is typically used to find which point (or object) is located below the mouse cursor.
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Pixel to convert view The view to use for converting the point
+
+
+
Returns The converted point, in "world" units
+
See also mapCoordsToPixel
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTarget::popGLStates
+ (
+ )
+
+
+
+
+
Restore the previously saved OpenGL render states and matrices.
+
See the description of pushGLStates to get a detailed description of these functions.
+
See also pushGLStates
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTarget::pushGLStates
+ (
+ )
+
+
+
+
+
Save the current OpenGL render states and matrices.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with popGLStates, it ensures that:
+SFML's internal states are not messed up by your OpenGL code
+your OpenGL states are not modified by a call to a SFML function
+
+
More specifically, it must be used around code that calls Draw functions. Example:
window.pushGLStates();
window.draw(...);
window.draw(...);
window.popGLStates();
Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the resetGLStates function if you do so.
+
See also popGLStates
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTarget::resetGLStates
+ (
+ )
+
+
+
+
+
Reset the internal OpenGL states so that the target is ready for drawing.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use pushGLStates/popGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent draw() calls will work as expected.
+
Example:
glPushAttrib(...);
window.resetGLStates();
window.draw(...);
window.draw(...);
glPopAttrib(...);
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::RenderTarget::setActive
+ (
+ bool
+ active = true)
+
+
+
+
+virtual
+
+
+
+
+
Activate or deactivate the render target for rendering.
+
This function makes the render target's context current for future OpenGL rendering operations (so you shouldn't care about it if you're not doing direct OpenGL stuff). A render target's context is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one context can be current in a thread, so if you want to draw OpenGL geometry to another render target don't forget to activate it again. Activating a render target will automatically deactivate the previously active context (if any).
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True if operation was successful, false otherwise
+
+
Reimplemented in sf::RenderTexture , and sf::RenderWindow .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTarget::setView
+ (
+ const View &
+ view )
+
+
+
+
+
Change the current active view.
+
The view is like a 2D camera, it controls which part of the 2D scene is visible, and how it is viewed in the render target. The new view will affect everything that is drawn, until another view is set. The render target keeps its own copy of the view object, so it is not necessary to keep the original one alive after calling this function. To restore the original view of the target, you can pass the result of getDefaultView() to this function.
+
Parameters
+
+
+
+
See also getView , getDefaultView
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::RenderTexture , including all inherited members.
+
+ clear (const Color &color=Color(0, 0, 0, 255))sf::RenderTarget create (unsigned int width, unsigned int height, bool depthBuffer)sf::RenderTexture create (unsigned int width, unsigned int height, const ContextSettings &settings=ContextSettings())sf::RenderTexture display ()sf::RenderTexture draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default)sf::RenderTarget generateMipmap ()sf::RenderTexture getDefaultView () constsf::RenderTarget getMaximumAntialiasingLevel ()sf::RenderTexture static getSize () constsf::RenderTexture virtual getTexture () constsf::RenderTexture getView () constsf::RenderTarget getViewport (const View &view) constsf::RenderTarget initialize ()sf::RenderTarget protected isRepeated () constsf::RenderTexture isSmooth () constsf::RenderTexture mapCoordsToPixel (const Vector2f &point) constsf::RenderTarget mapCoordsToPixel (const Vector2f &point, const View &view) constsf::RenderTarget mapPixelToCoords (const Vector2i &point) constsf::RenderTarget mapPixelToCoords (const Vector2i &point, const View &view) constsf::RenderTarget popGLStates ()sf::RenderTarget pushGLStates ()sf::RenderTarget RenderTarget ()sf::RenderTarget protected RenderTexture ()sf::RenderTexture resetGLStates ()sf::RenderTarget setActive (bool active=true)sf::RenderTexture virtual setRepeated (bool repeated)sf::RenderTexture setSmooth (bool smooth)sf::RenderTexture setView (const View &view)sf::RenderTarget ~RenderTarget ()sf::RenderTarget virtual ~RenderTexture ()sf::RenderTexture virtual
SFML - Simple and Fast Multimedia Library
+
+
+
Target for off-screen 2D rendering into a texture.
+ More...
+
+
#include <RenderTexture.hpp >
+
+
+
+
+
+
+
+
+ RenderTexture () Default constructor. More... virtual ~RenderTexture () Destructor. More... bool create (unsigned int width, unsigned int height, bool depthBuffer) Create the render-texture. More... bool create (unsigned int width, unsigned int height, const ContextSettings &settings=ContextSettings ()) Create the render-texture. More... void setSmooth (bool smooth) Enable or disable texture smoothing. More... bool isSmooth () const Tell whether the smooth filtering is enabled or not. More... void setRepeated (bool repeated) Enable or disable texture repeating. More... bool isRepeated () const Tell whether the texture is repeated or not. More... bool generateMipmap () Generate a mipmap using the current texture data. More... bool setActive (bool active=true) Activate or deactivate the render-texture for rendering. More... void display () Update the contents of the target texture. More... virtual Vector2u getSize () const Return the size of the rendering region of the texture. More... const Texture & getTexture () const Get a read-only reference to the target texture. More... void clear (const Color &color=Color (0, 0, 0, 255)) Clear the entire target with a single color. More... void setView (const View &view) Change the current active view. More... const View & getView () const Get the view currently in use in the render target. More... const View & getDefaultView () const Get the default view of the render target. More... IntRect getViewport (const View &view) const Get the viewport of a view, applied to this render target. More... Vector2f mapPixelToCoords (const Vector2i &point) const Convert a point from target coordinates to world coordinates, using the current view. More... Vector2f mapPixelToCoords (const Vector2i &point, const View &view) const Convert a point from target coordinates to world coordinates. More... Vector2i mapCoordsToPixel (const Vector2f &point) const Convert a point from world coordinates to target coordinates, using the current view. More... Vector2i mapCoordsToPixel (const Vector2f &point, const View &view) const Convert a point from world coordinates to target coordinates. More... void draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default ) Draw a drawable object to the render target. More... void draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default ) Draw primitives defined by an array of vertices. More... void draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... void draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... void pushGLStates () Save the current OpenGL render states and matrices. More... void popGLStates () Restore the previously saved OpenGL render states and matrices. More... void resetGLStates () Reset the internal OpenGL states so that the target is ready for drawing. More...
+void initialize () Performs the common initialization step after creation. More...
+
+
Target for off-screen 2D rendering into a texture.
+
sf::RenderTexture is the little brother of sf::RenderWindow .
+
It implements the same 2D drawing and OpenGL-related functions (see their base class sf::RenderTarget for more details), the difference is that the result is stored in an off-screen texture rather than being show in a window.
+
Rendering to a texture can be useful in a variety of situations:
+precomputing a complex static texture (like a level's background from multiple tiles)
+applying post-effects to the whole scene with shaders
+creating a sprite from a 3D object rendered with OpenGL
+etc.
+
+
Usage example:
+
if (!texture.
create (500, 500))
return -1;
{
window.clear();
window.draw(sprite);
}
Like sf::RenderWindow , sf::RenderTexture is still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands. If you need a depth buffer for 3D rendering, don't forget to request it when calling RenderTexture::create .
+
See also sf::RenderTarget , sf::RenderWindow , sf::View , sf::Texture
+
+
Definition at line 48 of file RenderTexture.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::RenderTexture::RenderTexture
+ (
+ )
+
+
+
+
+
Default constructor.
+
Constructs an empty, invalid render-texture. You must call create to have a valid render-texture.
+
See also create
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::RenderTexture::~RenderTexture
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::clear
+ (
+ const Color &
+ color = Color (0, 0, 0, 255))
+
+
+
+
+inherited
+
+
+
+
+
Clear the entire target with a single color.
+
This function is usually called once every frame, to clear the previous contents of the target.
+
Parameters
+
+ color Fill color to use to clear the render target
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool sf::RenderTexture::create
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ bool
+ depthBuffer
+
+ )
+
+
+
+
+
Create the render-texture.
+
Before calling this function, the render-texture is in an invalid state, thus it is mandatory to call it before doing anything with the render-texture. The last parameter, depthBuffer , is useful if you want to use the render-texture for 3D OpenGL rendering that requires a depth buffer. Otherwise it is unnecessary, and you should leave this parameter to false (which is its default value).
+
Parameters
+
+ width Width of the render-texture height Height of the render-texture depthBuffer Do you want this render-texture to have a depth buffer?
+
+
+
Returns True if creation has been successful
+
Deprecated: Use create(unsigned int, unsigned int, const ContextSettings&) instead.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool sf::RenderTexture::create
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ const ContextSettings &
+ settings = ContextSettings ()
+
+ )
+
+
+
+
+
Create the render-texture.
+
Before calling this function, the render-texture is in an invalid state, thus it is mandatory to call it before doing anything with the render-texture. The last parameter, settings , is useful if you want to enable multi-sampling or use the render-texture for OpenGL rendering that requires a depth or stencil buffer. Otherwise it is unnecessary, and you should leave this parameter at its default value.
+
Parameters
+
+ width Width of the render-texture height Height of the render-texture settings Additional settings for the underlying OpenGL texture and context
+
+
+
Returns True if creation has been successful
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTexture::display
+ (
+ )
+
+
+
+
+
Update the contents of the target texture.
+
This function updates the target texture with what has been drawn so far. Like for windows, calling this function is mandatory at the end of rendering. Not calling it may leave the texture in an undefined state.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
Draw a drawable object to the render target.
+
Parameters
+
+ drawable Object to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
Draw primitives defined by an array of vertices.
+
Parameters
+
+ vertices Pointer to the vertices vertexCount Number of vertices in the array type Type of primitives to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer states Render states to use for drawing
+
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::draw
+ (
+ const VertexBuffer &
+ vertexBuffer ,
+
+ std::size_t
+ firstVertex ,
+
+ std::size_t
+ vertexCount ,
+
+ const RenderStates &
+ states = RenderStates::Default
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer firstVertex Index of the first vertex to render vertexCount Number of vertices to render states Render states to use for drawing
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::RenderTexture::generateMipmap
+ (
+ )
+
+
+
+
+
Generate a mipmap using the current texture data.
+
This function is similar to Texture::generateMipmap and operates on the texture used as the target for drawing. Be aware that any draw operation may modify the base level image data. For this reason, calling this function only makes sense after all drawing is completed and display has been called. Not calling display after subsequent drawing will lead to undefined behavior if a mipmap had been previously generated.
+
Returns True if mipmap generation was successful, false if unsuccessful
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const View & sf::RenderTarget::getDefaultView
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the default view of the render target.
+
The default view has the initial size of the render target, and never changes after the target has been created.
+
Returns The default view of the render target
+
See also setView , getView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static unsigned int sf::RenderTexture::getMaximumAntialiasingLevel
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the maximum anti-aliasing level supported by the system.
+
Returns The maximum anti-aliasing level supported by the system
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2u sf::RenderTexture::getSize
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Return the size of the rendering region of the texture.
+
The returned value is the size that you passed to the create function.
+
Returns Size in pixels
+
+
Implements sf::RenderTarget .
+
+
+
+
+
◆
+
+
+
+
+
+ const Texture & sf::RenderTexture::getTexture
+ (
+ )
+ const
+
+
+
+
+
Get a read-only reference to the target texture.
+
After drawing to the render-texture and calling Display, you can retrieve the updated texture using this function, and draw it using a sprite (for example). The internal sf::Texture of a render-texture is always the same instance, so that it is possible to call this function once and keep a reference to the texture even after it is modified.
+
Returns Const reference to the texture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const View & sf::RenderTarget::getView
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the view currently in use in the render target.
+
Returns The view object that is currently used
+
See also setView , getDefaultView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ IntRect sf::RenderTarget::getViewport (
+ const View &
+ view )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the viewport of a view, applied to this render target.
+
The viewport is defined in the view as a ratio, this function simply applies this ratio to the current dimensions of the render target to calculate the pixels rectangle that the viewport actually covers in the target.
+
Parameters
+
+ view The view for which we want to compute the viewport
+
+
+
Returns Viewport rectangle, expressed in pixels
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::initialize
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Performs the common initialization step after creation.
+
The derived classes must call this function after the target is created and ready for drawing.
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::RenderTexture::isRepeated
+ (
+ )
+ const
+
+
+
+
+
Tell whether the texture is repeated or not.
+
Returns True if texture is repeated
+
See also setRepeated
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::RenderTexture::isSmooth
+ (
+ )
+ const
+
+
+
+
+
Tell whether the smooth filtering is enabled or not.
+
Returns True if texture smoothing is enabled
+
See also setSmooth
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from world coordinates to target coordinates, using the current view.
+
This function is an overload of the mapCoordsToPixel function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Point to convert
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from world coordinates to target coordinates.
+
This function finds the pixel of the render target that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render target – if the view is translated by (140, 25).
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Point to convert view The view to use for converting the point
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from target coordinates to world coordinates, using the current view.
+
This function is an overload of the mapPixelToCoords function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Pixel to convert
+
+
+
Returns The converted point, in "world" coordinates
+
See also mapCoordsToPixel
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from target coordinates to world coordinates.
+
This function finds the 2D position that matches the given pixel of the render target. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (10, 50) in your render target may map to the point (150, 75) in your 2D world – if the view is translated by (140, 25).
+
For render-windows, this function is typically used to find which point (or object) is located below the mouse cursor.
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Pixel to convert view The view to use for converting the point
+
+
+
Returns The converted point, in "world" units
+
See also mapCoordsToPixel
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::popGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Restore the previously saved OpenGL render states and matrices.
+
See the description of pushGLStates to get a detailed description of these functions.
+
See also pushGLStates
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::pushGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Save the current OpenGL render states and matrices.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with popGLStates, it ensures that:
+SFML's internal states are not messed up by your OpenGL code
+your OpenGL states are not modified by a call to a SFML function
+
+
More specifically, it must be used around code that calls Draw functions. Example:
window.pushGLStates();
window.draw(...);
window.draw(...);
window.popGLStates();
Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the resetGLStates function if you do so.
+
See also popGLStates
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::resetGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Reset the internal OpenGL states so that the target is ready for drawing.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use pushGLStates/popGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent draw() calls will work as expected.
+
Example:
glPushAttrib(...);
window.resetGLStates();
window.draw(...);
window.draw(...);
glPopAttrib(...);
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::RenderTexture::setActive
+ (
+ bool
+ active = true)
+
+
+
+
+virtual
+
+
+
+
+
Activate or deactivate the render-texture for rendering.
+
This function makes the render-texture's context current for future OpenGL rendering operations (so you shouldn't care about it if you're not doing direct OpenGL stuff). Only one context can be current in a thread, so if you want to draw OpenGL geometry to another render target (like a RenderWindow ) don't forget to activate it again.
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True if operation was successful, false otherwise
+
+
Reimplemented from sf::RenderTarget .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTexture::setRepeated
+ (
+ bool
+ repeated )
+
+
+
+
+
Enable or disable texture repeating.
+
This function is similar to Texture::setRepeated . This parameter is disabled by default.
+
Parameters
+
+ repeated True to enable repeating, false to disable it
+
+
+
See also isRepeated
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::RenderTexture::setSmooth
+ (
+ bool
+ smooth )
+
+
+
+
+
Enable or disable texture smoothing.
+
This function is similar to Texture::setSmooth . This parameter is disabled by default.
+
Parameters
+
+ smooth True to enable smoothing, false to disable it
+
+
+
See also isSmooth
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::setView
+ (
+ const View &
+ view )
+
+
+
+
+inherited
+
+
+
+
+
Change the current active view.
+
The view is like a 2D camera, it controls which part of the 2D scene is visible, and how it is viewed in the render target. The new view will affect everything that is drawn, until another view is set. The render target keeps its own copy of the view object, so it is not necessary to keep the original one alive after calling this function. To restore the original view of the target, you can pass the result of getDefaultView() to this function.
+
Parameters
+
+
+
+
See also getView , getDefaultView
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::RenderWindow , including all inherited members.
+
+ capture () constsf::RenderWindow clear (const Color &color=Color(0, 0, 0, 255))sf::RenderTarget close ()sf::Window create (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())sf::Window create (WindowHandle handle, const ContextSettings &settings=ContextSettings())sf::Window display ()sf::Window draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default)sf::RenderTarget draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default)sf::RenderTarget getDefaultView () constsf::RenderTarget getPosition () constsf::Window getSettings () constsf::Window getSize () constsf::RenderWindow virtual getSystemHandle () constsf::Window getView () constsf::RenderTarget getViewport (const View &view) constsf::RenderTarget hasFocus () constsf::Window initialize ()sf::RenderTarget protected isOpen () constsf::Window mapCoordsToPixel (const Vector2f &point) constsf::RenderTarget mapCoordsToPixel (const Vector2f &point, const View &view) constsf::RenderTarget mapPixelToCoords (const Vector2i &point) constsf::RenderTarget mapPixelToCoords (const Vector2i &point, const View &view) constsf::RenderTarget NonCopyable ()sf::NonCopyable inline protected onCreate ()sf::RenderWindow protected virtual onResize ()sf::RenderWindow protected virtual pollEvent (Event &event)sf::Window popGLStates ()sf::RenderTarget pushGLStates ()sf::RenderTarget RenderTarget ()sf::RenderTarget protected RenderWindow ()sf::RenderWindow RenderWindow (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())sf::RenderWindow RenderWindow (WindowHandle handle, const ContextSettings &settings=ContextSettings())sf::RenderWindow explicit requestFocus ()sf::Window resetGLStates ()sf::RenderTarget setActive (bool active=true)sf::RenderWindow virtual sf::Window::setActive (bool active=true) constsf::Window setFramerateLimit (unsigned int limit)sf::Window setIcon (unsigned int width, unsigned int height, const Uint8 *pixels)sf::Window setJoystickThreshold (float threshold)sf::Window setKeyRepeatEnabled (bool enabled)sf::Window setMouseCursor (const Cursor &cursor)sf::Window setMouseCursorGrabbed (bool grabbed)sf::Window setMouseCursorVisible (bool visible)sf::Window setPosition (const Vector2i &position)sf::Window setSize (const Vector2u &size)sf::Window setTitle (const String &title)sf::Window setVerticalSyncEnabled (bool enabled)sf::Window setView (const View &view)sf::RenderTarget setVisible (bool visible)sf::Window waitEvent (Event &event)sf::Window Window ()sf::Window Window (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())sf::Window Window (WindowHandle handle, const ContextSettings &settings=ContextSettings())sf::Window explicit ~NonCopyable ()sf::NonCopyable inline protected ~RenderTarget ()sf::RenderTarget virtual ~RenderWindow ()sf::RenderWindow virtual ~Window ()sf::Window virtual
SFML - Simple and Fast Multimedia Library
+
+
+
Window that can serve as a target for 2D drawing.
+ More...
+
+
#include <RenderWindow.hpp >
+
+
+
+
+
+
+
+
+ RenderWindow () Default constructor. More... RenderWindow (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings ()) Construct a new window. More... RenderWindow (WindowHandle handle, const ContextSettings &settings=ContextSettings ()) Construct the window from an existing control. More... virtual ~RenderWindow () Destructor. More... virtual Vector2u getSize () const Get the size of the rendering region of the window. More... bool setActive (bool active=true) Activate or deactivate the window as the current target for OpenGL rendering. More... Image capture () const Copy the current contents of the window to an image. More... void create (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings ()) Create (or recreate) the window. More... void create (WindowHandle handle, const ContextSettings &settings=ContextSettings ()) Create (or recreate) the window from an existing control. More... void close () Close the window and destroy all the attached resources. More... bool isOpen () const Tell whether or not the window is open. More... const ContextSettings & getSettings () const Get the settings of the OpenGL context of the window. More... bool pollEvent (Event &event) Pop the event on top of the event queue, if any, and return it. More... bool waitEvent (Event &event) Wait for an event and return it. More... Vector2i getPosition () const Get the position of the window. More... void setPosition (const Vector2i &position) Change the position of the window on screen. More... void setSize (const Vector2u &size) Change the size of the rendering region of the window. More... void setTitle (const String &title) Change the title of the window. More... void setIcon (unsigned int width, unsigned int height, const Uint8 *pixels) Change the window's icon. More... void setVisible (bool visible) Show or hide the window. More... void setVerticalSyncEnabled (bool enabled) Enable or disable vertical synchronization. More... void setMouseCursorVisible (bool visible) Show or hide the mouse cursor. More... void setMouseCursorGrabbed (bool grabbed) Grab or release the mouse cursor. More... void setMouseCursor (const Cursor &cursor) Set the displayed cursor to a native system cursor. More... void setKeyRepeatEnabled (bool enabled) Enable or disable automatic key-repeat. More... void setFramerateLimit (unsigned int limit) Limit the framerate to a maximum fixed frequency. More... void setJoystickThreshold (float threshold) Change the joystick threshold. More... bool setActive (bool active=true) const Activate or deactivate the window as the current target for OpenGL rendering. More... void requestFocus () Request the current window to be made the active foreground window. More... bool hasFocus () const Check whether the window has the input focus. More... void display () Display on screen what has been rendered to the window so far. More... WindowHandle getSystemHandle () const Get the OS-specific handle of the window. More... void clear (const Color &color=Color (0, 0, 0, 255)) Clear the entire target with a single color. More... void setView (const View &view) Change the current active view. More... const View & getView () const Get the view currently in use in the render target. More... const View & getDefaultView () const Get the default view of the render target. More... IntRect getViewport (const View &view) const Get the viewport of a view, applied to this render target. More... Vector2f mapPixelToCoords (const Vector2i &point) const Convert a point from target coordinates to world coordinates, using the current view. More... Vector2f mapPixelToCoords (const Vector2i &point, const View &view) const Convert a point from target coordinates to world coordinates. More... Vector2i mapCoordsToPixel (const Vector2f &point) const Convert a point from world coordinates to target coordinates, using the current view. More... Vector2i mapCoordsToPixel (const Vector2f &point, const View &view) const Convert a point from world coordinates to target coordinates. More... void draw (const Drawable &drawable, const RenderStates &states=RenderStates::Default ) Draw a drawable object to the render target. More... void draw (const Vertex *vertices, std::size_t vertexCount, PrimitiveType type, const RenderStates &states=RenderStates::Default ) Draw primitives defined by an array of vertices. More... void draw (const VertexBuffer &vertexBuffer, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... void draw (const VertexBuffer &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const RenderStates &states=RenderStates::Default ) Draw primitives defined by a vertex buffer. More... void pushGLStates () Save the current OpenGL render states and matrices. More... void popGLStates () Restore the previously saved OpenGL render states and matrices. More... void resetGLStates () Reset the internal OpenGL states so that the target is ready for drawing. More...
+virtual void onCreate () Function called after the window has been created. More... virtual void onResize () Function called after the window has been resized. More... void initialize () Performs the common initialization step after creation. More...
+
+
Window that can serve as a target for 2D drawing.
+
sf::RenderWindow is the main class of the Graphics module.
+
It defines an OS window that can be painted using the other classes of the graphics module.
+
sf::RenderWindow is derived from sf::Window , thus it inherits all its features: events, window management, OpenGL rendering, etc. See the documentation of sf::Window for a more complete description of all these features, as well as code examples.
+
On top of that, sf::RenderWindow adds more features related to 2D drawing with the graphics module (see its base class sf::RenderTarget for more details). Here is a typical rendering and event loop with a sf::RenderWindow :
+
{
{
}
window.clear();
window.draw(sprite);
window.draw(circle);
window.draw(text);
}
Like sf::Window , sf::RenderWindow is still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands.
+
...
glMatrixMode(GL_PROJECTION);
...
{
...
window.pushGLStates();
window.draw(sprite);
window.popGLStates();
glBegin(GL_QUADS);
glVertex3f(...);
...
glEnd();
window.pushGLStates();
window.draw(text);
window.popGLStates();
}
See also sf::Window , sf::RenderTarget , sf::RenderTexture , sf::View
+
+
Definition at line 44 of file RenderWindow.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::RenderWindow::RenderWindow
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor doesn't actually create the window, use the other constructors or call create() to do so.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
Construct a new window.
+
This constructor creates the window with the size and pixel depth defined in mode . An optional style can be passed to customize the look and behavior of the window (borders, title bar, resizable, closable, ...).
+
The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc. You shouldn't care about these parameters for a regular usage of the graphics module.
+
Parameters
+
+ mode Video mode to use (defines the width, height and depth of the rendering area of the window) title Title of the window style Window style, a bitwise OR combination of sf::Style enumerators settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
Construct the window from an existing control.
+
Use this constructor if you want to create an SFML rendering area into an already existing control.
+
The second parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc. You shouldn't care about these parameters for a regular usage of the graphics module.
+
Parameters
+
+ handle Platform-specific handle of the control (HWND on Windows, Window on Linux/FreeBSD, NSWindow on OS X) settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::RenderWindow::~RenderWindow
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Destructor.
+
Closes the window and frees all the resources attached to it.
+
+
+
+
+
+
◆
+
+
+
+
+
+ Image sf::RenderWindow::capture (
+ )
+ const
+
+
+
+
+
Copy the current contents of the window to an image.
+
Deprecated: Use a sf::Texture and its sf::Texture::update(const Window&) function and copy its contents into an sf::Image instead.
+
texture.
create (windowSize.
x , windowSize.
y );
This is a slow operation, whose main purpose is to make screenshots of the application. If you want to update an image with the contents of the window and then use it for drawing, you should rather use a sf::Texture and its update(Window&) function. You can also draw things directly to a texture with the sf::RenderTexture class.
+
Returns Image containing the captured contents
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::clear
+ (
+ const Color &
+ color = Color (0, 0, 0, 255))
+
+
+
+
+inherited
+
+
+
+
+
Clear the entire target with a single color.
+
This function is usually called once every frame, to clear the previous contents of the target.
+
Parameters
+
+ color Fill color to use to clear the render target
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::close
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Close the window and destroy all the attached resources.
+
After calling this function, the sf::Window instance remains valid and you can call create() to recreate the window. All other functions such as pollEvent() or display() will still work (i.e. you don't have to test isOpen() every time), and will have no effect on closed windows.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Create (or recreate) the window.
+
If the window was already created, it closes it first. If style contains Style::Fullscreen, then mode must be a valid video mode.
+
The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ mode Video mode to use (defines the width, height and depth of the rendering area of the window) title Title of the window style Window style, a bitwise OR combination of sf::Style enumerators settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Create (or recreate) the window from an existing control.
+
Use this function if you want to create an OpenGL rendering area into an already existing control. If the window was already created, it closes it first.
+
The second parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ handle Platform-specific handle of the control settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::display
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Display on screen what has been rendered to the window so far.
+
This function is typically called after all OpenGL rendering has been done for the current frame, in order to show it on screen.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
Draw a drawable object to the render target.
+
Parameters
+
+ drawable Object to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
Draw primitives defined by an array of vertices.
+
Parameters
+
+ vertices Pointer to the vertices vertexCount Number of vertices in the array type Type of primitives to draw states Render states to use for drawing
+
+
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer states Render states to use for drawing
+
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::draw
+ (
+ const VertexBuffer &
+ vertexBuffer ,
+
+ std::size_t
+ firstVertex ,
+
+ std::size_t
+ vertexCount ,
+
+ const RenderStates &
+ states = RenderStates::Default
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Draw primitives defined by a vertex buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer firstVertex Index of the first vertex to render vertexCount Number of vertices to render states Render states to use for drawing
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const View & sf::RenderTarget::getDefaultView
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the default view of the render target.
+
The default view has the initial size of the render target, and never changes after the target has been created.
+
Returns The default view of the render target
+
See also setView , getView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Vector2i sf::Window::getPosition (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the position of the window.
+
Returns Position of the window, in pixels
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
Get the settings of the OpenGL context of the window.
+
Note that these settings may be different from what was passed to the constructor or the create() function, if one or more settings were not supported. In this case, SFML chose the closest match.
+
Returns Structure containing the OpenGL context settings
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2u sf::RenderWindow::getSize
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the size of the rendering region of the window.
+
The size doesn't include the titlebar and borders of the window.
+
Returns Size in pixels
+
+
Implements sf::RenderTarget .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ WindowHandle sf::Window::getSystemHandle (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the OS-specific handle of the window.
+
The type of the returned handle is sf::WindowHandle, which is a typedef to the handle type defined by the OS. You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.
+
Returns System handle of the window
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const View & sf::RenderTarget::getView
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the view currently in use in the render target.
+
Returns The view object that is currently used
+
See also setView , getDefaultView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ IntRect sf::RenderTarget::getViewport (
+ const View &
+ view )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the viewport of a view, applied to this render target.
+
The viewport is defined in the view as a ratio, this function simply applies this ratio to the current dimensions of the render target to calculate the pixels rectangle that the viewport actually covers in the target.
+
Parameters
+
+ view The view for which we want to compute the viewport
+
+
+
Returns Viewport rectangle, expressed in pixels
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Window::hasFocus
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Check whether the window has the input focus.
+
At any given time, only one window may have the input focus to receive input events such as keystrokes or most mouse events.
+
Returns True if window has focus, false otherwise
+
See also requestFocus
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::initialize
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Performs the common initialization step after creation.
+
The derived classes must call this function after the target is created and ready for drawing.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Window::isOpen
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether or not the window is open.
+
This function returns whether or not the window exists. Note that a hidden window (setVisible(false)) is open (therefore this function would return true).
+
Returns True if the window is open, false if it has been closed
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from world coordinates to target coordinates, using the current view.
+
This function is an overload of the mapCoordsToPixel function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Point to convert
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Vector2i sf::RenderTarget::mapCoordsToPixel (
+ const Vector2f &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from world coordinates to target coordinates.
+
This function finds the pixel of the render target that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render target – if the view is translated by (140, 25).
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Point to convert view The view to use for converting the point
+
+
+
Returns The converted point, in target coordinates (pixels)
+
See also mapPixelToCoords
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from target coordinates to world coordinates, using the current view.
+
This function is an overload of the mapPixelToCoords function that implicitly uses the current view. It is equivalent to:
Parameters
+
+ point Pixel to convert
+
+
+
Returns The converted point, in "world" coordinates
+
See also mapCoordsToPixel
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Vector2f sf::RenderTarget::mapPixelToCoords (
+ const Vector2i &
+ point ,
+
+ const View &
+ view
+
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Convert a point from target coordinates to world coordinates.
+
This function finds the 2D position that matches the given pixel of the render target. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.
+
Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (10, 50) in your render target may map to the point (150, 75) in your 2D world – if the view is translated by (140, 25).
+
For render-windows, this function is typically used to find which point (or object) is located below the mouse cursor.
+
This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.
+
Parameters
+
+ point Pixel to convert view The view to use for converting the point
+
+
+
Returns The converted point, in "world" units
+
See also mapCoordsToPixel
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::RenderWindow::onCreate
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Function called after the window has been created.
+
This function is called so that derived classes can perform their own specific initialization as soon as the window is created.
+
+
Reimplemented from sf::Window .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::RenderWindow::onResize
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Function called after the window has been resized.
+
This function is called so that derived classes can perform custom actions when the size of the window changes.
+
+
Reimplemented from sf::Window .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Window::pollEvent
+ (
+ Event & event )
+
+
+
+
+inherited
+
+
+
+
+
Pop the event on top of the event queue, if any, and return it.
+
This function is not blocking: if there's no pending event then it will return false and leave event unmodified. Note that more than one event may be present in the event queue, thus you should always call this function in a loop to make sure that you process every pending event.
Parameters
+
+ event Event to be returned
+
+
+
Returns True if an event was returned, or false if the event queue was empty
+
See also waitEvent
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::popGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Restore the previously saved OpenGL render states and matrices.
+
See the description of pushGLStates to get a detailed description of these functions.
+
See also pushGLStates
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::pushGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Save the current OpenGL render states and matrices.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with popGLStates, it ensures that:
+SFML's internal states are not messed up by your OpenGL code
+your OpenGL states are not modified by a call to a SFML function
+
+
More specifically, it must be used around code that calls Draw functions. Example:
window.pushGLStates();
window.draw(...);
window.draw(...);
window.popGLStates();
Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the resetGLStates function if you do so.
+
See also popGLStates
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::requestFocus
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Request the current window to be made the active foreground window.
+
At any given time, only one window may have the input focus to receive input events such as keystrokes or mouse events. If a window requests focus, it only hints to the operating system, that it would like to be focused. The operating system is free to deny the request. This is not to be confused with setActive() .
+
See also hasFocus
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::resetGLStates
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Reset the internal OpenGL states so that the target is ready for drawing.
+
This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use pushGLStates/popGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent draw() calls will work as expected.
+
Example:
glPushAttrib(...);
window.resetGLStates();
window.draw(...);
window.draw(...);
glPopAttrib(...);
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ bool sf::RenderWindow::setActive
+ (
+ bool
+ active = true)
+
+
+
+
+virtual
+
+
+
+
+
Activate or deactivate the window as the current target for OpenGL rendering.
+
A window is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one window can be active on a thread at a time, thus the window previously active (if any) automatically gets deactivated. This is not to be confused with requestFocus() .
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True if operation was successful, false otherwise
+
+
Reimplemented from sf::RenderTarget .
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ bool sf::Window::setActive
+ (
+ bool
+ active = true)
+ const
+
+
+
+
+inherited
+
+
+
+
+
Activate or deactivate the window as the current target for OpenGL rendering.
+
A window is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one window can be active on a thread at a time, thus the window previously active (if any) automatically gets deactivated. This is not to be confused with requestFocus() .
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True if operation was successful, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setFramerateLimit
+ (
+ unsigned int
+ limit )
+
+
+
+
+inherited
+
+
+
+
+
Limit the framerate to a maximum fixed frequency.
+
If a limit is set, the window will use a small delay after each call to display() to ensure that the current frame lasted long enough to match the framerate limit. SFML will try to match the given limit as much as it can, but since it internally uses sf::sleep, whose precision depends on the underlying OS, the results may be a little unprecise as well (for example, you can get 65 FPS when requesting 60).
+
Parameters
+
+ limit Framerate limit, in frames per seconds (use 0 to disable limit)
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setIcon
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ const Uint8 *
+ pixels
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Change the window's icon.
+
pixels must be an array of width x height pixels in 32-bits RGBA format.
+
The OS default icon is used by default.
+
Parameters
+
+ width Icon's width, in pixels height Icon's height, in pixels pixels Pointer to the array of pixels in memory. The pixels are copied, so you need not keep the source alive after calling this function.
+
+
+
See also setTitle
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setJoystickThreshold
+ (
+ float
+ threshold )
+
+
+
+
+inherited
+
+
+
+
+
Change the joystick threshold.
+
The joystick threshold is the value below which no JoystickMoved event will be generated.
+
The threshold value is 0.1 by default.
+
Parameters
+
+ threshold New threshold, in the range [0, 100]
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setKeyRepeatEnabled
+ (
+ bool
+ enabled )
+
+
+
+
+inherited
+
+
+
+
+
Enable or disable automatic key-repeat.
+
If key repeat is enabled, you will receive repeated KeyPressed events while keeping a key pressed. If it is disabled, you will only get a single event when the key is pressed.
+
Key repeat is enabled by default.
+
Parameters
+
+ enabled True to enable, false to disable
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setMouseCursor
+ (
+ const Cursor &
+ cursor )
+
+
+
+
+inherited
+
+
+
+
+
Set the displayed cursor to a native system cursor.
+
Upon window creation, the arrow cursor is used by default.
+
Warning The cursor must not be destroyed while in use by the window.
+
+Features related to Cursor are not supported on iOS and Android.
+
Parameters
+
+ cursor Native system cursor type to display
+
+
+
See also sf::Cursor::loadFromSystem
+sf::Cursor::loadFromPixels
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setMouseCursorGrabbed
+ (
+ bool
+ grabbed )
+
+
+
+
+inherited
+
+
+
+
+
Grab or release the mouse cursor.
+
If set, grabs the mouse cursor inside this window's client area so it may no longer be moved outside its bounds. Note that grabbing is only active while the window has focus.
+
Parameters
+
+ grabbed True to enable, false to disable
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setMouseCursorVisible
+ (
+ bool
+ visible )
+
+
+
+
+inherited
+
+
+
+
+
Show or hide the mouse cursor.
+
The mouse cursor is visible by default.
+
Parameters
+
+ visible True to show the mouse cursor, false to hide it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setPosition
+ (
+ const Vector2i &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
Change the position of the window on screen.
+
This function only works for top-level windows (i.e. it will be ignored for windows created from the handle of a child window/control).
+
Parameters
+
+ position New position, in pixels
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setSize
+ (
+ const Vector2u &
+ size )
+
+
+
+
+inherited
+
+
+
+
+
Change the size of the rendering region of the window.
+
Parameters
+
+ size New size, in pixels
+
+
+
See also getSize
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setTitle
+ (
+ const String &
+ title )
+
+
+
+
+inherited
+
+
+
+
+
Change the title of the window.
+
Parameters
+
+
+
+
See also setIcon
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setVerticalSyncEnabled
+ (
+ bool
+ enabled )
+
+
+
+
+inherited
+
+
+
+
+
Enable or disable vertical synchronization.
+
Activating vertical synchronization will limit the number of frames displayed to the refresh rate of the monitor. This can avoid some visual artifacts, and limit the framerate to a good value (but not constant across different computers).
+
Vertical synchronization is disabled by default.
+
Parameters
+
+ enabled True to enable v-sync, false to deactivate it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::RenderTarget::setView
+ (
+ const View &
+ view )
+
+
+
+
+inherited
+
+
+
+
+
Change the current active view.
+
The view is like a 2D camera, it controls which part of the 2D scene is visible, and how it is viewed in the render target. The new view will affect everything that is drawn, until another view is set. The render target keeps its own copy of the view object, so it is not necessary to keep the original one alive after calling this function. To restore the original view of the target, you can pass the result of getDefaultView() to this function.
+
Parameters
+
+
+
+
See also getView , getDefaultView
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Window::setVisible
+ (
+ bool
+ visible )
+
+
+
+
+inherited
+
+
+
+
+
Show or hide the window.
+
The window is shown by default.
+
Parameters
+
+ visible True to show the window, false to hide it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Window::waitEvent
+ (
+ Event & event )
+
+
+
+
+inherited
+
+
+
+
+
Wait for an event and return it.
+
This function is blocking: if there's no pending event then it will wait until an event is received. After this function returns (and no error occurred), the event object is always valid and filled properly. This function is typically used when you have a thread that is dedicated to events handling: you want to make this thread sleep as long as no new event is received.
Parameters
+
+ event Event to be returned
+
+
+
Returns False if any error occurred
+
See also pollEvent
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Sensor , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the real-time state of the sensors.
+ More...
+
+
#include <Sensor.hpp >
+
+
+
Give access to the real-time state of the sensors.
+
sf::Sensor provides an interface to the state of the various sensors that a device provides.
+
It only contains static functions, so it's not meant to be instantiated.
+
This class allows users to query the sensors values at any time and directly, without having to deal with a window and its events. Compared to the SensorChanged event, sf::Sensor can retrieve the state of a sensor at any time (you don't need to store and update its current value on your side).
+
Depending on the OS and hardware of the device (phone, tablet, ...), some sensor types may not be available. You should always check the availability of a sensor before trying to read it, with the sf::Sensor::isAvailable function.
+
You may wonder why some sensor types look so similar, for example Accelerometer and Gravity / UserAcceleration. The first one is the raw measurement of the acceleration, and takes into account both the earth gravity and the user movement. The others are more precise: they provide these components separately, which is usually more useful. In fact they are not direct sensors, they are computed internally based on the raw acceleration and other sensors. This is exactly the same for Gyroscope vs Orientation.
+
Because sensors consume a non-negligible amount of current, they are all disabled by default. You must call sf::Sensor::setEnabled for each sensor in which you are interested.
+
Usage example:
+
Definition at line 42 of file Sensor.hpp .
+
+
+
◆
+
+
+
+
+
Sensor type.
+
+Enumerator Measures the raw acceleration (m/s^2)
+Measures the raw rotation rates (degrees/s)
+Measures the ambient magnetic field (micro-teslas)
+Measures the direction and intensity of gravity, independent of device acceleration (m/s^2)
+Measures the direction and intensity of device acceleration, independent of the gravity (m/s^2)
+Measures the absolute 3D orientation (degrees)
+Keep last – the total number of sensor types.
+
+
+
Definition at line 50 of file Sensor.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static Vector3f sf::Sensor::getValue
+ (
+ Type sensor )
+
+
+
+
+static
+
+
+
+
+
Get the current sensor value.
+
Parameters
+
+
+
+
Returns The current sensor value
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Sensor::isAvailable
+ (
+ Type sensor )
+
+
+
+
+static
+
+
+
+
+
Check if a sensor is available on the underlying platform.
+
Parameters
+
+
+
+
Returns True if the sensor is available, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Sensor::setEnabled
+ (
+ Type sensor ,
+
+ bool
+ enabled
+
+ )
+
+
+
+
+static
+
+
+
+
+
Enable or disable a sensor.
+
All sensors are disabled by default, to avoid consuming too much battery power. Once a sensor is enabled, it starts sending events of the corresponding type.
+
This function does nothing if the sensor is unavailable.
+
Parameters
+
+ sensor Sensor to enable enabled True to enable, false to disable
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Shader , including all inherited members.
+
+ bind (const Shader *shader)sf::Shader static CurrentTexture sf::Shader static Fragment enum valuesf::Shader Geometry enum valuesf::Shader getNativeHandle () constsf::Shader GlResource ()sf::GlResource private isAvailable ()sf::Shader static isGeometryAvailable ()sf::Shader static loadFromFile (const std::string &filename, Type type)sf::Shader loadFromFile (const std::string &vertexShaderFilename, const std::string &fragmentShaderFilename)sf::Shader loadFromFile (const std::string &vertexShaderFilename, const std::string &geometryShaderFilename, const std::string &fragmentShaderFilename)sf::Shader loadFromMemory (const std::string &shader, Type type)sf::Shader loadFromMemory (const std::string &vertexShader, const std::string &fragmentShader)sf::Shader loadFromMemory (const std::string &vertexShader, const std::string &geometryShader, const std::string &fragmentShader)sf::Shader loadFromStream (InputStream &stream, Type type)sf::Shader loadFromStream (InputStream &vertexShaderStream, InputStream &fragmentShaderStream)sf::Shader loadFromStream (InputStream &vertexShaderStream, InputStream &geometryShaderStream, InputStream &fragmentShaderStream)sf::Shader NonCopyable ()sf::NonCopyable inline private registerContextDestroyCallback (ContextDestroyCallback callback, void *arg)sf::GlResource private static setParameter (const std::string &name, float x)sf::Shader setParameter (const std::string &name, float x, float y)sf::Shader setParameter (const std::string &name, float x, float y, float z)sf::Shader setParameter (const std::string &name, float x, float y, float z, float w)sf::Shader setParameter (const std::string &name, const Vector2f &vector)sf::Shader setParameter (const std::string &name, const Vector3f &vector)sf::Shader setParameter (const std::string &name, const Color &color)sf::Shader setParameter (const std::string &name, const Transform &transform)sf::Shader setParameter (const std::string &name, const Texture &texture)sf::Shader setParameter (const std::string &name, CurrentTextureType)sf::Shader setUniform (const std::string &name, float x)sf::Shader setUniform (const std::string &name, const Glsl::Vec2 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Vec3 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Vec4 &vector)sf::Shader setUniform (const std::string &name, int x)sf::Shader setUniform (const std::string &name, const Glsl::Ivec2 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Ivec3 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Ivec4 &vector)sf::Shader setUniform (const std::string &name, bool x)sf::Shader setUniform (const std::string &name, const Glsl::Bvec2 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Bvec3 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Bvec4 &vector)sf::Shader setUniform (const std::string &name, const Glsl::Mat3 &matrix)sf::Shader setUniform (const std::string &name, const Glsl::Mat4 &matrix)sf::Shader setUniform (const std::string &name, const Texture &texture)sf::Shader setUniform (const std::string &name, CurrentTextureType)sf::Shader setUniformArray (const std::string &name, const float *scalarArray, std::size_t length)sf::Shader setUniformArray (const std::string &name, const Glsl::Vec2 *vectorArray, std::size_t length)sf::Shader setUniformArray (const std::string &name, const Glsl::Vec3 *vectorArray, std::size_t length)sf::Shader setUniformArray (const std::string &name, const Glsl::Vec4 *vectorArray, std::size_t length)sf::Shader setUniformArray (const std::string &name, const Glsl::Mat3 *matrixArray, std::size_t length)sf::Shader setUniformArray (const std::string &name, const Glsl::Mat4 *matrixArray, std::size_t length)sf::Shader Shader ()sf::Shader Type enum namesf::Shader Vertex enum valuesf::Shader ~GlResource ()sf::GlResource private ~NonCopyable ()sf::NonCopyable inline private ~Shader ()sf::Shader
SFML - Simple and Fast Multimedia Library
+
+
+
Shader class (vertex, geometry and fragment)
+ More...
+
+
#include <Shader.hpp >
+
+
+
+
+
+
+
+
+ Shader () Default constructor. More... ~Shader () Destructor. More... bool loadFromFile (const std::string &filename, Type type) Load the vertex, geometry or fragment shader from a file. More... bool loadFromFile (const std::string &vertexShaderFilename, const std::string &fragmentShaderFilename) Load both the vertex and fragment shaders from files. More... bool loadFromFile (const std::string &vertexShaderFilename, const std::string &geometryShaderFilename, const std::string &fragmentShaderFilename) Load the vertex, geometry and fragment shaders from files. More... bool loadFromMemory (const std::string &shader, Type type) Load the vertex, geometry or fragment shader from a source code in memory. More... bool loadFromMemory (const std::string &vertexShader, const std::string &fragmentShader) Load both the vertex and fragment shaders from source codes in memory. More... bool loadFromMemory (const std::string &vertexShader, const std::string &geometryShader, const std::string &fragmentShader) Load the vertex, geometry and fragment shaders from source codes in memory. More... bool loadFromStream (InputStream &stream, Type type) Load the vertex, geometry or fragment shader from a custom stream. More... bool loadFromStream (InputStream &vertexShaderStream, InputStream &fragmentShaderStream) Load both the vertex and fragment shaders from custom streams. More... bool loadFromStream (InputStream &vertexShaderStream, InputStream &geometryShaderStream, InputStream &fragmentShaderStream) Load the vertex, geometry and fragment shaders from custom streams. More... void setUniform (const std::string &name, float x) Specify value for float uniform. More... void setUniform (const std::string &name, const Glsl::Vec2 &vector) Specify value for vec2 uniform. More... void setUniform (const std::string &name, const Glsl::Vec3 &vector) Specify value for vec3 uniform. More... void setUniform (const std::string &name, const Glsl::Vec4 &vector) Specify value for vec4 uniform. More... void setUniform (const std::string &name, int x) Specify value for int uniform. More... void setUniform (const std::string &name, const Glsl::Ivec2 &vector) Specify value for ivec2 uniform. More... void setUniform (const std::string &name, const Glsl::Ivec3 &vector) Specify value for ivec3 uniform. More... void setUniform (const std::string &name, const Glsl::Ivec4 &vector) Specify value for ivec4 uniform. More... void setUniform (const std::string &name, bool x) Specify value for bool uniform. More... void setUniform (const std::string &name, const Glsl::Bvec2 &vector) Specify value for bvec2 uniform. More... void setUniform (const std::string &name, const Glsl::Bvec3 &vector) Specify value for bvec3 uniform. More... void setUniform (const std::string &name, const Glsl::Bvec4 &vector) Specify value for bvec4 uniform. More... void setUniform (const std::string &name, const Glsl::Mat3 &matrix) Specify value for mat3 matrix. More... void setUniform (const std::string &name, const Glsl::Mat4 &matrix) Specify value for mat4 matrix. More... void setUniform (const std::string &name, const Texture &texture) Specify a texture as sampler2D uniform. More... void setUniform (const std::string &name, CurrentTextureType ) Specify current texture as sampler2D uniform. More... void setUniformArray (const std::string &name, const float *scalarArray, std::size_t length) Specify values for float[] array uniform. More... void setUniformArray (const std::string &name, const Glsl::Vec2 *vectorArray, std::size_t length) Specify values for vec2[] array uniform. More... void setUniformArray (const std::string &name, const Glsl::Vec3 *vectorArray, std::size_t length) Specify values for vec3[] array uniform. More... void setUniformArray (const std::string &name, const Glsl::Vec4 *vectorArray, std::size_t length) Specify values for vec4[] array uniform. More... void setUniformArray (const std::string &name, const Glsl::Mat3 *matrixArray, std::size_t length) Specify values for mat3[] array uniform. More... void setUniformArray (const std::string &name, const Glsl::Mat4 *matrixArray, std::size_t length) Specify values for mat4[] array uniform. More... void setParameter (const std::string &name, float x) Change a float parameter of the shader. More... void setParameter (const std::string &name, float x, float y) Change a 2-components vector parameter of the shader. More... void setParameter (const std::string &name, float x, float y, float z) Change a 3-components vector parameter of the shader. More... void setParameter (const std::string &name, float x, float y, float z, float w) Change a 4-components vector parameter of the shader. More... void setParameter (const std::string &name, const Vector2f &vector) Change a 2-components vector parameter of the shader. More... void setParameter (const std::string &name, const Vector3f &vector) Change a 3-components vector parameter of the shader. More... void setParameter (const std::string &name, const Color &color) Change a color parameter of the shader. More... void setParameter (const std::string &name, const Transform &transform) Change a matrix parameter of the shader. More... void setParameter (const std::string &name, const Texture &texture) Change a texture parameter of the shader. More... void setParameter (const std::string &name, CurrentTextureType ) Change a texture parameter of the shader. More... unsigned int getNativeHandle () const Get the underlying OpenGL handle of the shader. More...
+
+
Shader class (vertex, geometry and fragment)
+
Shaders are programs written using a specific language, executed directly by the graphics card and allowing to apply real-time operations to the rendered entities.
+
There are three kinds of shaders:
+Vertex shaders, that process vertices
+Geometry shaders, that process primitives
+Fragment (pixel) shaders, that process pixels
+
+
A sf::Shader can be composed of either a vertex shader alone, a geometry shader alone, a fragment shader alone, or any combination of them. (see the variants of the load functions).
+
Shaders are written in GLSL, which is a C-like language dedicated to OpenGL shaders. You'll probably need to learn its basics before writing your own shaders for SFML.
+
Like any C/C++ program, a GLSL shader has its own variables called uniforms that you can set from your C++ application. sf::Shader handles different types of uniforms:
+scalars: float, int, bool
+vectors (2, 3 or 4 components)
+matrices (3x3 or 4x4)
+samplers (textures)
+
+
Some SFML-specific types can be converted:
+
Every uniform variable in a shader can be set through one of the setUniform() or setUniformArray() overloads. For example, if you have a shader with the following uniforms:
uniform float offset;
uniform vec3 point;
uniform vec4 color;
uniform mat4 matrix;
uniform sampler2D overlay;
uniform sampler2D current;
You can set their values from C++ code as follows, using the types defined in the sf::Glsl namespace:
shader.setUniform("offset" , 2.f);
shader.setUniform("overlay" , texture);
The old setParameter() overloads are deprecated and will be removed in a future version. You should use their setUniform() equivalents instead.
+
The special Shader::CurrentTexture argument maps the given sampler2D uniform to the current texture of the object being drawn (which cannot be known in advance).
+
To apply a shader to a drawable, you must pass it as an additional parameter to the RenderWindow::draw function:
window.draw(sprite, &shader);
... which is in fact just a shortcut for this:
window.draw(sprite, states);
In the code above we pass a pointer to the shader, because it may be null (which means "no shader").
+
Shaders can be used on any drawable, but some combinations are not interesting. For example, using a vertex shader on a sf::Sprite is limited because there are only 4 vertices, the sprite would have to be subdivided in order to apply wave effects. Another bad example is a fragment shader with sf::Text : the texture of the text is not the actual text that you see on screen, it is a big texture containing all the characters of the font in an arbitrary order; thus, texture lookups on pixels other than the current one may not give you the expected result.
+
Shaders can also be used to apply global post-effects to the current contents of the target (like the old sf::PostFx class in SFML 1). This can be done in two different ways:
+draw everything to a sf::RenderTexture , then draw it to the main target using the shader
+draw everything directly to the main target, then use sf::Texture::update(Window&) to copy its contents to a texture and draw it to the main target using the shader
+
+
The first technique is more optimized because it doesn't involve retrieving the target's pixels to system memory, but the second one doesn't impact the rendering process and can be easily inserted anywhere without impacting all the code.
+
Like sf::Texture that can be used as a raw OpenGL texture, sf::Shader can also be used directly as a raw shader for custom OpenGL geometry.
... render OpenGL geometry ...
sf::Shader::bind(NULL);
See also sf::Glsl
+
+
Definition at line 52 of file Shader.hpp .
+
+
+
◆
+
+
+
+
+
Types of shaders.
+
+Enumerator Vertex shader
+Geometry shader.
+Fragment (pixel) shader.
+
+
+
Definition at line 60 of file Shader.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Shader::Shader
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor creates an invalid shader.
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Shader::~Shader
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::Shader::bind
+ (
+ const Shader *
+ shader )
+
+
+
+
+static
+
+
+
+
+
Bind a shader for rendering.
+
This function is not part of the graphics API, it mustn't be used when drawing SFML entities. It must be used only if you mix sf::Shader with OpenGL code.
+
...
sf::Shader::bind(&s1);
Parameters
+
+ shader Shader to bind, can be null to use no shader
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Shader::getNativeHandle
+ (
+ )
+ const
+
+
+
+
+
Get the underlying OpenGL handle of the shader.
+
You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.
+
Returns OpenGL handle of the shader or 0 if not yet loaded
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Shader::isAvailable
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Tell whether or not the system supports shaders.
+
This function should always be called before using the shader features. If it returns false, then any attempt to use sf::Shader will fail.
+
Returns True if shaders are supported, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Shader::isGeometryAvailable
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Tell whether or not the system supports geometry shaders.
+
This function should always be called before using the geometry shader features. If it returns false, then any attempt to use sf::Shader geometry shader features will fail.
+
This function can only return true if isAvailable() would also return true, since shaders in general have to be supported in order for geometry shaders to be supported as well.
+
Note: The first call to this function, whether by your code or SFML will result in a context switch.
+
Returns True if geometry shaders are supported, false otherwise
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool sf::Shader::loadFromFile
+ (
+ const std::string &
+ filename ,
+
+ Type type
+
+ )
+
+
+
+
+
Load the vertex, geometry or fragment shader from a file.
+
This function loads a single shader, vertex, geometry or fragment, identified by the second argument. The source must be a text file containing a valid shader in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ filename Path of the vertex, geometry or fragment shader file to load type Type of shader (vertex, geometry or fragment)
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromMemory , loadFromStream
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool sf::Shader::loadFromFile
+ (
+ const std::string &
+ vertexShaderFilename ,
+
+ const std::string &
+ fragmentShaderFilename
+
+ )
+
+
+
+
+
Load both the vertex and fragment shaders from files.
+
This function loads both the vertex and the fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The sources must be text files containing valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShaderFilename Path of the vertex shader file to load fragmentShaderFilename Path of the fragment shader file to load
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromMemory , loadFromStream
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool sf::Shader::loadFromFile
+ (
+ const std::string &
+ vertexShaderFilename ,
+
+ const std::string &
+ geometryShaderFilename ,
+
+ const std::string &
+ fragmentShaderFilename
+
+ )
+
+
+
+
+
Load the vertex, geometry and fragment shaders from files.
+
This function loads the vertex, geometry and fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The sources must be text files containing valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShaderFilename Path of the vertex shader file to load geometryShaderFilename Path of the geometry shader file to load fragmentShaderFilename Path of the fragment shader file to load
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromMemory , loadFromStream
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool sf::Shader::loadFromMemory
+ (
+ const std::string &
+ shader ,
+
+ Type type
+
+ )
+
+
+
+
+
Load the vertex, geometry or fragment shader from a source code in memory.
+
This function loads a single shader, vertex, geometry or fragment, identified by the second argument. The source code must be a valid shader in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ shader String containing the source code of the shader type Type of shader (vertex, geometry or fragment)
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromStream
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool sf::Shader::loadFromMemory
+ (
+ const std::string &
+ vertexShader ,
+
+ const std::string &
+ fragmentShader
+
+ )
+
+
+
+
+
Load both the vertex and fragment shaders from source codes in memory.
+
This function loads both the vertex and the fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The sources must be valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShader String containing the source code of the vertex shader fragmentShader String containing the source code of the fragment shader
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromStream
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool sf::Shader::loadFromMemory
+ (
+ const std::string &
+ vertexShader ,
+
+ const std::string &
+ geometryShader ,
+
+ const std::string &
+ fragmentShader
+
+ )
+
+
+
+
+
Load the vertex, geometry and fragment shaders from source codes in memory.
+
This function loads the vertex, geometry and fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The sources must be valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShader String containing the source code of the vertex shader geometryShader String containing the source code of the geometry shader fragmentShader String containing the source code of the fragment shader
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromStream
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool sf::Shader::loadFromStream
+ (
+ InputStream & stream ,
+
+ Type type
+
+ )
+
+
+
+
+
Load the vertex, geometry or fragment shader from a custom stream.
+
This function loads a single shader, vertex, geometry or fragment, identified by the second argument. The source code must be a valid shader in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ stream Source stream to read from type Type of shader (vertex, geometry or fragment)
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool sf::Shader::loadFromStream
+ (
+ InputStream & vertexShaderStream ,
+
+ InputStream & fragmentShaderStream
+
+ )
+
+
+
+
+
Load both the vertex and fragment shaders from custom streams.
+
This function loads both the vertex and the fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The source codes must be valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShaderStream Source stream to read the vertex shader from fragmentShaderStream Source stream to read the fragment shader from
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool sf::Shader::loadFromStream
+ (
+ InputStream & vertexShaderStream ,
+
+ InputStream & geometryShaderStream ,
+
+ InputStream & fragmentShaderStream
+
+ )
+
+
+
+
+
Load the vertex, geometry and fragment shaders from custom streams.
+
This function loads the vertex, geometry and fragment shaders. If one of them fails to load, the shader is left empty (the valid shader is unloaded). The source codes must be valid shaders in GLSL language. GLSL is a C-like language dedicated to OpenGL shaders; you'll probably need to read a good documentation for it before writing your own shaders.
+
Parameters
+
+ vertexShaderStream Source stream to read the vertex shader from geometryShaderStream Source stream to read the geometry shader from fragmentShaderStream Source stream to read the fragment shader from
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆ [1/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ float
+ x
+
+ )
+
+
+
+
+
+
◆ [2/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+
+
◆ [3/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+
+
◆ [4/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z ,
+
+ float
+ w
+
+ )
+
+
+
+
+
+
◆ [5/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ const Vector2f &
+ vector
+
+ )
+
+
+
+
+
+
◆ [6/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ const Vector3f &
+ vector
+
+ )
+
+
+
+
+
+
◆ [7/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ const Color &
+ color
+
+ )
+
+
+
+
+
+
◆ [8/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ const Transform &
+ transform
+
+ )
+
+
+
+
+
+
◆ [9/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ const Texture &
+ texture
+
+ )
+
+
+
+
+
+
◆ [10/10]
+
+
+
+
+
+ void sf::Shader::setParameter
+ (
+ const std::string &
+ name ,
+
+ CurrentTextureType
+
+
+ )
+
+
+
+
+
+
◆ [1/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ float
+ x
+
+ )
+
+
+
+
+
Specify value for float uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL x Value of the float scalar
+
+
+
+
+
+
+
◆ [2/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec2 &
+ vector
+
+ )
+
+
+
+
+
Specify value for vec2 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the vec2 vector
+
+
+
+
+
+
+
◆ [3/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec3 &
+ vector
+
+ )
+
+
+
+
+
Specify value for vec3 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the vec3 vector
+
+
+
+
+
+
+
◆ [4/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec4 &
+ vector
+
+ )
+
+
+
+
+
Specify value for vec4 uniform.
+
This overload can also be called with sf::Color objects that are converted to sf::Glsl::Vec4 .
+
It is important to note that the components of the color are normalized before being passed to the shader. Therefore, they are converted from range [0 .. 255] to range [0 .. 1]. For example, a sf::Color(255, 127, 0, 255) will be transformed to a vec4(1.0, 0.5, 0.0, 1.0) in the shader.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the vec4 vector
+
+
+
+
+
+
+
◆ [5/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ int
+ x
+
+ )
+
+
+
+
+
Specify value for int uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL x Value of the int scalar
+
+
+
+
+
+
+
◆ [6/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Ivec2 &
+ vector
+
+ )
+
+
+
+
+
Specify value for ivec2 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the ivec2 vector
+
+
+
+
+
+
+
◆ [7/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Ivec3 &
+ vector
+
+ )
+
+
+
+
+
Specify value for ivec3 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the ivec3 vector
+
+
+
+
+
+
+
◆ [8/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Ivec4 &
+ vector
+
+ )
+
+
+
+
+
Specify value for ivec4 uniform.
+
This overload can also be called with sf::Color objects that are converted to sf::Glsl::Ivec4 .
+
If color conversions are used, the ivec4 uniform in GLSL will hold the same values as the original sf::Color instance. For example, sf::Color(255, 127, 0, 255) is mapped to ivec4(255, 127, 0, 255).
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the ivec4 vector
+
+
+
+
+
+
+
◆ [9/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ bool
+ x
+
+ )
+
+
+
+
+
Specify value for bool uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL x Value of the bool scalar
+
+
+
+
+
+
+
◆ [10/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Bvec2 &
+ vector
+
+ )
+
+
+
+
+
Specify value for bvec2 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the bvec2 vector
+
+
+
+
+
+
+
◆ [11/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Bvec3 &
+ vector
+
+ )
+
+
+
+
+
Specify value for bvec3 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the bvec3 vector
+
+
+
+
+
+
+
◆ [12/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Bvec4 &
+ vector
+
+ )
+
+
+
+
+
Specify value for bvec4 uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vector Value of the bvec4 vector
+
+
+
+
+
+
+
◆ [13/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Mat3 &
+ matrix
+
+ )
+
+
+
+
+
Specify value for mat3 matrix.
+
Parameters
+
+ name Name of the uniform variable in GLSL matrix Value of the mat3 matrix
+
+
+
+
+
+
+
◆ [14/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Mat4 &
+ matrix
+
+ )
+
+
+
+
+
Specify value for mat4 matrix.
+
Parameters
+
+ name Name of the uniform variable in GLSL matrix Value of the mat4 matrix
+
+
+
+
+
+
+
◆ [15/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ const Texture &
+ texture
+
+ )
+
+
+
+
+
Specify a texture as sampler2D uniform.
+
name is the name of the variable to change in the shader. The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).
+
Example:
uniform sampler2D the_texture;
...
shader.setUniform("the_texture" , texture);
It is important to note that texture must remain alive as long as the shader uses it, no copy is made internally.
+
To use the texture of the object being drawn, which cannot be known in advance, you can pass the special value sf::Shader::CurrentTexture :
Parameters
+
+ name Name of the texture in the shader texture Texture to assign
+
+
+
+
+
+
+
◆ [16/16]
+
+
+
+
+
+ void sf::Shader::setUniform
+ (
+ const std::string &
+ name ,
+
+ CurrentTextureType
+
+
+ )
+
+
+
+
+
Specify current texture as sampler2D uniform.
+
This overload maps a shader texture variable to the texture of the object being drawn, which cannot be known in advance. The second argument must be sf::Shader::CurrentTexture . The corresponding parameter in the shader must be a 2D texture (sampler2D GLSL type).
+
Example:
uniform sampler2D current;
Parameters
+
+ name Name of the texture in the shader
+
+
+
+
+
+
+
◆ [1/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const float *
+ scalarArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for float[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL scalarArray pointer to array of float values length Number of elements in the array
+
+
+
+
+
+
+
◆ [2/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec2 *
+ vectorArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for vec2[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vectorArray pointer to array of vec2 values length Number of elements in the array
+
+
+
+
+
+
+
◆ [3/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec3 *
+ vectorArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for vec3[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vectorArray pointer to array of vec3 values length Number of elements in the array
+
+
+
+
+
+
+
◆ [4/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Vec4 *
+ vectorArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for vec4[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL vectorArray pointer to array of vec4 values length Number of elements in the array
+
+
+
+
+
+
+
◆ [5/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Mat3 *
+ matrixArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for mat3[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL matrixArray pointer to array of mat3 values length Number of elements in the array
+
+
+
+
+
+
+
◆ [6/6]
+
+
+
+
+
+ void sf::Shader::setUniformArray
+ (
+ const std::string &
+ name ,
+
+ const Glsl::Mat4 *
+ matrixArray ,
+
+ std::size_t
+ length
+
+ )
+
+
+
+
+
Specify values for mat4[] array uniform.
+
Parameters
+
+ name Name of the uniform variable in GLSL matrixArray pointer to array of mat4 values length Number of elements in the array
+
+
+
+
+
+
+
+
◆
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Shape , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base class for textured shapes with outline.
+ More...
+
+
#include <Shape.hpp >
+
+
+
+
+
+
+
+
+
+
Base class for textured shapes with outline.
+
sf::Shape is a drawable class that allows to define and display a custom convex shape on a render target.
+
It's only an abstract base, it needs to be specialized for concrete types of shapes (circle, rectangle, convex polygon, star, ...).
+
In addition to the attributes provided by the specialized shape classes, a shape always has the following attributes:
+a texture
+a texture rectangle
+a fill color
+an outline color
+an outline thickness
+
+
Each feature is optional, and can be disabled easily:
+the texture can be null
+the fill/outline colors can be sf::Color::Transparent
+the outline thickness can be zero
+
+
You can write your own derived shape class, there are only two virtual functions to override:
+getPointCount must return the number of points of the shape
+getPoint must return the points of the shape
+
+
See also sf::RectangleShape , sf::CircleShape , sf::ConvexShape , sf::Transformable
+
+
Definition at line 44 of file Shape.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Shape::~Shape
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Virtual destructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::Shape::Shape
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Shape::getFillColor
+ (
+ )
+ const
+
+
+
+
+
Get the fill color of the shape.
+
Returns Fill color of the shape
+
See also setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Shape::getGlobalBounds (
+ )
+ const
+
+
+
+
+
Get the global (non-minimal) bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the shape in the global 2D world's coordinate system.
+
This function does not necessarily return the minimal bounding rectangle. It merely ensures that the returned rectangle covers all the vertices (but possibly more). This allows for a fast approximation of the bounds as a first check; you may want to use more precise checks on top of that.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Shape::getLocalBounds (
+ )
+ const
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Shape::getOutlineColor
+ (
+ )
+ const
+
+
+
+
+
Get the outline color of the shape.
+
Returns Outline color of the shape
+
See also setOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Shape::getOutlineThickness
+ (
+ )
+ const
+
+
+
+
+
Get the outline thickness of the shape.
+
Returns Outline thickness of the shape
+
See also setOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Vector2f sf::Shape::getPoint
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
Get a point of the shape.
+
The returned point is in local coordinates, that is, the shape's transforms (position, rotation, scale) are not taken into account. The result is undefined if index is out of the valid range.
+
Parameters
+
+
+
+
Returns index-th point of the shape
+
See also getPointCount
+
+
Implemented in sf::ConvexShape , sf::CircleShape , and sf::RectangleShape .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual std::size_t sf::Shape::getPointCount
+ (
+ )
+ const
+
+
+
+
+pure virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ const Texture * sf::Shape::getTexture
+ (
+ )
+ const
+
+
+
+
+
Get the source texture of the shape.
+
If the shape has no source texture, a NULL pointer is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.
+
Returns Pointer to the shape's texture
+
See also setTexture
+
+
+
+
+
◆
+
+
+
+
+
+ const IntRect & sf::Shape::getTextureRect
+ (
+ )
+ const
+
+
+
+
+
Get the sub-rectangle of the texture displayed by the shape.
+
Returns Texture rectangle of the shape
+
See also setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Shape::setFillColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the fill color of the shape.
+
This color is modulated (multiplied) with the shape's texture if any. It can be used to colorize the shape, or change its global opacity. You can use sf::Color::Transparent to make the inside of the shape transparent, and have the outline alone. By default, the shape's fill color is opaque white.
+
Parameters
+
+ color New color of the shape
+
+
+
See also getFillColor , setOutlineColor
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Shape::setOutlineColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the outline color of the shape.
+
By default, the shape's outline color is opaque white.
+
Parameters
+
+ color New outline color of the shape
+
+
+
See also getOutlineColor , setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Shape::setOutlineThickness
+ (
+ float
+ thickness )
+
+
+
+
+
Set the thickness of the shape's outline.
+
Note that negative values are allowed (so that the outline expands towards the center of the shape), and using zero disables the outline. By default, the outline thickness is 0.
+
Parameters
+
+ thickness New outline thickness
+
+
+
See also getOutlineThickness
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Shape::setTexture
+ (
+ const Texture *
+ texture ,
+
+ bool
+ resetRect = false
+
+ )
+
+
+
+
+
Change the source texture of the shape.
+
The texture argument refers to a texture that must exist as long as the shape uses it. Indeed, the shape doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the shape tries to use it, the behavior is undefined. texture can be NULL to disable texturing. If resetRect is true, the TextureRect property of the shape is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.
+
Parameters
+
+ texture New texture resetRect Should the texture rect be reset to the size of the new texture?
+
+
+
See also getTexture , setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Shape::setTextureRect
+ (
+ const IntRect &
+ rect )
+
+
+
+
+
Set the sub-rectangle of the texture that the shape will display.
+
The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.
+
Parameters
+
+ rect Rectangle defining the region of the texture to display
+
+
+
See also getTextureRect , setTexture
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Shape::update
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Recompute the internal geometry of the shape.
+
This function must be called by the derived class everytime the shape's points change (i.e. the result of either getPointCount or getPoint is different).
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Socket , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base class for all the socket types.
+ More...
+
+
#include <Socket.hpp >
+
+
+
+
+
+
+
+
+enum Type { Tcp ,
+Udp
+ } Types of protocols that the socket can use. More...
+ Socket (Type type) Default constructor. More... SocketHandle getHandle () const Return the internal handle of the socket. More... void create () Create the internal representation of the socket. More... void create (SocketHandle handle) Create the internal representation of the socket from a socket handle. More... void close () Close the socket gracefully. More...
+SocketSelector
+
+
Base class for all the socket types.
+
This class mainly defines internal stuff to be used by derived classes.
+
The only public features that it defines, and which is therefore common to all the socket classes, is the blocking state. All sockets can be set as blocking or non-blocking.
+
In blocking mode, socket functions will hang until the operation completes, which means that the entire program (well, in fact the current thread if you use multiple ones) will be stuck waiting for your socket operation to complete.
+
In non-blocking mode, all the socket functions will return immediately. If the socket is not ready to complete the requested operation, the function simply returns the proper status code (Socket::NotReady ).
+
The default mode, which is blocking, is the one that is generally used, in combination with threads or selectors. The non-blocking mode is rather used in real-time applications that run an endless loop that can poll the socket often enough, and cannot afford blocking this loop.
+
See also sf::TcpListener , sf::TcpSocket , sf::UdpSocket
+
+
Definition at line 45 of file Socket.hpp .
+
+
+
◆
+
+
+
+
+
Some special values used by sockets.
+
+Enumerator Special value that tells the system to pick any available port.
+
+
+
Definition at line 66 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Status codes that may be returned by socket functions.
+
+Enumerator The socket has sent / received the data.
+The socket is not ready to send / receive data yet.
+The socket sent a part of the data.
+The TCP socket has been disconnected.
+An unexpected error happened.
+
+
+
Definition at line 53 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Types of protocols that the socket can use.
+
+Enumerator TCP protocol.
+UDP protocol.
+
+
+
Definition at line 114 of file Socket.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Socket::~Socket
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::Socket::Socket
+ (
+ Type type )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
This constructor can only be accessed by derived classes.
+
Parameters
+
+ type Type of the socket (TCP or UDP)
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::close
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Close the socket gracefully.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Create the internal representation of the socket.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ SocketHandle
+ handle )
+
+
+
+
+protected
+
+
+
+
+
Create the internal representation of the socket from a socket handle.
+
This function can only be accessed by derived classes.
+
Parameters
+
+ handle OS-specific handle of the socket to wrap
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ SocketHandle sf::Socket::getHandle
+ (
+ )
+ const
+
+
+
+
+protected
+
+
+
+
+
Return the internal handle of the socket.
+
The returned handle may be invalid if the socket was not created yet (or already destroyed). This function can only be accessed by derived classes.
+
Returns The internal (OS-specific) handle of the socket
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Socket::isBlocking
+ (
+ )
+ const
+
+
+
+
+
Tell whether the socket is in blocking or non-blocking mode.
+
Returns True if the socket is blocking, false otherwise
+
See also setBlocking
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Socket::setBlocking
+ (
+ bool
+ blocking )
+
+
+
+
+
Set the blocking state of the socket.
+
In blocking mode, calls will not return until they have completed their task. For example, a call to Receive in blocking mode won't return until some data was actually received. In non-blocking mode, calls will always return immediately, using the return code to signal whether there was data available or not. By default, all sockets are blocking.
+
Parameters
+
+ blocking True to set the socket as blocking, false for non-blocking
+
+
+
See also isBlocking
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SocketSelector , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Multiplexer that allows to read from multiple sockets.
+ More...
+
+
#include <SocketSelector.hpp >
+
+
+
Multiplexer that allows to read from multiple sockets.
+
Socket selectors provide a way to wait until some data is available on a set of sockets, instead of just one.
+
This is convenient when you have multiple sockets that may possibly receive data, but you don't know which one will be ready first. In particular, it avoids to use a thread for each socket; with selectors, a single thread can handle all the sockets.
+
All types of sockets can be used in a selector:
+
A selector doesn't store its own copies of the sockets (socket classes are not copyable anyway), it simply keeps a reference to the original sockets that you pass to the "add" function. Therefore, you can't use the selector as a socket container, you must store them outside and make sure that they are alive as long as they are used in the selector.
+
Using a selector is simple:
+populate the selector with all the sockets that you want to observe
+make it wait until there is data available on any of the sockets
+test each socket to find out which ones are ready
+
+
Usage example:
std::list<sf::TcpSocket*> clients;
while (running)
{
{
{
{
clients.push_back(client);
}
else
{
delete client;
}
}
else
{
for (std::list<sf::TcpSocket*>::iterator it = clients.begin(); it != clients.end(); ++it)
{
{
{
...
}
}
}
}
}
}
See also sf::Socket
+
+
Definition at line 43 of file SocketSelector.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::SocketSelector::SocketSelector
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::SocketSelector::SocketSelector
+ (
+ const SocketSelector &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::SocketSelector::~SocketSelector
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SocketSelector::add
+ (
+ Socket & socket )
+
+
+
+
+
Add a new socket to the selector.
+
This function keeps a weak reference to the socket, so you have to make sure that the socket is not destroyed while it is stored in the selector. This function does nothing if the socket is not valid.
+
Parameters
+
+ socket Reference to the socket to add
+
+
+
See also remove , clear
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SocketSelector::clear
+ (
+ )
+
+
+
+
+
Remove all the sockets stored in the selector.
+
This function doesn't destroy any instance, it simply removes all the references that the selector has to external sockets.
+
See also add , remove
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SocketSelector::isReady
+ (
+ Socket & socket )
+ const
+
+
+
+
+
Test a socket to know if it is ready to receive data.
+
This function must be used after a call to Wait, to know which sockets are ready to receive data. If a socket is ready, a call to receive will never block because we know that there is data available to read. Note that if this function returns true for a TcpListener , this means that it is ready to accept a new connection.
+
Parameters
+
+
+
+
Returns True if the socket is ready to read, false otherwise
+
See also isReady
+
+
+
+
+
◆
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SocketSelector::remove
+ (
+ Socket & socket )
+
+
+
+
+
Remove a socket from the selector.
+
This function doesn't destroy the socket, it simply removes the reference that the selector has to it.
+
Parameters
+
+ socket Reference to the socket to remove
+
+
+
See also add , clear
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SocketSelector::wait
+ (
+ Time timeout = Time::Zero )
+
+
+
+
+
Wait until one or more sockets are ready to receive.
+
This function returns as soon as at least one socket has some data available to be received. To know which sockets are ready, use the isReady function. If you use a timeout and no socket is ready before the timeout is over, the function returns false.
+
Parameters
+
+ timeout Maximum time to wait, (use Time::Zero for infinity)
+
+
+
Returns True if there are sockets ready, false otherwise
+
See also isReady
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Sound , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Regular sound that can be played in the audio environment.
+ More...
+
+
#include <Sound.hpp >
+
+
+
+
+
+
+
+
+
+
Regular sound that can be played in the audio environment.
+
sf::Sound is the class to use to play sounds.
+
It provides:
+Control (play, pause, stop)
+Ability to modify output parameters in real-time (pitch, volume, ...)
+3D spatial features (position, attenuation, ...).
+
+
sf::Sound is perfect for playing short sounds that can fit in memory and require no latency, like foot steps or gun shots. For longer sounds, like background musics or long speeches, rather see sf::Music (which is based on streaming).
+
In order to work, a sound must be given a buffer of audio data to play. Audio data (samples) is stored in sf::SoundBuffer , and attached to a sound with the setBuffer() function. The buffer object attached to a sound must remain alive as long as the sound uses it. Note that multiple sounds can use the same sound buffer at the same time.
+
Usage example:
See also sf::SoundBuffer , sf::Music
+
+
Definition at line 45 of file Sound.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the sound source states.
+
+Enumerator Sound is not playing.
+Sound is paused.
+Sound is playing.
+
+
+
Definition at line 50 of file SoundSource.hpp .
+
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::Sound::Sound
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ sf::Sound::Sound
+ (
+ const SoundBuffer &
+ buffer )
+
+
+
+
+explicit
+
+
+
+
+
Construct the sound with a buffer.
+
Parameters
+
+ buffer Sound buffer containing the audio data to play with the sound
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ sf::Sound::Sound
+ (
+ const Sound &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Sound::~Sound
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getAttenuation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+ const SoundBuffer * sf::Sound::getBuffer
+ (
+ )
+ const
+
+
+
+
+
Get the audio buffer attached to the sound.
+
Returns Sound buffer attached to the sound (can be NULL)
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Sound::getLoop
+ (
+ )
+ const
+
+
+
+
+
Tell whether or not the sound is in loop mode.
+
Returns True if the sound is looping, false otherwise
+
See also setLoop
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getMinDistance
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getPitch
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the pitch of the sound.
+
Returns Pitch of the sound
+
See also setPitch
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::Sound::getPlayingOffset (
+ )
+ const
+
+
+
+
+
Get the current playing position of the sound.
+
Returns Current playing position, from the beginning of the sound
+
See also setPlayingOffset
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Vector3f sf::SoundSource::getPosition (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the 3D position of the sound in the audio scene.
+
Returns Position of the sound
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Status sf::Sound::getStatus (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the current status of the sound (stopped, paused, playing)
+
Returns Current status of the sound
+
+
Reimplemented from sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getVolume
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the volume of the sound.
+
Returns Volume of the sound, in the range [0, 100]
+
See also setVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundSource::isRelativeToListener
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the sound's position is relative to the listener or is absolute.
+
Returns True if the position is relative, false if it's absolute
+
See also setRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+ Sound & sf::Sound::operator= (
+ const Sound &
+ right )
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Sound::pause
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Pause the sound.
+
This function pauses the sound if it was playing, otherwise (sound already paused or stopped) it has no effect.
+
See also play , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Sound::play
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Start or resume playing the sound.
+
This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the sound is played.
+
See also pause , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sound::resetBuffer
+ (
+ )
+
+
+
+
+
Reset the internal buffer of the sound.
+
This function is for internal use only, you don't have to use it. It is called by the sf::SoundBuffer that this sound uses, when it is destroyed in order to prevent the sound from using a dead buffer.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setAttenuation
+ (
+ float
+ attenuation )
+
+
+
+
+inherited
+
+
+
+
+
Set the attenuation factor of the sound.
+
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.
+
Parameters
+
+ attenuation New attenuation factor of the sound
+
+
+
See also getAttenuation , setMinDistance
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sound::setBuffer
+ (
+ const SoundBuffer &
+ buffer )
+
+
+
+
+
Set the source buffer containing the audio data to play.
+
It is important to note that the sound buffer is not copied, thus the sf::SoundBuffer instance must remain alive as long as it is attached to the sound.
+
Parameters
+
+ buffer Sound buffer to attach to the sound
+
+
+
See also getBuffer
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sound::setLoop
+ (
+ bool
+ loop )
+
+
+
+
+
Set whether or not the sound should loop after reaching the end.
+
If set, the sound will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for sound is false.
+
Parameters
+
+ loop True to play in loop, false to play once
+
+
+
See also getLoop
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setMinDistance
+ (
+ float
+ distance )
+
+
+
+
+inherited
+
+
+
+
+
Set the minimum distance of the sound.
+
The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head
+of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.
+
Parameters
+
+ distance New minimum distance of the sound
+
+
+
See also getMinDistance , setAttenuation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPitch
+ (
+ float
+ pitch )
+
+
+
+
+inherited
+
+
+
+
+
Set the pitch of the sound.
+
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.
+
Parameters
+
+ pitch New pitch to apply to the sound
+
+
+
See also getPitch
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sound::setPlayingOffset
+ (
+ Time timeOffset )
+
+
+
+
+
Change the current playing position of the sound.
+
The playing position can be changed when the sound is either paused or playing. Changing the playing position when the sound is stopped has no effect, since playing the sound will reset its position.
+
Parameters
+
+ timeOffset New playing position, from the beginning of the sound
+
+
+
See also getPlayingOffset
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ x X coordinate of the position of the sound in the scene y Y coordinate of the position of the sound in the scene z Z coordinate of the position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ const Vector3f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ position Position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setRelativeToListener
+ (
+ bool
+ relative )
+
+
+
+
+inherited
+
+
+
+
+
Make the sound's position relative to the listener or absolute.
+
Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).
+
Parameters
+
+ relative True to set the position relative, false to set it absolute
+
+
+
See also isRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setVolume
+ (
+ float
+ volume )
+
+
+
+
+inherited
+
+
+
+
+
Set the volume of the sound.
+
The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
+
Parameters
+
+ volume Volume of the sound
+
+
+
See also getVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Sound::stop
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
stop playing the sound
+
This function stops the sound if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause() ).
+
See also play , pause
+
+
Implements sf::SoundSource .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundSource::m_source
+
+
+
+
+protected inherited
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundBuffer , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Storage for audio samples defining a sound.
+ More...
+
+
#include <SoundBuffer.hpp >
+
+
+
+
+
+
+
+
+
+
Storage for audio samples defining a sound.
+
A sound buffer holds the data of a sound, which is an array of audio samples.
+
A sample is a 16 bits signed integer that defines the amplitude of the sound at a given time. The sound is then reconstituted by playing these samples at a high rate (for example, 44100 samples per second is the standard rate used for playing CDs). In short, audio samples are like texture pixels, and a sf::SoundBuffer is similar to a sf::Texture .
+
A sound buffer can be loaded from a file (see loadFromFile() for the complete list of supported formats), from memory, from a custom stream (see sf::InputStream ) or directly from an array of samples. It can also be saved back to a file.
+
Sound buffers alone are not very useful: they hold the audio data but cannot be played. To do so, you need to use the sf::Sound class, which provides functions to play/pause/stop the sound as well as changing the way it is outputted (volume, pitch, 3D position, ...). This separation allows more flexibility and better performances: indeed a sf::SoundBuffer is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a sf::Sound is a lightweight object, which can use the audio data of a sound buffer and change the way it is played without actually modifying that data. Note that it is also possible to bind several sf::Sound instances to the same sf::SoundBuffer .
+
It is important to note that the sf::Sound instance doesn't copy the buffer that it uses, it only keeps a reference to it. Thus, a sf::SoundBuffer must not be destructed while it is used by a sf::Sound (i.e. never write a function that uses a local sf::SoundBuffer instance for loading a sound).
+
Usage example:
See also sf::Sound , sf::SoundBufferRecorder
+
+
Definition at line 49 of file SoundBuffer.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::SoundBuffer::SoundBuffer
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::SoundBuffer::SoundBuffer
+ (
+ const SoundBuffer &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::SoundBuffer::~SoundBuffer
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundBuffer::getChannelCount
+ (
+ )
+ const
+
+
+
+
+
Get the number of channels used by the sound.
+
If the sound is mono then the number of channels will be 1, 2 for stereo, etc.
+
Returns Number of channels
+
See also getSampleRate , getDuration
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::SoundBuffer::getDuration (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ Uint64 sf::SoundBuffer::getSampleCount
+ (
+ )
+ const
+
+
+
+
+
Get the number of samples stored in the buffer.
+
The array of samples can be accessed with the getSamples() function.
+
Returns Number of samples
+
See also getSamples
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundBuffer::getSampleRate
+ (
+ )
+ const
+
+
+
+
+
Get the sample rate of the sound.
+
The sample rate is the number of samples played per second. The higher, the better the quality (for example, 44100 samples/s is CD quality).
+
Returns Sample rate (number of samples per second)
+
See also getChannelCount , getDuration
+
+
+
+
+
◆
+
+
+
+
+
+ const Int16* sf::SoundBuffer::getSamples
+ (
+ )
+ const
+
+
+
+
+
Get the array of audio samples stored in the buffer.
+
The format of the returned samples is 16 bits signed integer (sf::Int16). The total number of samples in this array is given by the getSampleCount() function.
+
Returns Read-only pointer to the array of sound samples
+
See also getSampleCount
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundBuffer::loadFromFile
+ (
+ const std::string &
+ filename )
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundBuffer::loadFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+
Load the sound buffer from a file in memory.
+
See the documentation of sf::InputSoundFile for the list of supported formats.
+
Parameters
+
+ data Pointer to the file data in memory sizeInBytes Size of the data to load, in bytes
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromStream , loadFromSamples
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundBuffer::loadFromSamples
+ (
+ const Int16 *
+ samples ,
+
+ Uint64
+ sampleCount ,
+
+ unsigned int
+ channelCount ,
+
+ unsigned int
+ sampleRate
+
+ )
+
+
+
+
+
Load the sound buffer from an array of audio samples.
+
The assumed format of the audio samples is 16 bits signed integer (sf::Int16).
+
Parameters
+
+ samples Pointer to the array of samples in memory sampleCount Number of samples in the array channelCount Number of channels (1 = mono, 2 = stereo, ...) sampleRate Sample rate (number of samples to play per second)
+
+
+
Returns True if loading succeeded, false if it failed
+
See also loadFromFile , loadFromMemory , saveToFile
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundBuffer::loadFromStream
+ (
+ InputStream & stream )
+
+
+
+
+
+
◆
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundBuffer::saveToFile
+ (
+ const std::string &
+ filename )
+ const
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundBufferRecorder , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized SoundRecorder which stores the captured audio data into a sound buffer.
+ More...
+
+
#include <SoundBufferRecorder.hpp >
+
+
+
+
+
+
+
+
+
+
Specialized SoundRecorder which stores the captured audio data into a sound buffer.
+
sf::SoundBufferRecorder allows to access a recorded sound through a sf::SoundBuffer , so that it can be played, saved to a file, etc.
+
It has the same simple interface as its base class (start() , stop() ) and adds a function to retrieve the recorded sound buffer (getBuffer() ).
+
As usual, don't forget to call the isAvailable() function before using this class (see sf::SoundRecorder for more details about this).
+
Usage example:
See also sf::SoundRecorder
+
+
Definition at line 44 of file SoundBufferRecorder.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::SoundBufferRecorder::~SoundBufferRecorder
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::vector<std::string> sf::SoundRecorder::getAvailableDevices
+ (
+ )
+
+
+
+
+static inherited
+
+
+
+
+
Get a list of the names of all available audio capture devices.
+
This function returns a vector of strings, containing the names of all available audio capture devices.
+
Returns A vector of strings containing the names
+
+
+
+
+
◆
+
+
+
+
+
+ const SoundBuffer & sf::SoundBufferRecorder::getBuffer
+ (
+ )
+ const
+
+
+
+
+
Get the sound buffer containing the captured audio data.
+
The sound buffer is valid only after the capture has ended. This function provides a read-only access to the internal sound buffer, but it can be copied if you need to make any modification to it.
+
Returns Read-only access to the sound buffer
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundRecorder::getChannelCount
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the number of channels used by this recorder.
+
Currently only mono and stereo are supported, so the value is either 1 (for mono) or 2 (for stereo).
+
Returns Number of channels
+
See also setChannelCount
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::string sf::SoundRecorder::getDefaultDevice
+ (
+ )
+
+
+
+
+static inherited
+
+
+
+
+
Get the name of the default audio capture device.
+
This function returns the name of the default audio capture device. If none is available, an empty string is returned.
+
Returns The name of the default audio capture device
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const std::string& sf::SoundRecorder::getDevice
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the name of the current audio capture device.
+
Returns The name of the current audio capture device
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundRecorder::getSampleRate
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the sample rate.
+
The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).
+
Returns Sample rate, in samples per second
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::SoundRecorder::isAvailable
+ (
+ )
+
+
+
+
+static inherited
+
+
+
+
+
Check if the system supports audio capture.
+
This function should always be called before using the audio capture features. If it returns false, then any attempt to use sf::SoundRecorder or one of its derived classes will fail.
+
Returns True if audio capture is supported, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundBufferRecorder::onProcessSamples
+ (
+ const Int16 *
+ samples ,
+
+ std::size_t
+ sampleCount
+
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Process a new chunk of recorded samples.
+
Parameters
+
+ samples Pointer to the new chunk of recorded samples sampleCount Number of samples pointed by samples
+
+
+
Returns True to continue the capture, or false to stop it
+
+
Implements sf::SoundRecorder .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundBufferRecorder::onStart
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Start capturing audio data.
+
Returns True to start the capture, or false to abort it
+
+
Reimplemented from sf::SoundRecorder .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundBufferRecorder::onStop
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundRecorder::setChannelCount
+ (
+ unsigned int
+ channelCount )
+
+
+
+
+inherited
+
+
+
+
+
Set the channel count of the audio capture device.
+
This method allows you to specify the number of channels used for recording. Currently only 16-bit mono and 16-bit stereo are supported.
+
Parameters
+
+ channelCount Number of channels. Currently only mono (1) and stereo (2) are supported.
+
+
+
See also getChannelCount
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundRecorder::setDevice
+ (
+ const std::string &
+ name )
+
+
+
+
+inherited
+
+
+
+
+
Set the audio capture device.
+
This function sets the audio capture device to the device with the given name . It can be called on the fly (i.e: while recording). If you do so while recording and opening the device fails, it stops the recording.
+
Parameters
+
+ name The name of the audio capture device
+
+
+
Returns True, if it was able to set the requested device
+
See also getAvailableDevices , getDefaultDevice
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundRecorder::setProcessingInterval
+ (
+ Time interval )
+
+
+
+
+protected inherited
+
+
+
+
+
Set the processing interval.
+
The processing interval controls the period between calls to the onProcessSamples function. You may want to use a small interval if you want to process the recorded data in real time, for example.
+
Note: this is only a hint, the actual period may vary. So don't rely on this parameter to implement precise timing.
+
The default processing interval is 100 ms.
+
Parameters
+
+ interval Processing interval
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundRecorder::start
+ (
+ unsigned int
+ sampleRate = 44100)
+
+
+
+
+inherited
+
+
+
+
+
Start the capture.
+
The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time. You can select which capture device will be used, by passing the name to the setDevice() method. If none was selected before, the default capture device will be used. You can get a list of the names of all available capture devices by calling getAvailableDevices() .
+
Parameters
+
+ sampleRate Desired capture rate, in number of samples per second
+
+
+
Returns True, if start of capture was successful
+
See also stop , getAvailableDevices
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundRecorder::stop
+ (
+ )
+
+
+
+
+inherited
+
+
+
+
+
Stop the capture.
+
See also start
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundFileFactory , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Manages and instantiates sound file readers and writers.
+ More...
+
+
#include <SoundFileFactory.hpp >
+
+
+
Manages and instantiates sound file readers and writers.
+
This class is where all the sound file readers and writers are registered.
+
You should normally only need to use its registration and unregistration functions; readers/writers creation and manipulation are wrapped into the higher-level classes sf::InputSoundFile and sf::OutputSoundFile .
+
To register a new reader (writer) use the sf::SoundFileFactory::registerReader (registerWriter) static function. You don't have to call the unregisterReader (unregisterWriter) function, unless you want to unregister a format before your application ends (typically, when a plugin is unloaded).
+
Usage example:
sf::SoundFileFactory::registerReader<MySoundFileReader>();
sf::SoundFileFactory::registerWriter<MySoundFileWriter>();
See also sf::InputSoundFile , sf::OutputSoundFile , sf::SoundFileReader , sf::SoundFileWriter
+
+
Definition at line 46 of file SoundFileFactory.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ static SoundFileReader * sf::SoundFileFactory::createReaderFromFilename
+ (
+ const std::string &
+ filename )
+
+
+
+
+static
+
+
+
+
+
Instantiate the right reader for the given file on disk.
+
It's up to the caller to release the returned reader
+
Parameters
+
+ filename Path of the sound file
+
+
+
Returns A new sound file reader that can read the given file, or null if no reader can handle it
+
See also createReaderFromMemory , createReaderFromStream
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static SoundFileReader * sf::SoundFileFactory::createReaderFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ sizeInBytes
+
+ )
+
+
+
+
+static
+
+
+
+
+
Instantiate the right codec for the given file in memory.
+
It's up to the caller to release the returned reader
+
Parameters
+
+ data Pointer to the file data in memory sizeInBytes Total size of the file data, in bytes
+
+
+
Returns A new sound file codec that can read the given file, or null if no codec can handle it
+
See also createReaderFromFilename , createReaderFromStream
+
+
+
+
+
◆
+
+
+
+
+
Instantiate the right codec for the given file in stream.
+
It's up to the caller to release the returned reader
+
Parameters
+
+ stream Source stream to read from
+
+
+
Returns A new sound file codec that can read the given file, or null if no codec can handle it
+
See also createReaderFromFilename , createReaderFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static SoundFileWriter * sf::SoundFileFactory::createWriterFromFilename
+ (
+ const std::string &
+ filename )
+
+
+
+
+static
+
+
+
+
+
Instantiate the right writer for the given file on disk.
+
It's up to the caller to release the returned writer
+
Parameters
+
+ filename Path of the sound file
+
+
+
Returns A new sound file writer that can write given file, or null if no writer can handle it
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static void sf::SoundFileFactory::registerReader
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static void sf::SoundFileFactory::registerWriter
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static void sf::SoundFileFactory::unregisterReader
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static void sf::SoundFileFactory::unregisterWriter
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundFileReader , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract base class for sound file decoding.
+ More...
+
+
#include <SoundFileReader.hpp >
+
+struct Info Structure holding the audio properties of a sound file. More...
+virtual ~SoundFileReader () Virtual destructor. More... virtual bool open (InputStream &stream, Info &info)=0 Open a sound file for reading. More... virtual void seek (Uint64 sampleOffset)=0 Change the current read position to the given sample offset. More... virtual Uint64 read (Int16 *samples, Uint64 maxCount)=0 Read audio samples from the open file. More...
+
+
Abstract base class for sound file decoding.
+
This class allows users to read audio file formats not natively supported by SFML, and thus extend the set of supported readable audio formats.
+
A valid sound file reader must override the open, seek and write functions, as well as providing a static check function; the latter is used by SFML to find a suitable writer for a given input file.
+
To register a new reader, use the sf::SoundFileFactory::registerReader template function.
+
Usage example:
{
public :
{
}
{
}
virtual void seek (sf::Uint64 sampleOffset)
{
}
virtual sf::Uint64
read (sf::Int16* samples, sf::Uint64 maxCount)
{
}
};
sf::SoundFileFactory::registerReader<MySoundFileReader>();
See also sf::InputSoundFile , sf::SoundFileFactory , sf::SoundFileWriter
+
+
Definition at line 43 of file SoundFileReader.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::SoundFileReader::~SoundFileReader
+ (
+ )
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundFileReader::open
+ (
+ InputStream & stream ,
+
+ Info & info
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Open a sound file for reading.
+
The provided stream reference is valid as long as the SoundFileReader is alive, so it is safe to use/store it during the whole lifetime of the reader.
+
Parameters
+
+ stream Source stream to read from info Structure to fill with the properties of the loaded sound
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Uint64 sf::SoundFileReader::read
+ (
+ Int16 *
+ samples ,
+
+ Uint64
+ maxCount
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Read audio samples from the open file.
+
Parameters
+
+ samples Pointer to the sample array to fill maxCount Maximum number of samples to read
+
+
+
Returns Number of samples actually read (may be less than maxCount )
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundFileReader::seek
+ (
+ Uint64
+ sampleOffset )
+
+
+
+
+pure virtual
+
+
+
+
+
Change the current read position to the given sample offset.
+
The sample offset takes the channels into account. If you have a time offset instead, you can easily find the corresponding sample offset with the following formula: timeInSeconds * sampleRate * channelCount If the given offset exceeds to total number of samples, this function must jump to the end of the file.
+
Parameters
+
+ sampleOffset Index of the sample to jump to, relative to the beginning
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundFileWriter , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract base class for sound file encoding.
+ More...
+
+
#include <SoundFileWriter.hpp >
+
+virtual ~SoundFileWriter () Virtual destructor. More... virtual bool open (const std::string &filename, unsigned int sampleRate, unsigned int channelCount)=0 Open a sound file for writing. More... virtual void write (const Int16 *samples, Uint64 count)=0 Write audio samples to the open file. More...
+
+
Abstract base class for sound file encoding.
+
This class allows users to write audio file formats not natively supported by SFML, and thus extend the set of supported writable audio formats.
+
A valid sound file writer must override the open and write functions, as well as providing a static check function; the latter is used by SFML to find a suitable writer for a given filename.
+
To register a new writer, use the sf::SoundFileFactory::registerWriter template function.
+
Usage example:
{
public :
static bool check(const std::string& filename)
{
}
virtual bool open (
const std::string& filename,
unsigned int sampleRate,
unsigned int channelCount)
{
}
virtual void write (
const sf::Int16* samples, sf::Uint64 count)
{
}
};
sf::SoundFileFactory::registerWriter<MySoundFileWriter>();
See also sf::OutputSoundFile , sf::SoundFileFactory , sf::SoundFileReader
+
+
Definition at line 41 of file SoundFileWriter.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::SoundFileWriter::~SoundFileWriter
+ (
+ )
+
+
+
+
+inline virtual
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundFileWriter::open
+ (
+ const std::string &
+ filename ,
+
+ unsigned int
+ sampleRate ,
+
+ unsigned int
+ channelCount
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Open a sound file for writing.
+
Parameters
+
+ filename Path of the file to open sampleRate Sample rate of the sound channelCount Number of channels of the sound
+
+
+
Returns True if the file was successfully opened
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundFileWriter::write
+ (
+ const Int16 *
+ samples ,
+
+ Uint64
+ count
+
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Write audio samples to the open file.
+
Parameters
+
+ samples Pointer to the sample array to write count Number of samples to write
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundRecorder , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract base class for capturing sound data.
+ More...
+
+
#include <SoundRecorder.hpp >
+
+
+
+
+
+
+
+
+
+
Abstract base class for capturing sound data.
+
sf::SoundBuffer provides a simple interface to access the audio recording capabilities of the computer (the microphone).
+
As an abstract base class, it only cares about capturing sound samples, the task of making something useful with them is left to the derived class. Note that SFML provides a built-in specialization for saving the captured data to a sound buffer (see sf::SoundBufferRecorder ).
+
A derived class has only one virtual function to override:
+onProcessSamples provides the new chunks of audio samples while the capture happens
+
+
Moreover, two additional virtual functions can be overridden as well if necessary:
+onStart is called before the capture happens, to perform custom initializations
+onStop is called after the capture ends, to perform custom cleanup
+
+
A derived class can also control the frequency of the onProcessSamples calls, with the setProcessingInterval protected function. The default interval is chosen so that recording thread doesn't consume too much CPU, but it can be changed to a smaller value if you need to process the recorded data in real time, for example.
+
The audio capture feature may not be supported or activated on every platform, thus it is recommended to check its availability with the isAvailable() function. If it returns false, then any attempt to use an audio recorder will fail.
+
If you have multiple sound input devices connected to your computer (for example: microphone, external soundcard, webcam mic, ...) you can get a list of all available devices through the getAvailableDevices() function. You can then select a device by calling setDevice() with the appropriate device. Otherwise the default capturing device will be used.
+
By default the recording is in 16-bit mono. Using the setChannelCount method you can change the number of channels used by the audio capture device to record. Note that you have to decide whether you want to record in mono or stereo before starting the recording.
+
It is important to note that the audio capture happens in a separate thread, so that it doesn't block the rest of the program. In particular, the onProcessSamples virtual function (but not onStart and not onStop) will be called from this separate thread. It is important to keep this in mind, because you may have to take care of synchronization issues if you share data between threads. Another thing to bear in mind is that you must call stop() in the destructor of your derived class, so that the recording thread finishes before your object is destroyed.
+
Usage example:
{
~CustomRecorder()
{
}
{
...
return true ;
}
{
...
return true ;
}
{
...
}
}
if (CustomRecorder::isAvailable())
{
CustomRecorder recorder;
if (!recorder.start())
return -1;
...
recorder.stop();
}
See also sf::SoundBufferRecorder
+
+
Definition at line 45 of file SoundRecorder.hpp .
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::SoundRecorder::~SoundRecorder
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::SoundRecorder::SoundRecorder
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
This constructor is only meant to be called by derived classes.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::vector<std::string> sf::SoundRecorder::getAvailableDevices
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get a list of the names of all available audio capture devices.
+
This function returns a vector of strings, containing the names of all available audio capture devices.
+
Returns A vector of strings containing the names
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundRecorder::getChannelCount
+ (
+ )
+ const
+
+
+
+
+
Get the number of channels used by this recorder.
+
Currently only mono and stereo are supported, so the value is either 1 (for mono) or 2 (for stereo).
+
Returns Number of channels
+
See also setChannelCount
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::string sf::SoundRecorder::getDefaultDevice
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the name of the default audio capture device.
+
This function returns the name of the default audio capture device. If none is available, an empty string is returned.
+
Returns The name of the default audio capture device
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& sf::SoundRecorder::getDevice
+ (
+ )
+ const
+
+
+
+
+
Get the name of the current audio capture device.
+
Returns The name of the current audio capture device
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundRecorder::getSampleRate
+ (
+ )
+ const
+
+
+
+
+
Get the sample rate.
+
The sample rate defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality).
+
Returns Sample rate, in samples per second
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::SoundRecorder::isAvailable
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Check if the system supports audio capture.
+
This function should always be called before using the audio capture features. If it returns false, then any attempt to use sf::SoundRecorder or one of its derived classes will fail.
+
Returns True if audio capture is supported, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundRecorder::onProcessSamples
+ (
+ const Int16 *
+ samples ,
+
+ std::size_t
+ sampleCount
+
+ )
+
+
+
+
+protected pure virtual
+
+
+
+
+
Process a new chunk of recorded samples.
+
This virtual function is called every time a new chunk of recorded data is available. The derived class can then do whatever it wants with it (storing it, playing it, sending it over the network, etc.).
+
Parameters
+
+ samples Pointer to the new chunk of recorded samples sampleCount Number of samples pointed by samples
+
+
+
Returns True to continue the capture, or false to stop it
+
+
Implemented in sf::SoundBufferRecorder .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundRecorder::onStart
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Start capturing audio data.
+
This virtual function may be overridden by a derived class if something has to be done every time a new capture starts. If not, this function can be ignored; the default implementation does nothing.
+
Returns True to start the capture, or false to abort it
+
+
Reimplemented in sf::SoundBufferRecorder .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundRecorder::onStop
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Stop capturing audio data.
+
This virtual function may be overridden by a derived class if something has to be done every time the capture ends. If not, this function can be ignored; the default implementation does nothing.
+
+
Reimplemented in sf::SoundBufferRecorder .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundRecorder::setChannelCount
+ (
+ unsigned int
+ channelCount )
+
+
+
+
+
Set the channel count of the audio capture device.
+
This method allows you to specify the number of channels used for recording. Currently only 16-bit mono and 16-bit stereo are supported.
+
Parameters
+
+ channelCount Number of channels. Currently only mono (1) and stereo (2) are supported.
+
+
+
See also getChannelCount
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundRecorder::setDevice
+ (
+ const std::string &
+ name )
+
+
+
+
+
Set the audio capture device.
+
This function sets the audio capture device to the device with the given name . It can be called on the fly (i.e: while recording). If you do so while recording and opening the device fails, it stops the recording.
+
Parameters
+
+ name The name of the audio capture device
+
+
+
Returns True, if it was able to set the requested device
+
See also getAvailableDevices , getDefaultDevice
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundRecorder::setProcessingInterval
+ (
+ Time interval )
+
+
+
+
+protected
+
+
+
+
+
Set the processing interval.
+
The processing interval controls the period between calls to the onProcessSamples function. You may want to use a small interval if you want to process the recorded data in real time, for example.
+
Note: this is only a hint, the actual period may vary. So don't rely on this parameter to implement precise timing.
+
The default processing interval is 100 ms.
+
Parameters
+
+ interval Processing interval
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundRecorder::start
+ (
+ unsigned int
+ sampleRate = 44100)
+
+
+
+
+
Start the capture.
+
The sampleRate parameter defines the number of audio samples captured per second. The higher, the better the quality (for example, 44100 samples/sec is CD quality). This function uses its own thread so that it doesn't block the rest of the program while the capture runs. Please note that only one capture can happen at the same time. You can select which capture device will be used, by passing the name to the setDevice() method. If none was selected before, the default capture device will be used. You can get a list of the names of all available capture devices by calling getAvailableDevices() .
+
Parameters
+
+ sampleRate Desired capture rate, in number of samples per second
+
+
+
Returns True, if start of capture was successful
+
See also stop , getAvailableDevices
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundRecorder::stop
+ (
+ )
+
+
+
+
+
Stop the capture.
+
See also start
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundSource , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base class defining a sound's properties.
+ More...
+
+
#include <SoundSource.hpp >
+
+
+
+
+
+
+
+
+
+
Base class defining a sound's properties.
+
sf::SoundSource is not meant to be used directly, it only serves as a common base for all audio objects that can live in the audio environment.
+
It defines several properties for the sound: pitch, volume, position, attenuation, etc. All of them can be changed at any time with no impact on performances.
+
See also sf::Sound , sf::SoundStream
+
+
Definition at line 42 of file SoundSource.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the sound source states.
+
+Enumerator Sound is not playing.
+Sound is paused.
+Sound is playing.
+
+
+
Definition at line 50 of file SoundSource.hpp .
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::SoundSource::SoundSource
+ (
+ const SoundSource &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::SoundSource::~SoundSource
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ sf::SoundSource::SoundSource
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
This constructor is meant to be called by derived classes only.
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::SoundSource::getAttenuation
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::SoundSource::getMinDistance
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::SoundSource::getPitch
+ (
+ )
+ const
+
+
+
+
+
Get the pitch of the sound.
+
Returns Pitch of the sound
+
See also setPitch
+
+
+
+
+
◆
+
+
+
+
+
+ Vector3f sf::SoundSource::getPosition (
+ )
+ const
+
+
+
+
+
Get the 3D position of the sound in the audio scene.
+
Returns Position of the sound
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Status sf::SoundSource::getStatus
+ (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the current status of the sound (stopped, paused, playing)
+
Returns Current status of the sound
+
+
Reimplemented in sf::Sound , and sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::SoundSource::getVolume
+ (
+ )
+ const
+
+
+
+
+
Get the volume of the sound.
+
Returns Volume of the sound, in the range [0, 100]
+
See also setVolume
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundSource::isRelativeToListener
+ (
+ )
+ const
+
+
+
+
+
Tell whether the sound's position is relative to the listener or is absolute.
+
Returns True if the position is relative, false if it's absolute
+
See also setRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundSource::pause
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Pause the sound source.
+
This function pauses the source if it was playing, otherwise (source already paused or stopped) it has no effect.
+
See also play , stop
+
+
Implemented in sf::Sound , and sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundSource::play
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Start or resume playing the sound source.
+
This function starts the source if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing.
+
See also pause , stop
+
+
Implemented in sf::Sound , and sf::SoundStream .
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundSource::setAttenuation
+ (
+ float
+ attenuation )
+
+
+
+
+
Set the attenuation factor of the sound.
+
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.
+
Parameters
+
+ attenuation New attenuation factor of the sound
+
+
+
See also getAttenuation , setMinDistance
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundSource::setMinDistance
+ (
+ float
+ distance )
+
+
+
+
+
Set the minimum distance of the sound.
+
The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head
+of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.
+
Parameters
+
+ distance New minimum distance of the sound
+
+
+
See also getMinDistance , setAttenuation
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundSource::setPitch
+ (
+ float
+ pitch )
+
+
+
+
+
Set the pitch of the sound.
+
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.
+
Parameters
+
+ pitch New pitch to apply to the sound
+
+
+
See also getPitch
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ x X coordinate of the position of the sound in the scene y Y coordinate of the position of the sound in the scene z Z coordinate of the position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ const Vector3f &
+ position )
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ position Position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundSource::setRelativeToListener
+ (
+ bool
+ relative )
+
+
+
+
+
Make the sound's position relative to the listener or absolute.
+
Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).
+
Parameters
+
+ relative True to set the position relative, false to set it absolute
+
+
+
See also isRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundSource::setVolume
+ (
+ float
+ volume )
+
+
+
+
+
Set the volume of the sound.
+
The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
+
Parameters
+
+ volume Volume of the sound
+
+
+
See also getVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundSource::stop
+ (
+ )
+
+
+
+
+pure virtual
+
+
+
+
+
Stop playing the sound source.
+
This function stops the source if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause() ).
+
See also play , pause
+
+
Implemented in sf::Sound , and sf::SoundStream .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundSource::m_source
+
+
+
+
+protected
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundStream , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Abstract base class for streamed audio sources.
+ More...
+
+
#include <SoundStream.hpp >
+
+
+
+
+
+
+
+
+struct Chunk Structure defining a chunk of audio data to stream. More...
+ SoundStream () Default constructor. More... void initialize (unsigned int channelCount, unsigned int sampleRate) Define the audio stream parameters. More... virtual bool onGetData (Chunk &data)=0 Request a new chunk of audio samples from the stream source. More... virtual void onSeek (Time timeOffset)=0 Change the current playing position in the stream source. More... virtual Int64 onLoop () Change the current playing position in the stream source to the beginning of the loop. More...
+
+
Abstract base class for streamed audio sources.
+
Unlike audio buffers (see sf::SoundBuffer ), audio streams are never completely loaded in memory.
+
Instead, the audio data is acquired continuously while the stream is playing. This behavior allows to play a sound with no loading delay, and keeps the memory consumption very low.
+
Sound sources that need to be streamed are usually big files (compressed audio musics that would eat hundreds of MB in memory) or files that would take a lot of time to be received (sounds played over the network).
+
sf::SoundStream is a base class that doesn't care about the stream source, which is left to the derived class. SFML provides a built-in specialization for big files (see sf::Music ). No network stream source is provided, but you can write your own by combining this class with the network module.
+
A derived class has to override two virtual functions:
+onGetData fills a new chunk of audio data to be played
+onSeek changes the current playing position in the source
+
+
It is important to note that each SoundStream is played in its own separate thread, so that the streaming loop doesn't block the rest of the program. In particular, the OnGetData and OnSeek virtual functions may sometimes be called from this separate thread. It is important to keep this in mind, because you may have to take care of synchronization issues if you share data between threads.
+
Usage example:
{
public :
bool open(const std::string& location)
{
...
unsigned int channelCount = ...;
unsigned int sampleRate = ...;
}
private :
{
data.samples = ...;
data.sampleCount = ...;
return true ;
}
virtual void onSeek (Uint32 timeOffset)
{
...
}
}
CustomStream stream;
stream.open("path/to/stream" );
stream.play();
See also sf::Music
+
+
Definition at line 45 of file SoundStream.hpp .
+
+
+
◆
+
+
+
+
+Enumerator "Invalid" endSeeks value, telling us to continue uninterrupted
+
+
+
Definition at line 183 of file SoundStream.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of the sound source states.
+
+Enumerator Sound is not playing.
+Sound is paused.
+Sound is playing.
+
+
+
Definition at line 50 of file SoundSource.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::SoundStream::~SoundStream
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::SoundStream::SoundStream
+ (
+ )
+
+
+
+
+protected
+
+
+
+
+
Default constructor.
+
This constructor is only meant to be called by derived classes.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getAttenuation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundStream::getChannelCount
+ (
+ )
+ const
+
+
+
+
+
Return the number of channels of the stream.
+
1 channel means a mono sound, 2 means stereo, etc.
+
Returns Number of channels
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::SoundStream::getLoop
+ (
+ )
+ const
+
+
+
+
+
Tell whether or not the stream is in loop mode.
+
Returns True if the stream is looping, false otherwise
+
See also setLoop
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getMinDistance
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getPitch
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the pitch of the sound.
+
Returns Pitch of the sound
+
See also setPitch
+
+
+
+
+
◆
+
+
+
+
+
+ Time sf::SoundStream::getPlayingOffset (
+ )
+ const
+
+
+
+
+
Get the current playing position of the stream.
+
Returns Current playing position, from the beginning of the stream
+
See also setPlayingOffset
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Vector3f sf::SoundSource::getPosition (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the 3D position of the sound in the audio scene.
+
Returns Position of the sound
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundStream::getSampleRate
+ (
+ )
+ const
+
+
+
+
+
Get the stream sample rate of the stream.
+
The sample rate is the number of audio samples played per second. The higher, the better the quality.
+
Returns Sample rate, in number of samples per second
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Status sf::SoundStream::getStatus (
+ )
+ const
+
+
+
+
+virtual
+
+
+
+
+
Get the current status of the stream (stopped, paused, playing)
+
Returns Current status
+
+
Reimplemented from sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::SoundSource::getVolume
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Get the volume of the sound.
+
Returns Volume of the sound, in the range [0, 100]
+
See also setVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::initialize
+ (
+ unsigned int
+ channelCount ,
+
+ unsigned int
+ sampleRate
+
+ )
+
+
+
+
+protected
+
+
+
+
+
Define the audio stream parameters.
+
This function must be called by derived classes as soon as they know the audio settings of the stream to play. Any attempt to manipulate the stream (play() , ...) before calling this function will fail. It can be called multiple times if the settings of the audio stream change, but only when the stream is stopped.
+
Parameters
+
+ channelCount Number of channels of the stream sampleRate Sample rate, in samples per second
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::SoundSource::isRelativeToListener
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the sound's position is relative to the listener or is absolute.
+
Returns True if the position is relative, false if it's absolute
+
See also setRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual bool sf::SoundStream::onGetData
+ (
+ Chunk & data )
+
+
+
+
+protected pure virtual
+
+
+
+
+
Request a new chunk of audio samples from the stream source.
+
This function must be overridden by derived classes to provide the audio samples to play. It is called continuously by the streaming loop, in a separate thread. The source can choose to stop the streaming loop at any time, by returning false to the caller. If you return true (i.e. continue streaming) it is important that the returned array of samples is not empty; this would stop the stream due to an internal limitation.
+
Parameters
+
+ data Chunk of data to fill
+
+
+
Returns True to continue playback, false to stop
+
+
Implemented in sf::Music .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual Int64 sf::SoundStream::onLoop
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Change the current playing position in the stream source to the beginning of the loop.
+
This function can be overridden by derived classes to allow implementation of custom loop points. Otherwise, it just calls onSeek(Time::Zero) and returns 0.
+
Returns The seek position after looping (or -1 if there's no loop)
+
+
Reimplemented in sf::Music .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::SoundStream::onSeek
+ (
+ Time timeOffset )
+
+
+
+
+protected pure virtual
+
+
+
+
+
Change the current playing position in the stream source.
+
This function must be overridden by derived classes to allow random seeking into the stream source.
+
Parameters
+
+ timeOffset New playing position, relative to the beginning of the stream
+
+
+
+
Implemented in sf::Music .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::pause
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Pause the audio stream.
+
This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.
+
See also play , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::play
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Start or resume playing the audio stream.
+
This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing. This function uses its own thread so that it doesn't block the rest of the program while the stream is played.
+
See also pause , stop
+
+
Implements sf::SoundSource .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setAttenuation
+ (
+ float
+ attenuation )
+
+
+
+
+inherited
+
+
+
+
+
Set the attenuation factor of the sound.
+
The attenuation is a multiplicative factor which makes the sound more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.
+
Parameters
+
+ attenuation New attenuation factor of the sound
+
+
+
See also getAttenuation , setMinDistance
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundStream::setLoop
+ (
+ bool
+ loop )
+
+
+
+
+
Set whether or not the stream should loop after reaching the end.
+
If set, the stream will restart from beginning after reaching the end and so on, until it is stopped or setLoop(false) is called. The default looping state for streams is false.
+
Parameters
+
+ loop True to play in loop, false to play once
+
+
+
See also getLoop
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setMinDistance
+ (
+ float
+ distance )
+
+
+
+
+inherited
+
+
+
+
+
Set the minimum distance of the sound.
+
The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head
+of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.
+
Parameters
+
+ distance New minimum distance of the sound
+
+
+
See also getMinDistance , setAttenuation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPitch
+ (
+ float
+ pitch )
+
+
+
+
+inherited
+
+
+
+
+
Set the pitch of the sound.
+
The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.
+
Parameters
+
+ pitch New pitch to apply to the sound
+
+
+
See also getPitch
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::SoundStream::setPlayingOffset
+ (
+ Time timeOffset )
+
+
+
+
+
Change the current playing position of the stream.
+
The playing position can be changed when the stream is either paused or playing. Changing the playing position when the stream is stopped has no effect, since playing the stream would reset its position.
+
Parameters
+
+ timeOffset New playing position, from the beginning of the stream
+
+
+
See also getPlayingOffset
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ float
+ x ,
+
+ float
+ y ,
+
+ float
+ z
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ x X coordinate of the position of the sound in the scene y Y coordinate of the position of the sound in the scene z Z coordinate of the position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setPosition
+ (
+ const Vector3f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
Set the 3D position of the sound in the audio scene.
+
Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).
+
Parameters
+
+ position Position of the sound in the scene
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setRelativeToListener
+ (
+ bool
+ relative )
+
+
+
+
+inherited
+
+
+
+
+
Make the sound's position relative to the listener or absolute.
+
Making a sound relative to the listener will ensure that it will always be played the same way regardless of the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).
+
Parameters
+
+ relative True to set the position relative, false to set it absolute
+
+
+
See also isRelativeToListener
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundSource::setVolume
+ (
+ float
+ volume )
+
+
+
+
+inherited
+
+
+
+
+
Set the volume of the sound.
+
The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.
+
Parameters
+
+ volume Volume of the sound
+
+
+
See also getVolume
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::SoundStream::stop
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Stop playing the audio stream.
+
This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause() ).
+
See also play , pause
+
+
Implements sf::SoundSource .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ unsigned int sf::SoundSource::m_source
+
+
+
+
+protected inherited
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Sprite , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Drawable representation of a texture, with its own transformations, color, etc.
+ More...
+
+
#include <Sprite.hpp >
+
+
+
+
+
+
+
+
+
+
Drawable representation of a texture, with its own transformations, color, etc.
+
sf::Sprite is a drawable class that allows to easily display a texture (or a part of it) on a render target.
+
It inherits all the functions from sf::Transformable : position, rotation, scale, origin. It also adds sprite-specific properties such as the texture to use, the part of it to display, and some convenience functions to change the overall color of the sprite, or to get its bounding rectangle.
+
sf::Sprite works in combination with the sf::Texture class, which loads and provides the pixel data of a given texture.
+
The separation of sf::Sprite and sf::Texture allows more flexibility and better performances: indeed a sf::Texture is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a sf::Sprite is a lightweight object which can use the pixel data of a sf::Texture and draw it with its own transformation/color/blending attributes.
+
It is important to note that the sf::Sprite instance doesn't copy the texture that it uses, it only keeps a reference to it. Thus, a sf::Texture must not be destroyed while it is used by a sf::Sprite (i.e. never write a function that uses a local sf::Texture instance for creating a sprite).
+
See also the note on coordinates and undistorted rendering in sf::Transformable .
+
Usage example:
See also sf::Texture , sf::Transformable
+
+
Definition at line 47 of file Sprite.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::Sprite::Sprite
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty sprite with no source texture.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ sf::Sprite::Sprite
+ (
+ const Texture &
+ texture )
+
+
+
+
+explicit
+
+
+
+
+
Construct the sprite from a source texture.
+
Parameters
+
+ texture Source texture
+
+
+
See also setTexture
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ sf::Sprite::Sprite
+ (
+ const Texture &
+ texture ,
+
+ const IntRect &
+ rectangle
+
+ )
+
+
+
+
+
Construct the sprite from a sub-rectangle of a source texture.
+
Parameters
+
+ texture Source texture rectangle Sub-rectangle of the texture to assign to the sprite
+
+
+
See also setTexture , setTextureRect
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Sprite::getColor
+ (
+ )
+ const
+
+
+
+
+
Get the global color of the sprite.
+
Returns Global color of the sprite
+
See also setColor
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Sprite::getGlobalBounds (
+ )
+ const
+
+
+
+
+
Get the global bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Sprite::getLocalBounds (
+ )
+ const
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ const Texture * sf::Sprite::getTexture
+ (
+ )
+ const
+
+
+
+
+
Get the source texture of the sprite.
+
If the sprite has no source texture, a NULL pointer is returned. The returned pointer is const, which means that you can't modify the texture when you retrieve it with this function.
+
Returns Pointer to the sprite's texture
+
See also setTexture
+
+
+
+
+
◆
+
+
+
+
+
+ const IntRect & sf::Sprite::getTextureRect
+ (
+ )
+ const
+
+
+
+
+
Get the sub-rectangle of the texture displayed by the sprite.
+
Returns Texture rectangle of the sprite
+
See also setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sprite::setColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the global color of the sprite.
+
This color is modulated (multiplied) with the sprite's texture. It can be used to colorize the sprite, or change its global opacity. By default, the sprite's color is opaque white.
+
Parameters
+
+ color New color of the sprite
+
+
+
See also getColor
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sprite::setTexture
+ (
+ const Texture &
+ texture ,
+
+ bool
+ resetRect = false
+
+ )
+
+
+
+
+
Change the source texture of the sprite.
+
The texture argument refers to a texture that must exist as long as the sprite uses it. Indeed, the sprite doesn't store its own copy of the texture, but rather keeps a pointer to the one that you passed to this function. If the source texture is destroyed and the sprite tries to use it, the behavior is undefined. If resetRect is true, the TextureRect property of the sprite is automatically adjusted to the size of the new texture. If it is false, the texture rect is left unchanged.
+
Parameters
+
+ texture New texture resetRect Should the texture rect be reset to the size of the new texture?
+
+
+
See also getTexture , setTextureRect
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Sprite::setTextureRect
+ (
+ const IntRect &
+ rectangle )
+
+
+
+
+
Set the sub-rectangle of the texture that the sprite will display.
+
The texture rect is useful when you don't want to display the whole texture, but rather a part of it. By default, the texture rect covers the entire texture.
+
Parameters
+
+ rectangle Rectangle defining the region of the texture to display
+
+
+
See also getTextureRect , setTexture
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::String , including all inherited members.
+
+ begin ()sf::String begin () constsf::String clear ()sf::String ConstIterator typedefsf::String end ()sf::String end () constsf::String erase (std::size_t position, std::size_t count=1)sf::String find (const String &str, std::size_t start=0) constsf::String fromUtf16 (T begin, T end)sf::String static fromUtf32 (T begin, T end)sf::String static fromUtf8 (T begin, T end)sf::String static getData () constsf::String getSize () constsf::String insert (std::size_t position, const String &str)sf::String InvalidPos sf::String static isEmpty () constsf::String Iterator typedefsf::String operator std::string () constsf::String operator std::wstring () constsf::String operator!= (const String &left, const String &right)sf::String related operator+ (const String &left, const String &right)sf::String related operator+= (const String &right)sf::String operator< (defined in sf::String )sf::String friend operator< (const String &left, const String &right)sf::String related operator<= (const String &left, const String &right)sf::String related operator= (const String &right)sf::String operator== (defined in sf::String )sf::String friend operator== (const String &left, const String &right)sf::String related operator> (const String &left, const String &right)sf::String related operator>= (const String &left, const String &right)sf::String related operator[] (std::size_t index) constsf::String operator[] (std::size_t index)sf::String replace (std::size_t position, std::size_t length, const String &replaceWith)sf::String replace (const String &searchFor, const String &replaceWith)sf::String String ()sf::String String (char ansiChar, const std::locale &locale=std::locale())sf::String String (wchar_t wideChar)sf::String String (Uint32 utf32Char)sf::String String (const char *ansiString, const std::locale &locale=std::locale())sf::String String (const std::string &ansiString, const std::locale &locale=std::locale())sf::String String (const wchar_t *wideString)sf::String String (const std::wstring &wideString)sf::String String (const Uint32 *utf32String)sf::String String (const std::basic_string< Uint32 > &utf32String)sf::String String (const String ©)sf::String substring (std::size_t position, std::size_t length=InvalidPos) constsf::String toAnsiString (const std::locale &locale=std::locale()) constsf::String toUtf16 () constsf::String toUtf32 () constsf::String toUtf8 () constsf::String toWideString () constsf::String
SFML - Simple and Fast Multimedia Library
+
+
+
Utility string class that automatically handles conversions between types and encodings.
+ More...
+
+
#include <String.hpp >
+
+typedef std::basic_string< Uint32 >::iterator Iterator Iterator type. More... typedef std::basic_string< Uint32 >::const_iterator ConstIterator Read-only iterator type. More...
+ String () Default constructor. More... String (char ansiChar, const std::locale &locale=std::locale()) Construct from a single ANSI character and a locale. More... String (wchar_t wideChar) Construct from single wide character. More... String (Uint32 utf32Char) Construct from single UTF-32 character. More... String (const char *ansiString, const std::locale &locale=std::locale()) Construct from a null-terminated C-style ANSI string and a locale. More... String (const std::string &ansiString, const std::locale &locale=std::locale()) Construct from an ANSI string and a locale. More... String (const wchar_t *wideString) Construct from null-terminated C-style wide string. More... String (const std::wstring &wideString) Construct from a wide string. More... String (const Uint32 *utf32String) Construct from a null-terminated C-style UTF-32 string. More... String (const std::basic_string< Uint32 > &utf32String) Construct from an UTF-32 string. More... String (const String ©) Copy constructor. More... operator std::string () const Implicit conversion operator to std::string (ANSI string) More... operator std::wstring () const Implicit conversion operator to std::wstring (wide string) More... std::string toAnsiString (const std::locale &locale=std::locale()) const Convert the Unicode string to an ANSI string. More... std::wstring toWideString () const Convert the Unicode string to a wide string. More... std::basic_string< Uint8 > toUtf8 () const Convert the Unicode string to a UTF-8 string. More... std::basic_string< Uint16 > toUtf16 () const Convert the Unicode string to a UTF-16 string. More... std::basic_string< Uint32 > toUtf32 () const Convert the Unicode string to a UTF-32 string. More... String & operator= (const String &right) Overload of assignment operator. More... String & operator+= (const String &right) Overload of += operator to append an UTF-32 string. More... Uint32 operator[] (std::size_t index) const Overload of [] operator to access a character by its position. More... Uint32 & operator[] (std::size_t index) Overload of [] operator to access a character by its position. More... void clear () Clear the string. More... std::size_t getSize () const Get the size of the string. More... bool isEmpty () const Check whether the string is empty or not. More... void erase (std::size_t position, std::size_t count=1) Erase one or more characters from the string. More... void insert (std::size_t position, const String &str) Insert one or more characters into the string. More... std::size_t find (const String &str, std::size_t start=0) const Find a sequence of one or more characters in the string. More... void replace (std::size_t position, std::size_t length, const String &replaceWith) Replace a substring with another string. More... void replace (const String &searchFor, const String &replaceWith) Replace all occurrences of a substring with a replacement string. More... String substring (std::size_t position, std::size_t length=InvalidPos ) const Return a part of the string. More... const Uint32 * getData () const Get a pointer to the C-style array of characters. More... Iterator begin () Return an iterator to the beginning of the string. More... ConstIterator begin () const Return an iterator to the beginning of the string. More... Iterator end () Return an iterator to the end of the string. More... ConstIterator end () const Return an iterator to the end of the string. More...
+static const std::size_t InvalidPos Represents an invalid position in the string. More...
+operator== (const String &left, const String &right) operator< (const String &left, const String &right)
+
+
Utility string class that automatically handles conversions between types and encodings.
+
sf::String is a utility string class defined mainly for convenience.
+
It is a Unicode string (implemented using UTF-32), thus it can store any character in the world (European, Chinese, Arabic, Hebrew, etc.).
+
It automatically handles conversions from/to ANSI and wide strings, so that you can work with standard string classes and still be compatible with functions taking a sf::String .
+
std::string s1 = s;
std::wstring s2 = s;
s = "hello" ;
s = L"hello" ;
s += 'a' ;
s += L'a' ;
Conversions involving ANSI strings use the default user locale. However it is possible to use a custom locale if necessary:
sf::String defines the most important functions of the standard std::string class: removing, random access, iterating, appending, comparing, etc. However it is a simple class provided for convenience, and you may have to consider using a more optimized class if your program requires complex string handling. The automatic conversion functions will then take care of converting your string to sf::String whenever SFML requires it.
+
Please note that SFML also defines a low-level, generic interface for Unicode handling, see the sf::Utf classes.
+
+
Definition at line 45 of file String.hpp .
+
+
+
◆
+
+
+
+
+
Read-only iterator type.
+
+
Definition at line 53 of file String.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Iterator type.
+
+
Definition at line 52 of file String.hpp .
+
+
+
+
+
+
◆ [1/11]
+
+
+
+
+
+ sf::String::String
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor creates an empty string.
+
+
+
+
+
◆ [2/11]
+
+
+
+
+
+ sf::String::String
+ (
+ char
+ ansiChar ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+
Construct from a single ANSI character and a locale.
+
The source character is converted to UTF-32 according to the given locale.
+
Parameters
+
+ ansiChar ANSI character to convert locale Locale to use for conversion
+
+
+
+
+
+
+
◆ [3/11]
+
+
+
+
+
+ sf::String::String
+ (
+ wchar_t
+ wideChar )
+
+
+
+
+
Construct from single wide character.
+
Parameters
+
+ wideChar Wide character to convert
+
+
+
+
+
+
+
◆ [4/11]
+
+
+
+
+
+ sf::String::String
+ (
+ Uint32
+ utf32Char )
+
+
+
+
+
Construct from single UTF-32 character.
+
Parameters
+
+ utf32Char UTF-32 character to convert
+
+
+
+
+
+
+
◆ [5/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const char *
+ ansiString ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+
Construct from a null-terminated C-style ANSI string and a locale.
+
The source string is converted to UTF-32 according to the given locale.
+
Parameters
+
+ ansiString ANSI string to convert locale Locale to use for conversion
+
+
+
+
+
+
+
◆ [6/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const std::string &
+ ansiString ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+
Construct from an ANSI string and a locale.
+
The source string is converted to UTF-32 according to the given locale.
+
Parameters
+
+ ansiString ANSI string to convert locale Locale to use for conversion
+
+
+
+
+
+
+
◆ [7/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const wchar_t *
+ wideString )
+
+
+
+
+
Construct from null-terminated C-style wide string.
+
Parameters
+
+ wideString Wide string to convert
+
+
+
+
+
+
+
◆ [8/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const std::wstring &
+ wideString )
+
+
+
+
+
Construct from a wide string.
+
Parameters
+
+ wideString Wide string to convert
+
+
+
+
+
+
+
◆ [9/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const Uint32 *
+ utf32String )
+
+
+
+
+
Construct from a null-terminated C-style UTF-32 string.
+
Parameters
+
+ utf32String UTF-32 string to assign
+
+
+
+
+
+
+
◆ [10/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const std::basic_string< Uint32 > &
+ utf32String )
+
+
+
+
+
Construct from an UTF-32 string.
+
Parameters
+
+ utf32String UTF-32 string to assign
+
+
+
+
+
+
+
◆ [11/11]
+
+
+
+
+
+ sf::String::String
+ (
+ const String &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Iterator sf::String::begin (
+ )
+
+
+
+
+
Return an iterator to the beginning of the string.
+
Returns Read-write iterator to the beginning of the string characters
+
See also end
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Return an iterator to the beginning of the string.
+
Returns Read-only iterator to the beginning of the string characters
+
See also end
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::String::clear
+ (
+ )
+
+
+
+
+
Clear the string.
+
This function removes all the characters from the string.
+
See also isEmpty , erase
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Iterator sf::String::end (
+ )
+
+
+
+
+
Return an iterator to the end of the string.
+
The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.
+
Returns Read-write iterator to the end of the string characters
+
See also begin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Return an iterator to the end of the string.
+
The end iterator refers to 1 position past the last character; thus it represents an invalid character and should never be accessed.
+
Returns Read-only iterator to the end of the string characters
+
See also begin
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::String::erase
+ (
+ std::size_t
+ position ,
+
+ std::size_t
+ count = 1
+
+ )
+
+
+
+
+
Erase one or more characters from the string.
+
This function removes a sequence of count characters starting from position .
+
Parameters
+
+ position Position of the first character to erase count Number of characters to erase
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::String::find
+ (
+ const String &
+ str ,
+
+ std::size_t
+ start = 0
+
+ )
+ const
+
+
+
+
+
Find a sequence of one or more characters in the string.
+
This function searches for the characters of str in the string, starting from start .
+
Parameters
+
+ str Characters to find start Where to begin searching
+
+
+
Returns Position of str in the string, or String::InvalidPos if not found
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static String sf::String::fromUtf16
+ (
+ T
+ begin ,
+
+ T
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Create a new sf::String from a UTF-16 encoded string.
+
Parameters
+
+ begin Forward iterator to the beginning of the UTF-16 sequence end Forward iterator to the end of the UTF-16 sequence
+
+
+
Returns A sf::String containing the source string
+
See also fromUtf8 , fromUtf32
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static String sf::String::fromUtf32
+ (
+ T
+ begin ,
+
+ T
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Create a new sf::String from a UTF-32 encoded string.
+
This function is provided for consistency, it is equivalent to using the constructors that takes a const sf::Uint32* or a std::basic_string<sf::Uint32>.
+
Parameters
+
+ begin Forward iterator to the beginning of the UTF-32 sequence end Forward iterator to the end of the UTF-32 sequence
+
+
+
Returns A sf::String containing the source string
+
See also fromUtf8 , fromUtf16
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ static String sf::String::fromUtf8
+ (
+ T
+ begin ,
+
+ T
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Create a new sf::String from a UTF-8 encoded string.
+
Parameters
+
+ begin Forward iterator to the beginning of the UTF-8 sequence end Forward iterator to the end of the UTF-8 sequence
+
+
+
Returns A sf::String containing the source string
+
See also fromUtf16 , fromUtf32
+
+
+
+
+
◆
+
+
+
+
+
+ const Uint32* sf::String::getData
+ (
+ )
+ const
+
+
+
+
+
Get a pointer to the C-style array of characters.
+
This functions provides a read-only access to a null-terminated C-style representation of the string. The returned pointer is temporary and is meant only for immediate use, thus it is not recommended to store it.
+
Returns Read-only pointer to the array of characters
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::String::getSize
+ (
+ )
+ const
+
+
+
+
+
Get the size of the string.
+
Returns Number of characters in the string
+
See also isEmpty
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::String::insert
+ (
+ std::size_t
+ position ,
+
+ const String &
+ str
+
+ )
+
+
+
+
+
Insert one or more characters into the string.
+
This function inserts the characters of str into the string, starting from position .
+
Parameters
+
+ position Position of insertion str Characters to insert
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::String::isEmpty
+ (
+ )
+ const
+
+
+
+
+
Check whether the string is empty or not.
+
Returns True if the string is empty (i.e. contains no character)
+
See also clear , getSize
+
+
+
+
+
◆
+
+
+
+
+
+ sf::String::operator std::string
+ (
+ )
+ const
+
+
+
+
+
Implicit conversion operator to std::string (ANSI string)
+
The current global locale is used for conversion. If you want to explicitly specify a locale, see toAnsiString. Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling toAnsiString() .
+
Returns Converted ANSI string
+
See also toAnsiString , operator std::wstring
+
+
+
+
+
◆
+
+
+
+
+
+ sf::String::operator std::wstring
+ (
+ )
+ const
+
+
+
+
+
Implicit conversion operator to std::wstring (wide string)
+
Characters that do not fit in the target encoding are discarded from the returned string. This operator is defined for convenience, and is equivalent to calling toWideString() .
+
Returns Converted wide string
+
See also toWideString , operator std::string
+
+
+
+
+
◆
+
+
+
+
+
+ String & sf::String::operator+= (
+ const String &
+ right )
+
+
+
+
+
Overload of += operator to append an UTF-32 string.
+
Parameters
+
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+ String & sf::String::operator= (
+ const String &
+ right )
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Uint32 sf::String::operator[]
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Overload of [] operator to access a character by its position.
+
This function provides read-only access to characters. Note: the behavior is undefined if index is out of range.
+
Parameters
+
+ index Index of the character to get
+
+
+
Returns Character at position index
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Uint32& sf::String::operator[]
+ (
+ std::size_t
+ index )
+
+
+
+
+
Overload of [] operator to access a character by its position.
+
This function provides read and write access to characters. Note: the behavior is undefined if index is out of range.
+
Parameters
+
+ index Index of the character to get
+
+
+
Returns Reference to the character at position index
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::String::replace
+ (
+ std::size_t
+ position ,
+
+ std::size_t
+ length ,
+
+ const String &
+ replaceWith
+
+ )
+
+
+
+
+
Replace a substring with another string.
+
This function replaces the substring that starts at index position and spans length characters with the string replaceWith .
+
Parameters
+
+ position Index of the first character to be replaced length Number of characters to replace. You can pass InvalidPos to replace all characters until the end of the string. replaceWith String that replaces the given substring.
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::String::replace
+ (
+ const String &
+ searchFor ,
+
+ const String &
+ replaceWith
+
+ )
+
+
+
+
+
Replace all occurrences of a substring with a replacement string.
+
This function replaces all occurrences of searchFor in this string with the string replaceWith .
+
Parameters
+
+ searchFor The value being searched for replaceWith The value that replaces found searchFor values
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ String sf::String::substring (
+ std::size_t
+ position ,
+
+ std::size_t
+ length = InvalidPos
+
+ )
+ const
+
+
+
+
+
Return a part of the string.
+
This function returns the substring that starts at index position and spans length characters.
+
Parameters
+
+ position Index of the first character length Number of characters to include in the substring (if the string is shorter, as many characters as possible are included). InvalidPos can be used to include all characters until the end of the string.
+
+
+
Returns String object containing a substring of this object
+
+
+
+
+
◆
+
+
+
+
+
+ std::string sf::String::toAnsiString
+ (
+ const std::locale &
+ locale = std::locale())
+ const
+
+
+
+
+
Convert the Unicode string to an ANSI string.
+
The UTF-32 string is converted to an ANSI string in the encoding defined by locale . Characters that do not fit in the target encoding are discarded from the returned string.
+
Parameters
+
+ locale Locale to use for conversion
+
+
+
Returns Converted ANSI string
+
See also toWideString , operator std::string
+
+
+
+
+
◆
+
+
+
+
+
+ std::basic_string<Uint16> sf::String::toUtf16
+ (
+ )
+ const
+
+
+
+
+
Convert the Unicode string to a UTF-16 string.
+
Returns Converted UTF-16 string
+
See also toUtf8 , toUtf32
+
+
+
+
+
◆
+
+
+
+
+
+ std::basic_string<Uint32> sf::String::toUtf32
+ (
+ )
+ const
+
+
+
+
+
Convert the Unicode string to a UTF-32 string.
+
This function doesn't perform any conversion, since the string is already stored as UTF-32 internally.
+
Returns Converted UTF-32 string
+
See also toUtf8 , toUtf16
+
+
+
+
+
◆
+
+
+
+
+
+ std::basic_string<Uint8> sf::String::toUtf8
+ (
+ )
+ const
+
+
+
+
+
Convert the Unicode string to a UTF-8 string.
+
Returns Converted UTF-8 string
+
See also toUtf16 , toUtf32
+
+
+
+
+
◆
+
+
+
+
+
+ std::wstring sf::String::toWideString
+ (
+ )
+ const
+
+
+
+
+
Convert the Unicode string to a wide string.
+
Characters that do not fit in the target encoding are discarded from the returned string.
+
Returns Converted wide string
+
See also toAnsiString , operator std::wstring
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of != operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if both strings are different
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ String operator+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary + operator to concatenate two strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns Concatenated string
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of < operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if left is lexicographically before right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<=
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of <= operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if left is lexicographically before or equivalent to right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of == operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if both strings are equal
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of > operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if left is lexicographically after right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>=
+ (
+ const String &
+ left ,
+
+ const String &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of >= operator to compare two UTF-32 strings.
+
Parameters
+
+ left Left operand (a string) right Right operand (a string)
+
+
+
Returns True if left is lexicographically after or equivalent to right
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const std::size_t sf::String::InvalidPos
+
+
+
+
+static
+
+
+
+
+
Represents an invalid position in the string.
+
+
Definition at line 58 of file String.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::TcpListener , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Socket that listens to new TCP connections.
+ More...
+
+
#include <TcpListener.hpp >
+
+
+
+
+
+
+
+
+enum Type { Tcp ,
+Udp
+ } Types of protocols that the socket can use. More...
+SocketHandle getHandle () const Return the internal handle of the socket. More... void create () Create the internal representation of the socket. More... void create (SocketHandle handle) Create the internal representation of the socket from a socket handle. More...
+
+
Socket that listens to new TCP connections.
+
A listener socket is a special type of socket that listens to a given port and waits for connections on that port.
+
This is all it can do.
+
When a new connection is received, you must call accept and the listener returns a new instance of sf::TcpSocket that is properly initialized and can be used to communicate with the new client.
+
Listener sockets are specific to the TCP protocol, UDP sockets are connectionless and can therefore communicate directly. As a consequence, a listener socket will always return the new connections as sf::TcpSocket instances.
+
A listener is automatically closed on destruction, like all other types of socket. However if you want to stop listening before the socket is destroyed, you can call its close() function.
+
Usage example:
while (running)
{
{
std::cout <<
"New connection received from " << client.
getRemoteAddress () << std::endl;
doSomethingWith(client);
}
}
See also sf::TcpSocket , sf::Socket
+
+
Definition at line 44 of file TcpListener.hpp .
+
+
+
◆
+
+
+
+
+
Some special values used by sockets.
+
+Enumerator Special value that tells the system to pick any available port.
+
+
+
Definition at line 66 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Status codes that may be returned by socket functions.
+
+Enumerator The socket has sent / received the data.
+The socket is not ready to send / receive data yet.
+The socket sent a part of the data.
+The TCP socket has been disconnected.
+An unexpected error happened.
+
+
+
Definition at line 53 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+
+protected inherited
+
+
+
+
+
Types of protocols that the socket can use.
+
+Enumerator TCP protocol.
+UDP protocol.
+
+
+
Definition at line 114 of file Socket.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::TcpListener::TcpListener
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
Accept a new connection.
+
If the socket is in blocking mode, this function will not return until a connection is actually received.
+
Parameters
+
+ socket Socket that will hold the new connection
+
+
+
Returns Status code
+
See also listen
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::TcpListener::close
+ (
+ )
+
+
+
+
+
Stop listening and close the socket.
+
This function gracefully stops the listener. If the socket is not listening, this function has no effect.
+
See also listen
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ SocketHandle
+ handle )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket from a socket handle.
+
This function can only be accessed by derived classes.
+
Parameters
+
+ handle OS-specific handle of the socket to wrap
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ SocketHandle sf::Socket::getHandle
+ (
+ )
+ const
+
+
+
+
+protected inherited
+
+
+
+
+
Return the internal handle of the socket.
+
The returned handle may be invalid if the socket was not created yet (or already destroyed). This function can only be accessed by derived classes.
+
Returns The internal (OS-specific) handle of the socket
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned short sf::TcpListener::getLocalPort
+ (
+ )
+ const
+
+
+
+
+
Get the port to which the socket is bound locally.
+
If the socket is not listening to a port, this function returns 0.
+
Returns Port to which the socket is bound
+
See also listen
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Socket::isBlocking
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the socket is in blocking or non-blocking mode.
+
Returns True if the socket is blocking, false otherwise
+
See also setBlocking
+
+
+
+
+
◆
+
+
+
+
+
Start listening for incoming connection attempts.
+
This function makes the socket start listening on the specified port, waiting for incoming connection attempts.
+
If the socket is already listening on a port when this function is called, it will stop listening on the old port before starting to listen on the new port.
+
Parameters
+
+ port Port to listen on for incoming connection attempts address Address of the interface to listen on
+
+
+
Returns Status code
+
See also accept , close
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::setBlocking
+ (
+ bool
+ blocking )
+
+
+
+
+inherited
+
+
+
+
+
Set the blocking state of the socket.
+
In blocking mode, calls will not return until they have completed their task. For example, a call to Receive in blocking mode won't return until some data was actually received. In non-blocking mode, calls will always return immediately, using the return code to signal whether there was data available or not. By default, all sockets are blocking.
+
Parameters
+
+ blocking True to set the socket as blocking, false for non-blocking
+
+
+
See also isBlocking
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::TcpSocket , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized socket using the TCP protocol.
+ More...
+
+
#include <TcpSocket.hpp >
+
+
+
+
+
+
+
+
+enum Type { Tcp ,
+Udp
+ } Types of protocols that the socket can use. More...
+SocketHandle getHandle () const Return the internal handle of the socket. More... void create () Create the internal representation of the socket. More... void create (SocketHandle handle) Create the internal representation of the socket from a socket handle. More... void close () Close the socket gracefully. More...
+TcpListener
+
+
Specialized socket using the TCP protocol.
+
TCP is a connected protocol, which means that a TCP socket can only communicate with the host it is connected to.
+
It can't send or receive anything if it is not connected.
+
The TCP protocol is reliable but adds a slight overhead. It ensures that your data will always be received in order and without errors (no data corrupted, lost or duplicated).
+
When a socket is connected to a remote host, you can retrieve informations about this host with the getRemoteAddress and getRemotePort functions. You can also get the local port to which the socket is bound (which is automatically chosen when the socket is connected), with the getLocalPort function.
+
Sending and receiving data can use either the low-level or the high-level functions. The low-level functions process a raw sequence of bytes, and cannot ensure that one call to Send will exactly match one call to Receive at the other end of the socket.
+
The high-level interface uses packets (see sf::Packet ), which are easier to use and provide more safety regarding the data that is exchanged. You can look at the sf::Packet class to get more details about how they work.
+
The socket is automatically disconnected when it is destroyed, but if you want to explicitly close the connection while the socket instance is still alive, you can call disconnect.
+
Usage example:
socket.
connect (
"192.168.1.50" , 55001);
std::string message = "Hi, I am a client" ;
socket.
send (message.c_str(), message.size() + 1);
char buffer[1024];
std::size_t received = 0;
socket.
receive (buffer,
sizeof (buffer), received);
std::cout << "The server said: " << buffer << std::endl;
std::cout <<
"New client connected: " << socket.
getRemoteAddress () << std::endl;
char buffer[1024];
std::size_t received = 0;
socket.
receive (buffer,
sizeof (buffer), received);
std::cout << "The client said: " << buffer << std::endl;
std::string message = "Welcome, client" ;
socket.
send (message.c_str(), message.size() + 1);
See also sf::Socket , sf::UdpSocket , sf::Packet
+
+
Definition at line 46 of file TcpSocket.hpp .
+
+
+
◆
+
+
+
+
+
Some special values used by sockets.
+
+Enumerator Special value that tells the system to pick any available port.
+
+
+
Definition at line 66 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Status codes that may be returned by socket functions.
+
+Enumerator The socket has sent / received the data.
+The socket is not ready to send / receive data yet.
+The socket sent a part of the data.
+The TCP socket has been disconnected.
+An unexpected error happened.
+
+
+
Definition at line 53 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+
+protected inherited
+
+
+
+
+
Types of protocols that the socket can use.
+
+Enumerator TCP protocol.
+UDP protocol.
+
+
+
Definition at line 114 of file Socket.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::TcpSocket::TcpSocket
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::close
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Close the socket gracefully.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆
+
+
+
+
+
+ Status sf::TcpSocket::connect (
+ const IpAddress &
+ remoteAddress ,
+
+ unsigned short
+ remotePort ,
+
+ Time timeout = Time::Zero
+
+ )
+
+
+
+
+
Connect the socket to a remote peer.
+
In blocking mode, this function may take a while, especially if the remote peer is not reachable. The last parameter allows you to stop trying to connect after a given timeout. If the socket is already connected, the connection is forcibly disconnected before attempting to connect again.
+
Parameters
+
+ remoteAddress Address of the remote peer remotePort Port of the remote peer timeout Optional maximum time to wait
+
+
+
Returns Status code
+
See also disconnect
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ SocketHandle
+ handle )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket from a socket handle.
+
This function can only be accessed by derived classes.
+
Parameters
+
+ handle OS-specific handle of the socket to wrap
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::TcpSocket::disconnect
+ (
+ )
+
+
+
+
+
Disconnect the socket from its remote peer.
+
This function gracefully closes the connection. If the socket is not connected, this function has no effect.
+
See also connect
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ SocketHandle sf::Socket::getHandle
+ (
+ )
+ const
+
+
+
+
+protected inherited
+
+
+
+
+
Return the internal handle of the socket.
+
The returned handle may be invalid if the socket was not created yet (or already destroyed). This function can only be accessed by derived classes.
+
Returns The internal (OS-specific) handle of the socket
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned short sf::TcpSocket::getLocalPort
+ (
+ )
+ const
+
+
+
+
+
Get the port to which the socket is bound locally.
+
If the socket is not connected, this function returns 0.
+
Returns Port to which the socket is bound
+
See also connect , getRemotePort
+
+
+
+
+
◆
+
+
+
+
+
+ IpAddress sf::TcpSocket::getRemoteAddress (
+ )
+ const
+
+
+
+
+
Get the address of the connected peer.
+
It the socket is not connected, this function returns sf::IpAddress::None .
+
Returns Address of the remote peer
+
See also getRemotePort
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned short sf::TcpSocket::getRemotePort
+ (
+ )
+ const
+
+
+
+
+
Get the port of the connected peer to which the socket is connected.
+
If the socket is not connected, this function returns 0.
+
Returns Remote port to which the socket is connected
+
See also getRemoteAddress
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Socket::isBlocking
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the socket is in blocking or non-blocking mode.
+
Returns True if the socket is blocking, false otherwise
+
See also setBlocking
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Status sf::TcpSocket::receive (
+ void *
+ data ,
+
+ std::size_t
+ size ,
+
+ std::size_t &
+ received
+
+ )
+
+
+
+
+
Receive raw data from the remote peer.
+
In blocking mode, this function will wait until some bytes are actually received. This function will fail if the socket is not connected.
+
Parameters
+
+ data Pointer to the array to fill with the received bytes size Maximum number of bytes that can be received received This variable is filled with the actual number of bytes received
+
+
+
Returns Status code
+
See also send
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Status sf::TcpSocket::receive (
+ Packet & packet )
+
+
+
+
+
Receive a formatted packet of data from the remote peer.
+
In blocking mode, this function will wait until the whole packet has been received. This function will fail if the socket is not connected.
+
Parameters
+
+ packet Packet to fill with the received data
+
+
+
Returns Status code
+
See also send
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ Status sf::TcpSocket::send (
+ const void *
+ data ,
+
+ std::size_t
+ size
+
+ )
+
+
+
+
+
Send raw data to the remote peer.
+
To be able to handle partial sends over non-blocking sockets, use the send(const void*, std::size_t, std::size_t&) overload instead. This function will fail if the socket is not connected.
+
Parameters
+
+ data Pointer to the sequence of bytes to send size Number of bytes to send
+
+
+
Returns Status code
+
See also receive
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ Status sf::TcpSocket::send (
+ const void *
+ data ,
+
+ std::size_t
+ size ,
+
+ std::size_t &
+ sent
+
+ )
+
+
+
+
+
Send raw data to the remote peer.
+
This function will fail if the socket is not connected.
+
Parameters
+
+ data Pointer to the sequence of bytes to send size Number of bytes to send sent The number of bytes sent will be written here
+
+
+
Returns Status code
+
See also receive
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ Status sf::TcpSocket::send (
+ Packet & packet )
+
+
+
+
+
Send a formatted packet of data to the remote peer.
+
In non-blocking mode, if this function returns sf::Socket::Partial , you must retry sending the same unmodified packet before sending anything else in order to guarantee the packet arrives at the remote peer uncorrupted. This function will fail if the socket is not connected.
+
Parameters
+
+
+
+
Returns Status code
+
See also receive
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::setBlocking
+ (
+ bool
+ blocking )
+
+
+
+
+inherited
+
+
+
+
+
Set the blocking state of the socket.
+
In blocking mode, calls will not return until they have completed their task. For example, a call to Receive in blocking mode won't return until some data was actually received. In non-blocking mode, calls will always return immediately, using the return code to signal whether there was data available or not. By default, all sockets are blocking.
+
Parameters
+
+ blocking True to set the socket as blocking, false for non-blocking
+
+
+
See also isBlocking
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Text , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Graphical text that can be drawn to a render target.
+ More...
+
+
#include <Text.hpp >
+
+
+
+
+
+
+
+
+
+
Graphical text that can be drawn to a render target.
+
sf::Text is a drawable class that allows to easily display some text with custom style and color on a render target.
+
It inherits all the functions from sf::Transformable : position, rotation, scale, origin. It also adds text-specific properties such as the font to use, the character size, the font style (bold, italic, underlined and strike through), the text color, the outline thickness, the outline color, the character spacing, the line spacing and the text to display of course. It also provides convenience functions to calculate the graphical size of the text, or to get the global position of a given character.
+
sf::Text works in combination with the sf::Font class, which loads and provides the glyphs (visual characters) of a given font.
+
The separation of sf::Font and sf::Text allows more flexibility and better performances: indeed a sf::Font is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a sf::Text is a lightweight object which can combine the glyphs data and metrics of a sf::Font to display any text on a render target.
+
It is important to note that the sf::Text instance doesn't copy the font that it uses, it only keeps a reference to it. Thus, a sf::Font must not be destructed while it is used by a sf::Text (i.e. never write a function that uses a local sf::Font instance for creating a text).
+
See also the note on coordinates and undistorted rendering in sf::Transformable .
+
Usage example:
See also sf::Font , sf::Transformable
+
+
Definition at line 48 of file Text.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the string drawing styles.
+
+Enumerator Regular characters, no style.
+Bold characters.
+Italic characters.
+Underlined characters.
+Strike through characters.
+
+
+
Definition at line 56 of file Text.hpp .
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Text::Text
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Text::Text
+ (
+ const String &
+ string ,
+
+ const Font &
+ font ,
+
+ unsigned int
+ characterSize = 30
+
+ )
+
+
+
+
+
Construct the text from a string, font and size.
+
Note that if the used font is a bitmap font, it is not scalable, thus not all requested sizes will be available to use. This needs to be taken into consideration when setting the character size. If you need to display text of a certain size, make sure the corresponding bitmap font that supports that size is used.
+
Parameters
+
+ string Text assigned to the string font Font used to draw the string characterSize Base size of characters, in pixels
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ Vector2f sf::Text::findCharacterPos (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Return the position of the index-th character.
+
This function computes the visual position of a character from its index in the string. The returned position is in global coordinates (translation, rotation, scale and origin are applied). If index is out of range, the position of the end of the string is returned.
+
Parameters
+
+ index Index of the character
+
+
+
Returns Position of the character
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Text::getCharacterSize
+ (
+ )
+ const
+
+
+
+
+
Get the character size.
+
Returns Size of the characters, in pixels
+
See also setCharacterSize
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Text::getColor
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Text::getFillColor
+ (
+ )
+ const
+
+
+
+
+
Get the fill color of the text.
+
Returns Fill color of the text
+
See also setFillColor
+
+
+
+
+
◆
+
+
+
+
+
+ const Font * sf::Text::getFont
+ (
+ )
+ const
+
+
+
+
+
Get the text's font.
+
If the text has no font attached, a NULL pointer is returned. The returned pointer is const, which means that you cannot modify the font when you get it from this function.
+
Returns Pointer to the text's font
+
See also setFont
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Text::getGlobalBounds (
+ )
+ const
+
+
+
+
+
Get the global bounding rectangle of the entity.
+
The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the text in the global 2D world's coordinate system.
+
Returns Global bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Text::getLetterSpacing
+ (
+ )
+ const
+
+
+
+
+
Get the size of the letter spacing factor.
+
Returns Size of the letter spacing factor
+
See also setLetterSpacing
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Text::getLineSpacing
+ (
+ )
+ const
+
+
+
+
+
Get the size of the line spacing factor.
+
Returns Size of the line spacing factor
+
See also setLineSpacing
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Text::getLocalBounds (
+ )
+ const
+
+
+
+
+
Get the local bounding rectangle of the entity.
+
The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
+
Returns Local bounding rectangle of the entity
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+ const Color & sf::Text::getOutlineColor
+ (
+ )
+ const
+
+
+
+
+
Get the outline color of the text.
+
Returns Outline color of the text
+
See also setOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Text::getOutlineThickness
+ (
+ )
+ const
+
+
+
+
+
Get the outline thickness of the text.
+
Returns Outline thickness of the text, in pixels
+
See also setOutlineThickness
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ const String & sf::Text::getString
+ (
+ )
+ const
+
+
+
+
+
Get the text's string.
+
The returned string is a sf::String , which can automatically be converted to standard string types. So, the following lines of code are all valid:
Returns Text 's string
+
See also setString
+
+
+
+
+
◆
+
+
+
+
+
+ Uint32 sf::Text::getStyle
+ (
+ )
+ const
+
+
+
+
+
Get the text's style.
+
Returns Text 's style
+
See also setStyle
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+inherited
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+inherited
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setCharacterSize
+ (
+ unsigned int
+ size )
+
+
+
+
+
Set the character size.
+
The default size is 30.
+
Note that if the used font is a bitmap font, it is not scalable, thus not all requested sizes will be available to use. This needs to be taken into consideration when setting the character size. If you need to display text of a certain size, make sure the corresponding bitmap font that supports that size is used.
+
Parameters
+
+ size New character size, in pixels
+
+
+
See also getCharacterSize
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the fill color of the text.
+
By default, the text's fill color is opaque white. Setting the fill color to a transparent color with an outline will cause the outline to be displayed in the fill area of the text.
+
Parameters
+
+ color New fill color of the text
+
+
+
See also getFillColor
+
Deprecated: There is now fill and outline colors instead of a single global color. Use setFillColor() or setOutlineColor() instead.
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setFillColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the fill color of the text.
+
By default, the text's fill color is opaque white. Setting the fill color to a transparent color with an outline will cause the outline to be displayed in the fill area of the text.
+
Parameters
+
+ color New fill color of the text
+
+
+
See also getFillColor
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setFont
+ (
+ const Font &
+ font )
+
+
+
+
+
Set the text's font.
+
The font argument refers to a font that must exist as long as the text uses it. Indeed, the text doesn't store its own copy of the font, but rather keeps a pointer to the one that you passed to this function. If the font is destroyed and the text tries to use it, the behavior is undefined.
+
Parameters
+
+
+
+
See also getFont
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setLetterSpacing
+ (
+ float
+ spacingFactor )
+
+
+
+
+
Set the letter spacing factor.
+
The default spacing between letters is defined by the font. This factor doesn't directly apply to the existing spacing between each character, it rather adds a fixed space between them which is calculated from the font metrics and the character size. Note that factors below 1 (including negative numbers) bring characters closer to each other. By default the letter spacing factor is 1.
+
Parameters
+
+ spacingFactor New letter spacing factor
+
+
+
See also getLetterSpacing
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setLineSpacing
+ (
+ float
+ spacingFactor )
+
+
+
+
+
Set the line spacing factor.
+
The default spacing between lines is defined by the font. This method enables you to set a factor for the spacing between lines. By default the line spacing factor is 1.
+
Parameters
+
+ spacingFactor New line spacing factor
+
+
+
See also getLineSpacing
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+inherited
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setOutlineColor
+ (
+ const Color &
+ color )
+
+
+
+
+
Set the outline color of the text.
+
By default, the text's outline color is opaque black.
+
Parameters
+
+ color New outline color of the text
+
+
+
See also getOutlineColor
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setOutlineThickness
+ (
+ float
+ thickness )
+
+
+
+
+
Set the thickness of the text's outline.
+
By default, the outline thickness is 0.
+
Be aware that using a negative value for the outline thickness will cause distorted rendering.
+
Parameters
+
+ thickness New outline thickness, in pixels
+
+
+
See also getOutlineThickness
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+inherited
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+inherited
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+inherited
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setString
+ (
+ const String &
+ string )
+
+
+
+
+
Set the text's string.
+
The string argument is a sf::String , which can automatically be constructed from standard string types. So, the following calls are all valid:
A text's string is empty by default.
+
Parameters
+
+
+
+
See also getString
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Text::setStyle
+ (
+ Uint32
+ style )
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Texture , including all inherited members.
+
+ bind (const Texture *texture, CoordinateType coordinateType=Normalized)sf::Texture static CoordinateType enum namesf::Texture copyToImage () constsf::Texture create (unsigned int width, unsigned int height)sf::Texture generateMipmap ()sf::Texture getMaximumSize ()sf::Texture static getNativeHandle () constsf::Texture getSize () constsf::Texture GlResource ()sf::GlResource private isRepeated () constsf::Texture isSmooth () constsf::Texture isSrgb () constsf::Texture loadFromFile (const std::string &filename, const IntRect &area=IntRect())sf::Texture loadFromImage (const Image &image, const IntRect &area=IntRect())sf::Texture loadFromMemory (const void *data, std::size_t size, const IntRect &area=IntRect())sf::Texture loadFromStream (InputStream &stream, const IntRect &area=IntRect())sf::Texture Normalized enum valuesf::Texture operator= (const Texture &right)sf::Texture Pixels enum valuesf::Texture registerContextDestroyCallback (ContextDestroyCallback callback, void *arg)sf::GlResource private static RenderTarget (defined in sf::Texture )sf::Texture friend RenderTexture (defined in sf::Texture )sf::Texture friend setRepeated (bool repeated)sf::Texture setSmooth (bool smooth)sf::Texture setSrgb (bool sRgb)sf::Texture swap (Texture &right)sf::Texture Text (defined in sf::Texture )sf::Texture friend Texture ()sf::Texture Texture (const Texture ©)sf::Texture update (const Uint8 *pixels)sf::Texture update (const Uint8 *pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y)sf::Texture update (const Texture &texture)sf::Texture update (const Texture &texture, unsigned int x, unsigned int y)sf::Texture update (const Image &image)sf::Texture update (const Image &image, unsigned int x, unsigned int y)sf::Texture update (const Window &window)sf::Texture update (const Window &window, unsigned int x, unsigned int y)sf::Texture ~GlResource ()sf::GlResource private ~Texture ()sf::Texture
SFML - Simple and Fast Multimedia Library
+
+
+
Image living on the graphics card that can be used for drawing.
+ More...
+
+
#include <Texture.hpp >
+
+
+
+
+
+
+
+
+ Texture () Default constructor. More... Texture (const Texture ©) Copy constructor. More... ~Texture () Destructor. More... bool create (unsigned int width, unsigned int height) Create the texture. More... bool loadFromFile (const std::string &filename, const IntRect &area=IntRect ()) Load the texture from a file on disk. More... bool loadFromMemory (const void *data, std::size_t size, const IntRect &area=IntRect ()) Load the texture from a file in memory. More... bool loadFromStream (InputStream &stream, const IntRect &area=IntRect ()) Load the texture from a custom stream. More... bool loadFromImage (const Image &image, const IntRect &area=IntRect ()) Load the texture from an image. More... Vector2u getSize () const Return the size of the texture. More... Image copyToImage () const Copy the texture pixels to an image. More... void update (const Uint8 *pixels) Update the whole texture from an array of pixels. More... void update (const Uint8 *pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y) Update a part of the texture from an array of pixels. More... void update (const Texture &texture) Update a part of this texture from another texture. More... void update (const Texture &texture, unsigned int x, unsigned int y) Update a part of this texture from another texture. More... void update (const Image &image) Update the texture from an image. More... void update (const Image &image, unsigned int x, unsigned int y) Update a part of the texture from an image. More... void update (const Window &window) Update the texture from the contents of a window. More... void update (const Window &window, unsigned int x, unsigned int y) Update a part of the texture from the contents of a window. More... void setSmooth (bool smooth) Enable or disable the smooth filter. More... bool isSmooth () const Tell whether the smooth filter is enabled or not. More... void setSrgb (bool sRgb) Enable or disable conversion from sRGB. More... bool isSrgb () const Tell whether the texture source is converted from sRGB or not. More... void setRepeated (bool repeated) Enable or disable repeating. More... bool isRepeated () const Tell whether the texture is repeated or not. More... bool generateMipmap () Generate a mipmap using the current texture data. More... Texture & operator= (const Texture &right) Overload of assignment operator. More... void swap (Texture &right) Swap the contents of this texture with those of another. More... unsigned int getNativeHandle () const Get the underlying OpenGL handle of the texture. More...
+Text RenderTexture RenderTarget
+
+
Image living on the graphics card that can be used for drawing.
+
sf::Texture stores pixels that can be drawn, with a sprite for example.
+
A texture lives in the graphics card memory, therefore it is very fast to draw a texture to a render target, or copy a render target to a texture (the graphics card can access both directly).
+
Being stored in the graphics card memory has some drawbacks. A texture cannot be manipulated as freely as a sf::Image , you need to prepare the pixels first and then upload them to the texture in a single operation (see Texture::update ).
+
sf::Texture makes it easy to convert from/to sf::Image , but keep in mind that these calls require transfers between the graphics card and the central memory, therefore they are slow operations.
+
A texture can be loaded from an image, but also directly from a file/memory/stream. The necessary shortcuts are defined so that you don't need an image first for the most common cases. However, if you want to perform some modifications on the pixels before creating the final texture, you can load your file to a sf::Image , do whatever you need with the pixels, and then call Texture::loadFromImage .
+
Since they live in the graphics card memory, the pixels of a texture cannot be accessed without a slow copy first. And they cannot be accessed individually. Therefore, if you need to read the texture's pixels (like for pixel-perfect collisions), it is recommended to store the collision information separately, for example in an array of booleans.
+
Like sf::Image , sf::Texture can handle a unique internal representation of pixels, which is RGBA 32 bits. This means that a pixel must be composed of 8 bits red, green, blue and alpha channels – just like a sf::Color .
+
Usage example:
return -1;
window.draw(sprite);
if (!texture.
create (640, 480))
return -1;
while (...)
{
...
sf::Uint8* pixels = ...;
window.draw(sprite);
...
}
Like sf::Shader that can be used as a raw OpenGL shader, sf::Texture can also be used directly as a raw texture for custom OpenGL geometry.
... render OpenGL geometry ...
sf::Texture::bind(NULL);
See also sf::Sprite , sf::Image , sf::RenderTexture
+
+
Definition at line 48 of file Texture.hpp .
+
+
+
◆
+
+
+
+
+
Types of texture coordinates that can be used for rendering.
+
+Enumerator Texture coordinates in range [0 .. 1].
+Texture coordinates in range [0 .. size].
+
+
+
Definition at line 56 of file Texture.hpp .
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Texture::Texture
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty texture.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Texture::Texture
+ (
+ const Texture &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Texture::~Texture
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
Bind a texture for rendering.
+
This function is not part of the graphics API, it mustn't be used when drawing SFML entities. It must be used only if you mix sf::Texture with OpenGL code.
+
...
sf::Texture::bind(&t1);
The coordinateType argument controls how texture coordinates will be interpreted. If Normalized (the default), they must be in range [0 .. 1], which is the default way of handling texture coordinates with OpenGL. If Pixels, they must be given in pixels (range [0 .. size]). This mode is used internally by the graphics classes of SFML, it makes the definition of texture coordinates more intuitive for the high-level API, users don't need to compute normalized values.
+
Parameters
+
+ texture Pointer to the texture to bind, can be null to use no texture coordinateType Type of texture coordinates to use
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ Image sf::Texture::copyToImage (
+ )
+ const
+
+
+
+
+
Copy the texture pixels to an image.
+
This function performs a slow operation that downloads the texture's pixels from the graphics card and copies them to a new image, potentially applying transformations to pixels if necessary (texture may be padded or flipped).
+
Returns Image containing the texture's pixels
+
See also loadFromImage
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::create
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height
+
+ )
+
+
+
+
+
Create the texture.
+
If this function fails, the texture is left unchanged.
+
Parameters
+
+ width Width of the texture height Height of the texture
+
+
+
Returns True if creation was successful
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::generateMipmap
+ (
+ )
+
+
+
+
+
Generate a mipmap using the current texture data.
+
Mipmaps are pre-computed chains of optimized textures. Each level of texture in a mipmap is generated by halving each of the previous level's dimensions. This is done until the final level has the size of 1x1. The textures generated in this process may make use of more advanced filters which might improve the visual quality of textures when they are applied to objects much smaller than they are. This is known as minification. Because fewer texels (texture elements) have to be sampled from when heavily minified, usage of mipmaps can also improve rendering performance in certain scenarios.
+
Mipmap generation relies on the necessary OpenGL extension being available. If it is unavailable or generation fails due to another reason, this function will return false. Mipmap data is only valid from the time it is generated until the next time the base level image is modified, at which point this function will have to be called again to regenerate it.
+
Returns True if mipmap generation was successful, false if unsuccessful
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static unsigned int sf::Texture::getMaximumSize
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the maximum texture size allowed.
+
This maximum size is defined by the graphics driver. You can expect a value of 512 pixels for low-end graphics card, and up to 8192 pixels or more for newer hardware.
+
Returns Maximum size allowed for textures, in pixels
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Texture::getNativeHandle
+ (
+ )
+ const
+
+
+
+
+
Get the underlying OpenGL handle of the texture.
+
You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.
+
Returns OpenGL handle of the texture or 0 if not yet created
+
+
+
+
+
◆
+
+
+
+
+
+ Vector2u sf::Texture::getSize (
+ )
+ const
+
+
+
+
+
Return the size of the texture.
+
Returns Size in pixels
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::isRepeated
+ (
+ )
+ const
+
+
+
+
+
Tell whether the texture is repeated or not.
+
Returns True if repeat mode is enabled, false if it is disabled
+
See also setRepeated
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::isSmooth
+ (
+ )
+ const
+
+
+
+
+
Tell whether the smooth filter is enabled or not.
+
Returns True if smoothing is enabled, false if it is disabled
+
See also setSmooth
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::isSrgb
+ (
+ )
+ const
+
+
+
+
+
Tell whether the texture source is converted from sRGB or not.
+
Returns True if the texture source is converted from sRGB, false if not
+
See also setSrgb
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::loadFromFile
+ (
+ const std::string &
+ filename ,
+
+ const IntRect &
+ area = IntRect ()
+
+ )
+
+
+
+
+
Load the texture from a file on disk.
+
This function is a shortcut for the following code:
The area argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty IntRect). If the area rectangle crosses the bounds of the image, it is adjusted to fit the image size.
+
The maximum size for a texture depends on the graphics driver and can be retrieved with the getMaximumSize function.
+
If this function fails, the texture is left unchanged.
+
Parameters
+
+ filename Path of the image file to load area Area of the image to load
+
+
+
Returns True if loading was successful
+
See also loadFromMemory , loadFromStream , loadFromImage
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::loadFromImage
+ (
+ const Image &
+ image ,
+
+ const IntRect &
+ area = IntRect ()
+
+ )
+
+
+
+
+
Load the texture from an image.
+
The area argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty IntRect). If the area rectangle crosses the bounds of the image, it is adjusted to fit the image size.
+
The maximum size for a texture depends on the graphics driver and can be retrieved with the getMaximumSize function.
+
If this function fails, the texture is left unchanged.
+
Parameters
+
+ image Image to load into the texture area Area of the image to load
+
+
+
Returns True if loading was successful
+
See also loadFromFile , loadFromMemory
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::loadFromMemory
+ (
+ const void *
+ data ,
+
+ std::size_t
+ size ,
+
+ const IntRect &
+ area = IntRect ()
+
+ )
+
+
+
+
+
Load the texture from a file in memory.
+
This function is a shortcut for the following code:
The area argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty IntRect). If the area rectangle crosses the bounds of the image, it is adjusted to fit the image size.
+
The maximum size for a texture depends on the graphics driver and can be retrieved with the getMaximumSize function.
+
If this function fails, the texture is left unchanged.
+
Parameters
+
+ data Pointer to the file data in memory size Size of the data to load, in bytes area Area of the image to load
+
+
+
Returns True if loading was successful
+
See also loadFromFile , loadFromStream , loadFromImage
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Texture::loadFromStream
+ (
+ InputStream & stream ,
+
+ const IntRect &
+ area = IntRect ()
+
+ )
+
+
+
+
+
Load the texture from a custom stream.
+
This function is a shortcut for the following code:
The area argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty IntRect). If the area rectangle crosses the bounds of the image, it is adjusted to fit the image size.
+
The maximum size for a texture depends on the graphics driver and can be retrieved with the getMaximumSize function.
+
If this function fails, the texture is left unchanged.
+
Parameters
+
+ stream Source stream to read from area Area of the image to load
+
+
+
Returns True if loading was successful
+
See also loadFromFile , loadFromMemory , loadFromImage
+
+
+
+
+
◆
+
+
+
+
+
+ Texture & sf::Texture::operator= (
+ const Texture &
+ right )
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Texture::setRepeated
+ (
+ bool
+ repeated )
+
+
+
+
+
Enable or disable repeating.
+
Repeating is involved when using texture coordinates outside the texture rectangle [0, 0, width, height]. In this case, if repeat mode is enabled, the whole texture will be repeated as many times as needed to reach the coordinate (for example, if the X texture coordinate is 3 * width, the texture will be repeated 3 times). If repeat mode is disabled, the "extra space" will instead be filled with border pixels. Warning: on very old graphics cards, white pixels may appear when the texture is repeated. With such cards, repeat mode can be used reliably only if the texture has power-of-two dimensions (such as 256x128). Repeating is disabled by default.
+
Parameters
+
+ repeated True to repeat the texture, false to disable repeating
+
+
+
See also isRepeated
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Texture::setSmooth
+ (
+ bool
+ smooth )
+
+
+
+
+
Enable or disable the smooth filter.
+
When the filter is activated, the texture appears smoother so that pixels are less noticeable. However if you want the texture to look exactly the same as its source file, you should leave it disabled. The smooth filter is disabled by default.
+
Parameters
+
+ smooth True to enable smoothing, false to disable it
+
+
+
See also isSmooth
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Texture::setSrgb
+ (
+ bool
+ sRgb )
+
+
+
+
+
Enable or disable conversion from sRGB.
+
When providing texture data from an image file or memory, it can either be stored in a linear color space or an sRGB color space. Most digital images account for gamma correction already, so they would need to be "uncorrected" back to linear color space before being processed by the hardware. The hardware can automatically convert it from the sRGB color space to a linear color space when it gets sampled. When the rendered image gets output to the final framebuffer, it gets converted back to sRGB.
+
After enabling or disabling sRGB conversion, make sure to reload the texture data in order for the setting to take effect.
+
This option is only useful in conjunction with an sRGB capable framebuffer. This can be requested during window creation.
+
Parameters
+
+ sRgb True to enable sRGB conversion, false to disable it
+
+
+
See also isSrgb
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Texture::swap
+ (
+ Texture & right )
+
+
+
+
+
Swap the contents of this texture with those of another.
+
Parameters
+
+ right Instance to swap with
+
+
+
+
+
+
+
◆ [1/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Uint8 *
+ pixels )
+
+
+
+
+
Update the whole texture from an array of pixels.
+
The pixel array is assumed to have the same size as the area rectangle, and to contain 32-bits RGBA pixels.
+
No additional check is performed on the size of the pixel array, passing invalid arguments will lead to an undefined behavior.
+
This function does nothing if pixels is null or if the texture was not previously created.
+
Parameters
+
+ pixels Array of pixels to copy to the texture
+
+
+
+
+
+
+
◆ [2/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Uint8 *
+ pixels ,
+
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ unsigned int
+ x ,
+
+ unsigned int
+ y
+
+ )
+
+
+
+
+
Update a part of the texture from an array of pixels.
+
The size of the pixel array must match the width and height arguments, and it must contain 32-bits RGBA pixels.
+
No additional check is performed on the size of the pixel array or the bounds of the area to update, passing invalid arguments will lead to an undefined behavior.
+
This function does nothing if pixels is null or if the texture was not previously created.
+
Parameters
+
+ pixels Array of pixels to copy to the texture width Width of the pixel region contained in pixels height Height of the pixel region contained in pixels x X offset in the texture where to copy the source pixels y Y offset in the texture where to copy the source pixels
+
+
+
+
+
+
+
◆ [3/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Texture &
+ texture )
+
+
+
+
+
Update a part of this texture from another texture.
+
Although the source texture can be smaller than this texture, this function is usually used for updating the whole texture. The other overload, which has (x, y) additional arguments, is more convenient for updating a sub-area of this texture.
+
No additional check is performed on the size of the passed texture, passing a texture bigger than this texture will lead to an undefined behavior.
+
This function does nothing if either texture was not previously created.
+
Parameters
+
+ texture Source texture to copy to this texture
+
+
+
+
+
+
+
◆ [4/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Texture &
+ texture ,
+
+ unsigned int
+ x ,
+
+ unsigned int
+ y
+
+ )
+
+
+
+
+
Update a part of this texture from another texture.
+
No additional check is performed on the size of the texture, passing an invalid combination of texture size and offset will lead to an undefined behavior.
+
This function does nothing if either texture was not previously created.
+
Parameters
+
+ texture Source texture to copy to this texture x X offset in this texture where to copy the source texture y Y offset in this texture where to copy the source texture
+
+
+
+
+
+
+
◆ [5/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Image &
+ image )
+
+
+
+
+
Update the texture from an image.
+
Although the source image can be smaller than the texture, this function is usually used for updating the whole texture. The other overload, which has (x, y) additional arguments, is more convenient for updating a sub-area of the texture.
+
No additional check is performed on the size of the image, passing an image bigger than the texture will lead to an undefined behavior.
+
This function does nothing if the texture was not previously created.
+
Parameters
+
+ image Image to copy to the texture
+
+
+
+
+
+
+
◆ [6/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Image &
+ image ,
+
+ unsigned int
+ x ,
+
+ unsigned int
+ y
+
+ )
+
+
+
+
+
Update a part of the texture from an image.
+
No additional check is performed on the size of the image, passing an invalid combination of image size and offset will lead to an undefined behavior.
+
This function does nothing if the texture was not previously created.
+
Parameters
+
+ image Image to copy to the texture x X offset in the texture where to copy the source image y Y offset in the texture where to copy the source image
+
+
+
+
+
+
+
◆ [7/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Window &
+ window )
+
+
+
+
+
Update the texture from the contents of a window.
+
Although the source window can be smaller than the texture, this function is usually used for updating the whole texture. The other overload, which has (x, y) additional arguments, is more convenient for updating a sub-area of the texture.
+
No additional check is performed on the size of the window, passing a window bigger than the texture will lead to an undefined behavior.
+
This function does nothing if either the texture or the window was not previously created.
+
Parameters
+
+ window Window to copy to the texture
+
+
+
+
+
+
+
◆ [8/8]
+
+
+
+
+
+ void sf::Texture::update
+ (
+ const Window &
+ window ,
+
+ unsigned int
+ x ,
+
+ unsigned int
+ y
+
+ )
+
+
+
+
+
Update a part of the texture from the contents of a window.
+
No additional check is performed on the size of the window, passing an invalid combination of window size and offset will lead to an undefined behavior.
+
This function does nothing if either the texture or the window was not previously created.
+
Parameters
+
+ window Window to copy to the texture x X offset in the texture where to copy the source window y Y offset in the texture where to copy the source window
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Thread , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class to manipulate threads.
+ More...
+
+
#include <Thread.hpp >
+
+
+
+
+
+
+
+
+template<typename F > Thread (F function) Construct the thread from a functor with no argument. More... template<typename F , typename A > Thread (F function, A argument) Construct the thread from a functor with an argument. More... template<typename C > Thread (void(C::*function)(), C *object) Construct the thread from a member function and an object. More... ~Thread () Destructor. More... void launch () Run the thread. More... void wait () Wait until the thread finishes. More... void terminate () Terminate the thread. More...
+
+
Utility class to manipulate threads.
+
Threads provide a way to run multiple parts of the code in parallel.
+
When you launch a new thread, the execution is split and both the new thread and the caller run in parallel.
+
To use a sf::Thread , you construct it directly with the function to execute as the entry point of the thread. sf::Thread has multiple template constructors, which means that you can use several types of entry points:
+non-member functions with no argument
+non-member functions with one argument of any type
+functors with no argument (this one is particularly useful for compatibility with boost/std::bind)
+functors with one argument of any type
+member functions from any class with no argument
+
+
The function argument, if any, is copied in the sf::Thread instance, as well as the functor (if the corresponding constructor is used). Class instances, however, are passed by pointer so you must make sure that the object won't be destroyed while the thread is still using it.
+
The thread ends when its function is terminated. If the owner sf::Thread instance is destroyed before the thread is finished, the destructor will wait (see wait() )
+
Usage examples:
void threadFunc(int argument)
{
...
}
thread.launch();
class Task
{
public :
void run()
{
...
}
};
Task task;
thread.launch();
struct Task
{
void operator()()
{
...
}
};
thread.launch();
Creating parallel threads of execution can be dangerous: all threads inside the same process share the same memory space, which means that you may end up accessing the same variable from multiple threads at the same time. To prevent this kind of situations, you can use mutexes (see sf::Mutex ).
+
See also sf::Mutex
+
+
Definition at line 48 of file Thread.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+template<typename F >
+
+
+ sf::Thread::Thread
+ (
+ F
+ function )
+
+
+
+
+
Construct the thread from a functor with no argument.
+
This constructor works for function objects, as well as free functions.
+
Use this constructor for this kind of function:
void function ();
struct Functor
{
void operator()();
};
Note: this does not run the thread, use launch() .
+
Parameters
+
+ function Functor or free function to use as the entry point of the thread
+
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+template<typename F , typename A >
+
+
+ sf::Thread::Thread
+ (
+ F
+ function ,
+
+ A
+ argument
+
+ )
+
+
+
+
+
Construct the thread from a functor with an argument.
+
This constructor works for function objects, as well as free functions. It is a template, which means that the argument can have any type (int, std::string, void*, Toto, ...).
+
Use this constructor for this kind of function:
void function (int arg);
struct Functor
{
void operator()(std::string arg);
};
Note: this does not run the thread, use launch() .
+
Parameters
+
+ function Functor or free function to use as the entry point of the thread argument argument to forward to the function
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+template<typename C >
+
+
+ sf::Thread::Thread
+ (
+ void(C::*)()
+ function ,
+
+ C *
+ object
+
+ )
+
+
+
+
+
Construct the thread from a member function and an object.
+
This constructor is a template, which means that you can use it with any class. Use this constructor for this kind of function:
class MyClass
{
public :
void function ();
};
Note: this does not run the thread, use launch() .
+
Parameters
+
+ function Entry point of the thread object Pointer to the object to use
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::Thread::~Thread
+ (
+ )
+
+
+
+
+
Destructor.
+
This destructor calls wait() , so that the internal thread cannot survive after its sf::Thread instance is destroyed.
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Thread::launch
+ (
+ )
+
+
+
+
+
Run the thread.
+
This function starts the entry point passed to the thread's constructor, and returns immediately. After this function returns, the thread's function is running in parallel to the calling code.
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Thread::terminate
+ (
+ )
+
+
+
+
+
Terminate the thread.
+
This function immediately stops the thread, without waiting for its function to finish. Terminating a thread with this function is not safe, and can lead to local variables not being destroyed on some operating systems. You should rather try to make the thread function terminate by itself.
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Thread::wait
+ (
+ )
+
+
+
+
+
Wait until the thread finishes.
+
This function will block the execution until the thread's function ends. Warning: if the thread function never ends, the calling thread will block forever. If this function is called from its owner thread, it returns without doing anything.
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::ThreadLocal , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Defines variables with thread-local storage.
+ More...
+
+
#include <ThreadLocal.hpp >
+
+
+
+
+
+
+
+
+
+
Defines variables with thread-local storage.
+
This class manipulates void* parameters and thus is not appropriate for strongly-typed variables.
+
You should rather use the sf::ThreadLocalPtr template class.
+
+
Definition at line 47 of file ThreadLocal.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::ThreadLocal::ThreadLocal
+ (
+ void *
+ value = NULL)
+
+
+
+
+
Default constructor.
+
Parameters
+
+ value Optional value to initialize the variable
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::ThreadLocal::~ThreadLocal
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void* sf::ThreadLocal::getValue
+ (
+ )
+ const
+
+
+
+
+
Retrieve the thread-specific value of the variable.
+
Returns Value of the variable for the current thread
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::ThreadLocal::setValue
+ (
+ void *
+ value )
+
+
+
+
+
Set the thread-specific value of the variable.
+
Parameters
+
+ value Value of the variable for the current thread
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::ThreadLocalPtr< T > , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Pointer to a thread-local variable.
+ More...
+
+
#include <ThreadLocalPtr.hpp >
+
+
+
+
+
+
+
+
+void setValue (void *value) Set the thread-specific value of the variable. More... void * getValue () const Retrieve the thread-specific value of the variable. More...
+
+
template<typename T>
+
+
Pointer to a thread-local variable.
+
sf::ThreadLocalPtr is a type-safe wrapper for storing pointers to thread-local variables.
+
A thread-local variable holds a different value for each different thread, unlike normal variables that are shared.
+
Its usage is completely transparent, so that it is similar to manipulating the raw pointer directly (like any smart pointer).
+
Usage example:
MyClass object1;
MyClass object2;
void thread1()
{
objectPtr = &object1;
...
}
void thread2()
{
objectPtr = &object2;
...
}
int main()
{
t1.launch();
t2.launch();
return 0;
}
ThreadLocalPtr is designed for internal use; however you can use it if you feel like it fits well your implementation.
+
+
Definition at line 41 of file ThreadLocalPtr.hpp .
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Default constructor.
+
Parameters
+
+ value Optional value to initialize the variable
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Conversion operator to implicitly convert the pointer to its raw pointer type (T*)
+
Returns Pointer to the actual object
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Overload of unary operator *.
+
Like raw pointers, applying the * operator returns a reference to the pointed-to object.
+
Returns Reference to the thread-local variable
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
Overload of operator ->
+
Similarly to raw pointers, applying the -> operator returns the pointed-to object.
+
Returns Pointer to the thread-local variable
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+
+
Assignment operator for a raw pointer parameter.
+
Parameters
+
+ value Pointer to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+
+
Assignment operator for a ThreadLocalPtr parameter.
+
Parameters
+
+
+
+
Returns Reference to self
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Time , including all inherited members.
+
+ asMicroseconds () constsf::Time asMilliseconds () constsf::Time asSeconds () constsf::Time microseconds (defined in sf::Time )sf::Time friend microseconds (Int64 amount)sf::Time related milliseconds (defined in sf::Time )sf::Time friend milliseconds (Int32 amount)sf::Time related operator!= (Time left, Time right)sf::Time related operator% (Time left, Time right)sf::Time related operator%= (Time &left, Time right)sf::Time related operator* (Time left, float right)sf::Time related operator* (Time left, Int64 right)sf::Time related operator* (float left, Time right)sf::Time related operator* (Int64 left, Time right)sf::Time related operator*= (Time &left, float right)sf::Time related operator*= (Time &left, Int64 right)sf::Time related operator+ (Time left, Time right)sf::Time related operator+= (Time &left, Time right)sf::Time related operator- (Time right)sf::Time related operator- (Time left, Time right)sf::Time related operator-= (Time &left, Time right)sf::Time related operator/ (Time left, float right)sf::Time related operator/ (Time left, Int64 right)sf::Time related operator/ (Time left, Time right)sf::Time related operator/= (Time &left, float right)sf::Time related operator/= (Time &left, Int64 right)sf::Time related operator< (Time left, Time right)sf::Time related operator<= (Time left, Time right)sf::Time related operator== (Time left, Time right)sf::Time related operator> (Time left, Time right)sf::Time related operator>= (Time left, Time right)sf::Time related seconds (defined in sf::Time )sf::Time friend seconds (float amount)sf::Time related Time ()sf::Time Zero sf::Time static
SFML - Simple and Fast Multimedia Library
+
+
+
Represents a time value.
+ More...
+
+
#include <Time.hpp >
+
+Time seconds (float) Time milliseconds (Int32) Time microseconds (Int64)
+(Note that these are not member functions.)
+Time seconds (float amount) Construct a time value from a number of seconds. More... Time milliseconds (Int32 amount) Construct a time value from a number of milliseconds. More... Time microseconds (Int64 amount) Construct a time value from a number of microseconds. More... bool operator== (Time left, Time right) Overload of == operator to compare two time values. More... bool operator!= (Time left, Time right) Overload of != operator to compare two time values. More... bool operator< (Time left, Time right) Overload of < operator to compare two time values. More... bool operator> (Time left, Time right) Overload of > operator to compare two time values. More... bool operator<= (Time left, Time right) Overload of <= operator to compare two time values. More... bool operator>= (Time left, Time right) Overload of >= operator to compare two time values. More... Time operator- (Time right) Overload of unary - operator to negate a time value. More... Time operator+ (Time left, Time right) Overload of binary + operator to add two time values. More... Time & operator+= (Time &left, Time right) Overload of binary += operator to add/assign two time values. More... Time operator- (Time left, Time right) Overload of binary - operator to subtract two time values. More... Time & operator-= (Time &left, Time right) Overload of binary -= operator to subtract/assign two time values. More... Time operator* (Time left, float right) Overload of binary * operator to scale a time value. More... Time operator* (Time left, Int64 right) Overload of binary * operator to scale a time value. More... Time operator* (float left, Time right) Overload of binary * operator to scale a time value. More... Time operator* (Int64 left, Time right) Overload of binary * operator to scale a time value. More... Time & operator*= (Time &left, float right) Overload of binary *= operator to scale/assign a time value. More... Time & operator*= (Time &left, Int64 right) Overload of binary *= operator to scale/assign a time value. More... Time operator/ (Time left, float right) Overload of binary / operator to scale a time value. More... Time operator/ (Time left, Int64 right) Overload of binary / operator to scale a time value. More... Time & operator/= (Time &left, float right) Overload of binary /= operator to scale/assign a time value. More... Time & operator/= (Time &left, Int64 right) Overload of binary /= operator to scale/assign a time value. More... float operator/ (Time left, Time right) Overload of binary / operator to compute the ratio of two time values. More... Time operator% (Time left, Time right) Overload of binary % operator to compute remainder of a time value. More... Time & operator%= (Time &left, Time right) Overload of binary %= operator to compute/assign remainder of a time value. More...
+
+
Represents a time value.
+
sf::Time encapsulates a time value in a flexible way.
+
It allows to define a time value either as a number of seconds, milliseconds or microseconds. It also works the other way round: you can read a time value as either a number of seconds, milliseconds or microseconds.
+
By using such a flexible interface, the API doesn't impose any fixed type or resolution for time values, and let the user choose its own favorite representation.
+
Time values support the usual mathematical operations: you can add or subtract two times, multiply or divide a time by a number, compare two times, etc.
+
Since they represent a time span and not an absolute time value, times can also be negative.
+
Usage example:
sf::Time t3 = sf::microseconds(-800000);
{
}
update(sf::milliseconds(100));
See also sf::Clock
+
+
Definition at line 40 of file Time.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Time::Time
+ (
+ )
+
+
+
+
+
Default constructor.
+
Sets the time value to zero.
+
+
+
+
+
+
◆
+
+
+
+
+
+ Int64 sf::Time::asMicroseconds
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ Int32 sf::Time::asMilliseconds
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Time::asSeconds
+ (
+ )
+ const
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time microseconds (
+ Int64
+ amount )
+
+
+
+
+related
+
+
+
+
+
Construct a time value from a number of microseconds.
+
Parameters
+
+ amount Number of microseconds
+
+
+
Returns Time value constructed from the amount of microseconds
+
See also seconds , milliseconds
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time milliseconds (
+ Int32
+ amount )
+
+
+
+
+related
+
+
+
+
+
Construct a time value from a number of milliseconds.
+
Parameters
+
+ amount Number of milliseconds
+
+
+
Returns Time value constructed from the amount of milliseconds
+
See also seconds , microseconds
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of != operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if both time values are different
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time operator% (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary % operator to compute remainder of a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns left modulo right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time & operator%= (
+ Time & left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary %= operator to compute/assign remainder of a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns left modulo right
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ Time operator* (
+ Time left ,
+
+ float
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary * operator to scale a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+
+
+
+ Time operator* (
+ Time left ,
+
+ Int64
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary * operator to scale a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+
+
+
+ Time operator* (
+ float
+ left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary * operator to scale a time value.
+
Parameters
+
+ left Left operand (a number) right Right operand (a time)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ Time operator* (
+ Int64
+ left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary * operator to scale a time value.
+
Parameters
+
+ left Left operand (a number) right Right operand (a time)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Time & operator*= (
+ Time & left ,
+
+ float
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary *= operator to scale/assign a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Time & operator*= (
+ Time & left ,
+
+ Int64
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary *= operator to scale/assign a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left multiplied by right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time operator+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary + operator to add two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns Sum of the two times values
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time & operator+= (
+ Time & left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary += operator to add/assign two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns Sum of the two times values
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Time operator- (
+ Time right )
+
+
+
+
+related
+
+
+
+
+
Overload of unary - operator to negate a time value.
+
Parameters
+
+ right Right operand (a time)
+
+
+
Returns Opposite of the time value
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Time operator- (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary - operator to subtract two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns Difference of the two times values
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time & operator-= (
+ Time & left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary -= operator to subtract/assign two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns Difference of the two times values
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+
+
+
+ Time operator/ (
+ Time left ,
+
+ float
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary / operator to scale a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left divided by right
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ Time operator/ (
+ Time left ,
+
+ Int64
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary / operator to scale a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left divided by right
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ float operator/
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary / operator to compute the ratio of two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns left divided by right
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ Time & operator/= (
+ Time & left ,
+
+ float
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary /= operator to scale/assign a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left divided by right
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ Time & operator/= (
+ Time & left ,
+
+ Int64
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary /= operator to scale/assign a time value.
+
Parameters
+
+ left Left operand (a time) right Right operand (a number)
+
+
+
Returns left divided by right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of < operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if left is lesser than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<=
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of <= operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if left is lesser or equal than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of == operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if both time values are equal
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of > operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if left is greater than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>=
+ (
+ Time left ,
+
+ Time right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of >= operator to compare two time values.
+
Parameters
+
+ left Left operand (a time) right Right operand (a time)
+
+
+
Returns True if left is greater or equal than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ Time seconds (
+ float
+ amount )
+
+
+
+
+related
+
+
+
+
+
Construct a time value from a number of seconds.
+
Parameters
+
+ amount Number of seconds
+
+
+
Returns Time value constructed from the amount of seconds
+
See also milliseconds , microseconds
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Time sf::Time::Zero
+
+
+
+
+static
+
+
+
+
+
Predefined "zero" time value.
+
+
Definition at line 85 of file Time.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Touch , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Give access to the real-time state of the touches.
+ More...
+
+
#include <Touch.hpp >
+
+static bool isDown (unsigned int finger) Check if a touch event is currently down. More... static Vector2i getPosition (unsigned int finger) Get the current position of a touch in desktop coordinates. More... static Vector2i getPosition (unsigned int finger, const Window &relativeTo) Get the current position of a touch in window coordinates. More...
+
+
Give access to the real-time state of the touches.
+
sf::Touch provides an interface to the state of the touches.
+
It only contains static functions, so it's not meant to be instantiated.
+
This class allows users to query the touches state at any time and directly, without having to deal with a window and its events. Compared to the TouchBegan, TouchMoved and TouchEnded events, sf::Touch can retrieve the state of the touches at any time (you don't need to store and update a boolean on your side in order to know if a touch is down), and you always get the real state of the touches, even if they happen when your window is out of focus and no event is triggered.
+
The getPosition function can be used to retrieve the current position of a touch. There are two versions: one that operates in global coordinates (relative to the desktop) and one that operates in window coordinates (relative to a specific window).
+
Touches are identified by an index (the "finger"), so that in multi-touch events, individual touches can be tracked correctly. As long as a finger touches the screen, it will keep the same index even if other fingers start or stop touching the screen in the meantime. As a consequence, active touch indices may not always be sequential (i.e. touch number 0 may be released while touch number 1 is still down).
+
Usage example:
See also sf::Joystick , sf::Keyboard , sf::Mouse
+
+
Definition at line 43 of file Touch.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static Vector2i sf::Touch::getPosition
+ (
+ unsigned int
+ finger )
+
+
+
+
+static
+
+
+
+
+
Get the current position of a touch in desktop coordinates.
+
This function returns the current touch position in global (desktop) coordinates.
+
Parameters
+
+
+
+
Returns Current position of finger , or undefined if it's not down
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static Vector2i sf::Touch::getPosition
+ (
+ unsigned int
+ finger ,
+
+ const Window &
+ relativeTo
+
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current position of a touch in window coordinates.
+
This function returns the current touch position relative to the given window.
+
Parameters
+
+ finger Finger index relativeTo Reference window
+
+
+
Returns Current position of finger , or undefined if it's not down
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::Touch::isDown
+ (
+ unsigned int
+ finger )
+
+
+
+
+static
+
+
+
+
+
Check if a touch event is currently down.
+
Parameters
+
+
+
+
Returns True if finger is currently touching the screen, false otherwise
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Transform , including all inherited members.
+
+ combine (const Transform &transform)sf::Transform getInverse () constsf::Transform getMatrix () constsf::Transform Identity sf::Transform static operator!= (const Transform &left, const Transform &right)sf::Transform related operator* (const Transform &left, const Transform &right)sf::Transform related operator* (const Transform &left, const Vector2f &right)sf::Transform related operator*= (Transform &left, const Transform &right)sf::Transform related operator== (const Transform &left, const Transform &right)sf::Transform related rotate (float angle)sf::Transform rotate (float angle, float centerX, float centerY)sf::Transform rotate (float angle, const Vector2f ¢er)sf::Transform scale (float scaleX, float scaleY)sf::Transform scale (float scaleX, float scaleY, float centerX, float centerY)sf::Transform scale (const Vector2f &factors)sf::Transform scale (const Vector2f &factors, const Vector2f ¢er)sf::Transform Transform ()sf::Transform Transform (float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)sf::Transform transformPoint (float x, float y) constsf::Transform transformPoint (const Vector2f &point) constsf::Transform transformRect (const FloatRect &rectangle) constsf::Transform translate (float x, float y)sf::Transform translate (const Vector2f &offset)sf::Transform
SFML - Simple and Fast Multimedia Library
+
+
+
Define a 3x3 transform matrix.
+ More...
+
+
#include <Transform.hpp >
+
+ Transform () Default constructor. More... Transform (float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22) Construct a transform from a 3x3 matrix. More... const float * getMatrix () const Return the transform as a 4x4 matrix. More... Transform getInverse () const Return the inverse of the transform. More... Vector2f transformPoint (float x, float y) const Transform a 2D point. More... Vector2f transformPoint (const Vector2f &point) const Transform a 2D point. More... FloatRect transformRect (const FloatRect &rectangle) const Transform a rectangle. More... Transform & combine (const Transform &transform) Combine the current transform with another one. More... Transform & translate (float x, float y) Combine the current transform with a translation. More... Transform & translate (const Vector2f &offset) Combine the current transform with a translation. More... Transform & rotate (float angle) Combine the current transform with a rotation. More... Transform & rotate (float angle, float centerX, float centerY) Combine the current transform with a rotation. More... Transform & rotate (float angle, const Vector2f ¢er) Combine the current transform with a rotation. More... Transform & scale (float scaleX, float scaleY) Combine the current transform with a scaling. More... Transform & scale (float scaleX, float scaleY, float centerX, float centerY) Combine the current transform with a scaling. More... Transform & scale (const Vector2f &factors) Combine the current transform with a scaling. More... Transform & scale (const Vector2f &factors, const Vector2f ¢er) Combine the current transform with a scaling. More...
+
+
Define a 3x3 transform matrix.
+
A sf::Transform specifies how to translate, rotate, scale, shear, project, whatever things.
+
In mathematical terms, it defines how to transform a coordinate system into another.
+
For example, if you apply a rotation transform to a sprite, the result will be a rotated sprite. And anything that is transformed by this rotation transform will be rotated the same way, according to its initial position.
+
Transforms are typically used for drawing. But they can also be used for any computation that requires to transform points between the local and global coordinate systems of an entity (like collision detection).
+
Example:
See also sf::Transformable , sf::RenderStates
+
+
Definition at line 42 of file Transform.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::Transform::Transform
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an identity transform (a transform that does nothing).
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::Transform::Transform
+ (
+ float
+ a00 ,
+
+ float
+ a01 ,
+
+ float
+ a02 ,
+
+ float
+ a10 ,
+
+ float
+ a11 ,
+
+ float
+ a12 ,
+
+ float
+ a20 ,
+
+ float
+ a21 ,
+
+ float
+ a22
+
+ )
+
+
+
+
+
Construct a transform from a 3x3 matrix.
+
Parameters
+
+ a00 Element (0, 0) of the matrix a01 Element (0, 1) of the matrix a02 Element (0, 2) of the matrix a10 Element (1, 0) of the matrix a11 Element (1, 1) of the matrix a12 Element (1, 2) of the matrix a20 Element (2, 0) of the matrix a21 Element (2, 1) of the matrix a22 Element (2, 2) of the matrix
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
Combine the current transform with another one.
+
The result is a transform that is equivalent to applying *this followed by transform . Mathematically, it is equivalent to a matrix multiplication.
+
Parameters
+
+ transform Transform to combine with this transform
+
+
+
Returns Reference to *this
+
+
+
+
+
◆
+
+
+
+
+
+ Transform sf::Transform::getInverse (
+ )
+ const
+
+
+
+
+
Return the inverse of the transform.
+
If the inverse cannot be computed, an identity transform is returned.
+
Returns A new transform which is the inverse of self
+
+
+
+
+
◆
+
+
+
+
+
+ const float* sf::Transform::getMatrix
+ (
+ )
+ const
+
+
+
+
+
Return the transform as a 4x4 matrix.
+
This function returns a pointer to an array of 16 floats containing the transform elements as a 4x4 matrix, which is directly compatible with OpenGL functions.
+
Returns Pointer to a 4x4 matrix
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ Transform & sf::Transform::rotate (
+ float
+ angle )
+
+
+
+
+
Combine the current transform with a rotation.
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ angle Rotation angle, in degrees
+
+
+
Returns Reference to *this
+
See also translate , scale
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ Transform & sf::Transform::rotate (
+ float
+ angle ,
+
+ float
+ centerX ,
+
+ float
+ centerY
+
+ )
+
+
+
+
+
Combine the current transform with a rotation.
+
The center of rotation is provided for convenience as a second argument, so that you can build rotations around arbitrary points more easily (and efficiently) than the usual translate(-center).rotate(angle).translate(center).
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ angle Rotation angle, in degrees centerX X coordinate of the center of rotation centerY Y coordinate of the center of rotation
+
+
+
Returns Reference to *this
+
See also translate , scale
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ Transform & sf::Transform::rotate (
+ float
+ angle ,
+
+ const Vector2f &
+ center
+
+ )
+
+
+
+
+
Combine the current transform with a rotation.
+
The center of rotation is provided for convenience as a second argument, so that you can build rotations around arbitrary points more easily (and efficiently) than the usual translate(-center).rotate(angle).translate(center).
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ angle Rotation angle, in degrees center Center of rotation
+
+
+
Returns Reference to *this
+
See also translate , scale
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ Transform & sf::Transform::scale (
+ float
+ scaleX ,
+
+ float
+ scaleY
+
+ )
+
+
+
+
+
Combine the current transform with a scaling.
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ scaleX Scaling factor on the X axis scaleY Scaling factor on the Y axis
+
+
+
Returns Reference to *this
+
See also translate , rotate
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ Transform & sf::Transform::scale (
+ float
+ scaleX ,
+
+ float
+ scaleY ,
+
+ float
+ centerX ,
+
+ float
+ centerY
+
+ )
+
+
+
+
+
Combine the current transform with a scaling.
+
The center of scaling is provided for convenience as a second argument, so that you can build scaling around arbitrary points more easily (and efficiently) than the usual translate(-center).scale(factors).translate(center).
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ scaleX Scaling factor on X axis scaleY Scaling factor on Y axis centerX X coordinate of the center of scaling centerY Y coordinate of the center of scaling
+
+
+
Returns Reference to *this
+
See also translate , rotate
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Combine the current transform with a scaling.
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ factors Scaling factors
+
+
+
Returns Reference to *this
+
See also translate , rotate
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
Combine the current transform with a scaling.
+
The center of scaling is provided for convenience as a second argument, so that you can build scaling around arbitrary points more easily (and efficiently) than the usual translate(-center).scale(factors).translate(center).
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ factors Scaling factors center Center of scaling
+
+
+
Returns Reference to *this
+
See also translate , rotate
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Vector2f sf::Transform::transformPoint (
+ float
+ x ,
+
+ float
+ y
+
+ )
+ const
+
+
+
+
+
Transform a 2D point.
+
Parameters
+
+ x X coordinate of the point to transform y Y coordinate of the point to transform
+
+
+
Returns Transformed point
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Vector2f sf::Transform::transformPoint (
+ const Vector2f &
+ point )
+ const
+
+
+
+
+
Transform a 2D point.
+
Parameters
+
+ point Point to transform
+
+
+
Returns Transformed point
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::Transform::transformRect (
+ const FloatRect &
+ rectangle )
+ const
+
+
+
+
+
Transform a rectangle.
+
Since SFML doesn't provide support for oriented rectangles, the result of this function is always an axis-aligned rectangle. Which means that if the transform contains a rotation, the bounding rectangle of the transformed rectangle is returned.
+
Parameters
+
+ rectangle Rectangle to transform
+
+
+
Returns Transformed rectangle
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Transform & sf::Transform::translate (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+
Combine the current transform with a translation.
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ x Offset to apply on X axis y Offset to apply on Y axis
+
+
+
Returns Reference to *this
+
See also rotate , scale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Combine the current transform with a translation.
+
This function returns a reference to *this, so that calls can be chained.
Parameters
+
+ offset Translation offset to apply
+
+
+
Returns Reference to *this
+
See also rotate , scale
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ const Transform &
+ left ,
+
+ const Transform &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator != to compare two transforms.
+
This call is equivalent to !(left == right).
+
Parameters
+
+ left Left operand (the first transform) right Right operand (the second transform)
+
+
+
Returns true if the transforms are not equal, false otherwise
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Overload of binary operator * to combine two transforms.
+
This call is equivalent to calling Transform(left).combine(right).
+
Parameters
+
+ left Left operand (the first transform) right Right operand (the second transform)
+
+
+
Returns New combined transform
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Overload of binary operator * to transform a point.
+
This call is equivalent to calling left.transformPoint(right).
+
Parameters
+
+ left Left operand (the transform) right Right operand (the point to transform)
+
+
+
Returns New transformed point
+
+
+
+
+
◆
+
+
+
+
+
Overload of binary operator *= to combine two transforms.
+
This call is equivalent to calling left.combine(right).
+
Parameters
+
+ left Left operand (the first transform) right Right operand (the second transform)
+
+
+
Returns The combined transform
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ const Transform &
+ left ,
+
+ const Transform &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator == to compare two transforms.
+
Performs an element-wise comparison of the elements of the left transform with the elements of the right transform.
+
Parameters
+
+ left Left operand (the first transform) right Right operand (the second transform)
+
+
+
Returns true if the transforms are equal, false otherwise
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ const Transform sf::Transform::Identity
+
+
+
+
+static
+
+
+
+
+
The identity transform (does nothing)
+
+
Definition at line 354 of file Transform.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Transformable , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Decomposed transform defined by a position, a rotation and a scale.
+ More...
+
+
#include <Transformable.hpp >
+
+
+
+
+
+
+
+
+
+
Decomposed transform defined by a position, a rotation and a scale.
+
This class is provided for convenience, on top of sf::Transform .
+
sf::Transform , as a low-level class, offers a great level of flexibility but it is not always convenient to manage. Indeed, one can easily combine any kind of operation, such as a translation followed by a rotation followed by a scaling, but once the result transform is built, there's no way to go backward and, let's say, change only the rotation without modifying the translation and scaling. The entire transform must be recomputed, which means that you need to retrieve the initial translation and scale factors as well, and combine them the same way you did before updating the rotation. This is a tedious operation, and it requires to store all the individual components of the final transform.
+
That's exactly what sf::Transformable was written for: it hides these variables and the composed transform behind an easy to use interface. You can set or get any of the individual components without worrying about the others. It also provides the composed transform (as a sf::Transform ), and keeps it up-to-date.
+
In addition to the position, rotation and scale, sf::Transformable provides an "origin" component, which represents the local origin of the three other components. Let's take an example with a 10x10 pixels sprite. By default, the sprite is positioned/rotated/scaled relatively to its top-left corner, because it is the local point (0, 0). But if we change the origin to be (5, 5), the sprite will be positioned/rotated/scaled around its center instead. And if we set the origin to (10, 10), it will be transformed around its bottom-right corner.
+
To keep the sf::Transformable class simple, there's only one origin for all the components. You cannot position the sprite relatively to its top-left corner while rotating it around its center, for example. To do such things, use sf::Transform directly.
+
sf::Transformable can be used as a base class. It is often combined with sf::Drawable – that's what SFML's sprites, texts and shapes do.
{
{
target.
draw (..., states);
}
};
MyEntity entity;
entity.setPosition(10, 20);
entity.setRotation(45);
window.draw(entity);
It can also be used as a member, if you don't want to use its API directly (because you don't need all its functions, or you have different naming conventions for example).
class MyEntity
{
public :
void SetPosition(const MyVector& v)
{
myTransform.setPosition(v.x(), v.y());
}
{
target.
draw (..., myTransform.getTransform());
}
private :
};
A note on coordinates and undistorted rendering: sf::Drawable object pixel-perfectly, make sure the involved coordinates allow a 1:1 mapping of pixels in the window to texels (pixels in the texture). More specifically, this means:
+The object's position, origin and scale have no fractional part
+The object's and the view's rotation are a multiple of 90 degrees
+The view's center and size have no fractional part
+
+
See also sf::Transform
+
+
Definition at line 41 of file Transformable.hpp .
+
+
+
◆
+
+
+
+
+
+ sf::Transformable::Transformable
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Transformable::~Transformable
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Virtual destructor.
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Transform & sf::Transformable::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+
get the inverse of the combined transform of the object
+
Returns Inverse of the combined transformations applied to the object
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::Transformable::getOrigin
+ (
+ )
+ const
+
+
+
+
+
get the local origin of the object
+
Returns Current origin
+
See also setOrigin
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::Transformable::getPosition
+ (
+ )
+ const
+
+
+
+
+
get the position of the object
+
Returns Current position
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Transformable::getRotation
+ (
+ )
+ const
+
+
+
+
+
get the orientation of the object
+
The rotation is always in the range [0, 360].
+
Returns Current rotation, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::Transformable::getScale
+ (
+ )
+ const
+
+
+
+
+
get the current scale of the object
+
Returns Current scale factors
+
See also setScale
+
+
+
+
+
◆
+
+
+
+
+
+ const Transform & sf::Transformable::getTransform
+ (
+ )
+ const
+
+
+
+
+
get the combined transform of the object
+
Returns Transform combining the position/rotation/scale/origin of the object
+
See also getInverseTransform
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
object .setPosition(pos.
x + offsetX, pos.
y + offsetY);
Parameters
+
+ offsetX X offset offsetY Y offset
+
+
+
See also setPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Transformable::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+
Move the object by a given offset.
+
This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+
+
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Transformable::rotate
+ (
+ float
+ angle )
+
+
+
+
+
Rotate the object.
+
This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code:
Parameters
+
+ angle Angle of rotation, in degrees
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factorX,
scale .y * factorY);
Parameters
+
+ factorX Horizontal scale factor factorY Vertical scale factor
+
+
+
See also setScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Transformable::scale
+ (
+ const Vector2f &
+ factor )
+
+
+
+
+
Scale the object.
+
This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code:
object .setScale(
scale .x * factor.x,
scale .y * factor.y);
Parameters
+
+
+
+
See also setScale
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new origin y Y coordinate of the new origin
+
+
+
See also getOrigin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Transformable::setOrigin
+ (
+ const Vector2f &
+ origin )
+
+
+
+
+
set the local origin of the object
+
The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also getOrigin
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+ x X coordinate of the new position y Y coordinate of the new position
+
+
+
See also move , getPosition
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Transformable::setPosition
+ (
+ const Vector2f &
+ position )
+
+
+
+
+
set the position of the object
+
This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).
+
Parameters
+
+
+
+
See also move , getPosition
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Transformable::setRotation
+ (
+ float
+ angle )
+
+
+
+
+
set the orientation of the object
+
This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.
+
Parameters
+
+ angle New rotation, in degrees
+
+
+
See also rotate , getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ float
+ factorX ,
+
+ float
+ factorY
+
+ )
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factorX New horizontal scale factor factorY New vertical scale factor
+
+
+
See also scale , getScale
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::Transformable::setScale
+ (
+ const Vector2f &
+ factors )
+
+
+
+
+
set the scale factors of the object
+
This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).
+
Parameters
+
+ factors New scale factors
+
+
+
See also scale , getScale
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::UdpSocket , including all inherited members.
+
+ AnyPort enum valuesf::Socket bind (unsigned short port, const IpAddress &address=IpAddress::Any)sf::UdpSocket close ()sf::Socket protected create ()sf::Socket protected create (SocketHandle handle)sf::Socket protected Disconnected enum valuesf::Socket Done enum valuesf::Socket Error enum valuesf::Socket getHandle () constsf::Socket protected getLocalPort () constsf::UdpSocket isBlocking () constsf::Socket MaxDatagramSize enum valuesf::UdpSocket NotReady enum valuesf::Socket Partial enum valuesf::Socket receive (void *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort)sf::UdpSocket receive (Packet &packet, IpAddress &remoteAddress, unsigned short &remotePort)sf::UdpSocket send (const void *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort)sf::UdpSocket send (Packet &packet, const IpAddress &remoteAddress, unsigned short remotePort)sf::UdpSocket setBlocking (bool blocking)sf::Socket Socket (Type type)sf::Socket protected Status enum namesf::Socket Tcp enum valuesf::Socket protected Type enum namesf::Socket protected Udp enum valuesf::Socket protected UdpSocket ()sf::UdpSocket unbind ()sf::UdpSocket ~Socket ()sf::Socket virtual
SFML - Simple and Fast Multimedia Library
+
+
+
Specialized socket using the UDP protocol.
+ More...
+
+
#include <UdpSocket.hpp >
+
+
+
+
+
+
+
+
+ UdpSocket () Default constructor. More... unsigned short getLocalPort () const Get the port to which the socket is bound locally. More... Status bind (unsigned short port, const IpAddress &address=IpAddress::Any ) Bind the socket to a specific port. More... void unbind () Unbind the socket from the local port to which it is bound. More... Status send (const void *data, std::size_t size, const IpAddress &remoteAddress, unsigned short remotePort) Send raw data to a remote peer. More... Status receive (void *data, std::size_t size, std::size_t &received, IpAddress &remoteAddress, unsigned short &remotePort) Receive raw data from a remote peer. More... Status send (Packet &packet, const IpAddress &remoteAddress, unsigned short remotePort) Send a formatted packet of data to a remote peer. More... Status receive (Packet &packet, IpAddress &remoteAddress, unsigned short &remotePort) Receive a formatted packet of data from a remote peer. More... void setBlocking (bool blocking) Set the blocking state of the socket. More... bool isBlocking () const Tell whether the socket is in blocking or non-blocking mode. More...
+enum Type { Tcp ,
+Udp
+ } Types of protocols that the socket can use. More...
+SocketHandle getHandle () const Return the internal handle of the socket. More... void create () Create the internal representation of the socket. More... void create (SocketHandle handle) Create the internal representation of the socket from a socket handle. More... void close () Close the socket gracefully. More...
+
+
Specialized socket using the UDP protocol.
+
A UDP socket is a connectionless socket.
+
Instead of connecting once to a remote host, like TCP sockets, it can send to and receive from any host at any time.
+
It is a datagram protocol: bounded blocks of data (datagrams) are transfered over the network rather than a continuous stream of data (TCP). Therefore, one call to send will always match one call to receive (if the datagram is not lost), with the same data that was sent.
+
The UDP protocol is lightweight but unreliable. Unreliable means that datagrams may be duplicated, be lost or arrive reordered. However, if a datagram arrives, its data is guaranteed to be valid.
+
UDP is generally used for real-time communication (audio or video streaming, real-time games, etc.) where speed is crucial and lost data doesn't matter much.
+
Sending and receiving data can use either the low-level or the high-level functions. The low-level functions process a raw sequence of bytes, whereas the high-level interface uses packets (see sf::Packet ), which are easier to use and provide more safety regarding the data that is exchanged. You can look at the sf::Packet class to get more details about how they work.
+
It is important to note that UdpSocket is unable to send datagrams bigger than MaxDatagramSize. In this case, it returns an error and doesn't send anything. This applies to both raw data and packets. Indeed, even packets are unable to split and recompose data, due to the unreliability of the protocol (dropped, mixed or duplicated datagrams may lead to a big mess when trying to recompose a packet).
+
If the socket is bound to a port, it is automatically unbound from it when the socket is destroyed. However, you can unbind the socket explicitly with the Unbind function if necessary, to stop receiving messages or make the port available for other sockets.
+
Usage example:
socket.
send (message.c_str(), message.size() + 1,
"192.168.1.50" , 55002);
char buffer[1024];
std::size_t received = 0;
unsigned short port;
socket.
receive (buffer,
sizeof (buffer), received, sender, port);
std::cout << sender.ToString() << " said: " << buffer << std::endl;
char buffer[1024];
std::size_t received = 0;
unsigned short port;
socket.
receive (buffer,
sizeof (buffer), received, sender, port);
std::cout << sender.ToString() << " said: " << buffer << std::endl;
std::string message =
"Welcome " + sender.
toString ();
socket.
send (message.c_str(), message.size() + 1, sender, port);
See also sf::Socket , sf::TcpSocket , sf::Packet
+
+
Definition at line 45 of file UdpSocket.hpp .
+
+
+
◆
+
+
+
+
+
Some special values used by sockets.
+
+Enumerator Special value that tells the system to pick any available port.
+
+
+
Definition at line 66 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+Enumerator The maximum number of bytes that can be sent in a single UDP datagram.
+
+
+
Definition at line 52 of file UdpSocket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Status codes that may be returned by socket functions.
+
+Enumerator The socket has sent / received the data.
+The socket is not ready to send / receive data yet.
+The socket sent a part of the data.
+The TCP socket has been disconnected.
+An unexpected error happened.
+
+
+
Definition at line 53 of file Socket.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+
+protected inherited
+
+
+
+
+
Types of protocols that the socket can use.
+
+Enumerator TCP protocol.
+UDP protocol.
+
+
+
Definition at line 114 of file Socket.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::UdpSocket::UdpSocket
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
Bind the socket to a specific port.
+
Binding the socket to a port is necessary for being able to receive data on that port. You can use the special value Socket::AnyPort to tell the system to automatically pick an available port, and then call getLocalPort to retrieve the chosen port.
+
Since the socket can only be bound to a single port at any given moment, if it is already bound when this function is called, it will be unbound from the previous port before being bound to the new one.
+
Parameters
+
+ port Port to bind the socket to address Address of the interface to bind to
+
+
+
Returns Status code
+
See also unbind , getLocalPort
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::close
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Close the socket gracefully.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket.
+
This function can only be accessed by derived classes.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void sf::Socket::create
+ (
+ SocketHandle
+ handle )
+
+
+
+
+protected inherited
+
+
+
+
+
Create the internal representation of the socket from a socket handle.
+
This function can only be accessed by derived classes.
+
Parameters
+
+ handle OS-specific handle of the socket to wrap
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ SocketHandle sf::Socket::getHandle
+ (
+ )
+ const
+
+
+
+
+protected inherited
+
+
+
+
+
Return the internal handle of the socket.
+
The returned handle may be invalid if the socket was not created yet (or already destroyed). This function can only be accessed by derived classes.
+
Returns The internal (OS-specific) handle of the socket
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned short sf::UdpSocket::getLocalPort
+ (
+ )
+ const
+
+
+
+
+
Get the port to which the socket is bound locally.
+
If the socket is not bound to a port, this function returns 0.
+
Returns Port to which the socket is bound
+
See also bind
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool sf::Socket::isBlocking
+ (
+ )
+ const
+
+
+
+
+inherited
+
+
+
+
+
Tell whether the socket is in blocking or non-blocking mode.
+
Returns True if the socket is blocking, false otherwise
+
See also setBlocking
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Status sf::UdpSocket::receive (
+ void *
+ data ,
+
+ std::size_t
+ size ,
+
+ std::size_t &
+ received ,
+
+ IpAddress & remoteAddress ,
+
+ unsigned short &
+ remotePort
+
+ )
+
+
+
+
+
Receive raw data from a remote peer.
+
In blocking mode, this function will wait until some bytes are actually received. Be careful to use a buffer which is large enough for the data that you intend to receive, if it is too small then an error will be returned and all the data will be lost.
+
Parameters
+
+ data Pointer to the array to fill with the received bytes size Maximum number of bytes that can be received received This variable is filled with the actual number of bytes received remoteAddress Address of the peer that sent the data remotePort Port of the peer that sent the data
+
+
+
Returns Status code
+
See also send
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Status sf::UdpSocket::receive (
+ Packet & packet ,
+
+ IpAddress & remoteAddress ,
+
+ unsigned short &
+ remotePort
+
+ )
+
+
+
+
+
Receive a formatted packet of data from a remote peer.
+
In blocking mode, this function will wait until the whole packet has been received.
+
Parameters
+
+ packet Packet to fill with the received data remoteAddress Address of the peer that sent the data remotePort Port of the peer that sent the data
+
+
+
Returns Status code
+
See also send
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Status sf::UdpSocket::send (
+ const void *
+ data ,
+
+ std::size_t
+ size ,
+
+ const IpAddress &
+ remoteAddress ,
+
+ unsigned short
+ remotePort
+
+ )
+
+
+
+
+
Send raw data to a remote peer.
+
Make sure that size is not greater than UdpSocket::MaxDatagramSize , otherwise this function will fail and no data will be sent.
+
Parameters
+
+ data Pointer to the sequence of bytes to send size Number of bytes to send remoteAddress Address of the receiver remotePort Port of the receiver to send the data to
+
+
+
Returns Status code
+
See also receive
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ Status sf::UdpSocket::send (
+ Packet & packet ,
+
+ const IpAddress &
+ remoteAddress ,
+
+ unsigned short
+ remotePort
+
+ )
+
+
+
+
+
Send a formatted packet of data to a remote peer.
+
Make sure that the packet size is not greater than UdpSocket::MaxDatagramSize , otherwise this function will fail and no data will be sent.
+
Parameters
+
+ packet Packet to send remoteAddress Address of the receiver remotePort Port of the receiver to send the data to
+
+
+
Returns Status code
+
See also receive
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void sf::Socket::setBlocking
+ (
+ bool
+ blocking )
+
+
+
+
+inherited
+
+
+
+
+
Set the blocking state of the socket.
+
In blocking mode, calls will not return until they have completed their task. For example, a call to Receive in blocking mode won't return until some data was actually received. In non-blocking mode, calls will always return immediately, using the return code to signal whether there was data available or not. By default, all sockets are blocking.
+
Parameters
+
+ blocking True to set the socket as blocking, false for non-blocking
+
+
+
See also isBlocking
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::UdpSocket::unbind
+ (
+ )
+
+
+
+
+
Unbind the socket from the local port to which it is bound.
+
The port that the socket was previously bound to is immediately made available to the operating system after this function is called. This means that a subsequent call to bind() will be able to re-bind the port if no other process has done so in the mean time. If the socket is not bound to a port, this function has no effect.
+
See also bind
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
Utility class providing generic functions for UTF conversions.
+ More...
+
+
#include <Utf.hpp >
+
+
template<unsigned int N>
+
+
Utility class providing generic functions for UTF conversions.
+
sf::Utf is a low-level, generic interface for counting, iterating, encoding and decoding Unicode characters and strings. It is able to handle ANSI, wide, latin-1, UTF-8, UTF-16 and UTF-32 encodings.
+
sf::Utf<X> functions are all static, these classes are not meant to be instantiated. All the functions are template, so that you can use any character / string type for a given encoding.
+
It has 3 specializations:
+
+
Definition at line 41 of file Utf.hpp .
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Utf< 16 > , including all inherited members.
+
+ count (In begin, In end)sf::Utf< 16 > static decode (In begin, In end, Uint32 &output, Uint32 replacement=0)sf::Utf< 16 > static encode (Uint32 input, Out output, Uint16 replacement=0)sf::Utf< 16 > static fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale())sf::Utf< 16 > static fromLatin1 (In begin, In end, Out output)sf::Utf< 16 > static fromWide (In begin, In end, Out output)sf::Utf< 16 > static next (In begin, In end)sf::Utf< 16 > static toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale())sf::Utf< 16 > static toLatin1 (In begin, In end, Out output, char replacement=0)sf::Utf< 16 > static toUtf16 (In begin, In end, Out output)sf::Utf< 16 > static toUtf32 (In begin, In end, Out output)sf::Utf< 16 > static toUtf8 (In begin, In end, Out output)sf::Utf< 16 > static toWide (In begin, In end, Out output, wchar_t replacement=0)sf::Utf< 16 > static
SFML - Simple and Fast Multimedia Library
+
+
+
Specialization of the Utf template for UTF-16.
+ More...
+
+
#include <Utf.hpp >
+
+template<typename In > static In decode (In begin, In end, Uint32 &output, Uint32 replacement=0) Decode a single UTF-16 character. More... template<typename Out > static Out encode (Uint32 input, Out output, Uint16 replacement=0) Encode a single UTF-16 character. More... template<typename In > static In next (In begin, In end) Advance to the next UTF-16 character. More... template<typename In > static std::size_t count (In begin, In end) Count the number of characters of a UTF-16 sequence. More... template<typename In , typename Out > static Out fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale()) Convert an ANSI characters range to UTF-16. More... template<typename In , typename Out > static Out fromWide (In begin, In end, Out output) Convert a wide characters range to UTF-16. More... template<typename In , typename Out > static Out fromLatin1 (In begin, In end, Out output) Convert a latin-1 (ISO-5589-1) characters range to UTF-16. More... template<typename In , typename Out > static Out toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale()) Convert an UTF-16 characters range to ANSI characters. More... template<typename In , typename Out > static Out toWide (In begin, In end, Out output, wchar_t replacement=0) Convert an UTF-16 characters range to wide characters. More... template<typename In , typename Out > static Out toLatin1 (In begin, In end, Out output, char replacement=0) Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters. More... template<typename In , typename Out > static Out toUtf8 (In begin, In end, Out output) Convert a UTF-16 characters range to UTF-8. More... template<typename In , typename Out > static Out toUtf16 (In begin, In end, Out output) Convert a UTF-16 characters range to UTF-16. More... template<typename In , typename Out > static Out toUtf32 (In begin, In end, Out output) Convert a UTF-16 characters range to UTF-32. More...
+
+
template<>
+
+
Specialization of the Utf template for UTF-16.
+
+
Definition at line 255 of file Utf.hpp .
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static std::size_t sf::Utf < 16 >::count
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Count the number of characters of a UTF-16 sequence.
+
This function is necessary for multi-elements encodings, as a single character may use more than 1 storage element, thus the total size can be different from (begin - end).
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 16 >::decode
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Uint32 &
+ output ,
+
+ Uint32
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Decode a single UTF-16 character.
+
Decoding a character means finding its unique 32-bits code (called the codepoint) in the Unicode standard.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Codepoint of the decoded UTF-16 character replacement Replacement character to use in case the UTF-8 sequence is invalid
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::encode
+ (
+ Uint32
+ input ,
+
+ Out
+ output ,
+
+ Uint16
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Encode a single UTF-16 character.
+
Encoding a character means converting a unique 32-bits code (called the codepoint) in the target encoding, UTF-16.
+
Parameters
+
+ input Codepoint to encode as UTF-16 output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to UTF-16 (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::fromAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an ANSI characters range to UTF-16.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::fromLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a latin-1 (ISO-5589-1) characters range to UTF-16.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::fromWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a wide characters range to UTF-16.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 16 >::next
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Advance to the next UTF-16 character.
+
This function is necessary for multi-elements encodings, as a single character may use more than 1 storage element.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-16 characters range to ANSI characters.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to ANSI (use 0 to skip them) locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toUtf16
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-16 characters range to UTF-16.
+
This functions does nothing more than a direct copy; it is defined only to provide the same interface as other specializations of the sf::Utf<> template, and allow generic code to be written on top of it.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toUtf32
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-16 characters range to UTF-32.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toUtf8
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-16 characters range to UTF-8.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 16 >::toWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ wchar_t
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-16 characters range to wide characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Utf< 32 > , including all inherited members.
+
+ count (In begin, In end)sf::Utf< 32 > static decode (In begin, In end, Uint32 &output, Uint32 replacement=0)sf::Utf< 32 > static decodeAnsi (In input, const std::locale &locale=std::locale())sf::Utf< 32 > static decodeWide (In input)sf::Utf< 32 > static encode (Uint32 input, Out output, Uint32 replacement=0)sf::Utf< 32 > static encodeAnsi (Uint32 codepoint, Out output, char replacement=0, const std::locale &locale=std::locale())sf::Utf< 32 > static encodeWide (Uint32 codepoint, Out output, wchar_t replacement=0)sf::Utf< 32 > static fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale())sf::Utf< 32 > static fromLatin1 (In begin, In end, Out output)sf::Utf< 32 > static fromWide (In begin, In end, Out output)sf::Utf< 32 > static next (In begin, In end)sf::Utf< 32 > static toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale())sf::Utf< 32 > static toLatin1 (In begin, In end, Out output, char replacement=0)sf::Utf< 32 > static toUtf16 (In begin, In end, Out output)sf::Utf< 32 > static toUtf32 (In begin, In end, Out output)sf::Utf< 32 > static toUtf8 (In begin, In end, Out output)sf::Utf< 32 > static toWide (In begin, In end, Out output, wchar_t replacement=0)sf::Utf< 32 > static
SFML - Simple and Fast Multimedia Library
+
+
+
Specialization of the Utf template for UTF-32.
+ More...
+
+
#include <Utf.hpp >
+
+template<typename In > static In decode (In begin, In end, Uint32 &output, Uint32 replacement=0) Decode a single UTF-32 character. More... template<typename Out > static Out encode (Uint32 input, Out output, Uint32 replacement=0) Encode a single UTF-32 character. More... template<typename In > static In next (In begin, In end) Advance to the next UTF-32 character. More... template<typename In > static std::size_t count (In begin, In end) Count the number of characters of a UTF-32 sequence. More... template<typename In , typename Out > static Out fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale()) Convert an ANSI characters range to UTF-32. More... template<typename In , typename Out > static Out fromWide (In begin, In end, Out output) Convert a wide characters range to UTF-32. More... template<typename In , typename Out > static Out fromLatin1 (In begin, In end, Out output) Convert a latin-1 (ISO-5589-1) characters range to UTF-32. More... template<typename In , typename Out > static Out toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale()) Convert an UTF-32 characters range to ANSI characters. More... template<typename In , typename Out > static Out toWide (In begin, In end, Out output, wchar_t replacement=0) Convert an UTF-32 characters range to wide characters. More... template<typename In , typename Out > static Out toLatin1 (In begin, In end, Out output, char replacement=0) Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters. More... template<typename In , typename Out > static Out toUtf8 (In begin, In end, Out output) Convert a UTF-32 characters range to UTF-8. More... template<typename In , typename Out > static Out toUtf16 (In begin, In end, Out output) Convert a UTF-32 characters range to UTF-16. More... template<typename In , typename Out > static Out toUtf32 (In begin, In end, Out output) Convert a UTF-32 characters range to UTF-32. More... template<typename In > static Uint32 decodeAnsi (In input, const std::locale &locale=std::locale()) Decode a single ANSI character to UTF-32. More... template<typename In > static Uint32 decodeWide (In input) Decode a single wide character to UTF-32. More... template<typename Out > static Out encodeAnsi (Uint32 codepoint, Out output, char replacement=0, const std::locale &locale=std::locale()) Encode a single UTF-32 character to ANSI. More... template<typename Out > static Out encodeWide (Uint32 codepoint, Out output, wchar_t replacement=0) Encode a single UTF-32 character to wide. More...
+
+
template<>
+
+
Specialization of the Utf template for UTF-32.
+
+
Definition at line 462 of file Utf.hpp .
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static std::size_t sf::Utf < 32 >::count
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Count the number of characters of a UTF-32 sequence.
+
This function is trivial for UTF-32, which can store every character in a single storage element.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 32 >::decode
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Uint32 &
+ output ,
+
+ Uint32
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Decode a single UTF-32 character.
+
Decoding a character means finding its unique 32-bits code (called the codepoint) in the Unicode standard. For UTF-32, the character value is the same as the codepoint.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Codepoint of the decoded UTF-32 character replacement Replacement character to use in case the UTF-8 sequence is invalid
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static Uint32 sf::Utf < 32 >::decodeAnsi
+ (
+ In
+ input ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Decode a single ANSI character to UTF-32.
+
This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).
+
Parameters
+
+ input Input ANSI character locale Locale to use for conversion
+
+
+
Returns Converted character
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static Uint32 sf::Utf < 32 >::decodeWide
+ (
+ In
+ input )
+
+
+
+
+static
+
+
+
+
+
Decode a single wide character to UTF-32.
+
This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).
+
Parameters
+
+ input Input wide character
+
+
+
Returns Converted character
+
+
+
+
+
◆
+
+
+
+
+template<typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::encode
+ (
+ Uint32
+ input ,
+
+ Out
+ output ,
+
+ Uint32
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Encode a single UTF-32 character.
+
Encoding a character means converting a unique 32-bits code (called the codepoint) in the target encoding, UTF-32. For UTF-32, the codepoint is the same as the character value.
+
Parameters
+
+ input Codepoint to encode as UTF-32 output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to UTF-32 (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::encodeAnsi
+ (
+ Uint32
+ codepoint ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Encode a single UTF-32 character to ANSI.
+
This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).
+
Parameters
+
+ codepoint Iterator pointing to the beginning of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement if the input character is not convertible to ANSI (use 0 to skip it) locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::encodeWide
+ (
+ Uint32
+ codepoint ,
+
+ Out
+ output ,
+
+ wchar_t
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Encode a single UTF-32 character to wide.
+
This function does not exist in other specializations of sf::Utf<>, it is defined for convenience (it is used by several other conversion functions).
+
Parameters
+
+ codepoint Iterator pointing to the beginning of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement if the input character is not convertible to wide (use 0 to skip it)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::fromAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an ANSI characters range to UTF-32.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::fromLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a latin-1 (ISO-5589-1) characters range to UTF-32.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::fromWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a wide characters range to UTF-32.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 32 >::next
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Advance to the next UTF-32 character.
+
This function is trivial for UTF-32, which can store every character in a single storage element.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-32 characters range to ANSI characters.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to ANSI (use 0 to skip them) locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-16 characters range to latin-1 (ISO-5589-1) characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toUtf16
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-32 characters range to UTF-16.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toUtf32
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-32 characters range to UTF-32.
+
This functions does nothing more than a direct copy; it is defined only to provide the same interface as other specializations of the sf::Utf<> template, and allow generic code to be written on top of it.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toUtf8
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-32 characters range to UTF-8.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 32 >::toWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ wchar_t
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-32 characters range to wide characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Utf< 8 > , including all inherited members.
+
+ count (In begin, In end)sf::Utf< 8 > static decode (In begin, In end, Uint32 &output, Uint32 replacement=0)sf::Utf< 8 > static encode (Uint32 input, Out output, Uint8 replacement=0)sf::Utf< 8 > static fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale())sf::Utf< 8 > static fromLatin1 (In begin, In end, Out output)sf::Utf< 8 > static fromWide (In begin, In end, Out output)sf::Utf< 8 > static next (In begin, In end)sf::Utf< 8 > static toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale())sf::Utf< 8 > static toLatin1 (In begin, In end, Out output, char replacement=0)sf::Utf< 8 > static toUtf16 (In begin, In end, Out output)sf::Utf< 8 > static toUtf32 (In begin, In end, Out output)sf::Utf< 8 > static toUtf8 (In begin, In end, Out output)sf::Utf< 8 > static toWide (In begin, In end, Out output, wchar_t replacement=0)sf::Utf< 8 > static
SFML - Simple and Fast Multimedia Library
+
+
+
Specialization of the Utf template for UTF-8.
+ More...
+
+
#include <Utf.hpp >
+
+template<typename In > static In decode (In begin, In end, Uint32 &output, Uint32 replacement=0) Decode a single UTF-8 character. More... template<typename Out > static Out encode (Uint32 input, Out output, Uint8 replacement=0) Encode a single UTF-8 character. More... template<typename In > static In next (In begin, In end) Advance to the next UTF-8 character. More... template<typename In > static std::size_t count (In begin, In end) Count the number of characters of a UTF-8 sequence. More... template<typename In , typename Out > static Out fromAnsi (In begin, In end, Out output, const std::locale &locale=std::locale()) Convert an ANSI characters range to UTF-8. More... template<typename In , typename Out > static Out fromWide (In begin, In end, Out output) Convert a wide characters range to UTF-8. More... template<typename In , typename Out > static Out fromLatin1 (In begin, In end, Out output) Convert a latin-1 (ISO-5589-1) characters range to UTF-8. More... template<typename In , typename Out > static Out toAnsi (In begin, In end, Out output, char replacement=0, const std::locale &locale=std::locale()) Convert an UTF-8 characters range to ANSI characters. More... template<typename In , typename Out > static Out toWide (In begin, In end, Out output, wchar_t replacement=0) Convert an UTF-8 characters range to wide characters. More... template<typename In , typename Out > static Out toLatin1 (In begin, In end, Out output, char replacement=0) Convert an UTF-8 characters range to latin-1 (ISO-5589-1) characters. More... template<typename In , typename Out > static Out toUtf8 (In begin, In end, Out output) Convert a UTF-8 characters range to UTF-8. More... template<typename In , typename Out > static Out toUtf16 (In begin, In end, Out output) Convert a UTF-8 characters range to UTF-16. More... template<typename In , typename Out > static Out toUtf32 (In begin, In end, Out output) Convert a UTF-8 characters range to UTF-32. More...
+
+
template<>
+
+
Specialization of the Utf template for UTF-8.
+
+
Definition at line 48 of file Utf.hpp .
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static std::size_t sf::Utf < 8 >::count
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Count the number of characters of a UTF-8 sequence.
+
This function is necessary for multi-elements encodings, as a single character may use more than 1 storage element, thus the total size can be different from (begin - end).
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 8 >::decode
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Uint32 &
+ output ,
+
+ Uint32
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Decode a single UTF-8 character.
+
Decoding a character means finding its unique 32-bits code (called the codepoint) in the Unicode standard.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Codepoint of the decoded UTF-8 character replacement Replacement character to use in case the UTF-8 sequence is invalid
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::encode
+ (
+ Uint32
+ input ,
+
+ Out
+ output ,
+
+ Uint8
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Encode a single UTF-8 character.
+
Encoding a character means converting a unique 32-bits code (called the codepoint) in the target encoding, UTF-8.
+
Parameters
+
+ input Codepoint to encode as UTF-8 output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to UTF-8 (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::fromAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an ANSI characters range to UTF-8.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::fromLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a latin-1 (ISO-5589-1) characters range to UTF-8.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::fromWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a wide characters range to UTF-8.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In >
+
+
+
+
+
+ static In sf::Utf < 8 >::next
+ (
+ In
+ begin ,
+
+ In
+ end
+
+ )
+
+
+
+
+static
+
+
+
+
+
Advance to the next UTF-8 character.
+
This function is necessary for multi-elements encodings, as a single character may use more than 1 storage element.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence
+
+
+
Returns Iterator pointing to one past the last read element of the input sequence
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toAnsi
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0,
+
+ const std::locale &
+ locale = std::locale()
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-8 characters range to ANSI characters.
+
The current global locale will be used by default, unless you pass a custom one in the locale parameter.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to ANSI (use 0 to skip them) locale Locale to use for conversion
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toLatin1
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ char
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-8 characters range to latin-1 (ISO-5589-1) characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toUtf16
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-8 characters range to UTF-16.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toUtf32
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-8 characters range to UTF-32.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toUtf8
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert a UTF-8 characters range to UTF-8.
+
This functions does nothing more than a direct copy; it is defined only to provide the same interface as other specializations of the sf::Utf<> template, and allow generic code to be written on top of it.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
+
◆
+
+
+
+
+template<typename In , typename Out >
+
+
+
+
+
+ static Out sf::Utf < 8 >::toWide
+ (
+ In
+ begin ,
+
+ In
+ end ,
+
+ Out
+ output ,
+
+ wchar_t
+ replacement = 0
+
+ )
+
+
+
+
+static
+
+
+
+
+
Convert an UTF-8 characters range to wide characters.
+
Parameters
+
+ begin Iterator pointing to the beginning of the input sequence end Iterator pointing to the end of the input sequence output Iterator pointing to the beginning of the output sequence replacement Replacement for characters not convertible to wide (use 0 to skip them)
+
+
+
Returns Iterator to the end of the output sequence which has been written
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Vector2< T > , including all inherited members.
+
+ operator!= (const Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related operator* (const Vector2< T > &left, T right)sf::Vector2< T > related operator* (T left, const Vector2< T > &right)sf::Vector2< T > related operator*= (Vector2< T > &left, T right)sf::Vector2< T > related operator+ (const Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related operator+= (Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related operator- (const Vector2< T > &right)sf::Vector2< T > related operator- (const Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related operator-= (Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related operator/ (const Vector2< T > &left, T right)sf::Vector2< T > related operator/= (Vector2< T > &left, T right)sf::Vector2< T > related operator== (const Vector2< T > &left, const Vector2< T > &right)sf::Vector2< T > related Vector2 ()sf::Vector2< T > Vector2 (T X, T Y)sf::Vector2< T > Vector2 (const Vector2< U > &vector)sf::Vector2< T > explicit x sf::Vector2< T > y sf::Vector2< T >
SFML - Simple and Fast Multimedia Library
+
+
+
Utility template class for manipulating 2-dimensional vectors.
+ More...
+
+
#include <Vector2.hpp >
+
+ Vector2 () Default constructor. More... Vector2 (T X, T Y) Construct the vector from its coordinates. More... template<typename U > Vector2 (const Vector2 < U > &vector) Construct the vector from another type of vector. More...
+T x X coordinate of the vector. More... T y Y coordinate of the vector. More...
+(Note that these are not member functions.)
+template<typename T > Vector2 < T > operator- (const Vector2 < T > &right) Overload of unary operator -. More... template<typename T > Vector2 < T > & operator+= (Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator +=. More... template<typename T > Vector2 < T > & operator-= (Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator -=. More... template<typename T > Vector2 < T > operator+ (const Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator +. More... template<typename T > Vector2 < T > operator- (const Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator -. More... template<typename T > Vector2 < T > operator* (const Vector2 < T > &left, T right) Overload of binary operator *. More... template<typename T > Vector2 < T > operator* (T left, const Vector2 < T > &right) Overload of binary operator *. More... template<typename T > Vector2 < T > & operator*= (Vector2 < T > &left, T right) Overload of binary operator *=. More... template<typename T > Vector2 < T > operator/ (const Vector2 < T > &left, T right) Overload of binary operator /. More... template<typename T > Vector2 < T > & operator/= (Vector2 < T > &left, T right) Overload of binary operator /=. More... template<typename T > bool operator== (const Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator ==. More... template<typename T > bool operator!= (const Vector2 < T > &left, const Vector2 < T > &right) Overload of binary operator !=. More...
+
+
template<typename T>
+
+
Utility template class for manipulating 2-dimensional vectors.
+
sf::Vector2 is a simple class that defines a mathematical vector with two coordinates (x and y).
+
It can be used to represent anything that has two dimensions: a size, a point, a velocity, etc.
+
The template parameter T is the type of the coordinates. It can be any type that supports arithmetic operations (+, -, /, *) and comparisons (==, !=), for example int or float.
+
You generally don't have to care about the templated form (sf::Vector2<T>), the most common specializations have special typedefs:
+sf::Vector2<float> is sf::Vector2f
+sf::Vector2<int> is sf::Vector2i
+sf::Vector2<unsigned int> is sf::Vector2u
+
+
The sf::Vector2 class has a small and simple interface, its x and y members can be accessed directly (there are no accessors like setX(), getX()) and it contains no mathematical function like dot product, cross product, length, etc.
+
Usage example:
v1.x = 18.2f;
v3 = v1 + v2;
bool different = (v2 != v3);
Note: for 3-dimensional vectors, see sf::Vector3 .
+
+
Definition at line 37 of file Vector2.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+template<typename T>
+
+
+
+
Default constructor.
+
Creates a Vector2(0, 0).
+
+
+
+
+
◆ [2/3]
+
+
+
+
+template<typename T>
+
+
+
+
Construct the vector from its coordinates.
+
Parameters
+
+ X X coordinate Y Y coordinate
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+template<typename T>
+
+template<typename U >
+
+
+
+
Construct the vector from another type of vector.
+
This constructor doesn't replace the copy constructor, it's called only when U != T. A call to this constructor will fail to compile if U is not convertible to T.
+
Parameters
+
+ vector Vector to convert
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator!=
+ (
+ const Vector2 < T > &
+ left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator !=.
+
This operator compares strict difference between two vectors.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns True if left is not equal to right
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > operator* (
+ const Vector2 < T > &
+ left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Memberwise multiplication by right
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > operator* (
+ T
+ left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *.
+
Parameters
+
+ left Left operand (a scalar value) right Right operand (a vector)
+
+
+
Returns Memberwise multiplication by left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > & operator*= (
+ Vector2 < T > & left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *=.
+
This operator performs a memberwise multiplication by right , and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > operator+ (
+ const Vector2 < T > &
+ left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator +.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Memberwise addition of both vectors
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > & operator+= (
+ Vector2 < T > & left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator +=.
+
This operator performs a memberwise addition of both vectors, and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Reference to left
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
Overload of unary operator -.
+
Parameters
+
+ right Vector to negate
+
+
+
Returns Memberwise opposite of the vector
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > operator- (
+ const Vector2 < T > &
+ left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator -.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Memberwise subtraction of both vectors
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > & operator-= (
+ Vector2 < T > & left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator -=.
+
This operator performs a memberwise subtraction of both vectors, and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > operator/ (
+ const Vector2 < T > &
+ left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator /.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Memberwise division by right
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector2 < T > & operator/= (
+ Vector2 < T > & left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator /=.
+
This operator performs a memberwise division by right , and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator==
+ (
+ const Vector2 < T > &
+ left ,
+
+ const Vector2 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator ==.
+
This operator compares strict equality between two vectors.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns True if left is equal to right
+
+
+
+
+
+
+
+
+
+
+template<typename T>
+
+
+
+
X coordinate of the vector.
+
+
Definition at line 75 of file Vector2.hpp .
+
+
+
+
+
+
+
+
+
+template<typename T>
+
+
+
+
Y coordinate of the vector.
+
+
Definition at line 76 of file Vector2.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Vector3< T > , including all inherited members.
+
+ operator!= (const Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related operator* (const Vector3< T > &left, T right)sf::Vector3< T > related operator* (T left, const Vector3< T > &right)sf::Vector3< T > related operator*= (Vector3< T > &left, T right)sf::Vector3< T > related operator+ (const Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related operator+= (Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related operator- (const Vector3< T > &left)sf::Vector3< T > related operator- (const Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related operator-= (Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related operator/ (const Vector3< T > &left, T right)sf::Vector3< T > related operator/= (Vector3< T > &left, T right)sf::Vector3< T > related operator== (const Vector3< T > &left, const Vector3< T > &right)sf::Vector3< T > related Vector3 ()sf::Vector3< T > Vector3 (T X, T Y, T Z)sf::Vector3< T > Vector3 (const Vector3< U > &vector)sf::Vector3< T > explicit x sf::Vector3< T > y sf::Vector3< T > z sf::Vector3< T >
SFML - Simple and Fast Multimedia Library
+
+
+
Utility template class for manipulating 3-dimensional vectors.
+ More...
+
+
#include <Vector3.hpp >
+
+ Vector3 () Default constructor. More... Vector3 (T X, T Y, T Z) Construct the vector from its coordinates. More... template<typename U > Vector3 (const Vector3 < U > &vector) Construct the vector from another type of vector. More...
+T x X coordinate of the vector. More... T y Y coordinate of the vector. More... T z Z coordinate of the vector. More...
+(Note that these are not member functions.)
+template<typename T > Vector3 < T > operator- (const Vector3 < T > &left) Overload of unary operator -. More... template<typename T > Vector3 < T > & operator+= (Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator +=. More... template<typename T > Vector3 < T > & operator-= (Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator -=. More... template<typename T > Vector3 < T > operator+ (const Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator +. More... template<typename T > Vector3 < T > operator- (const Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator -. More... template<typename T > Vector3 < T > operator* (const Vector3 < T > &left, T right) Overload of binary operator *. More... template<typename T > Vector3 < T > operator* (T left, const Vector3 < T > &right) Overload of binary operator *. More... template<typename T > Vector3 < T > & operator*= (Vector3 < T > &left, T right) Overload of binary operator *=. More... template<typename T > Vector3 < T > operator/ (const Vector3 < T > &left, T right) Overload of binary operator /. More... template<typename T > Vector3 < T > & operator/= (Vector3 < T > &left, T right) Overload of binary operator /=. More... template<typename T > bool operator== (const Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator ==. More... template<typename T > bool operator!= (const Vector3 < T > &left, const Vector3 < T > &right) Overload of binary operator !=. More...
+
+
template<typename T>
+
+
Utility template class for manipulating 3-dimensional vectors.
+
sf::Vector3 is a simple class that defines a mathematical vector with three coordinates (x, y and z).
+
It can be used to represent anything that has three dimensions: a size, a point, a velocity, etc.
+
The template parameter T is the type of the coordinates. It can be any type that supports arithmetic operations (+, -, /, *) and comparisons (==, !=), for example int or float.
+
You generally don't have to care about the templated form (sf::Vector3<T>), the most common specializations have special typedefs:
+sf::Vector3<float> is sf::Vector3f
+sf::Vector3<int> is sf::Vector3i
+
+
The sf::Vector3 class has a small and simple interface, its x and y members can be accessed directly (there are no accessors like setX(), getX()) and it contains no mathematical function like dot product, cross product, length, etc.
+
Usage example:
v1.x = 18.2f;
v3 = v1 + v2;
bool different = (v2 != v3);
Note: for 2-dimensional vectors, see sf::Vector2 .
+
+
Definition at line 37 of file Vector3.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+template<typename T>
+
+
+
+
Default constructor.
+
Creates a Vector3(0, 0, 0).
+
+
+
+
+
◆ [2/3]
+
+
+
+
+template<typename T>
+
+
+ sf::Vector3 < T >::Vector3 (
+ T
+ X ,
+
+ T
+ Y ,
+
+ T
+ Z
+
+ )
+
+
+
+
+
Construct the vector from its coordinates.
+
Parameters
+
+ X X coordinate Y Y coordinate Z Z coordinate
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+template<typename T>
+
+template<typename U >
+
+
+
+
Construct the vector from another type of vector.
+
This constructor doesn't replace the copy constructor, it's called only when U != T. A call to this constructor will fail to compile if U is not convertible to T.
+
Parameters
+
+ vector Vector to convert
+
+
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator!=
+ (
+ const Vector3 < T > &
+ left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator !=.
+
This operator compares strict difference between two vectors.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns True if left is not equal to right
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > operator* (
+ const Vector3 < T > &
+ left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Memberwise multiplication by right
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > operator* (
+ T
+ left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *.
+
Parameters
+
+ left Left operand (a scalar value) right Right operand (a vector)
+
+
+
Returns Memberwise multiplication by left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > & operator*= (
+ Vector3 < T > & left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator *=.
+
This operator performs a memberwise multiplication by right , and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > operator+ (
+ const Vector3 < T > &
+ left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator +.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Memberwise addition of both vectors
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > & operator+= (
+ Vector3 < T > & left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator +=.
+
This operator performs a memberwise addition of both vectors, and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Reference to left
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T >
+
+
+
+
Overload of unary operator -.
+
Parameters
+
+
+
+
Returns Memberwise opposite of the vector
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > operator- (
+ const Vector3 < T > &
+ left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator -.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Memberwise subtraction of both vectors
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > & operator-= (
+ Vector3 < T > & left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator -=.
+
This operator performs a memberwise subtraction of both vectors, and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > operator/ (
+ const Vector3 < T > &
+ left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator /.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Memberwise division by right
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ Vector3 < T > & operator/= (
+ Vector3 < T > & left ,
+
+ T
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator /=.
+
This operator performs a memberwise division by right , and assigns the result to left .
+
Parameters
+
+ left Left operand (a vector) right Right operand (a scalar value)
+
+
+
Returns Reference to left
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+
+
+
+ bool operator==
+ (
+ const Vector3 < T > &
+ left ,
+
+ const Vector3 < T > &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of binary operator ==.
+
This operator compares strict equality between two vectors.
+
Parameters
+
+ left Left operand (a vector) right Right operand (a vector)
+
+
+
Returns True if left is equal to right
+
+
+
+
+
+
+
+
+
+
+template<typename T>
+
+
+
+
X coordinate of the vector.
+
+
Definition at line 76 of file Vector3.hpp .
+
+
+
+
+
+
+
+
+
+template<typename T>
+
+
+
+
Y coordinate of the vector.
+
+
Definition at line 77 of file Vector3.hpp .
+
+
+
+
+
+
+
+
+
+template<typename T>
+
+
+
+
Z coordinate of the vector.
+
+
Definition at line 78 of file Vector3.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Vertex , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define a point with color and texture coordinates.
+ More...
+
+
#include <Vertex.hpp >
+
+
+
Define a point with color and texture coordinates.
+
A vertex is an improved point.
+
It has a position and other extra attributes that will be used for drawing: in SFML, vertices also have a color and a pair of texture coordinates.
+
The vertex is the building block of drawing. Everything which is visible on screen is made of vertices. They are grouped as 2D primitives (triangles, quads, ...), and these primitives are grouped to create even more complex 2D entities such as sprites, texts, etc.
+
If you use the graphical entities of SFML (sprite, text, shape) you won't have to deal with vertices directly. But if you want to define your own 2D entities, such as tiled maps or particle systems, using vertices will allow you to get maximum performances.
+
Example:
Note: although texture coordinates are supposed to be an integer amount of pixels, their type is float because of some buggy graphics drivers that are not able to process integer coordinates correctly.
+
See also sf::VertexArray
+
+
Definition at line 42 of file Vertex.hpp .
+
+
+
◆ [1/5]
+
+
+
+
+
+ sf::Vertex::Vertex
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ sf::Vertex::Vertex
+ (
+ const Vector2f &
+ thePosition )
+
+
+
+
+
Construct the vertex from its position.
+
The vertex color is white and texture coordinates are (0, 0).
+
Parameters
+
+ thePosition Vertex position
+
+
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ sf::Vertex::Vertex
+ (
+ const Vector2f &
+ thePosition ,
+
+ const Color &
+ theColor
+
+ )
+
+
+
+
+
Construct the vertex from its position and color.
+
The texture coordinates are (0, 0).
+
Parameters
+
+
+
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ sf::Vertex::Vertex
+ (
+ const Vector2f &
+ thePosition ,
+
+ const Vector2f &
+ theTexCoords
+
+ )
+
+
+
+
+
Construct the vertex from its position and texture coordinates.
+
The vertex color is white.
+
Parameters
+
+ thePosition Vertex position theTexCoords Vertex texture coordinates
+
+
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ sf::Vertex::Vertex
+ (
+ const Vector2f &
+ thePosition ,
+
+ const Color &
+ theColor ,
+
+ const Vector2f &
+ theTexCoords
+
+ )
+
+
+
+
+
Construct the vertex from its position, color and texture coordinates.
+
Parameters
+
+ thePosition Vertex position theColor Vertex color theTexCoords Vertex texture coordinates
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ Color sf::Vertex::color
+
+
+
+
+
◆
+
+
+
+
+
2D position of the vertex
+
+
Definition at line 97 of file Vertex.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Coordinates of the texture's pixel to map to the vertex.
+
+
Definition at line 99 of file Vertex.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::VertexArray , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Define a set of one or more 2D primitives.
+ More...
+
+
#include <VertexArray.hpp >
+
+
+
+
+
+
+
+
+
+
Define a set of one or more 2D primitives.
+
sf::VertexArray is a very simple wrapper around a dynamic array of vertices and a primitives type.
+
It inherits sf::Drawable , but unlike other drawables it is not transformable.
+
Example:
See also sf::Vertex
+
+
Definition at line 45 of file VertexArray.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::VertexArray::VertexArray
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty vertex array.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ sf::VertexArray::VertexArray
+ (
+ PrimitiveType type ,
+
+ std::size_t
+ vertexCount = 0
+
+ )
+
+
+
+
+explicit
+
+
+
+
+
Construct the vertex array with a type and an initial number of vertices.
+
Parameters
+
+ type Type of primitives vertexCount Initial number of vertices in the array
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexArray::append
+ (
+ const Vertex &
+ vertex )
+
+
+
+
+
Add a vertex to the array.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexArray::clear
+ (
+ )
+
+
+
+
+
Clear the vertex array.
+
This function removes all the vertices from the array. It doesn't deallocate the corresponding memory, so that adding new vertices after clearing doesn't involve reallocating all the memory.
+
+
+
+
+
◆
+
+
+
+
+
+ FloatRect sf::VertexArray::getBounds (
+ )
+ const
+
+
+
+
+
Compute the bounding rectangle of the vertex array.
+
This function returns the minimal axis-aligned rectangle that contains all the vertices of the array.
+
Returns Bounding rectangle of the vertex array
+
+
+
+
+
◆
+
+
+
+
+
+ PrimitiveType sf::VertexArray::getPrimitiveType (
+ )
+ const
+
+
+
+
+
Get the type of primitives drawn by the vertex array.
+
Returns Primitive type
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::VertexArray::getVertexCount
+ (
+ )
+ const
+
+
+
+
+
Return the vertex count.
+
Returns Number of vertices in the array
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ Vertex & sf::VertexArray::operator[] (
+ std::size_t
+ index )
+
+
+
+
+
Get a read-write access to a vertex by its index.
+
This function doesn't check index , it must be in range [0, getVertexCount() - 1]. The behavior is undefined otherwise.
+
Parameters
+
+ index Index of the vertex to get
+
+
+
Returns Reference to the index-th vertex
+
See also getVertexCount
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const Vertex & sf::VertexArray::operator[]
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Get a read-only access to a vertex by its index.
+
This function doesn't check index , it must be in range [0, getVertexCount() - 1]. The behavior is undefined otherwise.
+
Parameters
+
+ index Index of the vertex to get
+
+
+
Returns Const reference to the index-th vertex
+
See also getVertexCount
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexArray::resize
+ (
+ std::size_t
+ vertexCount )
+
+
+
+
+
Resize the vertex array.
+
If vertexCount is greater than the current size, the previous vertices are kept and new (default-constructed) vertices are added. If vertexCount is less than the current size, existing vertices are removed from the array.
+
Parameters
+
+ vertexCount New size of the array (number of vertices)
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexArray::setPrimitiveType
+ (
+ PrimitiveType type )
+
+
+
+
+
Set the type of primitives to draw.
+
This function defines how the vertices must be interpreted when it's time to draw them:
+As points
+As lines
+As triangles
+As quads The default primitive type is sf::Points.
+
+
Parameters
+
+ type Type of primitive
+
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::VertexBuffer , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Vertex buffer storage for one or more 2D primitives.
+ More...
+
+
#include <VertexBuffer.hpp >
+
+
+
+
+
+
+
+
+
+
Vertex buffer storage for one or more 2D primitives.
+
sf::VertexBuffer is a simple wrapper around a dynamic buffer of vertices and a primitives type.
+
Unlike sf::VertexArray , the vertex data is stored in graphics memory.
+
In situations where a large amount of vertex data would have to be transferred from system memory to graphics memory every frame, using sf::VertexBuffer can help. By using a sf::VertexBuffer , data that has not been changed between frames does not have to be re-transferred from system to graphics memory as would be the case with sf::VertexArray . If data transfer is a bottleneck, this can lead to performance gains.
+
Using sf::VertexBuffer , the user also has the ability to only modify a portion of the buffer in graphics memory. This way, a large buffer can be allocated at the start of the application and only the applicable portions of it need to be updated during the course of the application. This allows the user to take full control of data transfers between system and graphics memory if they need to.
+
In special cases, the user can make use of multiple threads to update vertex data in multiple distinct regions of the buffer simultaneously. This might make sense when e.g. the position of multiple objects has to be recalculated very frequently. The computation load can be spread across multiple threads as long as there are no other data dependencies.
+
Simultaneous updates to the vertex buffer are not guaranteed to be carried out by the driver in any specific order. Updating the same region of the buffer from multiple threads will not cause undefined behaviour, however the final state of the buffer will be unpredictable.
+
Simultaneous updates of distinct non-overlapping regions of the buffer are also not guaranteed to complete in a specific order. However, in this case the user can make sure to synchronize the writer threads at well-defined points in their code. The driver will make sure that all pending data transfers complete before the vertex buffer is sourced by the rendering pipeline.
+
It inherits sf::Drawable , but unlike other drawables it is not transformable.
+
Example:
...
triangles.create(15);
triangles.update(vertices);
...
window.draw(triangles);
See also sf::Vertex , sf::VertexArray
+
+
Definition at line 46 of file VertexBuffer.hpp .
+
+
+
◆
+
+
+
+
+
Usage specifiers.
+
If data is going to be updated once or more every frame, set the usage to Stream. If data is going to be set once and used for a long time without being modified, set the usage to Static. For everything else Dynamic should be a good compromise.
+
+Enumerator Constantly changing data.
+Occasionally changing data.
+Rarely changing data.
+
+
+
Definition at line 60 of file VertexBuffer.hpp .
+
+
+
+
+
+
◆ [1/5]
+
+
+
+
+
+ sf::VertexBuffer::VertexBuffer
+ (
+ )
+
+
+
+
+
Default constructor.
+
Creates an empty vertex buffer.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+
+
+
+ sf::VertexBuffer::VertexBuffer
+ (
+ PrimitiveType type )
+
+
+
+
+explicit
+
+
+
+
+
Construct a VertexBuffer with a specific PrimitiveType.
+
Creates an empty vertex buffer and sets its primitive type to type.
+
Parameters
+
+ type Type of primitive
+
+
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+
+
+
+ sf::VertexBuffer::VertexBuffer
+ (
+ Usage usage )
+
+
+
+
+explicit
+
+
+
+
+
Construct a VertexBuffer with a specific usage specifier.
+
Creates an empty vertex buffer and sets its usage to usage.
+
Parameters
+
+
+
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ sf::VertexBuffer::VertexBuffer
+ (
+ PrimitiveType type ,
+
+ Usage usage
+
+ )
+
+
+
+
+
Construct a VertexBuffer with a specific PrimitiveType and usage specifier.
+
Creates an empty vertex buffer and sets its primitive type to type and usage to usage.
+
Parameters
+
+ type Type of primitive usage Usage specifier
+
+
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ sf::VertexBuffer::VertexBuffer
+ (
+ const VertexBuffer &
+ copy )
+
+
+
+
+
Copy constructor.
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ sf::VertexBuffer::~VertexBuffer
+ (
+ )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static void sf::VertexBuffer::bind
+ (
+ const VertexBuffer *
+ vertexBuffer )
+
+
+
+
+static
+
+
+
+
+
Bind a vertex buffer for rendering.
+
This function is not part of the graphics API, it mustn't be used when drawing SFML entities. It must be used only if you mix sf::VertexBuffer with OpenGL code.
+
...
sf::VertexBuffer::bind(&vb1);
Parameters
+
+ vertexBuffer Pointer to the vertex buffer to bind, can be null to use no vertex buffer
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::VertexBuffer::create
+ (
+ std::size_t
+ vertexCount )
+
+
+
+
+
Create the vertex buffer.
+
Creates the vertex buffer and allocates enough graphics memory to hold vertexCount vertices. Any previously allocated memory is freed in the process.
+
In order to deallocate previously allocated memory pass 0 as vertexCount. Don't forget to recreate with a non-zero value when graphics memory should be allocated again.
+
Parameters
+
+ vertexCount Number of vertices worth of memory to allocate
+
+
+
Returns True if creation was successful
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::VertexBuffer::getNativeHandle
+ (
+ )
+ const
+
+
+
+
+
Get the underlying OpenGL handle of the vertex buffer.
+
You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.
+
Returns OpenGL handle of the vertex buffer or 0 if not yet created
+
+
+
+
+
◆
+
+
+
+
+
+ PrimitiveType sf::VertexBuffer::getPrimitiveType (
+ )
+ const
+
+
+
+
+
Get the type of primitives drawn by the vertex buffer.
+
Returns Primitive type
+
+
+
+
+
◆
+
+
+
+
+
+ Usage sf::VertexBuffer::getUsage (
+ )
+ const
+
+
+
+
+
Get the usage specifier of this vertex buffer.
+
Returns Usage specifier
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::VertexBuffer::getVertexCount
+ (
+ )
+ const
+
+
+
+
+
Return the vertex count.
+
Returns Number of vertices in the vertex buffer
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool sf::VertexBuffer::isAvailable
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Tell whether or not the system supports vertex buffers.
+
This function should always be called before using the vertex buffer features. If it returns false, then any attempt to use sf::VertexBuffer will fail.
+
Returns True if vertex buffers are supported, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
Overload of assignment operator.
+
Parameters
+
+ right Instance to assign
+
+
+
Returns Reference to self
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexBuffer::setPrimitiveType
+ (
+ PrimitiveType type )
+
+
+
+
+
Set the type of primitives to draw.
+
This function defines how the vertices must be interpreted when it's time to draw them.
+
The default primitive type is sf::Points.
+
Parameters
+
+ type Type of primitive
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexBuffer::setUsage
+ (
+ Usage usage )
+
+
+
+
+
Set the usage specifier of this vertex buffer.
+
This function provides a hint about how this vertex buffer is going to be used in terms of data update frequency.
+
After changing the usage specifier, the vertex buffer has to be updated with new data for the usage specifier to take effect.
+
The default primitive type is sf::VertexBuffer::Stream .
+
Parameters
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::VertexBuffer::swap
+ (
+ VertexBuffer & right )
+
+
+
+
+
Swap the contents of this vertex buffer with those of another.
+
Parameters
+
+ right Instance to swap with
+
+
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool sf::VertexBuffer::update
+ (
+ const Vertex *
+ vertices )
+
+
+
+
+
Update the whole buffer from an array of vertices.
+
The vertex array is assumed to have the same size as the created buffer.
+
No additional check is performed on the size of the vertex array, passing invalid arguments will lead to undefined behavior.
+
This function does nothing if vertices is null or if the buffer was not previously created.
+
Parameters
+
+ vertices Array of vertices to copy to the buffer
+
+
+
Returns True if the update was successful
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool sf::VertexBuffer::update
+ (
+ const Vertex *
+ vertices ,
+
+ std::size_t
+ vertexCount ,
+
+ unsigned int
+ offset
+
+ )
+
+
+
+
+
Update a part of the buffer from an array of vertices.
+
offset is specified as the number of vertices to skip from the beginning of the buffer.
+
If offset is 0 and vertexCount is equal to the size of the currently created buffer, its whole contents are replaced.
+
If offset is 0 and vertexCount is greater than the size of the currently created buffer, a new buffer is created containing the vertex data.
+
If offset is 0 and vertexCount is less than the size of the currently created buffer, only the corresponding region is updated.
+
If offset is not 0 and offset + vertexCount is greater than the size of the currently created buffer, the update fails.
+
No additional check is performed on the size of the vertex array, passing invalid arguments will lead to undefined behavior.
+
Parameters
+
+ vertices Array of vertices to copy to the buffer vertexCount Number of vertices to copy offset Offset in the buffer to copy to
+
+
+
Returns True if the update was successful
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool sf::VertexBuffer::update
+ (
+ const VertexBuffer &
+ vertexBuffer )
+
+
+
+
+
Copy the contents of another buffer into this buffer.
+
Parameters
+
+ vertexBuffer Vertex buffer whose contents to copy into this vertex buffer
+
+
+
Returns True if the copy was successful
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::VideoMode , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
VideoMode defines a video mode (width, height, bpp)
+ More...
+
+
#include <VideoMode.hpp >
+
+ VideoMode () Default constructor. More... VideoMode (unsigned int modeWidth, unsigned int modeHeight, unsigned int modeBitsPerPixel=32) Construct the video mode with its attributes. More... bool isValid () const Tell whether or not the video mode is valid. More...
+
+
VideoMode defines a video mode (width, height, bpp)
+
A video mode is defined by a width and a height (in pixels) and a depth (in bits per pixel).
+
Video modes are used to setup windows (sf::Window ) at creation time.
+
The main usage of video modes is for fullscreen mode: indeed you must use one of the valid video modes allowed by the OS (which are defined by what the monitor and the graphics card support), otherwise your window creation will just fail.
+
sf::VideoMode provides a static function for retrieving the list of all the video modes supported by the system: getFullscreenModes() .
+
A custom video mode can also be checked directly for fullscreen compatibility with its isValid() function.
+
Additionally, sf::VideoMode provides a static function to get the mode currently used by the desktop: getDesktopMode() . This allows to build windows with the same size or pixel depth as the current resolution.
+
Usage example:
for (std::size_t i = 0; i < modes.size(); ++i)
{
std::cout << "Mode #" << i << ": "
}
+
Definition at line 41 of file VideoMode.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+
+ sf::VideoMode::VideoMode
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructors initializes all members to 0.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ sf::VideoMode::VideoMode
+ (
+ unsigned int
+ modeWidth ,
+
+ unsigned int
+ modeHeight ,
+
+ unsigned int
+ modeBitsPerPixel = 32
+
+ )
+
+
+
+
+
Construct the video mode with its attributes.
+
Parameters
+
+ modeWidth Width in pixels modeHeight Height in pixels modeBitsPerPixel Pixel depths in bits per pixel
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static VideoMode sf::VideoMode::getDesktopMode
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Get the current desktop video mode.
+
Returns Current desktop video mode
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const std::vector<VideoMode >& sf::VideoMode::getFullscreenModes
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Retrieve all the video modes supported in fullscreen mode.
+
When creating a fullscreen window, the video mode is restricted to be compatible with what the graphics driver and monitor support. This function returns the complete list of all video modes that can be used in fullscreen mode. The returned array is sorted from best to worst, so that the first element will always give the best mode (higher width, height and bits-per-pixel).
+
Returns Array containing all the supported fullscreen modes
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::VideoMode::isValid
+ (
+ )
+ const
+
+
+
+
+
Tell whether or not the video mode is valid.
+
The validity of video modes is only relevant when using fullscreen windows; otherwise any video mode can be used with no restriction.
+
Returns True if the video mode is valid for fullscreen mode
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of != operator to compare two video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if modes are different
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of < operator to compare video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if left is lesser than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator<=
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of <= operator to compare video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if left is lesser or equal than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of == operator to compare two video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if modes are equal
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of > operator to compare video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if left is greater than right
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator>=
+ (
+ const VideoMode &
+ left ,
+
+ const VideoMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of >= operator to compare video modes.
+
Parameters
+
+ left Left operand (a video mode) right Right operand (a video mode)
+
+
+
Returns True if left is greater or equal than right
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::VideoMode::bitsPerPixel
+
+
+
+
+
Video mode pixel depth, in bits per pixels.
+
+
Definition at line 104 of file VideoMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::VideoMode::height
+
+
+
+
+
Video mode height, in pixels.
+
+
Definition at line 103 of file VideoMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::VideoMode::width
+
+
+
+
+
Video mode width, in pixels.
+
+
Definition at line 102 of file VideoMode.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::View , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
2D camera that defines what region is shown on screen
+ More...
+
+
#include <View.hpp >
+
+
+
2D camera that defines what region is shown on screen
+
sf::View defines a camera in the 2D scene.
+
This is a very powerful concept: you can scroll, rotate or zoom the entire scene without altering the way that your drawable objects are drawn.
+
A view is composed of a source rectangle, which defines what part of the 2D scene is shown, and a target viewport, which defines where the contents of the source rectangle will be displayed on the render target (window or texture).
+
The viewport allows to map the scene to a custom part of the render target, and can be used for split-screen or for displaying a minimap, for example. If the source rectangle doesn't have the same size as the viewport, its contents will be stretched to fit in.
+
To apply a view, you have to assign it to the render target. Then, objects drawn in this render target will be affected by the view until you use another view.
+
Usage example:
See also the note on coordinates and undistorted rendering in sf::Transformable .
+
See also sf::RenderWindow , sf::RenderTexture
+
+
Definition at line 43 of file View.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::View::View
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor creates a default view of (0, 0, 1000, 1000)
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ sf::View::View
+ (
+ const FloatRect &
+ rectangle )
+
+
+
+
+explicit
+
+
+
+
+
Construct the view from a rectangle.
+
Parameters
+
+ rectangle Rectangle defining the zone to display
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ sf::View::View
+ (
+ const Vector2f &
+ center ,
+
+ const Vector2f &
+ size
+
+ )
+
+
+
+
+
Construct the view from its center and size.
+
Parameters
+
+ center Center of the zone to display size Size of zone to display
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::View::getCenter
+ (
+ )
+ const
+
+
+
+
+
Get the center of the view.
+
Returns Center of the view
+
See also getSize , setCenter
+
+
+
+
+
◆
+
+
+
+
+
+ const Transform & sf::View::getInverseTransform
+ (
+ )
+ const
+
+
+
+
+
Get the inverse projection transform of the view.
+
This function is meant for internal use only.
+
Returns Inverse of the projection transform defining the view
+
See also getTransform
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::View::getRotation
+ (
+ )
+ const
+
+
+
+
+
Get the current orientation of the view.
+
Returns Rotation angle of the view, in degrees
+
See also setRotation
+
+
+
+
+
◆
+
+
+
+
+
+ const Vector2f & sf::View::getSize
+ (
+ )
+ const
+
+
+
+
+
Get the size of the view.
+
Returns Size of the view
+
See also getCenter , setSize
+
+
+
+
+
◆
+
+
+
+
+
+ const Transform & sf::View::getTransform
+ (
+ )
+ const
+
+
+
+
+
Get the projection transform of the view.
+
This function is meant for internal use only.
+
Returns Projection transform defining the view
+
See also getInverseTransform
+
+
+
+
+
◆
+
+
+
+
+
+ const FloatRect & sf::View::getViewport
+ (
+ )
+ const
+
+
+
+
+
Get the target viewport rectangle of the view.
+
Returns Viewport rectangle, expressed as a factor of the target size
+
See also setViewport
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::View::move
+ (
+ float
+ offsetX ,
+
+ float
+ offsetY
+
+ )
+
+
+
+
+
Move the view relatively to its current position.
+
Parameters
+
+ offsetX X coordinate of the move offset offsetY Y coordinate of the move offset
+
+
+
See also setCenter , rotate , zoom
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::View::move
+ (
+ const Vector2f &
+ offset )
+
+
+
+
+
Move the view relatively to its current position.
+
Parameters
+
+
+
+
See also setCenter , rotate , zoom
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::View::reset
+ (
+ const FloatRect &
+ rectangle )
+
+
+
+
+
Reset the view to the given rectangle.
+
Note that this function resets the rotation angle to 0.
+
Parameters
+
+ rectangle Rectangle defining the zone to display
+
+
+
See also setCenter , setSize , setRotation
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::View::rotate
+ (
+ float
+ angle )
+
+
+
+
+
Rotate the view relatively to its current orientation.
+
Parameters
+
+ angle Angle to rotate, in degrees
+
+
+
See also setRotation , move , zoom
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::View::setCenter
+ (
+ float
+ x ,
+
+ float
+ y
+
+ )
+
+
+
+
+
Set the center of the view.
+
Parameters
+
+ x X coordinate of the new center y Y coordinate of the new center
+
+
+
See also setSize , getCenter
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::View::setCenter
+ (
+ const Vector2f &
+ center )
+
+
+
+
+
Set the center of the view.
+
Parameters
+
+
+
+
See also setSize , getCenter
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::View::setRotation
+ (
+ float
+ angle )
+
+
+
+
+
Set the orientation of the view.
+
The default rotation of a view is 0 degree.
+
Parameters
+
+ angle New angle, in degrees
+
+
+
See also getRotation
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void sf::View::setSize
+ (
+ float
+ width ,
+
+ float
+ height
+
+ )
+
+
+
+
+
Set the size of the view.
+
Parameters
+
+ width New width of the view height New height of the view
+
+
+
See also setCenter , getCenter
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void sf::View::setSize
+ (
+ const Vector2f &
+ size )
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::View::setViewport
+ (
+ const FloatRect &
+ viewport )
+
+
+
+
+
Set the target viewport.
+
The viewport is the rectangle into which the contents of the view are displayed, expressed as a factor (between 0 and 1) of the size of the RenderTarget to which the view is applied. For example, a view which takes the left side of the target would be defined with View.setViewport (sf::FloatRect(0, 0, 0.5, 1)). By default, a view has a viewport which covers the entire target.
+
Parameters
+
+ viewport New viewport rectangle
+
+
+
See also getViewport
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::View::zoom
+ (
+ float
+ factor )
+
+
+
+
+
Resize the view rectangle relatively to its current size.
+
Resizing the view simulates a zoom, as the zone displayed on screen grows or shrinks. factor is a multiplier:
+1 keeps the size unchanged
+> 1 makes the view bigger (objects appear smaller)
+< 1 makes the view smaller (objects appear bigger)
+
+
Parameters
+
+ factor Zoom factor to apply
+
+
+
See also setSize , move , rotate
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Window , including all inherited members.
+
+ close ()sf::Window create (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())sf::Window create (WindowHandle handle, const ContextSettings &settings=ContextSettings())sf::Window display ()sf::Window getPosition () constsf::Window getSettings () constsf::Window getSize () constsf::Window getSystemHandle () constsf::Window GlResource ()sf::GlResource private hasFocus () constsf::Window isOpen () constsf::Window NonCopyable ()sf::NonCopyable inline private onCreate ()sf::Window protected virtual onResize ()sf::Window protected virtual pollEvent (Event &event)sf::Window registerContextDestroyCallback (ContextDestroyCallback callback, void *arg)sf::GlResource private static requestFocus ()sf::Window setActive (bool active=true) constsf::Window setFramerateLimit (unsigned int limit)sf::Window setIcon (unsigned int width, unsigned int height, const Uint8 *pixels)sf::Window setJoystickThreshold (float threshold)sf::Window setKeyRepeatEnabled (bool enabled)sf::Window setMouseCursor (const Cursor &cursor)sf::Window setMouseCursorGrabbed (bool grabbed)sf::Window setMouseCursorVisible (bool visible)sf::Window setPosition (const Vector2i &position)sf::Window setSize (const Vector2u &size)sf::Window setTitle (const String &title)sf::Window setVerticalSyncEnabled (bool enabled)sf::Window setVisible (bool visible)sf::Window waitEvent (Event &event)sf::Window Window ()sf::Window Window (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings())sf::Window Window (WindowHandle handle, const ContextSettings &settings=ContextSettings())sf::Window explicit ~GlResource ()sf::GlResource private ~NonCopyable ()sf::NonCopyable inline private ~Window ()sf::Window virtual
SFML - Simple and Fast Multimedia Library
+
+
+
Window that serves as a target for OpenGL rendering.
+ More...
+
+
#include <Window.hpp >
+
+
+
+
+
+
+
+
+ Window () Default constructor. More... Window (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings ()) Construct a new window. More... Window (WindowHandle handle, const ContextSettings &settings=ContextSettings ()) Construct the window from an existing control. More... virtual ~Window () Destructor. More... void create (VideoMode mode, const String &title, Uint32 style=Style::Default, const ContextSettings &settings=ContextSettings ()) Create (or recreate) the window. More... void create (WindowHandle handle, const ContextSettings &settings=ContextSettings ()) Create (or recreate) the window from an existing control. More... void close () Close the window and destroy all the attached resources. More... bool isOpen () const Tell whether or not the window is open. More... const ContextSettings & getSettings () const Get the settings of the OpenGL context of the window. More... bool pollEvent (Event &event) Pop the event on top of the event queue, if any, and return it. More... bool waitEvent (Event &event) Wait for an event and return it. More... Vector2i getPosition () const Get the position of the window. More... void setPosition (const Vector2i &position) Change the position of the window on screen. More... Vector2u getSize () const Get the size of the rendering region of the window. More... void setSize (const Vector2u &size) Change the size of the rendering region of the window. More... void setTitle (const String &title) Change the title of the window. More... void setIcon (unsigned int width, unsigned int height, const Uint8 *pixels) Change the window's icon. More... void setVisible (bool visible) Show or hide the window. More... void setVerticalSyncEnabled (bool enabled) Enable or disable vertical synchronization. More... void setMouseCursorVisible (bool visible) Show or hide the mouse cursor. More... void setMouseCursorGrabbed (bool grabbed) Grab or release the mouse cursor. More... void setMouseCursor (const Cursor &cursor) Set the displayed cursor to a native system cursor. More... void setKeyRepeatEnabled (bool enabled) Enable or disable automatic key-repeat. More... void setFramerateLimit (unsigned int limit) Limit the framerate to a maximum fixed frequency. More... void setJoystickThreshold (float threshold) Change the joystick threshold. More... bool setActive (bool active=true) const Activate or deactivate the window as the current target for OpenGL rendering. More... void requestFocus () Request the current window to be made the active foreground window. More... bool hasFocus () const Check whether the window has the input focus. More... void display () Display on screen what has been rendered to the window so far. More... WindowHandle getSystemHandle () const Get the OS-specific handle of the window. More...
+virtual void onCreate () Function called after the window has been created. More... virtual void onResize () Function called after the window has been resized. More...
+
+
Window that serves as a target for OpenGL rendering.
+
sf::Window is the main class of the Window module.
+
It defines an OS window that is able to receive an OpenGL rendering.
+
A sf::Window can create its own new window, or be embedded into an already existing control using the create(handle) function. This can be useful for embedding an OpenGL rendering area into a view which is part of a bigger GUI with existing windows, controls, etc. It can also serve as embedding an OpenGL rendering area into a window created by another (probably richer) GUI library like Qt or wxWidgets.
+
The sf::Window class provides a simple interface for manipulating the window: move, resize, show/hide, control mouse cursor, etc. It also provides event handling through its pollEvent() and waitEvent() functions.
+
Note that OpenGL experts can pass their own parameters (antialiasing level, bits for the depth and stencil buffers, etc.) to the OpenGL context attached to the window, with the sf::ContextSettings structure which is passed as an optional argument when creating the window.
+
On dual-graphics systems consisting of a low-power integrated GPU and a powerful discrete GPU, the driver picks which GPU will run an SFML application. In order to inform the driver that an SFML application can benefit from being run on the more powerful discrete GPU, SFML_DEFINE_DISCRETE_GPU_PREFERENCE can be placed in a source file that is compiled and linked into the final application. The macro should be placed outside of any scopes in the global namespace.
+
Usage example:
+
Definition at line 58 of file Window/Window.hpp .
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::Window::Window
+ (
+ )
+
+
+
+
+
Default constructor.
+
This constructor doesn't actually create the window, use the other constructors or call create() to do so.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
Construct a new window.
+
This constructor creates the window with the size and pixel depth defined in mode . An optional style can be passed to customize the look and behavior of the window (borders, title bar, resizable, closable, ...). If style contains Style::Fullscreen, then mode must be a valid video mode.
+
The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ mode Video mode to use (defines the width, height and depth of the rendering area of the window) title Title of the window style Window style, a bitwise OR combination of sf::Style enumerators settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
Construct the window from an existing control.
+
Use this constructor if you want to create an OpenGL rendering area into an already existing control.
+
The second parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ handle Platform-specific handle of the control settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual sf::Window::~Window
+ (
+ )
+
+
+
+
+virtual
+
+
+
+
+
Destructor.
+
Closes the window and frees all the resources attached to it.
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::close
+ (
+ )
+
+
+
+
+
Close the window and destroy all the attached resources.
+
After calling this function, the sf::Window instance remains valid and you can call create() to recreate the window. All other functions such as pollEvent() or display() will still work (i.e. you don't have to test isOpen() every time), and will have no effect on closed windows.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Create (or recreate) the window.
+
If the window was already created, it closes it first. If style contains Style::Fullscreen, then mode must be a valid video mode.
+
The fourth parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ mode Video mode to use (defines the width, height and depth of the rendering area of the window) title Title of the window style Window style, a bitwise OR combination of sf::Style enumerators settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Create (or recreate) the window from an existing control.
+
Use this function if you want to create an OpenGL rendering area into an already existing control. If the window was already created, it closes it first.
+
The second parameter is an optional structure specifying advanced OpenGL context settings such as antialiasing, depth-buffer bits, etc.
+
Parameters
+
+ handle Platform-specific handle of the control settings Additional settings for the underlying OpenGL context
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::display
+ (
+ )
+
+
+
+
+
Display on screen what has been rendered to the window so far.
+
This function is typically called after all OpenGL rendering has been done for the current frame, in order to show it on screen.
+
+
+
+
+
◆
+
+
+
+
+
+ Vector2i sf::Window::getPosition (
+ )
+ const
+
+
+
+
+
Get the position of the window.
+
Returns Position of the window, in pixels
+
See also setPosition
+
+
+
+
+
◆
+
+
+
+
+
Get the settings of the OpenGL context of the window.
+
Note that these settings may be different from what was passed to the constructor or the create() function, if one or more settings were not supported. In this case, SFML chose the closest match.
+
Returns Structure containing the OpenGL context settings
+
+
+
+
+
◆
+
+
+
+
+
+ Vector2u sf::Window::getSize (
+ )
+ const
+
+
+
+
+
Get the size of the rendering region of the window.
+
The size doesn't include the titlebar and borders of the window.
+
Returns Size in pixels
+
See also setSize
+
+
+
+
+
◆
+
+
+
+
+
+ WindowHandle sf::Window::getSystemHandle (
+ )
+ const
+
+
+
+
+
Get the OS-specific handle of the window.
+
The type of the returned handle is sf::WindowHandle, which is a typedef to the handle type defined by the OS. You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.
+
Returns System handle of the window
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Window::hasFocus
+ (
+ )
+ const
+
+
+
+
+
Check whether the window has the input focus.
+
At any given time, only one window may have the input focus to receive input events such as keystrokes or most mouse events.
+
Returns True if window has focus, false otherwise
+
See also requestFocus
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Window::isOpen
+ (
+ )
+ const
+
+
+
+
+
Tell whether or not the window is open.
+
This function returns whether or not the window exists. Note that a hidden window (setVisible(false)) is open (therefore this function would return true).
+
Returns True if the window is open, false if it has been closed
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::Window::onCreate
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Function called after the window has been created.
+
This function is called so that derived classes can perform their own specific initialization as soon as the window is created.
+
+
Reimplemented in sf::RenderWindow .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ virtual void sf::Window::onResize
+ (
+ )
+
+
+
+
+protected virtual
+
+
+
+
+
Function called after the window has been resized.
+
This function is called so that derived classes can perform custom actions when the size of the window changes.
+
+
Reimplemented in sf::RenderWindow .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Window::pollEvent
+ (
+ Event & event )
+
+
+
+
+
Pop the event on top of the event queue, if any, and return it.
+
This function is not blocking: if there's no pending event then it will return false and leave event unmodified. Note that more than one event may be present in the event queue, thus you should always call this function in a loop to make sure that you process every pending event.
Parameters
+
+ event Event to be returned
+
+
+
Returns True if an event was returned, or false if the event queue was empty
+
See also waitEvent
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::requestFocus
+ (
+ )
+
+
+
+
+
Request the current window to be made the active foreground window.
+
At any given time, only one window may have the input focus to receive input events such as keystrokes or mouse events. If a window requests focus, it only hints to the operating system, that it would like to be focused. The operating system is free to deny the request. This is not to be confused with setActive() .
+
See also hasFocus
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Window::setActive
+ (
+ bool
+ active = true)
+ const
+
+
+
+
+
Activate or deactivate the window as the current target for OpenGL rendering.
+
A window is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one window can be active on a thread at a time, thus the window previously active (if any) automatically gets deactivated. This is not to be confused with requestFocus() .
+
Parameters
+
+ active True to activate, false to deactivate
+
+
+
Returns True if operation was successful, false otherwise
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setFramerateLimit
+ (
+ unsigned int
+ limit )
+
+
+
+
+
Limit the framerate to a maximum fixed frequency.
+
If a limit is set, the window will use a small delay after each call to display() to ensure that the current frame lasted long enough to match the framerate limit. SFML will try to match the given limit as much as it can, but since it internally uses sf::sleep, whose precision depends on the underlying OS, the results may be a little unprecise as well (for example, you can get 65 FPS when requesting 60).
+
Parameters
+
+ limit Framerate limit, in frames per seconds (use 0 to disable limit)
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setIcon
+ (
+ unsigned int
+ width ,
+
+ unsigned int
+ height ,
+
+ const Uint8 *
+ pixels
+
+ )
+
+
+
+
+
Change the window's icon.
+
pixels must be an array of width x height pixels in 32-bits RGBA format.
+
The OS default icon is used by default.
+
Parameters
+
+ width Icon's width, in pixels height Icon's height, in pixels pixels Pointer to the array of pixels in memory. The pixels are copied, so you need not keep the source alive after calling this function.
+
+
+
See also setTitle
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setJoystickThreshold
+ (
+ float
+ threshold )
+
+
+
+
+
Change the joystick threshold.
+
The joystick threshold is the value below which no JoystickMoved event will be generated.
+
The threshold value is 0.1 by default.
+
Parameters
+
+ threshold New threshold, in the range [0, 100]
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setKeyRepeatEnabled
+ (
+ bool
+ enabled )
+
+
+
+
+
Enable or disable automatic key-repeat.
+
If key repeat is enabled, you will receive repeated KeyPressed events while keeping a key pressed. If it is disabled, you will only get a single event when the key is pressed.
+
Key repeat is enabled by default.
+
Parameters
+
+ enabled True to enable, false to disable
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setMouseCursor
+ (
+ const Cursor &
+ cursor )
+
+
+
+
+
Set the displayed cursor to a native system cursor.
+
Upon window creation, the arrow cursor is used by default.
+
Warning The cursor must not be destroyed while in use by the window.
+
+Features related to Cursor are not supported on iOS and Android.
+
Parameters
+
+ cursor Native system cursor type to display
+
+
+
See also sf::Cursor::loadFromSystem
+sf::Cursor::loadFromPixels
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setMouseCursorGrabbed
+ (
+ bool
+ grabbed )
+
+
+
+
+
Grab or release the mouse cursor.
+
If set, grabs the mouse cursor inside this window's client area so it may no longer be moved outside its bounds. Note that grabbing is only active while the window has focus.
+
Parameters
+
+ grabbed True to enable, false to disable
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setMouseCursorVisible
+ (
+ bool
+ visible )
+
+
+
+
+
Show or hide the mouse cursor.
+
The mouse cursor is visible by default.
+
Parameters
+
+ visible True to show the mouse cursor, false to hide it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setPosition
+ (
+ const Vector2i &
+ position )
+
+
+
+
+
Change the position of the window on screen.
+
This function only works for top-level windows (i.e. it will be ignored for windows created from the handle of a child window/control).
+
Parameters
+
+ position New position, in pixels
+
+
+
See also getPosition
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setSize
+ (
+ const Vector2u &
+ size )
+
+
+
+
+
Change the size of the rendering region of the window.
+
Parameters
+
+ size New size, in pixels
+
+
+
See also getSize
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setTitle
+ (
+ const String &
+ title )
+
+
+
+
+
Change the title of the window.
+
Parameters
+
+
+
+
See also setIcon
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setVerticalSyncEnabled
+ (
+ bool
+ enabled )
+
+
+
+
+
Enable or disable vertical synchronization.
+
Activating vertical synchronization will limit the number of frames displayed to the refresh rate of the monitor. This can avoid some visual artifacts, and limit the framerate to a good value (but not constant across different computers).
+
Vertical synchronization is disabled by default.
+
Parameters
+
+ enabled True to enable v-sync, false to deactivate it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::Window::setVisible
+ (
+ bool
+ visible )
+
+
+
+
+
Show or hide the window.
+
The window is shown by default.
+
Parameters
+
+ visible True to show the window, false to hide it
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Window::waitEvent
+ (
+ Event & event )
+
+
+
+
+
Wait for an event and return it.
+
This function is blocking: if there's no pending event then it will wait until an event is received. After this function returns (and no error occurred), the event object is always valid and filled properly. This function is typically used when you have a thread that is dedicated to events handling: you want to make this thread sleep as long as no new event is received.
Parameters
+
+ event Event to be returned
+
+
+
Returns False if any error occurred
+
See also pollEvent
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+sf::Event::MouseWheelEvent This event is deprecated and potentially inaccurate. Use MouseWheelScrollEvent instead.
+sf::Keyboard::BackSlash Use Backslash instead
+sf::Keyboard::BackSpace Use Backspace instead
+sf::Keyboard::Dash Use Hyphen instead
+sf::Keyboard::Return Use Enter instead
+sf::Keyboard::SemiColon Use Semicolon instead
+sf::LinesStrip Use LineStrip instead
+sf::RenderTexture::create (unsigned int width, unsigned int height, bool depthBuffer)Use create(unsigned int, unsigned int, const ContextSettings&) instead.
+sf::RenderWindow::capture () constUse a sf::Texture and its sf::Texture::update(const Window&) function and copy its contents into an sf::Image instead.
+sf::Shader::setParameter (const std::string &name, const Color &color)Use setUniform(const std::string&, const Glsl::Vec4&) instead.
+sf::Shader::setParameter (const std::string &name, CurrentTextureType )Use setUniform(const std::string&, CurrentTextureType) instead.
+sf::Shader::setParameter (const std::string &name, const Vector2f &vector)Use setUniform(const std::string&, const Glsl::Vec2&) instead.
+sf::Shader::setParameter (const std::string &name, const Transform &transform)Use setUniform(const std::string&, const Glsl::Mat4&) instead.
+sf::Shader::setParameter (const std::string &name, float x, float y, float z)Use setUniform(const std::string&, const Glsl::Vec3&) instead.
+sf::Shader::setParameter (const std::string &name, float x)Use setUniform(const std::string&, float) instead.
+sf::Shader::setParameter (const std::string &name, float x, float y)Use setUniform(const std::string&, const Glsl::Vec2&) instead.
+sf::Shader::setParameter (const std::string &name, const Texture &texture)Use setUniform(const std::string&, const Texture&) instead.
+sf::Shader::setParameter (const std::string &name, const Vector3f &vector)Use setUniform(const std::string&, const Glsl::Vec3&) instead.
+sf::Shader::setParameter (const std::string &name, float x, float y, float z, float w)Use setUniform(const std::string&, const Glsl::Vec4&) instead.
+sf::Text::getColor () constThere is now fill and outline colors instead of a single global color. Use getFillColor() or getOutlineColor() instead.
+sf::Text::setColor (const Color &color)There is now fill and outline colors instead of a single global color. Use setFillColor() or setOutlineColor() instead.
+sf::TrianglesFan Use TriangleFan instead
+sf::TrianglesStrip Use TriangleStrip instead
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dir_83d50c0b1f1eceb6f182949162e90861.html b/SQCSim2021/external/sfml251-32/doc/html/dir_83d50c0b1f1eceb6f182949162e90861.html
new file mode 100644
index 0000000..6c34f0e
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dir_83d50c0b1f1eceb6f182949162e90861.html
@@ -0,0 +1,56 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dir_89e9fb32471ae291b179a889144513db.html b/SQCSim2021/external/sfml251-32/doc/html/dir_89e9fb32471ae291b179a889144513db.html
new file mode 100644
index 0000000..1cfadfe
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dir_89e9fb32471ae291b179a889144513db.html
@@ -0,0 +1,56 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html b/SQCSim2021/external/sfml251-32/doc/html/dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html
new file mode 100644
index 0000000..60f4465
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html
@@ -0,0 +1,66 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dir_e68e8157741866f444e17edd764ebbae.html b/SQCSim2021/external/sfml251-32/doc/html/dir_e68e8157741866f444e17edd764ebbae.html
new file mode 100644
index 0000000..66ad8e9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dir_e68e8157741866f444e17edd764ebbae.html
@@ -0,0 +1,56 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dir_e71ec51a9abd604c65f6abb639f6ea75.html b/SQCSim2021/external/sfml251-32/doc/html/dir_e71ec51a9abd604c65f6abb639f6ea75.html
new file mode 100644
index 0000000..96ea9a1
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dir_e71ec51a9abd604c65f6abb639f6ea75.html
@@ -0,0 +1,56 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/doc.png b/SQCSim2021/external/sfml251-32/doc/html/doc.png
new file mode 100644
index 0000000..17edabf
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/doc/html/doc.png differ
diff --git a/SQCSim2021/external/sfml251-32/doc/html/doxygen.css b/SQCSim2021/external/sfml251-32/doc/html/doxygen.css
new file mode 100644
index 0000000..9c2fc6a
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/doxygen.css
@@ -0,0 +1,1450 @@
+/* The standard CSS for doxygen */
+
+/* @group Heading Levels */
+
+div.contents .textblock h1 {
+ text-align: left;
+ font-size: 20pt;
+ font-weight: normal;
+ margin-top: 1.5em;
+ padding: 0 0 0.4em 0;
+ border-bottom: 1px solid #999;
+ border-top-width: 0;
+ border-left-width: 0;
+ border-right-width: 0;
+ background-color: transparent;
+}
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+.title {
+ font-size: 20pt;
+ font-weight: normal;
+ margin: 10px 2px;
+}
+
+dt {
+ font-weight: bold;
+}
+
+div.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+}
+
+p.startli, p.startdd, p.starttd {
+ margin-top: 2px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.qindex {
+ margin-bottom: 1em;
+}
+
+div.qindex, div.navtab{
+ background-color: #eee;
+ border: 1px solid #999;
+ text-align: center;
+}
+
+div.qindex, div.navpath {
+ width: 100%;
+ line-height: 140%;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a.qindex {
+ font-weight: bold;
+}
+
+a.qindexHL {
+ font-weight: bold;
+ background-color: #9CAFD4;
+ color: #ffffff;
+ border: 1px double #869DCA;
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+a.el {
+ padding: 1px;
+ text-decoration: none;
+ color: #577E25;
+}
+
+a.el:hover {
+ text-decoration: underline;
+}
+
+pre.fragment {
+ /*border: 1px solid #C4CFE5;
+ background-color: #FBFCFD;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
+ font-family: monospace, fixed;
+ font-size: 105%;*/
+ font-family: Consolas, "Liberation Mono", Courier, monospace;
+ font-size: 10pt;
+ padding: 0.5em 1em;
+ background-color: #f5f5f5;
+ border: 1px solid #bbb;
+ border-radius(5px);
+}
+
+div.fragment {
+ /*margin: 0 0 0 5px;
+ padding: 0.5em 1em;
+ font-family: Consolas, "Liberation Mono", Courier, monospace;
+ font-size: 10pt;
+ background-color: #eef7e3;
+ border-left: 3px solid #8DC841;
+ border-right: 0;
+ border-bottom: 0;*/
+
+ font-family: Consolas, "Liberation Mono", Courier, monospace;
+ font-size: 10pt;
+ padding: 0.5em 1em;
+ background-color: #f5f5f5;
+ border: 1px solid #bbb;
+ border-radius(5px);
+}
+
+div.line {
+ min-height: 13px;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ line-height: normal;
+}
+
+span.lineno {
+ padding-right: 4px;
+ text-align: right;
+ background-color: #E8E8E8;
+ white-space: pre;
+}
+
+div.ah {
+ width: 100%;
+ background-color: #eee;
+ font-weight: bold;
+ color: #000;
+ margin-bottom: 1px;
+ margin-top: 1px;
+ border: solid 1px #999;
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background-color: white;
+ color: black;
+ margin: 0;
+}
+
+div.contents {
+ width: 950px;
+ margin: 0 auto;
+}
+
+td.indexkey {
+ background-color: #EBEFF6;
+ font-weight: bold;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+ white-space: nowrap;
+ vertical-align: top;
+}
+
+td.indexvalue {
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: #008000
+}
+
+span.keywordtype {
+ color: #604020
+}
+
+span.keywordflow {
+ color: #e08000
+}
+
+span.comment {
+ color: #800000
+}
+
+span.preprocessor {
+ color: #806020
+}
+
+span.stringliteral {
+ color: #002080
+}
+
+span.charliteral {
+ color: #008080
+}
+
+span.vhdldigit {
+ color: #ff00ff
+}
+
+span.vhdlchar {
+ color: #000000
+}
+
+span.vhdlkeyword {
+ color: #700070
+}
+
+span.vhdllogic {
+ color: #ff0000
+}
+
+blockquote {
+ background-color: #F7F8FB;
+ border-left: 2px solid #9CAFD4;
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+/* @end */
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
+}
+
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: bold;
+}
+
+hr {
+ display: none;
+ height: 0px;
+ border: none;
+ border-top: 1px solid #4A6AAA;
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: cyan;
+ /*box-shadow: 0 0 15px cyan;*/
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #F9FAFC;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memSeparator {
+ border-bottom: 1px solid #DEE4F0;
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: #4665A2;
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtemplate {
+ font-size: 80%;
+ color: #4665A2;
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.memtitle {
+ display: none;
+}
+
+.memnav {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ /*margin-bottom: 10px;*/
+ margin-right: 5px;
+ display: table !important;
+ width: 100%;
+}
+
+.memname {
+ font-weight: bold;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 0px 6px 0px;
+ color: #000;
+ font-weight: bold;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ background-color: #eee;
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ -moz-border-radius-topright: 4px;
+ -moz-border-radius-topleft: 4px;
+ -webkit-border-top-right-radius: 4px;
+ -webkit-border-top-left-radius: 4px;
+
+}
+
+.memdoc, dl.reflist dd {
+ border: 1px solid #A8B8D9;
+ padding: 6px 10px 2px 10px;
+ background-color: #FBFCFD;
+ background-color: #FFFFFF;
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+.paramname code {
+ line-height: 14px;
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir {
+ font-family: "courier new",courier,monospace;
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: #728DC1;
+ border-top:1px solid #5373B4;
+ border-left:1px solid #5373B4;
+ border-right:1px solid #C4CFE5;
+ border-bottom:1px solid #C4CFE5;
+ text-shadow: none;
+ color: white;
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view when not used as main index */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid #bbb;
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding: 5px 5px 5px 0;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ /*border-left: 1px solid rgba(0,0,0,0.05);*/
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: #F7F8FB;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: #3D578C;
+}
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: #2A3D61;
+}
+
+table table {
+ width: 90%;
+}
+
+.memitem table table {
+ width: auto;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ width: 100%;
+ margin-bottom: 10px;
+ border: 1px solid #A8B8D9;
+ border-spacing: 0px;
+ -moz-border-radius: 4px;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid #A8B8D9;
+ border-bottom: 1px solid #A8B8D9;
+ vertical-align: top;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid #A8B8D9;
+ width: 100%;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-color: #E2E8F2;
+ font-size: 90%;
+ color: #253555;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid #A8B8D9;
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath {
+ display: none;
+}
+
+.navpath ul {
+ font-size: 11px;
+ height:30px;
+ line-height:30px;
+ color:#8AA0CC;
+ border:solid 1px #C2CDE4;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li {
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ color:#364D7C;
+}
+
+.navpath li.navelem a {
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
+ color: #283A5D;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover {
+ color:#6884BD;
+}
+
+.navpath li.footer {
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+ font-size: 8pt;
+}
+
+
+div.summary {
+ font-size: 8pt;
+ padding-right: 5px;
+}
+
+div.summary a {
+ white-space: nowrap;
+ padding: 1px;
+ text-decoration: none;
+ color: #577E25;
+}
+
+div.summary a:hover {
+ text-decoration: underline;
+}
+
+div.ingroups {
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a {
+ white-space: nowrap;
+}
+
+div.header {
+ width: 950px;
+ margin: 2em auto;
+ border-bottom: 1px solid #999;
+}
+
+dl {
+ padding: 0 0 0 10px;
+}
+
+/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
+dl.section {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.note {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #505050;
+}
+
+dl.todo {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug {
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #C08050;
+}
+
+dl.section dd {
+ margin-bottom: 6px;
+}
+
+
+#projectlogo {
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img {
+ border: 0px none;
+}
+
+#projectname {
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief {
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber {
+ font: 50% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea {
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #5373B4;
+}
+
+.image {
+ text-align: center;
+}
+
+.dotgraph {
+ text-align: center;
+}
+
+.mscgraph {
+ text-align: center;
+}
+
+.caption {
+ font-weight: bold;
+}
+
+div.zoom {
+ border: 1px solid #90A5CE;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:#334975;
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+}
+
+dl.citelist dd {
+ margin:2px 0;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: #F4F6FA;
+ border: 1px solid #D8DFEE;
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 20px 10px 10px;
+ width: 200px;
+}
+
+div.toc li {
+ font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 Arial,FreeSans,sans-serif;
+ color: #4665A2;
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 30px;
+}
+
+div.toc li.level4 {
+ margin-left: 45px;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: gray;
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+@media print {
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+
+ #doc-content {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
+/* tabs.css */
+.tabs, .tabs2, .tabs3 {
+ width: 100%;
+ z-index: 101;
+ font-size: 11pt;
+ background-color: #EAF5DB;
+ border-left: 1px solid #999;
+ border-right: 1px solid #999;
+ border-bottom: 1px solid #999;
+ padding: 0;
+ margin: 0;
+}
+
+.tabs2 {
+ font-size: 10pt;
+}
+.tabs3 {
+ font-size: 9pt;
+}
+
+#navrow1 .tablist, #navrow2 .tablist, #navrow3 .tablist, #navrow4 .tablist {
+ margin: 0;
+ padding: 0;
+ display: table;
+}
+
+.tablist li {
+ float: left;
+ display: table-cell;
+ list-style: none;
+}
+
+#navrow1 {
+ border-top: 1px solid #999;
+ margin-top: 2em;
+}
+
+#navrow1 .tablist a, #navrow2 .tablist a, #navrow3 .tablist a, #navrow4 .tablist a {
+ display: block;
+ margin: 8px 0;
+ padding: 0 8px;
+ border-right: 1px solid #bbb;
+}
+
+.tablist li {
+ margin-bottom: 0 !important;
+}
+
+.tablist li.current a {
+ font-weight: bold;
+}
+
+
+
+
+
+/* SFML css */
+body {
+ font-family: 'Ubuntu', 'Arial', sans-serif;
+ line-height: 140%;
+ margin: 0 0 2em 0;
+ padding: 0;
+}
+
+#banner-container {
+ width: 100%;
+ margin-top: 25px;
+ border-top: 2px solid #999;
+ border-bottom: 2px solid #999;
+ background-color: rgb(140, 200, 65);
+}
+
+#banner {
+ width: 950px;
+ height: 60px;
+ line-height: 54px;
+ margin: 0 auto;
+ text-align: center;
+}
+
+#banner #sfml {
+ display: inline;
+ vertical-align: top;
+ margin-left: 15px;
+ color: #fff;
+ font-size: 50pt;
+ text-shadow: rgba(0, 0, 0, 0.5) 1px 1px 5px;
+}
+
+#footer-container {
+ clear: both;
+ width: 100%;
+ margin-top: 50px;
+ border-top: 1px solid #999;
+}
+
+#footer {
+ width: 950px;
+ margin: 10px auto;
+ text-align: center;
+ font-size: 10pt;
+ color: #555;
+}
+
+#footer a {
+ padding: 1px;
+ text-decoration: none;
+ color: rgb(70, 100, 30);
+}
+
+#footer a:hover {
+ text-decoration: underline;
+}
+
+div.contents, #content {
+ width: 950px;
+ margin: 0 auto;
+ padding: 0;
+}
+
+div.contents h1 {
+ color: #333;
+ padding: 0.5em 0;
+ margin-top: 30px;
+ margin-bottom: 0;
+ text-align: center;
+ font-size: 26pt;
+ font-weight: normal;
+}
+
+div.contents h2 {
+ font-size: 20pt;
+ font-weight: normal;
+ margin-top: 1.5em;
+ padding-bottom: 0.4em;
+ border-bottom: 1px solid #999;
+}
+
+div.contents h3 {
+ font-size: 16pt;
+ font-weight: normal;
+}
+
+div.contents p {
+ color: #333;
+ text-align: justify;
+}
+
+div.contents a, #content a {
+ padding: 1px;
+ text-decoration: none;
+ color: rgb(70, 100, 30);
+}
+
+div.contents a:hover, #content a:hover {
+ text-decoration: underline;
+}
+
+div.contents code {
+ font-size: 11pt;
+ font-family: Consolas, "Liberation Mono", Courier, monospace;
+}
+
+div.contents pre code {
+ font-family: Consolas, "Liberation Mono", Courier, monospace;
+ font-size: 10pt;
+ padding: 0.5em 1em;
+ background-color: #f5f5f5;
+ border: 1px solid #bbb;
+}
+
+div.contents ul {
+ list-style-type: square;
+ list-style-position: outside;
+ margin: 0 0 0 1.5em;
+ padding: 0;
+}
+
+div.contents ul li {
+ color: #333;
+ margin: 0 0 0.3em 0;
+}
+
+
+.icon {
+ font-family: Arial, Helvetica;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: #8cc445;
+ color: white;
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+ line-height: normal;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2folderopen.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2folderclosed.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2doc.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ white-space: nowrap;
+ background-color: white;
+ border: 1px solid gray;
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: 1px 1px 7px gray;
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: grey;
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: #006318;
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font: 12px/16px Roboto,sans-serif;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before {
+ border-top-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+.arrow {
+ cursor: pointer;
+}
diff --git a/SQCSim2021/external/sfml251-32/doc/html/doxygen.png b/SQCSim2021/external/sfml251-32/doc/html/doxygen.png
new file mode 100644
index 0000000..3ff17d8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/doc/html/doxygen.png differ
diff --git a/SQCSim2021/external/sfml251-32/doc/html/dynsections.js b/SQCSim2021/external/sfml251-32/doc/html/dynsections.js
new file mode 100644
index 0000000..537e3e4
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/dynsections.js
@@ -0,0 +1,127 @@
+/*
+ @licstart The following is the entire license notice for the
+ JavaScript code in this file.
+
+ Copyright (C) 1997-2017 by Dimitri van Heesch
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+ @licend The above is the entire license notice
+ for the JavaScript code in this file
+ */
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+ content.hide();
+ summary.show();
+ $(linkObj).addClass('closed').removeClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ content.show();
+ summary.hide();
+ $(linkObj).removeClass('closed').addClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ return false;
+}
+
+function updateStripes()
+{
+ $('table.directory tr').
+ removeClass('even').filter(':visible:even').addClass('even');
+}
+
+function toggleLevel(level)
+{
+ $('table.directory tr').each(function() {
+ var l = this.id.split('_').length-1;
+ var i = $('#img'+this.id.substring(3));
+ var a = $('#arr'+this.id.substring(3));
+ if (l
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented files with brief descriptions:
+
+ AlResource.hpp Audio.hpp BlendMode.hpp CircleShape.hpp Clipboard.hpp Clock.hpp Color.hpp Config.hpp Context.hpp ContextSettings.hpp ConvexShape.hpp Cursor.hpp Drawable.hpp Err.hpp Event.hpp Audio/Export.hpp Graphics/Export.hpp Network/Export.hpp System/Export.hpp Window/Export.hpp FileInputStream.hpp Font.hpp Ftp.hpp GlResource.hpp Glsl.hpp Glyph.hpp GpuPreference.hpp Headers Graphics.hpp Http.hpp Image.hpp InputSoundFile.hpp InputStream.hpp IpAddress.hpp Joystick.hpp Keyboard.hpp Listener.hpp Lock.hpp Main.hpp mainpage.hpp MemoryInputStream.hpp Mouse.hpp Music.hpp Mutex.hpp NativeActivity.hpp Network.hpp NonCopyable.hpp OpenGL.hpp OutputSoundFile.hpp Packet.hpp PrimitiveType.hpp Rect.hpp RectangleShape.hpp RenderStates.hpp RenderTarget.hpp RenderTexture.hpp RenderWindow.hpp Sensor.hpp Shader.hpp Shape.hpp Sleep.hpp Socket.hpp SocketHandle.hpp SocketSelector.hpp Sound.hpp SoundBuffer.hpp SoundBufferRecorder.hpp SoundFileFactory.hpp SoundFileReader.hpp SoundFileWriter.hpp SoundRecorder.hpp SoundSource.hpp SoundStream.hpp Sprite.hpp String.hpp System.hpp TcpListener.hpp TcpSocket.hpp Text.hpp Texture.hpp Thread.hpp ThreadLocal.hpp ThreadLocalPtr.hpp Time.hpp Touch.hpp Transform.hpp Transformable.hpp UdpSocket.hpp Utf.hpp Vector2.hpp Vector3.hpp Vertex.hpp VertexArray.hpp VertexBuffer.hpp VideoMode.hpp View.hpp Window/Window.hpp Window.hpp WindowHandle.hpp WindowStyle.hpp
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+C
+: sf::Keyboard
+
+capture()
+: sf::RenderWindow
+
+changeDirectory()
+: sf::Ftp
+
+channelCount
+: sf::SoundFileReader::Info
+
+CircleShape()
+: sf::CircleShape
+
+clear()
+: sf::Packet
+, sf::RenderTarget
+, sf::SocketSelector
+, sf::String
+, sf::VertexArray
+
+Clock()
+: sf::Clock
+
+close()
+: sf::Socket
+, sf::TcpListener
+, sf::Window
+
+Closed
+: sf::Event
+
+ClosingConnection
+: sf::Ftp::Response
+
+ClosingDataConnection
+: sf::Ftp::Response
+
+code
+: sf::Event::KeyEvent
+
+Color()
+: sf::Color
+
+color
+: sf::Vertex
+
+colorDstFactor
+: sf::BlendMode
+
+colorEquation
+: sf::BlendMode
+
+colorSrcFactor
+: sf::BlendMode
+
+combine()
+: sf::Transform
+
+Comma
+: sf::Keyboard
+
+CommandNotImplemented
+: sf::Ftp::Response
+
+CommandUnknown
+: sf::Ftp::Response
+
+connect()
+: sf::Ftp
+, sf::TcpSocket
+
+ConnectionClosed
+: sf::Ftp::Response
+
+ConnectionFailed
+: sf::Ftp::Response
+, sf::Http::Response
+
+ConstIterator
+: sf::String
+
+contains()
+: sf::Rect< T >
+
+Context()
+: sf::Context
+
+ContextSettings()
+: sf::ContextSettings
+
+control
+: sf::Event::KeyEvent
+
+ConvexShape()
+: sf::ConvexShape
+
+CoordinateType
+: sf::Texture
+
+copy()
+: sf::Image
+
+copyToImage()
+: sf::Texture
+
+Core
+: sf::ContextSettings
+
+Count
+: sf::Event
+, sf::Joystick
+, sf::Sensor
+
+count()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+create()
+: sf::Image
+, sf::RenderTexture
+, sf::Socket
+, sf::Texture
+, sf::VertexBuffer
+, sf::Window
+
+Created
+: sf::Http::Response
+
+createDirectory()
+: sf::Ftp
+
+createMaskFromColor()
+: sf::Image
+
+createReaderFromFilename()
+: sf::SoundFileFactory
+
+createReaderFromMemory()
+: sf::SoundFileFactory
+
+createReaderFromStream()
+: sf::SoundFileFactory
+
+createWriterFromFilename()
+: sf::SoundFileFactory
+
+Cross
+: sf::Cursor
+
+CurrentTexture
+: sf::Shader
+
+Cursor()
+: sf::Cursor
+
+Cyan
+: sf::Color
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+capture()
+: sf::RenderWindow
+
+changeDirectory()
+: sf::Ftp
+
+CircleShape()
+: sf::CircleShape
+
+clear()
+: sf::Packet
+, sf::RenderTarget
+, sf::SocketSelector
+, sf::String
+, sf::VertexArray
+
+Clock()
+: sf::Clock
+
+close()
+: sf::Socket
+, sf::TcpListener
+, sf::Window
+
+Color()
+: sf::Color
+
+combine()
+: sf::Transform
+
+connect()
+: sf::Ftp
+, sf::TcpSocket
+
+contains()
+: sf::Rect< T >
+
+Context()
+: sf::Context
+
+ContextSettings()
+: sf::ContextSettings
+
+ConvexShape()
+: sf::ConvexShape
+
+copy()
+: sf::Image
+
+copyToImage()
+: sf::Texture
+
+count()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+create()
+: sf::Image
+, sf::RenderTexture
+, sf::Socket
+, sf::Texture
+, sf::VertexBuffer
+, sf::Window
+
+createDirectory()
+: sf::Ftp
+
+createMaskFromColor()
+: sf::Image
+
+createReaderFromFilename()
+: sf::SoundFileFactory
+
+createReaderFromMemory()
+: sf::SoundFileFactory
+
+createReaderFromStream()
+: sf::SoundFileFactory
+
+createWriterFromFilename()
+: sf::SoundFileFactory
+
+Cursor()
+: sf::Cursor
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+generateMipmap()
+: sf::RenderTexture
+, sf::Texture
+
+getActiveContext()
+: sf::Context
+
+getActiveContextId()
+: sf::Context
+
+getAttenuation()
+: sf::SoundSource
+
+getAvailableDevices()
+: sf::SoundRecorder
+
+getAxisPosition()
+: sf::Joystick
+
+getBody()
+: sf::Http::Response
+
+getBounds()
+: sf::VertexArray
+
+getBuffer()
+: sf::Sound
+, sf::SoundBufferRecorder
+
+getButtonCount()
+: sf::Joystick
+
+getCenter()
+: sf::View
+
+getChannelCount()
+: sf::InputSoundFile
+, sf::SoundBuffer
+, sf::SoundRecorder
+, sf::SoundStream
+
+getCharacterSize()
+: sf::Text
+
+getColor()
+: sf::Sprite
+, sf::Text
+
+getData()
+: sf::Packet
+, sf::String
+
+getDataSize()
+: sf::Packet
+
+getDefaultDevice()
+: sf::SoundRecorder
+
+getDefaultView()
+: sf::RenderTarget
+
+getDesktopMode()
+: sf::VideoMode
+
+getDevice()
+: sf::SoundRecorder
+
+getDirection()
+: sf::Listener
+
+getDirectory()
+: sf::Ftp::DirectoryResponse
+
+getDirectoryListing()
+: sf::Ftp
+
+getDuration()
+: sf::InputSoundFile
+, sf::Music
+, sf::SoundBuffer
+
+getElapsedTime()
+: sf::Clock
+
+getField()
+: sf::Http::Response
+
+getFillColor()
+: sf::Shape
+, sf::Text
+
+getFont()
+: sf::Text
+
+getFullscreenModes()
+: sf::VideoMode
+
+getFunction()
+: sf::Context
+
+getGlobalBounds()
+: sf::Shape
+, sf::Sprite
+, sf::Text
+
+getGlobalVolume()
+: sf::Listener
+
+getGlyph()
+: sf::Font
+
+getHandle()
+: sf::Socket
+
+getIdentification()
+: sf::Joystick
+
+getInfo()
+: sf::Font
+
+getInverse()
+: sf::Transform
+
+getInverseTransform()
+: sf::Transformable
+, sf::View
+
+getKerning()
+: sf::Font
+
+getLetterSpacing()
+: sf::Text
+
+getLineSpacing()
+: sf::Font
+, sf::Text
+
+getListing()
+: sf::Ftp::ListingResponse
+
+getLocalAddress()
+: sf::IpAddress
+
+getLocalBounds()
+: sf::Shape
+, sf::Sprite
+, sf::Text
+
+getLocalPort()
+: sf::TcpListener
+, sf::TcpSocket
+, sf::UdpSocket
+
+getLoop()
+: sf::Sound
+, sf::SoundStream
+
+getLoopPoints()
+: sf::Music
+
+getMajorHttpVersion()
+: sf::Http::Response
+
+getMatrix()
+: sf::Transform
+
+getMaximumAntialiasingLevel()
+: sf::RenderTexture
+
+getMaximumSize()
+: sf::Texture
+
+getMessage()
+: sf::Ftp::Response
+
+getMinDistance()
+: sf::SoundSource
+
+getMinorHttpVersion()
+: sf::Http::Response
+
+getNativeHandle()
+: sf::Shader
+, sf::Texture
+, sf::VertexBuffer
+
+getOrigin()
+: sf::Transformable
+
+getOutlineColor()
+: sf::Shape
+, sf::Text
+
+getOutlineThickness()
+: sf::Shape
+, sf::Text
+
+getPitch()
+: sf::SoundSource
+
+getPixel()
+: sf::Image
+
+getPixelsPtr()
+: sf::Image
+
+getPlayingOffset()
+: sf::Sound
+, sf::SoundStream
+
+getPoint()
+: sf::CircleShape
+, sf::ConvexShape
+, sf::RectangleShape
+, sf::Shape
+
+getPointCount()
+: sf::CircleShape
+, sf::ConvexShape
+, sf::RectangleShape
+, sf::Shape
+
+getPosition()
+: sf::Listener
+, sf::Mouse
+, sf::SoundSource
+, sf::Touch
+, sf::Transformable
+, sf::Window
+
+getPrimitiveType()
+: sf::VertexArray
+, sf::VertexBuffer
+
+getPublicAddress()
+: sf::IpAddress
+
+getRadius()
+: sf::CircleShape
+
+getRemoteAddress()
+: sf::TcpSocket
+
+getRemotePort()
+: sf::TcpSocket
+
+getRotation()
+: sf::Transformable
+, sf::View
+
+getSampleCount()
+: sf::InputSoundFile
+, sf::SoundBuffer
+
+getSampleOffset()
+: sf::InputSoundFile
+
+getSampleRate()
+: sf::InputSoundFile
+, sf::SoundBuffer
+, sf::SoundRecorder
+, sf::SoundStream
+
+getSamples()
+: sf::SoundBuffer
+
+getScale()
+: sf::Transformable
+
+getSettings()
+: sf::Context
+, sf::Window
+
+getSize()
+: sf::FileInputStream
+, sf::Image
+, sf::InputStream
+, sf::MemoryInputStream
+, sf::RectangleShape
+, sf::RenderTarget
+, sf::RenderTexture
+, sf::RenderWindow
+, sf::String
+, sf::Texture
+, sf::View
+, sf::Window
+
+getStatus()
+: sf::Ftp::Response
+, sf::Http::Response
+, sf::Sound
+, sf::SoundSource
+, sf::SoundStream
+
+getString()
+: sf::Clipboard
+, sf::Text
+
+getStyle()
+: sf::Text
+
+getSystemHandle()
+: sf::Window
+
+getTexture()
+: sf::Font
+, sf::RenderTexture
+, sf::Shape
+, sf::Sprite
+
+getTextureRect()
+: sf::Shape
+, sf::Sprite
+
+getTimeOffset()
+: sf::InputSoundFile
+
+getTransform()
+: sf::Transformable
+, sf::View
+
+getUnderlinePosition()
+: sf::Font
+
+getUnderlineThickness()
+: sf::Font
+
+getUpVector()
+: sf::Listener
+
+getUsage()
+: sf::VertexBuffer
+
+getValue()
+: sf::Sensor
+, sf::ThreadLocal
+
+getVertexCount()
+: sf::VertexArray
+, sf::VertexBuffer
+
+getView()
+: sf::RenderTarget
+
+getViewport()
+: sf::RenderTarget
+, sf::View
+
+getVolume()
+: sf::SoundSource
+
+getWorkingDirectory()
+: sf::Ftp
+
+GlResource()
+: sf::GlResource
+
+Glyph()
+: sf::Glyph
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+launch()
+: sf::Thread
+
+listen()
+: sf::TcpListener
+
+ListingResponse()
+: sf::Ftp::ListingResponse
+
+loadFromFile()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromImage()
+: sf::Texture
+
+loadFromMemory()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromPixels()
+: sf::Cursor
+
+loadFromSamples()
+: sf::SoundBuffer
+
+loadFromStream()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromSystem()
+: sf::Cursor
+
+Lock()
+: sf::Lock
+
+lock()
+: sf::Mutex
+
+login()
+: sf::Ftp
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+onCreate()
+: sf::RenderWindow
+, sf::Window
+
+onGetData()
+: sf::Music
+, sf::SoundStream
+
+onLoop()
+: sf::Music
+, sf::SoundStream
+
+onProcessSamples()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+onReceive()
+: sf::Packet
+
+onResize()
+: sf::RenderWindow
+, sf::Window
+
+onSeek()
+: sf::Music
+, sf::SoundStream
+
+onSend()
+: sf::Packet
+
+onStart()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+onStop()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+open()
+: sf::FileInputStream
+, sf::MemoryInputStream
+, sf::SoundFileReader
+, sf::SoundFileWriter
+
+openFromFile()
+: sf::InputSoundFile
+, sf::Music
+, sf::OutputSoundFile
+
+openFromMemory()
+: sf::InputSoundFile
+, sf::Music
+
+openFromStream()
+: sf::InputSoundFile
+, sf::Music
+
+operator BoolType()
+: sf::Packet
+
+operator std::string()
+: sf::String
+
+operator std::wstring()
+: sf::String
+
+operator T*()
+: sf::ThreadLocalPtr< T >
+
+operator!=()
+: sf::BlendMode
+, sf::Color
+, sf::Rect< T >
+, sf::String
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+, sf::VideoMode
+
+operator%()
+: sf::Time
+
+operator%=()
+: sf::Time
+
+operator*()
+: sf::Color
+, sf::ThreadLocalPtr< T >
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator*=()
+: sf::Color
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator+()
+: sf::Color
+, sf::String
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator+=()
+: sf::Color
+, sf::String
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator-()
+: sf::Color
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator-=()
+: sf::Color
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator->()
+: sf::ThreadLocalPtr< T >
+
+operator/()
+: sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator/=()
+: sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator<()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator<<()
+: sf::Packet
+
+operator<=()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator=()
+: sf::Font
+, sf::SocketSelector
+, sf::Sound
+, sf::SoundBuffer
+, sf::SoundSource
+, sf::String
+, sf::Texture
+, sf::ThreadLocalPtr< T >
+, sf::VertexBuffer
+
+operator==()
+: sf::BlendMode
+, sf::Color
+, sf::Rect< T >
+, sf::String
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+, sf::VideoMode
+
+operator>()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator>=()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator>>()
+: sf::Packet
+
+operator[]()
+: sf::String
+, sf::VertexArray
+
+OutputSoundFile()
+: sf::OutputSoundFile
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
+
+saveToFile()
+: sf::Image
+, sf::SoundBuffer
+
+scale()
+: sf::Transform
+, sf::Transformable
+
+seconds()
+: sf::Time
+
+seek()
+: sf::FileInputStream
+, sf::InputSoundFile
+, sf::InputStream
+, sf::MemoryInputStream
+, sf::SoundFileReader
+
+send()
+: sf::TcpSocket
+, sf::UdpSocket
+
+sendCommand()
+: sf::Ftp
+
+sendRequest()
+: sf::Http
+
+setActive()
+: sf::Context
+, sf::RenderTarget
+, sf::RenderTexture
+, sf::RenderWindow
+, sf::Window
+
+setAttenuation()
+: sf::SoundSource
+
+setBlocking()
+: sf::Socket
+
+setBody()
+: sf::Http::Request
+
+setBuffer()
+: sf::Sound
+
+setCenter()
+: sf::View
+
+setChannelCount()
+: sf::SoundRecorder
+
+setCharacterSize()
+: sf::Text
+
+setColor()
+: sf::Sprite
+, sf::Text
+
+setDevice()
+: sf::SoundRecorder
+
+setDirection()
+: sf::Listener
+
+setEnabled()
+: sf::Sensor
+
+setField()
+: sf::Http::Request
+
+setFillColor()
+: sf::Shape
+, sf::Text
+
+setFont()
+: sf::Text
+
+setFramerateLimit()
+: sf::Window
+
+setGlobalVolume()
+: sf::Listener
+
+setHost()
+: sf::Http
+
+setHttpVersion()
+: sf::Http::Request
+
+setIcon()
+: sf::Window
+
+setJoystickThreshold()
+: sf::Window
+
+setKeyRepeatEnabled()
+: sf::Window
+
+setLetterSpacing()
+: sf::Text
+
+setLineSpacing()
+: sf::Text
+
+setLoop()
+: sf::Sound
+, sf::SoundStream
+
+setLoopPoints()
+: sf::Music
+
+setMethod()
+: sf::Http::Request
+
+setMinDistance()
+: sf::SoundSource
+
+setMouseCursor()
+: sf::Window
+
+setMouseCursorGrabbed()
+: sf::Window
+
+setMouseCursorVisible()
+: sf::Window
+
+setOrigin()
+: sf::Transformable
+
+setOutlineColor()
+: sf::Shape
+, sf::Text
+
+setOutlineThickness()
+: sf::Shape
+, sf::Text
+
+setParameter()
+: sf::Shader
+
+setPitch()
+: sf::SoundSource
+
+setPixel()
+: sf::Image
+
+setPlayingOffset()
+: sf::Sound
+, sf::SoundStream
+
+setPoint()
+: sf::ConvexShape
+
+setPointCount()
+: sf::CircleShape
+, sf::ConvexShape
+
+setPosition()
+: sf::Listener
+, sf::Mouse
+, sf::SoundSource
+, sf::Transformable
+, sf::Window
+
+setPrimitiveType()
+: sf::VertexArray
+, sf::VertexBuffer
+
+setProcessingInterval()
+: sf::SoundRecorder
+
+setRadius()
+: sf::CircleShape
+
+setRelativeToListener()
+: sf::SoundSource
+
+setRepeated()
+: sf::RenderTexture
+, sf::Texture
+
+setRotation()
+: sf::Transformable
+, sf::View
+
+setScale()
+: sf::Transformable
+
+setSize()
+: sf::RectangleShape
+, sf::View
+, sf::Window
+
+setSmooth()
+: sf::RenderTexture
+, sf::Texture
+
+setSrgb()
+: sf::Texture
+
+setString()
+: sf::Clipboard
+, sf::Text
+
+setStyle()
+: sf::Text
+
+setTexture()
+: sf::Shape
+, sf::Sprite
+
+setTextureRect()
+: sf::Shape
+, sf::Sprite
+
+setTitle()
+: sf::Window
+
+setUniform()
+: sf::Shader
+
+setUniformArray()
+: sf::Shader
+
+setUpVector()
+: sf::Listener
+
+setUri()
+: sf::Http::Request
+
+setUsage()
+: sf::VertexBuffer
+
+setValue()
+: sf::ThreadLocal
+
+setVerticalSyncEnabled()
+: sf::Window
+
+setView()
+: sf::RenderTarget
+
+setViewport()
+: sf::View
+
+setVirtualKeyboardVisible()
+: sf::Keyboard
+
+setVisible()
+: sf::Window
+
+setVolume()
+: sf::SoundSource
+
+Shader()
+: sf::Shader
+
+Shape()
+: sf::Shape
+
+Socket()
+: sf::Socket
+
+SocketSelector()
+: sf::SocketSelector
+
+Sound()
+: sf::Sound
+
+SoundBuffer()
+: sf::SoundBuffer
+
+SoundRecorder()
+: sf::SoundRecorder
+
+SoundSource()
+: sf::SoundSource
+
+SoundStream()
+: sf::SoundStream
+
+Span()
+: sf::Music::Span< T >
+
+Sprite()
+: sf::Sprite
+
+start()
+: sf::SoundRecorder
+
+stop()
+: sf::Sound
+, sf::SoundRecorder
+, sf::SoundSource
+, sf::SoundStream
+
+String()
+: sf::String
+
+substring()
+: sf::String
+
+swap()
+: sf::Texture
+, sf::VertexBuffer
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
+
+TcpListener()
+: sf::TcpListener
+
+TcpSocket()
+: sf::TcpSocket
+
+tell()
+: sf::FileInputStream
+, sf::InputStream
+, sf::MemoryInputStream
+
+terminate()
+: sf::Thread
+
+Text()
+: sf::Text
+
+Texture()
+: sf::Texture
+
+Thread()
+: sf::Thread
+
+ThreadLocal()
+: sf::ThreadLocal
+
+ThreadLocalPtr()
+: sf::ThreadLocalPtr< T >
+
+Time()
+: sf::Time
+
+toAnsi()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toAnsiString()
+: sf::String
+
+toInteger()
+: sf::Color
+, sf::IpAddress
+
+toLatin1()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toString()
+: sf::IpAddress
+
+toUtf16()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toUtf32()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toUtf8()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toWide()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toWideString()
+: sf::String
+
+Transform()
+: sf::Transform
+
+Transformable()
+: sf::Transformable
+
+transformPoint()
+: sf::Transform
+
+transformRect()
+: sf::Transform
+
+TransientContextLock()
+: sf::GlResource::TransientContextLock
+
+translate()
+: sf::Transform
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+g
+: sf::Color
+
+G
+: sf::Keyboard
+
+GainedFocus
+: sf::Event
+
+GatewayTimeout
+: sf::Http::Response
+
+generateMipmap()
+: sf::RenderTexture
+, sf::Texture
+
+Geometry
+: sf::Shader
+
+Get
+: sf::Http::Request
+
+getActiveContext()
+: sf::Context
+
+getActiveContextId()
+: sf::Context
+
+getAttenuation()
+: sf::SoundSource
+
+getAvailableDevices()
+: sf::SoundRecorder
+
+getAxisPosition()
+: sf::Joystick
+
+getBody()
+: sf::Http::Response
+
+getBounds()
+: sf::VertexArray
+
+getBuffer()
+: sf::Sound
+, sf::SoundBufferRecorder
+
+getButtonCount()
+: sf::Joystick
+
+getCenter()
+: sf::View
+
+getChannelCount()
+: sf::InputSoundFile
+, sf::SoundBuffer
+, sf::SoundRecorder
+, sf::SoundStream
+
+getCharacterSize()
+: sf::Text
+
+getColor()
+: sf::Sprite
+, sf::Text
+
+getData()
+: sf::Packet
+, sf::String
+
+getDataSize()
+: sf::Packet
+
+getDefaultDevice()
+: sf::SoundRecorder
+
+getDefaultView()
+: sf::RenderTarget
+
+getDesktopMode()
+: sf::VideoMode
+
+getDevice()
+: sf::SoundRecorder
+
+getDirection()
+: sf::Listener
+
+getDirectory()
+: sf::Ftp::DirectoryResponse
+
+getDirectoryListing()
+: sf::Ftp
+
+getDuration()
+: sf::InputSoundFile
+, sf::Music
+, sf::SoundBuffer
+
+getElapsedTime()
+: sf::Clock
+
+getField()
+: sf::Http::Response
+
+getFillColor()
+: sf::Shape
+, sf::Text
+
+getFont()
+: sf::Text
+
+getFullscreenModes()
+: sf::VideoMode
+
+getFunction()
+: sf::Context
+
+getGlobalBounds()
+: sf::Shape
+, sf::Sprite
+, sf::Text
+
+getGlobalVolume()
+: sf::Listener
+
+getGlyph()
+: sf::Font
+
+getHandle()
+: sf::Socket
+
+getIdentification()
+: sf::Joystick
+
+getInfo()
+: sf::Font
+
+getInverse()
+: sf::Transform
+
+getInverseTransform()
+: sf::Transformable
+, sf::View
+
+getKerning()
+: sf::Font
+
+getLetterSpacing()
+: sf::Text
+
+getLineSpacing()
+: sf::Font
+, sf::Text
+
+getListing()
+: sf::Ftp::ListingResponse
+
+getLocalAddress()
+: sf::IpAddress
+
+getLocalBounds()
+: sf::Shape
+, sf::Sprite
+, sf::Text
+
+getLocalPort()
+: sf::TcpListener
+, sf::TcpSocket
+, sf::UdpSocket
+
+getLoop()
+: sf::Sound
+, sf::SoundStream
+
+getLoopPoints()
+: sf::Music
+
+getMajorHttpVersion()
+: sf::Http::Response
+
+getMatrix()
+: sf::Transform
+
+getMaximumAntialiasingLevel()
+: sf::RenderTexture
+
+getMaximumSize()
+: sf::Texture
+
+getMessage()
+: sf::Ftp::Response
+
+getMinDistance()
+: sf::SoundSource
+
+getMinorHttpVersion()
+: sf::Http::Response
+
+getNativeHandle()
+: sf::Shader
+, sf::Texture
+, sf::VertexBuffer
+
+getOrigin()
+: sf::Transformable
+
+getOutlineColor()
+: sf::Shape
+, sf::Text
+
+getOutlineThickness()
+: sf::Shape
+, sf::Text
+
+getPitch()
+: sf::SoundSource
+
+getPixel()
+: sf::Image
+
+getPixelsPtr()
+: sf::Image
+
+getPlayingOffset()
+: sf::Sound
+, sf::SoundStream
+
+getPoint()
+: sf::CircleShape
+, sf::ConvexShape
+, sf::RectangleShape
+, sf::Shape
+
+getPointCount()
+: sf::CircleShape
+, sf::ConvexShape
+, sf::RectangleShape
+, sf::Shape
+
+getPosition()
+: sf::Listener
+, sf::Mouse
+, sf::SoundSource
+, sf::Touch
+, sf::Transformable
+, sf::Window
+
+getPrimitiveType()
+: sf::VertexArray
+, sf::VertexBuffer
+
+getPublicAddress()
+: sf::IpAddress
+
+getRadius()
+: sf::CircleShape
+
+getRemoteAddress()
+: sf::TcpSocket
+
+getRemotePort()
+: sf::TcpSocket
+
+getRotation()
+: sf::Transformable
+, sf::View
+
+getSampleCount()
+: sf::InputSoundFile
+, sf::SoundBuffer
+
+getSampleOffset()
+: sf::InputSoundFile
+
+getSampleRate()
+: sf::InputSoundFile
+, sf::SoundBuffer
+, sf::SoundRecorder
+, sf::SoundStream
+
+getSamples()
+: sf::SoundBuffer
+
+getScale()
+: sf::Transformable
+
+getSettings()
+: sf::Context
+, sf::Window
+
+getSize()
+: sf::FileInputStream
+, sf::Image
+, sf::InputStream
+, sf::MemoryInputStream
+, sf::RectangleShape
+, sf::RenderTarget
+, sf::RenderTexture
+, sf::RenderWindow
+, sf::String
+, sf::Texture
+, sf::View
+, sf::Window
+
+getStatus()
+: sf::Ftp::Response
+, sf::Http::Response
+, sf::Sound
+, sf::SoundSource
+, sf::SoundStream
+
+getString()
+: sf::Clipboard
+, sf::Text
+
+getStyle()
+: sf::Text
+
+getSystemHandle()
+: sf::Window
+
+getTexture()
+: sf::Font
+, sf::RenderTexture
+, sf::Shape
+, sf::Sprite
+
+getTextureRect()
+: sf::Shape
+, sf::Sprite
+
+getTimeOffset()
+: sf::InputSoundFile
+
+getTransform()
+: sf::Transformable
+, sf::View
+
+getUnderlinePosition()
+: sf::Font
+
+getUnderlineThickness()
+: sf::Font
+
+getUpVector()
+: sf::Listener
+
+getUsage()
+: sf::VertexBuffer
+
+getValue()
+: sf::Sensor
+, sf::ThreadLocal
+
+getVertexCount()
+: sf::VertexArray
+, sf::VertexBuffer
+
+getView()
+: sf::RenderTarget
+
+getViewport()
+: sf::RenderTarget
+, sf::View
+
+getVolume()
+: sf::SoundSource
+
+getWorkingDirectory()
+: sf::Ftp
+
+GlResource()
+: sf::GlResource
+
+Glyph()
+: sf::Glyph
+
+Gravity
+: sf::Sensor
+
+Green
+: sf::Color
+
+Gyroscope
+: sf::Sensor
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+L
+: sf::Keyboard
+
+LAlt
+: sf::Keyboard
+
+launch()
+: sf::Thread
+
+LBracket
+: sf::Keyboard
+
+LControl
+: sf::Keyboard
+
+Left
+: sf::Keyboard
+, sf::Mouse
+
+left
+: sf::Rect< T >
+
+length
+: sf::Music::Span< T >
+
+listen()
+: sf::TcpListener
+
+ListingResponse()
+: sf::Ftp::ListingResponse
+
+loadFromFile()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromImage()
+: sf::Texture
+
+loadFromMemory()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromPixels()
+: sf::Cursor
+
+loadFromSamples()
+: sf::SoundBuffer
+
+loadFromStream()
+: sf::Font
+, sf::Image
+, sf::Shader
+, sf::SoundBuffer
+, sf::Texture
+
+loadFromSystem()
+: sf::Cursor
+
+LocalError
+: sf::Ftp::Response
+
+LocalHost
+: sf::IpAddress
+
+Lock()
+: sf::Lock
+
+lock()
+: sf::Mutex
+
+LoggedIn
+: sf::Ftp::Response
+
+login()
+: sf::Ftp
+
+LostFocus
+: sf::Event
+
+LShift
+: sf::Keyboard
+
+LSystem
+: sf::Keyboard
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+O
+: sf::Keyboard
+
+offset
+: sf::Music::Span< T >
+
+Ok
+: sf::Ftp::Response
+, sf::Http::Response
+
+onCreate()
+: sf::RenderWindow
+, sf::Window
+
+One
+: sf::BlendMode
+
+OneMinusDstAlpha
+: sf::BlendMode
+
+OneMinusDstColor
+: sf::BlendMode
+
+OneMinusSrcAlpha
+: sf::BlendMode
+
+OneMinusSrcColor
+: sf::BlendMode
+
+onGetData()
+: sf::Music
+, sf::SoundStream
+
+onLoop()
+: sf::Music
+, sf::SoundStream
+
+onProcessSamples()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+onReceive()
+: sf::Packet
+
+onResize()
+: sf::RenderWindow
+, sf::Window
+
+onSeek()
+: sf::Music
+, sf::SoundStream
+
+onSend()
+: sf::Packet
+
+onStart()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+onStop()
+: sf::SoundBufferRecorder
+, sf::SoundRecorder
+
+open()
+: sf::FileInputStream
+, sf::MemoryInputStream
+, sf::SoundFileReader
+, sf::SoundFileWriter
+
+openFromFile()
+: sf::InputSoundFile
+, sf::Music
+, sf::OutputSoundFile
+
+openFromMemory()
+: sf::InputSoundFile
+, sf::Music
+
+openFromStream()
+: sf::InputSoundFile
+, sf::Music
+
+OpeningDataConnection
+: sf::Ftp::Response
+
+operator BoolType()
+: sf::Packet
+
+operator std::string()
+: sf::String
+
+operator std::wstring()
+: sf::String
+
+operator T*()
+: sf::ThreadLocalPtr< T >
+
+operator!=()
+: sf::BlendMode
+, sf::Color
+, sf::Rect< T >
+, sf::String
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+, sf::VideoMode
+
+operator%()
+: sf::Time
+
+operator%=()
+: sf::Time
+
+operator*()
+: sf::Color
+, sf::ThreadLocalPtr< T >
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator*=()
+: sf::Color
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator+()
+: sf::Color
+, sf::String
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator+=()
+: sf::Color
+, sf::String
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator-()
+: sf::Color
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator-=()
+: sf::Color
+, sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator->()
+: sf::ThreadLocalPtr< T >
+
+operator/()
+: sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator/=()
+: sf::Time
+, sf::Vector2< T >
+, sf::Vector3< T >
+
+operator<
+: sf::IpAddress
+, sf::String
+, sf::Time
+, sf::VideoMode
+
+operator<<()
+: sf::Packet
+
+operator<=()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator=()
+: sf::Font
+, sf::SocketSelector
+, sf::Sound
+, sf::SoundBuffer
+, sf::SoundSource
+, sf::String
+, sf::Texture
+, sf::ThreadLocalPtr< T >
+, sf::VertexBuffer
+
+operator==()
+: sf::BlendMode
+, sf::Color
+, sf::Rect< T >
+, sf::String
+, sf::Time
+, sf::Transform
+, sf::Vector2< T >
+, sf::Vector3< T >
+, sf::VideoMode
+
+operator>()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator>=()
+: sf::String
+, sf::Time
+, sf::VideoMode
+
+operator>>()
+: sf::Packet
+
+operator[]()
+: sf::String
+, sf::VertexArray
+
+Orientation
+: sf::Sensor
+
+OutputSoundFile()
+: sf::OutputSoundFile
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+r
+: sf::Color
+
+R
+: sf::Joystick
+, sf::Keyboard
+
+RAlt
+: sf::Keyboard
+
+RangeNotSatisfiable
+: sf::Http::Response
+
+RBracket
+: sf::Keyboard
+
+RControl
+: sf::Keyboard
+
+read()
+: sf::FileInputStream
+, sf::InputSoundFile
+, sf::InputStream
+, sf::MemoryInputStream
+, sf::SoundFileReader
+
+receive()
+: sf::TcpSocket
+, sf::UdpSocket
+
+Rect()
+: sf::Rect< T >
+
+RectangleShape()
+: sf::RectangleShape
+
+Red
+: sf::Color
+
+registerContextDestroyCallback()
+: sf::GlResource
+
+registerReader()
+: sf::SoundFileFactory
+
+registerWriter()
+: sf::SoundFileFactory
+
+Regular
+: sf::Text
+
+remove()
+: sf::SocketSelector
+
+renameFile()
+: sf::Ftp
+
+RenderStates()
+: sf::RenderStates
+
+RenderTarget()
+: sf::RenderTarget
+
+RenderTexture()
+: sf::RenderTexture
+
+RenderWindow()
+: sf::RenderWindow
+
+replace()
+: sf::String
+
+Request()
+: sf::Http::Request
+
+requestFocus()
+: sf::Window
+
+reset()
+: sf::View
+
+resetBuffer()
+: sf::Sound
+
+ResetContent
+: sf::Http::Response
+
+resetGLStates()
+: sf::RenderTarget
+
+resize()
+: sf::VertexArray
+
+Resized
+: sf::Event
+
+Response()
+: sf::Ftp::Response
+, sf::Http::Response
+
+restart()
+: sf::Clock
+
+RestartMarkerReply
+: sf::Ftp::Response
+
+Return
+: sf::Keyboard
+
+ReverseSubtract
+: sf::BlendMode
+
+Right
+: sf::Keyboard
+, sf::Mouse
+
+rotate()
+: sf::Transform
+, sf::Transformable
+, sf::View
+
+RShift
+: sf::Keyboard
+
+RSystem
+: sf::Keyboard
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+S
+: sf::Keyboard
+
+sampleCount
+: sf::SoundFileReader::Info
+, sf::SoundStream::Chunk
+
+sampleRate
+: sf::SoundFileReader::Info
+
+samples
+: sf::SoundStream::Chunk
+
+saveToFile()
+: sf::Image
+, sf::SoundBuffer
+
+scale()
+: sf::Transform
+, sf::Transformable
+
+seconds()
+: sf::Time
+
+seek()
+: sf::FileInputStream
+, sf::InputSoundFile
+, sf::InputStream
+, sf::MemoryInputStream
+, sf::SoundFileReader
+
+SemiColon
+: sf::Keyboard
+
+Semicolon
+: sf::Keyboard
+
+send()
+: sf::TcpSocket
+, sf::UdpSocket
+
+sendCommand()
+: sf::Ftp
+
+sendRequest()
+: sf::Http
+
+sensor
+: sf::Event
+
+SensorChanged
+: sf::Event
+
+ServiceNotAvailable
+: sf::Http::Response
+
+ServiceReady
+: sf::Ftp::Response
+
+ServiceReadySoon
+: sf::Ftp::Response
+
+ServiceUnavailable
+: sf::Ftp::Response
+
+setActive()
+: sf::Context
+, sf::RenderTarget
+, sf::RenderTexture
+, sf::RenderWindow
+, sf::Window
+
+setAttenuation()
+: sf::SoundSource
+
+setBlocking()
+: sf::Socket
+
+setBody()
+: sf::Http::Request
+
+setBuffer()
+: sf::Sound
+
+setCenter()
+: sf::View
+
+setChannelCount()
+: sf::SoundRecorder
+
+setCharacterSize()
+: sf::Text
+
+setColor()
+: sf::Sprite
+, sf::Text
+
+setDevice()
+: sf::SoundRecorder
+
+setDirection()
+: sf::Listener
+
+setEnabled()
+: sf::Sensor
+
+setField()
+: sf::Http::Request
+
+setFillColor()
+: sf::Shape
+, sf::Text
+
+setFont()
+: sf::Text
+
+setFramerateLimit()
+: sf::Window
+
+setGlobalVolume()
+: sf::Listener
+
+setHost()
+: sf::Http
+
+setHttpVersion()
+: sf::Http::Request
+
+setIcon()
+: sf::Window
+
+setJoystickThreshold()
+: sf::Window
+
+setKeyRepeatEnabled()
+: sf::Window
+
+setLetterSpacing()
+: sf::Text
+
+setLineSpacing()
+: sf::Text
+
+setLoop()
+: sf::Sound
+, sf::SoundStream
+
+setLoopPoints()
+: sf::Music
+
+setMethod()
+: sf::Http::Request
+
+setMinDistance()
+: sf::SoundSource
+
+setMouseCursor()
+: sf::Window
+
+setMouseCursorGrabbed()
+: sf::Window
+
+setMouseCursorVisible()
+: sf::Window
+
+setOrigin()
+: sf::Transformable
+
+setOutlineColor()
+: sf::Shape
+, sf::Text
+
+setOutlineThickness()
+: sf::Shape
+, sf::Text
+
+setParameter()
+: sf::Shader
+
+setPitch()
+: sf::SoundSource
+
+setPixel()
+: sf::Image
+
+setPlayingOffset()
+: sf::Sound
+, sf::SoundStream
+
+setPoint()
+: sf::ConvexShape
+
+setPointCount()
+: sf::CircleShape
+, sf::ConvexShape
+
+setPosition()
+: sf::Listener
+, sf::Mouse
+, sf::SoundSource
+, sf::Transformable
+, sf::Window
+
+setPrimitiveType()
+: sf::VertexArray
+, sf::VertexBuffer
+
+setProcessingInterval()
+: sf::SoundRecorder
+
+setRadius()
+: sf::CircleShape
+
+setRelativeToListener()
+: sf::SoundSource
+
+setRepeated()
+: sf::RenderTexture
+, sf::Texture
+
+setRotation()
+: sf::Transformable
+, sf::View
+
+setScale()
+: sf::Transformable
+
+setSize()
+: sf::RectangleShape
+, sf::View
+, sf::Window
+
+setSmooth()
+: sf::RenderTexture
+, sf::Texture
+
+setSrgb()
+: sf::Texture
+
+setString()
+: sf::Clipboard
+, sf::Text
+
+setStyle()
+: sf::Text
+
+setTexture()
+: sf::Shape
+, sf::Sprite
+
+setTextureRect()
+: sf::Shape
+, sf::Sprite
+
+setTitle()
+: sf::Window
+
+setUniform()
+: sf::Shader
+
+setUniformArray()
+: sf::Shader
+
+setUpVector()
+: sf::Listener
+
+setUri()
+: sf::Http::Request
+
+setUsage()
+: sf::VertexBuffer
+
+setValue()
+: sf::ThreadLocal
+
+setVerticalSyncEnabled()
+: sf::Window
+
+setView()
+: sf::RenderTarget
+
+setViewport()
+: sf::View
+
+setVirtualKeyboardVisible()
+: sf::Keyboard
+
+setVisible()
+: sf::Window
+
+setVolume()
+: sf::SoundSource
+
+shader
+: sf::RenderStates
+
+Shader()
+: sf::Shader
+
+Shape()
+: sf::Shape
+
+shift
+: sf::Event::KeyEvent
+
+size
+: sf::Event
+
+SizeAll
+: sf::Cursor
+
+SizeBottomLeftTopRight
+: sf::Cursor
+
+SizeHorizontal
+: sf::Cursor
+
+SizeTopLeftBottomRight
+: sf::Cursor
+
+SizeVertical
+: sf::Cursor
+
+Slash
+: sf::Keyboard
+
+Socket()
+: sf::Socket
+
+SocketSelector()
+: sf::SocketSelector
+
+Sound()
+: sf::Sound
+
+SoundBuffer()
+: sf::SoundBuffer
+
+SoundRecorder()
+: sf::SoundRecorder
+
+SoundSource()
+: sf::SoundSource
+
+SoundStream()
+: sf::SoundStream
+
+Space
+: sf::Keyboard
+
+Span()
+: sf::Music::Span< T >
+
+Sprite()
+: sf::Sprite
+
+SrcAlpha
+: sf::BlendMode
+
+SrcColor
+: sf::BlendMode
+
+sRgbCapable
+: sf::ContextSettings
+
+start()
+: sf::SoundRecorder
+
+Static
+: sf::VertexBuffer
+
+Status
+: sf::Ftp::Response
+, sf::Http::Response
+, sf::Socket
+, sf::SoundSource
+
+stencilBits
+: sf::ContextSettings
+
+stop()
+: sf::Sound
+, sf::SoundRecorder
+, sf::SoundSource
+, sf::SoundStream
+
+Stopped
+: sf::SoundSource
+
+Stream
+: sf::VertexBuffer
+
+StrikeThrough
+: sf::Text
+
+String()
+: sf::String
+
+Style
+: sf::Text
+
+substring()
+: sf::String
+
+Subtract
+: sf::BlendMode
+, sf::Keyboard
+
+swap()
+: sf::Texture
+, sf::VertexBuffer
+
+system
+: sf::Event::KeyEvent
+
+SystemStatus
+: sf::Ftp::Response
+
+SystemType
+: sf::Ftp::Response
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+T
+: sf::Keyboard
+
+Tab
+: sf::Keyboard
+
+Tcp
+: sf::Socket
+
+TcpListener()
+: sf::TcpListener
+
+TcpSocket()
+: sf::TcpSocket
+
+tell()
+: sf::FileInputStream
+, sf::InputStream
+, sf::MemoryInputStream
+
+terminate()
+: sf::Thread
+
+texCoords
+: sf::Vertex
+
+Text
+: sf::Cursor
+
+text
+: sf::Event
+
+Text()
+: sf::Text
+
+TextEntered
+: sf::Event
+
+texture
+: sf::RenderStates
+
+Texture()
+: sf::Texture
+
+textureRect
+: sf::Glyph
+
+Thread()
+: sf::Thread
+
+ThreadLocal()
+: sf::ThreadLocal
+
+ThreadLocalPtr()
+: sf::ThreadLocalPtr< T >
+
+Tilde
+: sf::Keyboard
+
+Time()
+: sf::Time
+
+toAnsi()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toAnsiString()
+: sf::String
+
+toInteger()
+: sf::Color
+, sf::IpAddress
+
+toLatin1()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+top
+: sf::Rect< T >
+
+toString()
+: sf::IpAddress
+
+touch
+: sf::Event
+
+TouchBegan
+: sf::Event
+
+TouchEnded
+: sf::Event
+
+TouchMoved
+: sf::Event
+
+toUtf16()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toUtf32()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toUtf8()
+: sf::String
+, sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toWide()
+: sf::Utf< 16 >
+, sf::Utf< 32 >
+, sf::Utf< 8 >
+
+toWideString()
+: sf::String
+
+TransferAborted
+: sf::Ftp::Response
+
+TransferMode
+: sf::Ftp
+
+transform
+: sf::RenderStates
+
+Transform()
+: sf::Transform
+
+Transformable()
+: sf::Transformable
+
+transformPoint()
+: sf::Transform
+
+transformRect()
+: sf::Transform
+
+TransientContextLock()
+: sf::GlResource::TransientContextLock
+
+translate()
+: sf::Transform
+
+Transparent
+: sf::Color
+
+Type
+: sf::Cursor
+
+type
+: sf::Event::SensorEvent
+, sf::Event
+
+Type
+: sf::Sensor
+, sf::Shader
+, sf::Socket
+
+
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented file members with links to the documentation:
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
+
Sounds, streaming (musics or custom sources), recording, spatialization.
+More...
+
+
+
Sounds, streaming (musics or custom sources), recording, spatialization.
+
SFML - Simple and Fast Multimedia Library
+
+
+
2D graphics module: sprites, text, shapes, ...
+More...
+
+ sf::Glsl Namespace with GLSL types.
+
+
2D graphics module: sprites, text, shapes, ...
+
+
+
◆
+
+
+
+
+
Types of primitives that a sf::VertexArray can render.
+
Points and lines have no area, therefore their thickness will always be 1 pixel, regardless the current transform and view.
+
+Enumerator List of individual points.
+List of individual lines.
+List of connected lines, a point uses the previous point to form a line.
+List of individual triangles.
+List of connected triangles, a point uses the two previous points to form a triangle.
+List of connected triangles, a point uses the common center and the previous point to form a triangle.
+List of individual quads (deprecated, don't work with OpenGL ES)
+Deprecated: Use LineStrip instead Deprecated: Use TriangleStrip instead Deprecated: Use TriangleFan instead
+
+
Definition at line 39 of file PrimitiveType.hpp .
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
Socket-based communication, utilities and higher-level network protocols (HTTP, FTP).
+More...
+
+
+
Socket-based communication, utilities and higher-level network protocols (HTTP, FTP).
+
SFML - Simple and Fast Multimedia Library
+
+
+
Base module of SFML, defining various utilities.
+More...
+
+
+
Base module of SFML, defining various utilities.
+
It provides vector classes, Unicode strings and conversion functions, threads and mutexes, timing classes.
+
+
+
◆
+
+
+
+
+
+ sf::err
+ (
+ )
+
+
+
+
+
Standard stream used by SFML to output warnings and errors.
+
By default, sf::err() outputs to the same location as std::cerr, (-> the stderr descriptor) which is the console if there's one available.
+
It is a standard std::ostream instance, so it supports all the insertion operations defined by the STL (operator <<, manipulators, etc.).
+
sf::err() can be redirected to write to another output, independently of std::cerr, by using the rdbuf() function provided by the std::ostream class.
+
Example:
std::ofstream file("sfml-log.txt" );
std::streambuf* previous =
sf::err ().rdbuf(file.rdbuf());
Returns Reference to std::ostream representing the SFML error stream
+
+
+
+
+
◆
+
+
+
+
+
+ ANativeActivity* sf::getNativeActivity
+ (
+ )
+
+
+
+
+
Return a pointer to the Android native activity.
+
You shouldn't have to use this function, unless you want to implement very specific details, that SFML doesn't support, or to use a workaround for a known issue.
+
Returns Pointer to Android native activity structure
+
+Platform Limitation
+This is only available on Android and to use it, you'll have to specifically include SFML/System/NativeActivity.hpp in your code.
+
+
+
+
+
◆
+
+
+
+
+
+ void sf::sleep
+ (
+ Time duration )
+
+
+
+
+
Make the current thread sleep for a given duration.
+
sf::sleep is the best way to block a program or one of its threads, as it doesn't consume any CPU power.
+
Parameters
+
+ duration Time to sleep
+
+
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
Provides OpenGL-based windows, and abstractions for events and input handling.
+More...
+
+typedef platform specific sf::WindowHandle Define a low-level window handle type, specific to each platform. More...
+
+
Provides OpenGL-based windows, and abstractions for events and input handling.
+
+
+
◆
+
+
+
+
+
Define a low-level window handle type, specific to each platform.
+
+
+Platform Type -------------—
+
+Windows HWND
+
+Linux/FreeBSD Window
+
+Mac OS X either NSWindow* or NSView*, disguised as void*
+
+iOS UIWindow*
+
+Android ANativeWindow*
+
+
Mac OS X Specification
+
On Mac OS X, a sf::Window can be created either from an existing NSWindow* or an NSView*. When the window is created from a window, SFML will use its content view as the OpenGL area. sf::Window::getSystemHandle() will return the handle that was used to create the window, which is a NSWindow* by default.
+
+
Definition at line 68 of file WindowHandle.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of the window styles.
+
+Enumerator No border / title bar (this flag and all others are mutually exclusive)
+Title bar + fixed border.
+Title bar + resizable border + maximize button.
+Title bar + close button.
+Fullscreen mode (this flag and all others are mutually exclusive)
+Default window style.
+
+
+
Definition at line 38 of file WindowStyle.hpp .
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
[detail level 1 2 3 4 ]
+ ▶ C sf::AlResource Base class for classes that require an OpenAL context C sf::SoundBuffer Storage for audio samples defining a sound ▶ C sf::SoundRecorder Abstract base class for capturing sound data C sf::SoundBufferRecorder Specialized SoundRecorder which stores the captured audio data into a sound buffer ▶ C sf::SoundSource Base class defining a sound's properties C sf::Sound Regular sound that can be played in the audio environment ▶ C sf::SoundStream Abstract base class for streamed audio sources C sf::Music Streamed music played from an audio file C sf::BlendMode Blending modes for drawing C sf::SoundStream::Chunk Structure defining a chunk of audio data to stream C sf::Clipboard Give access to the system clipboard C sf::Clock Utility class that measures the elapsed time C sf::Color Utility class for manipulating RGBA colors C sf::ContextSettings Structure defining the settings of the OpenGL context attached to a window C sf::Shader::CurrentTextureType Special type that can be passed to setUniform() , and that represents the texture of the object being drawn ▶ C sf::Drawable Abstract base class for objects that can be drawn to a render target ▶ C sf::Shape Base class for textured shapes with outline C sf::CircleShape Specialized shape representing a circle C sf::ConvexShape Specialized shape representing a convex polygon C sf::RectangleShape Specialized shape representing a rectangle C sf::Sprite Drawable representation of a texture, with its own transformations, color, etc C sf::Text Graphical text that can be drawn to a render target C sf::VertexArray Define a set of one or more 2D primitives C sf::VertexBuffer Vertex buffer storage for one or more 2D primitives C sf::Event Defines a system event and its parameters C sf::Font Class for loading and manipulating character fonts ▶ C sf::GlResource Base class for classes that require an OpenGL context C sf::Context Class holding a valid drawing context C sf::Shader Shader class (vertex, geometry and fragment) C sf::Texture Image living on the graphics card that can be used for drawing C sf::VertexBuffer Vertex buffer storage for one or more 2D primitives ▶ C sf::Window Window that serves as a target for OpenGL rendering C sf::RenderWindow Window that can serve as a target for 2D drawing C sf::Glyph Structure describing a glyph C sf::Joystick::Identification Structure holding a joystick's identification C sf::Image Class for loading, manipulating and saving images C sf::SoundFileReader::Info Structure holding the audio properties of a sound file C sf::Font::Info Holds various information about a font ▶ C sf::InputStream Abstract class for custom file input streams C sf::FileInputStream Implementation of input stream based on a file C sf::MemoryInputStream Implementation of input stream based on a memory chunk C sf::IpAddress Encapsulate an IPv4 network address C sf::Joystick Give access to the real-time state of the joysticks C sf::Event::JoystickButtonEvent Joystick buttons events parameters (JoystickButtonPressed, JoystickButtonReleased) C sf::Event::JoystickConnectEvent Joystick connection events parameters (JoystickConnected, JoystickDisconnected) C sf::Event::JoystickMoveEvent Joystick axis move event parameters (JoystickMoved) C sf::Keyboard Give access to the real-time state of the keyboard C sf::Event::KeyEvent Keyboard event parameters (KeyPressed, KeyReleased) C sf::Listener The audio listener is the point in the scene from where all the sounds are heard C sf::Mouse Give access to the real-time state of the mouse C sf::Event::MouseButtonEvent Mouse buttons events parameters (MouseButtonPressed, MouseButtonReleased) C sf::Event::MouseMoveEvent Mouse move event parameters (MouseMoved) C sf::Event::MouseWheelEvent Mouse wheel events parameters (MouseWheelMoved) C sf::Event::MouseWheelScrollEvent Mouse wheel events parameters (MouseWheelScrolled) ▶ C sf::NonCopyable Utility class that makes any derived class non-copyable C sf::Context Class holding a valid drawing context C sf::Cursor Cursor defines the appearance of a system cursor C sf::FileInputStream Implementation of input stream based on a file C sf::Ftp A FTP client C sf::GlResource::TransientContextLock RAII helper class to temporarily lock an available context for use C sf::Http A HTTP client C sf::InputSoundFile Provide read access to sound files C sf::Lock Automatic wrapper for locking and unlocking mutexes C sf::Mutex Blocks concurrent access to shared resources from multiple threads C sf::OutputSoundFile Provide write access to sound files ▶ C sf::RenderTarget Base class for all render targets (window, texture, ...) C sf::RenderTexture Target for off-screen 2D rendering into a texture C sf::RenderWindow Window that can serve as a target for 2D drawing C sf::Shader Shader class (vertex, geometry and fragment) ▶ C sf::Socket Base class for all the socket types C sf::TcpListener Socket that listens to new TCP connections C sf::TcpSocket Specialized socket using the TCP protocol C sf::UdpSocket Specialized socket using the UDP protocol C sf::Thread Utility class to manipulate threads ▶ C sf::ThreadLocal Defines variables with thread-local storage C sf::ThreadLocalPtr< T > Pointer to a thread-local variable C sf::Window Window that serves as a target for OpenGL rendering C sf::Packet Utility class to build blocks of data to transfer over the network C sf::Rect< T > Utility class for manipulating 2D axis aligned rectangles C sf::Rect< float > C sf::Rect< int > C sf::RenderStates Define the states used for drawing to a RenderTarget C sf::Http::Request Define a HTTP request ▶ C sf::Ftp::Response Define a FTP response C sf::Ftp::DirectoryResponse Specialization of FTP response returning a directory C sf::Ftp::ListingResponse Specialization of FTP response returning a filename listing C sf::Http::Response Define a HTTP response C sf::Sensor Give access to the real-time state of the sensors C sf::Event::SensorEvent Sensor event parameters (SensorChanged) C sf::Event::SizeEvent Size events parameters (Resized) C sf::SocketSelector Multiplexer that allows to read from multiple sockets C sf::SoundFileFactory Manages and instantiates sound file readers and writers C sf::SoundFileReader Abstract base class for sound file decoding C sf::SoundFileWriter Abstract base class for sound file encoding C sf::Music::Span< T > Structure defining a time range using the template type C sf::Music::Span< Uint64 > C sf::String Utility string class that automatically handles conversions between types and encodings C sf::Event::TextEvent Text event parameters (TextEntered) C sf::Time Represents a time value C sf::Touch Give access to the real-time state of the touches C sf::Event::TouchEvent Touch events parameters (TouchBegan, TouchMoved, TouchEnded) C sf::Transform Define a 3x3 transform matrix ▶ C sf::Transformable Decomposed transform defined by a position, a rotation and a scale C sf::Shape Base class for textured shapes with outline C sf::Sprite Drawable representation of a texture, with its own transformations, color, etc C sf::Text Graphical text that can be drawn to a render target C sf::Utf< N > Utility class providing generic functions for UTF conversions C sf::Utf< 16 > Specialization of the Utf template for UTF-16 C sf::Utf< 32 > Specialization of the Utf template for UTF-32 C sf::Utf< 8 > Specialization of the Utf template for UTF-8 C sf::Vector2< T > Utility template class for manipulating 2-dimensional vectors C sf::Vector2< float > C sf::Vector2< unsigned int > C sf::Vector3< T > Utility template class for manipulating 3-dimensional vectors C sf::Vertex Define a point with color and texture coordinates C sf::VideoMode VideoMode defines a video mode (width, height, bpp) C sf::View 2D camera that defines what region is shown on screen
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
Welcome to the official SFML documentation. Here you will find a detailed view of all the SFML classes and functions. www.sfml-dev.org .
+
+
Here is a short example, to show you how simple it is to use SFML:
+
#include <SFML/Audio.hpp>
#include <SFML/Graphics.hpp>
int main()
{
return EXIT_FAILURE;
return EXIT_FAILURE;
return EXIT_FAILURE;
{
{
}
}
return EXIT_SUCCESS;
}
0){return}bC.fireWith(av,[bF]);if(bF.fn.trigger){bF(av).trigger("ready").off("ready")}}},bindReady:function(){if(bC){return}bC=bF.Callbacks("once memory");if(av.readyState==="complete"){return setTimeout(bF.ready,1)}if(av.addEventListener){av.addEventListener("DOMContentLoaded",e,false);bb.addEventListener("load",bF.ready,false)}else{if(av.attachEvent){av.attachEvent("onreadystatechange",e);bb.attachEvent("onload",bF.ready);var b0=false;try{b0=bb.frameElement==null}catch(b1){}if(av.documentElement.doScroll&&b0){bw()}}}},isFunction:function(b0){return bF.type(b0)==="function"},isArray:Array.isArray||function(b0){return bF.type(b0)==="array"},isWindow:function(b0){return b0&&typeof b0==="object"&&"setInterval" in b0},isNumeric:function(b0){return !isNaN(parseFloat(b0))&&isFinite(b0)},type:function(b0){return b0==null?String(b0):bx[bL.call(b0)]||"object"},isPlainObject:function(b2){if(!b2||bF.type(b2)!=="object"||b2.nodeType||bF.isWindow(b2)){return false}try{if(b2.constructor&&!bG.call(b2,"constructor")&&!bG.call(b2.constructor.prototype,"isPrototypeOf")){return false}}catch(b1){return false}var b0;for(b0 in b2){}return b0===L||bG.call(b2,b0)},isEmptyObject:function(b1){for(var b0 in b1){return false}return true},error:function(b0){throw new Error(b0)},parseJSON:function(b0){if(typeof b0!=="string"||!b0){return null}b0=bF.trim(b0);if(bb.JSON&&bb.JSON.parse){return bb.JSON.parse(b0)}if(bN.test(b0.replace(bW,"@").replace(bP,"]").replace(bJ,""))){return(new Function("return "+b0))()}bF.error("Invalid JSON: "+b0)},parseXML:function(b2){var b0,b1;try{if(bb.DOMParser){b1=new DOMParser();b0=b1.parseFromString(b2,"text/xml")}else{b0=new ActiveXObject("Microsoft.XMLDOM");b0.async="false";b0.loadXML(b2)}}catch(b3){b0=L}if(!b0||!b0.documentElement||b0.getElementsByTagName("parsererror").length){bF.error("Invalid XML: "+b2)}return b0},noop:function(){},globalEval:function(b0){if(b0&&bM.test(b0)){(bb.execScript||function(b1){bb["eval"].call(bb,b1)})(b0)}},camelCase:function(b0){return b0.replace(bZ,"ms-").replace(bB,bT)},nodeName:function(b1,b0){return b1.nodeName&&b1.nodeName.toUpperCase()===b0.toUpperCase()},each:function(b3,b6,b2){var b1,b4=0,b5=b3.length,b0=b5===L||bF.isFunction(b3);if(b2){if(b0){for(b1 in b3){if(b6.apply(b3[b1],b2)===false){break}}}else{for(;b40&&b0[0]&&b0[b1-1])||b1===0||bF.isArray(b0));if(b3){for(;b21?aJ.call(arguments,0):bG;if(!(--bw)){bC.resolveWith(bC,bx)}}}function bz(bF){return function(bG){bB[bF]=arguments.length>1?aJ.call(arguments,0):bG;bC.notifyWith(bE,bB)}}if(e>1){for(;bva
";bJ.shrinkWrapBlocks=(bv.offsetWidth!==2)}bv.style.cssText=bS+bR;bv.innerHTML=bP;bU=bv.firstChild;bV=bU.firstChild;bN=bU.nextSibling.firstChild.firstChild;bO={doesNotAddBorder:(bV.offsetTop!==5),doesAddBorderForTableAndCells:(bN.offsetTop===5)};bV.style.position="fixed";bV.style.top="20px";bO.fixedPosition=(bV.offsetTop===20||bV.offsetTop===15);bV.style.position=bV.style.top="";bU.style.overflow="hidden";bU.style.position="relative";bO.subtractsBorderForOverflowNotVisible=(bV.offsetTop===-5);bO.doesNotIncludeMarginInBodyOffset=(bQ.offsetTop!==bL);bQ.removeChild(bM);bv=bM=null;b.extend(bJ,bO)});return bJ})();var aS=/^(?:\{.*\}|\[.*\])$/,aA=/([A-Z])/g;b.extend({cache:{},uuid:0,expando:"jQuery"+(b.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:true,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:true},hasData:function(e){e=e.nodeType?b.cache[e[b.expando]]:e[b.expando];return !!e&&!S(e)},data:function(bx,bv,bz,by){if(!b.acceptData(bx)){return}var bG,bA,bD,bE=b.expando,bC=typeof bv==="string",bF=bx.nodeType,e=bF?b.cache:bx,bw=bF?bx[bE]:bx[bE]&&bE,bB=bv==="events";if((!bw||!e[bw]||(!bB&&!by&&!e[bw].data))&&bC&&bz===L){return}if(!bw){if(bF){bx[bE]=bw=++b.uuid}else{bw=bE}}if(!e[bw]){e[bw]={};if(!bF){e[bw].toJSON=b.noop}}if(typeof bv==="object"||typeof bv==="function"){if(by){e[bw]=b.extend(e[bw],bv)}else{e[bw].data=b.extend(e[bw].data,bv)}}bG=bA=e[bw];if(!by){if(!bA.data){bA.data={}}bA=bA.data}if(bz!==L){bA[b.camelCase(bv)]=bz}if(bB&&!bA[bv]){return bG.events}if(bC){bD=bA[bv];if(bD==null){bD=bA[b.camelCase(bv)]}}else{bD=bA}return bD},removeData:function(bx,bv,by){if(!b.acceptData(bx)){return}var bB,bA,bz,bC=b.expando,bD=bx.nodeType,e=bD?b.cache:bx,bw=bD?bx[bC]:bC;if(!e[bw]){return}if(bv){bB=by?e[bw]:e[bw].data;if(bB){if(!b.isArray(bv)){if(bv in bB){bv=[bv]}else{bv=b.camelCase(bv);if(bv in bB){bv=[bv]}else{bv=bv.split(" ")}}}for(bA=0,bz=bv.length;bA-1){return true}}return false},val:function(bx){var e,bv,by,bw=this[0];if(!arguments.length){if(bw){e=b.valHooks[bw.nodeName.toLowerCase()]||b.valHooks[bw.type];if(e&&"get" in e&&(bv=e.get(bw,"value"))!==L){return bv}bv=bw.value;return typeof bv==="string"?bv.replace(aU,""):bv==null?"":bv}return}by=b.isFunction(bx);return this.each(function(bA){var bz=b(this),bB;if(this.nodeType!==1){return}if(by){bB=bx.call(this,bA,bz.val())}else{bB=bx}if(bB==null){bB=""}else{if(typeof bB==="number"){bB+=""}else{if(b.isArray(bB)){bB=b.map(bB,function(bC){return bC==null?"":bC+""})}}}e=b.valHooks[this.nodeName.toLowerCase()]||b.valHooks[this.type];if(!e||!("set" in e)||e.set(this,bB,"value")===L){this.value=bB}})}});b.extend({valHooks:{option:{get:function(e){var bv=e.attributes.value;return !bv||bv.specified?e.value:e.text}},select:{get:function(e){var bA,bv,bz,bx,by=e.selectedIndex,bB=[],bC=e.options,bw=e.type==="select-one";if(by<0){return null}bv=bw?by:0;bz=bw?by+1:bC.length;for(;bv=0});if(!e.length){bv.selectedIndex=-1}return e}}},attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(bA,bx,bB,bz){var bw,e,by,bv=bA.nodeType;if(!bA||bv===3||bv===8||bv===2){return}if(bz&&bx in b.attrFn){return b(bA)[bx](bB)}if(typeof bA.getAttribute==="undefined"){return b.prop(bA,bx,bB)}by=bv!==1||!b.isXMLDoc(bA);if(by){bx=bx.toLowerCase();e=b.attrHooks[bx]||(ao.test(bx)?aY:be)}if(bB!==L){if(bB===null){b.removeAttr(bA,bx);return}else{if(e&&"set" in e&&by&&(bw=e.set(bA,bB,bx))!==L){return bw}else{bA.setAttribute(bx,""+bB);return bB}}}else{if(e&&"get" in e&&by&&(bw=e.get(bA,bx))!==null){return bw}else{bw=bA.getAttribute(bx);return bw===null?L:bw}}},removeAttr:function(bx,bz){var by,bA,bv,e,bw=0;if(bz&&bx.nodeType===1){bA=bz.toLowerCase().split(af);e=bA.length;for(;bw=0)}}})});var bd=/^(?:textarea|input|select)$/i,n=/^([^\.]*)?(?:\.(.+))?$/,J=/\bhover(\.\S+)?\b/,aO=/^key/,bf=/^(?:mouse|contextmenu)|click/,T=/^(?:focusinfocus|focusoutblur)$/,U=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,Y=function(e){var bv=U.exec(e);if(bv){bv[1]=(bv[1]||"").toLowerCase();bv[3]=bv[3]&&new RegExp("(?:^|\\s)"+bv[3]+"(?:\\s|$)")}return bv},j=function(bw,e){var bv=bw.attributes||{};return((!e[1]||bw.nodeName.toLowerCase()===e[1])&&(!e[2]||(bv.id||{}).value===e[2])&&(!e[3]||e[3].test((bv["class"]||{}).value)))},bt=function(e){return b.event.special.hover?e:e.replace(J,"mouseenter$1 mouseleave$1")};b.event={add:function(bx,bC,bJ,bA,by){var bD,bB,bK,bI,bH,bF,e,bG,bv,bz,bw,bE;if(bx.nodeType===3||bx.nodeType===8||!bC||!bJ||!(bD=b._data(bx))){return}if(bJ.handler){bv=bJ;bJ=bv.handler}if(!bJ.guid){bJ.guid=b.guid++}bK=bD.events;if(!bK){bD.events=bK={}}bB=bD.handle;if(!bB){bD.handle=bB=function(bL){return typeof b!=="undefined"&&(!bL||b.event.triggered!==bL.type)?b.event.dispatch.apply(bB.elem,arguments):L};bB.elem=bx}bC=b.trim(bt(bC)).split(" ");for(bI=0;bI=0){bG=bG.slice(0,-1);bw=true}if(bG.indexOf(".")>=0){bx=bG.split(".");bG=bx.shift();bx.sort()}if((!bA||b.event.customEvent[bG])&&!b.event.global[bG]){return}bv=typeof bv==="object"?bv[b.expando]?bv:new b.Event(bG,bv):new b.Event(bG);bv.type=bG;bv.isTrigger=true;bv.exclusive=bw;bv.namespace=bx.join(".");bv.namespace_re=bv.namespace?new RegExp("(^|\\.)"+bx.join("\\.(?:.*\\.)?")+"(\\.|$)"):null;by=bG.indexOf(":")<0?"on"+bG:"";if(!bA){e=b.cache;for(bC in e){if(e[bC].events&&e[bC].events[bG]){b.event.trigger(bv,bD,e[bC].handle.elem,true)}}return}bv.result=L;if(!bv.target){bv.target=bA}bD=bD!=null?b.makeArray(bD):[];bD.unshift(bv);bF=b.event.special[bG]||{};if(bF.trigger&&bF.trigger.apply(bA,bD)===false){return}bB=[[bA,bF.bindType||bG]];if(!bJ&&!bF.noBubble&&!b.isWindow(bA)){bI=bF.delegateType||bG;bH=T.test(bI+bG)?bA:bA.parentNode;bz=null;for(;bH;bH=bH.parentNode){bB.push([bH,bI]);bz=bH}if(bz&&bz===bA.ownerDocument){bB.push([bz.defaultView||bz.parentWindow||bb,bI])}}for(bC=0;bCbA){bH.push({elem:this,matches:bz.slice(bA)})}for(bC=0;bC0?this.on(e,null,bx,bw):this.trigger(e)};if(b.attrFn){b.attrFn[e]=true}if(aO.test(e)){b.event.fixHooks[e]=b.event.keyHooks}if(bf.test(e)){b.event.fixHooks[e]=b.event.mouseHooks}});
+/*!
+ * Sizzle CSS Selector Engine
+ * Copyright 2011, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ * More information: http://sizzlejs.com/
+ */
+(function(){var bH=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,bC="sizcache"+(Math.random()+"").replace(".",""),bI=0,bL=Object.prototype.toString,bB=false,bA=true,bK=/\\/g,bO=/\r\n/g,bQ=/\W/;[0,0].sort(function(){bA=false;return 0});var by=function(bV,e,bY,bZ){bY=bY||[];e=e||av;var b1=e;if(e.nodeType!==1&&e.nodeType!==9){return[]}if(!bV||typeof bV!=="string"){return bY}var bS,b3,b6,bR,b2,b5,b4,bX,bU=true,bT=by.isXML(e),bW=[],b0=bV;do{bH.exec("");bS=bH.exec(b0);if(bS){b0=bS[3];bW.push(bS[1]);if(bS[2]){bR=bS[3];break}}}while(bS);if(bW.length>1&&bD.exec(bV)){if(bW.length===2&&bE.relative[bW[0]]){b3=bM(bW[0]+bW[1],e,bZ)}else{b3=bE.relative[bW[0]]?[e]:by(bW.shift(),e);while(bW.length){bV=bW.shift();if(bE.relative[bV]){bV+=bW.shift()}b3=bM(bV,b3,bZ)}}}else{if(!bZ&&bW.length>1&&e.nodeType===9&&!bT&&bE.match.ID.test(bW[0])&&!bE.match.ID.test(bW[bW.length-1])){b2=by.find(bW.shift(),e,bT);e=b2.expr?by.filter(b2.expr,b2.set)[0]:b2.set[0]}if(e){b2=bZ?{expr:bW.pop(),set:bF(bZ)}:by.find(bW.pop(),bW.length===1&&(bW[0]==="~"||bW[0]==="+")&&e.parentNode?e.parentNode:e,bT);b3=b2.expr?by.filter(b2.expr,b2.set):b2.set;if(bW.length>0){b6=bF(b3)}else{bU=false}while(bW.length){b5=bW.pop();b4=b5;if(!bE.relative[b5]){b5=""}else{b4=bW.pop()}if(b4==null){b4=e}bE.relative[b5](b6,b4,bT)}}else{b6=bW=[]}}if(!b6){b6=b3}if(!b6){by.error(b5||bV)}if(bL.call(b6)==="[object Array]"){if(!bU){bY.push.apply(bY,b6)}else{if(e&&e.nodeType===1){for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&(b6[bX]===true||b6[bX].nodeType===1&&by.contains(e,b6[bX]))){bY.push(b3[bX])}}}else{for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&b6[bX].nodeType===1){bY.push(b3[bX])}}}}}else{bF(b6,bY)}if(bR){by(bR,b1,bY,bZ);by.uniqueSort(bY)}return bY};by.uniqueSort=function(bR){if(bJ){bB=bA;bR.sort(bJ);if(bB){for(var e=1;e0};by.find=function(bX,e,bY){var bW,bS,bU,bT,bV,bR;if(!bX){return[]}for(bS=0,bU=bE.order.length;bS":function(bW,bR){var bV,bU=typeof bR==="string",bS=0,e=bW.length;if(bU&&!bQ.test(bR)){bR=bR.toLowerCase();for(;bS=0)){if(!bS){e.push(bV)}}else{if(bS){bR[bU]=false}}}}return false},ID:function(e){return e[1].replace(bK,"")},TAG:function(bR,e){return bR[1].replace(bK,"").toLowerCase()},CHILD:function(e){if(e[1]==="nth"){if(!e[2]){by.error(e[0])}e[2]=e[2].replace(/^\+|\s*/g,"");var bR=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(e[2]==="even"&&"2n"||e[2]==="odd"&&"2n+1"||!/\D/.test(e[2])&&"0n+"+e[2]||e[2]);e[2]=(bR[1]+(bR[2]||1))-0;e[3]=bR[3]-0}else{if(e[2]){by.error(e[0])}}e[0]=bI++;return e},ATTR:function(bU,bR,bS,e,bV,bW){var bT=bU[1]=bU[1].replace(bK,"");if(!bW&&bE.attrMap[bT]){bU[1]=bE.attrMap[bT]}bU[4]=(bU[4]||bU[5]||"").replace(bK,"");if(bU[2]==="~="){bU[4]=" "+bU[4]+" "}return bU},PSEUDO:function(bU,bR,bS,e,bV){if(bU[1]==="not"){if((bH.exec(bU[3])||"").length>1||/^\w/.test(bU[3])){bU[3]=by(bU[3],null,null,bR)}else{var bT=by.filter(bU[3],bR,bS,true^bV);if(!bS){e.push.apply(e,bT)}return false}}else{if(bE.match.POS.test(bU[0])||bE.match.CHILD.test(bU[0])){return true}}return bU},POS:function(e){e.unshift(true);return e}},filters:{enabled:function(e){return e.disabled===false&&e.type!=="hidden"},disabled:function(e){return e.disabled===true},checked:function(e){return e.checked===true},selected:function(e){if(e.parentNode){e.parentNode.selectedIndex}return e.selected===true},parent:function(e){return !!e.firstChild},empty:function(e){return !e.firstChild},has:function(bS,bR,e){return !!by(e[3],bS).length},header:function(e){return(/h\d/i).test(e.nodeName)},text:function(bS){var e=bS.getAttribute("type"),bR=bS.type;return bS.nodeName.toLowerCase()==="input"&&"text"===bR&&(e===bR||e===null)},radio:function(e){return e.nodeName.toLowerCase()==="input"&&"radio"===e.type},checkbox:function(e){return e.nodeName.toLowerCase()==="input"&&"checkbox"===e.type},file:function(e){return e.nodeName.toLowerCase()==="input"&&"file"===e.type},password:function(e){return e.nodeName.toLowerCase()==="input"&&"password"===e.type},submit:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"submit"===bR.type},image:function(e){return e.nodeName.toLowerCase()==="input"&&"image"===e.type},reset:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"reset"===bR.type},button:function(bR){var e=bR.nodeName.toLowerCase();return e==="input"&&"button"===bR.type||e==="button"},input:function(e){return(/input|select|textarea|button/i).test(e.nodeName)},focus:function(e){return e===e.ownerDocument.activeElement}},setFilters:{first:function(bR,e){return e===0},last:function(bS,bR,e,bT){return bR===bT.length-1},even:function(bR,e){return e%2===0},odd:function(bR,e){return e%2===1},lt:function(bS,bR,e){return bRe[3]-0},nth:function(bS,bR,e){return e[3]-0===bR},eq:function(bS,bR,e){return e[3]-0===bR}},filter:{PSEUDO:function(bS,bX,bW,bY){var e=bX[1],bR=bE.filters[e];if(bR){return bR(bS,bW,bX,bY)}else{if(e==="contains"){return(bS.textContent||bS.innerText||bw([bS])||"").indexOf(bX[3])>=0}else{if(e==="not"){var bT=bX[3];for(var bV=0,bU=bT.length;bV=0)}}},ID:function(bR,e){return bR.nodeType===1&&bR.getAttribute("id")===e},TAG:function(bR,e){return(e==="*"&&bR.nodeType===1)||!!bR.nodeName&&bR.nodeName.toLowerCase()===e},CLASS:function(bR,e){return(" "+(bR.className||bR.getAttribute("class"))+" ").indexOf(e)>-1},ATTR:function(bV,bT){var bS=bT[1],e=by.attr?by.attr(bV,bS):bE.attrHandle[bS]?bE.attrHandle[bS](bV):bV[bS]!=null?bV[bS]:bV.getAttribute(bS),bW=e+"",bU=bT[2],bR=bT[4];return e==null?bU==="!=":!bU&&by.attr?e!=null:bU==="="?bW===bR:bU==="*="?bW.indexOf(bR)>=0:bU==="~="?(" "+bW+" ").indexOf(bR)>=0:!bR?bW&&e!==false:bU==="!="?bW!==bR:bU==="^="?bW.indexOf(bR)===0:bU==="$="?bW.substr(bW.length-bR.length)===bR:bU==="|="?bW===bR||bW.substr(0,bR.length+1)===bR+"-":false},POS:function(bU,bR,bS,bV){var e=bR[2],bT=bE.setFilters[e];if(bT){return bT(bU,bS,bR,bV)}}}};var bD=bE.match.POS,bx=function(bR,e){return"\\"+(e-0+1)};for(var bz in bE.match){bE.match[bz]=new RegExp(bE.match[bz].source+(/(?![^\[]*\])(?![^\(]*\))/.source));bE.leftMatch[bz]=new RegExp(/(^(?:.|\r|\n)*?)/.source+bE.match[bz].source.replace(/\\(\d+)/g,bx))}var bF=function(bR,e){bR=Array.prototype.slice.call(bR,0);if(e){e.push.apply(e,bR);return e}return bR};try{Array.prototype.slice.call(av.documentElement.childNodes,0)[0].nodeType}catch(bP){bF=function(bU,bT){var bS=0,bR=bT||[];if(bL.call(bU)==="[object Array]"){Array.prototype.push.apply(bR,bU)}else{if(typeof bU.length==="number"){for(var e=bU.length;bS
";if(bT.querySelectorAll&&bT.querySelectorAll(".TEST").length===0){return}by=function(b4,bV,bZ,b3){bV=bV||av;if(!b3&&!by.isXML(bV)){var b2=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b4);if(b2&&(bV.nodeType===1||bV.nodeType===9)){if(b2[1]){return bF(bV.getElementsByTagName(b4),bZ)}else{if(b2[2]&&bE.find.CLASS&&bV.getElementsByClassName){return bF(bV.getElementsByClassName(b2[2]),bZ)}}}if(bV.nodeType===9){if(b4==="body"&&bV.body){return bF([bV.body],bZ)}else{if(b2&&b2[3]){var bY=bV.getElementById(b2[3]);if(bY&&bY.parentNode){if(bY.id===b2[3]){return bF([bY],bZ)}}else{return bF([],bZ)}}}try{return bF(bV.querySelectorAll(b4),bZ)}catch(b0){}}else{if(bV.nodeType===1&&bV.nodeName.toLowerCase()!=="object"){var bW=bV,bX=bV.getAttribute("id"),bU=bX||bS,b6=bV.parentNode,b5=/^\s*[+~]/.test(b4);if(!bX){bV.setAttribute("id",bU)}else{bU=bU.replace(/'/g,"\\$&")}if(b5&&b6){bV=bV.parentNode}try{if(!b5||b6){return bF(bV.querySelectorAll("[id='"+bU+"'] "+b4),bZ)}}catch(b1){}finally{if(!bX){bW.removeAttribute("id")}}}}}return e(b4,bV,bZ,b3)};for(var bR in e){by[bR]=e[bR]}bT=null})()}(function(){var e=av.documentElement,bS=e.matchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.msMatchesSelector;if(bS){var bU=!bS.call(av.createElement("div"),"div"),bR=false;try{bS.call(av.documentElement,"[test!='']:sizzle")}catch(bT){bR=true}by.matchesSelector=function(bW,bY){bY=bY.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!by.isXML(bW)){try{if(bR||!bE.match.PSEUDO.test(bY)&&!/!=/.test(bY)){var bV=bS.call(bW,bY);if(bV||!bU||bW.document&&bW.document.nodeType!==11){return bV}}}catch(bX){}}return by(bY,null,null,[bW]).length>0}}})();(function(){var e=av.createElement("div");e.innerHTML="
";if(!e.getElementsByClassName||e.getElementsByClassName("e").length===0){return}e.lastChild.className="e";if(e.getElementsByClassName("e").length===1){return}bE.order.splice(1,0,"CLASS");bE.find.CLASS=function(bR,bS,bT){if(typeof bS.getElementsByClassName!=="undefined"&&!bT){return bS.getElementsByClassName(bR[1])}};e=null})();function bv(bR,bW,bV,bZ,bX,bY){for(var bT=0,bS=bZ.length;bT0){bU=e;break}}}e=e[bR]}bZ[bT]=bU}}}if(av.documentElement.contains){by.contains=function(bR,e){return bR!==e&&(bR.contains?bR.contains(e):true)}}else{if(av.documentElement.compareDocumentPosition){by.contains=function(bR,e){return !!(bR.compareDocumentPosition(e)&16)}}else{by.contains=function(){return false}}}by.isXML=function(e){var bR=(e?e.ownerDocument||e:0).documentElement;return bR?bR.nodeName!=="HTML":false};var bM=function(bS,e,bW){var bV,bX=[],bU="",bY=e.nodeType?[e]:e;while((bV=bE.match.PSEUDO.exec(bS))){bU+=bV[0];bS=bS.replace(bE.match.PSEUDO,"")}bS=bE.relative[bS]?bS+"*":bS;for(var bT=0,bR=bY.length;bT0){for(bB=bA;bB=0:b.filter(e,this).length>0:this.filter(e).length>0)},closest:function(by,bx){var bv=[],bw,e,bz=this[0];if(b.isArray(by)){var bB=1;while(bz&&bz.ownerDocument&&bz!==bx){for(bw=0;bw-1:b.find.matchesSelector(bz,by)){bv.push(bz);break}else{bz=bz.parentNode;if(!bz||!bz.ownerDocument||bz===bx||bz.nodeType===11){break}}}}bv=bv.length>1?b.unique(bv):bv;return this.pushStack(bv,"closest",by)},index:function(e){if(!e){return(this[0]&&this[0].parentNode)?this.prevAll().length:-1}if(typeof e==="string"){return b.inArray(this[0],b(e))}return b.inArray(e.jquery?e[0]:e,this)},add:function(e,bv){var bx=typeof e==="string"?b(e,bv):b.makeArray(e&&e.nodeType?[e]:e),bw=b.merge(this.get(),bx);return this.pushStack(C(bx[0])||C(bw[0])?bw:b.unique(bw))},andSelf:function(){return this.add(this.prevObject)}});function C(e){return !e||!e.parentNode||e.parentNode.nodeType===11}b.each({parent:function(bv){var e=bv.parentNode;return e&&e.nodeType!==11?e:null},parents:function(e){return b.dir(e,"parentNode")},parentsUntil:function(bv,e,bw){return b.dir(bv,"parentNode",bw)},next:function(e){return b.nth(e,2,"nextSibling")},prev:function(e){return b.nth(e,2,"previousSibling")},nextAll:function(e){return b.dir(e,"nextSibling")},prevAll:function(e){return b.dir(e,"previousSibling")},nextUntil:function(bv,e,bw){return b.dir(bv,"nextSibling",bw)},prevUntil:function(bv,e,bw){return b.dir(bv,"previousSibling",bw)},siblings:function(e){return b.sibling(e.parentNode.firstChild,e)},children:function(e){return b.sibling(e.firstChild)},contents:function(e){return b.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:b.makeArray(e.childNodes)}},function(e,bv){b.fn[e]=function(by,bw){var bx=b.map(this,bv,by);if(!ab.test(e)){bw=by}if(bw&&typeof bw==="string"){bx=b.filter(bw,bx)}bx=this.length>1&&!ay[e]?b.unique(bx):bx;if((this.length>1||a9.test(bw))&&aq.test(e)){bx=bx.reverse()}return this.pushStack(bx,e,P.call(arguments).join(","))}});b.extend({filter:function(bw,e,bv){if(bv){bw=":not("+bw+")"}return e.length===1?b.find.matchesSelector(e[0],bw)?[e[0]]:[]:b.find.matches(bw,e)},dir:function(bw,bv,by){var e=[],bx=bw[bv];while(bx&&bx.nodeType!==9&&(by===L||bx.nodeType!==1||!b(bx).is(by))){if(bx.nodeType===1){e.push(bx)}bx=bx[bv]}return e},nth:function(by,e,bw,bx){e=e||1;var bv=0;for(;by;by=by[bw]){if(by.nodeType===1&&++bv===e){break}}return by},sibling:function(bw,bv){var e=[];for(;bw;bw=bw.nextSibling){if(bw.nodeType===1&&bw!==bv){e.push(bw)}}return e}});function aG(bx,bw,e){bw=bw||0;if(b.isFunction(bw)){return b.grep(bx,function(bz,by){var bA=!!bw.call(bz,by,bz);return bA===e})}else{if(bw.nodeType){return b.grep(bx,function(bz,by){return(bz===bw)===e})}else{if(typeof bw==="string"){var bv=b.grep(bx,function(by){return by.nodeType===1});if(bp.test(bw)){return b.filter(bw,bv,!e)}else{bw=b.filter(bw,bv)}}}}return b.grep(bx,function(bz,by){return(b.inArray(bz,bw)>=0)===e})}function a(e){var bw=aR.split("|"),bv=e.createDocumentFragment();if(bv.createElement){while(bw.length){bv.createElement(bw.pop())}}return bv}var aR="abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ag=/ jQuery\d+="(?:\d+|null)"/g,ar=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,d=/<([\w:]+)/,w=/",""],legend:[1,""," "],thead:[1,""],tr:[2,""],td:[3,""],col:[2,""],area:[1,""," "],_default:[0,"",""]},ac=a(av);ax.optgroup=ax.option;ax.tbody=ax.tfoot=ax.colgroup=ax.caption=ax.thead;ax.th=ax.td;if(!b.support.htmlSerialize){ax._default=[1,"div","
"]}b.fn.extend({text:function(e){if(b.isFunction(e)){return this.each(function(bw){var bv=b(this);bv.text(e.call(this,bw,bv.text()))})}if(typeof e!=="object"&&e!==L){return this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(e))}return b.text(this)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(bx){if(bx===L){return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(ag,""):null}else{if(typeof bx==="string"&&!ae.test(bx)&&(b.support.leadingWhitespace||!ar.test(bx))&&!ax[(d.exec(bx)||["",""])[1].toLowerCase()]){bx=bx.replace(R,"<$1>");try{for(var bw=0,bv=this.length;bw1&&bw0?this.clone(true):this).get();b(bC[bA])[bv](by);bz=bz.concat(by)}return this.pushStack(bz,e,bC.selector)}}});function bg(e){if(typeof e.getElementsByTagName!=="undefined"){return e.getElementsByTagName("*")}else{if(typeof e.querySelectorAll!=="undefined"){return e.querySelectorAll("*")}else{return[]}}}function az(e){if(e.type==="checkbox"||e.type==="radio"){e.defaultChecked=e.checked}}function E(e){var bv=(e.nodeName||"").toLowerCase();if(bv==="input"){az(e)}else{if(bv!=="script"&&typeof e.getElementsByTagName!=="undefined"){b.grep(e.getElementsByTagName("input"),az)}}}function al(e){var bv=av.createElement("div");ac.appendChild(bv);bv.innerHTML=e.outerHTML;return bv.firstChild}b.extend({clone:function(by,bA,bw){var e,bv,bx,bz=b.support.html5Clone||!ah.test("<"+by.nodeName)?by.cloneNode(true):al(by);if((!b.support.noCloneEvent||!b.support.noCloneChecked)&&(by.nodeType===1||by.nodeType===11)&&!b.isXMLDoc(by)){ai(by,bz);e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){if(bv[bx]){ai(e[bx],bv[bx])}}}if(bA){t(by,bz);if(bw){e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){t(e[bx],bv[bx])}}}e=bv=null;return bz},clean:function(bw,by,bH,bA){var bF;by=by||av;if(typeof by.createElement==="undefined"){by=by.ownerDocument||by[0]&&by[0].ownerDocument||av}var bI=[],bB;for(var bE=0,bz;(bz=bw[bE])!=null;bE++){if(typeof bz==="number"){bz+=""}if(!bz){continue}if(typeof bz==="string"){if(!W.test(bz)){bz=by.createTextNode(bz)}else{bz=bz.replace(R,"<$1>");var bK=(d.exec(bz)||["",""])[1].toLowerCase(),bx=ax[bK]||ax._default,bD=bx[0],bv=by.createElement("div");if(by===av){ac.appendChild(bv)}else{a(by).appendChild(bv)}bv.innerHTML=bx[1]+bz+bx[2];while(bD--){bv=bv.lastChild}if(!b.support.tbody){var e=w.test(bz),bC=bK==="table"&&!e?bv.firstChild&&bv.firstChild.childNodes:bx[1]===""&&!e?bv.childNodes:[];for(bB=bC.length-1;bB>=0;--bB){if(b.nodeName(bC[bB],"tbody")&&!bC[bB].childNodes.length){bC[bB].parentNode.removeChild(bC[bB])}}}if(!b.support.leadingWhitespace&&ar.test(bz)){bv.insertBefore(by.createTextNode(ar.exec(bz)[0]),bv.firstChild)}bz=bv.childNodes}}var bG;if(!b.support.appendChecked){if(bz[0]&&typeof(bG=bz.length)==="number"){for(bB=0;bB=0){return bx+"px"}}else{return bx}}}});if(!b.support.opacity){b.cssHooks.opacity={get:function(bv,e){return au.test((e&&bv.currentStyle?bv.currentStyle.filter:bv.style.filter)||"")?(parseFloat(RegExp.$1)/100)+"":e?"1":""},set:function(by,bz){var bx=by.style,bv=by.currentStyle,e=b.isNumeric(bz)?"alpha(opacity="+bz*100+")":"",bw=bv&&bv.filter||bx.filter||"";bx.zoom=1;if(bz>=1&&b.trim(bw.replace(ak,""))===""){bx.removeAttribute("filter");if(bv&&!bv.filter){return}}bx.filter=ak.test(bw)?bw.replace(ak,e):bw+" "+e}}}b(function(){if(!b.support.reliableMarginRight){b.cssHooks.marginRight={get:function(bw,bv){var e;b.swap(bw,{display:"inline-block"},function(){if(bv){e=Z(bw,"margin-right","marginRight")}else{e=bw.style.marginRight}});return e}}}});if(av.defaultView&&av.defaultView.getComputedStyle){aI=function(by,bw){var bv,bx,e;bw=bw.replace(z,"-$1").toLowerCase();if((bx=by.ownerDocument.defaultView)&&(e=bx.getComputedStyle(by,null))){bv=e.getPropertyValue(bw);if(bv===""&&!b.contains(by.ownerDocument.documentElement,by)){bv=b.style(by,bw)}}return bv}}if(av.documentElement.currentStyle){aX=function(bz,bw){var bA,e,by,bv=bz.currentStyle&&bz.currentStyle[bw],bx=bz.style;if(bv===null&&bx&&(by=bx[bw])){bv=by}if(!bc.test(bv)&&bn.test(bv)){bA=bx.left;e=bz.runtimeStyle&&bz.runtimeStyle.left;if(e){bz.runtimeStyle.left=bz.currentStyle.left}bx.left=bw==="fontSize"?"1em":(bv||0);bv=bx.pixelLeft+"px";bx.left=bA;if(e){bz.runtimeStyle.left=e}}return bv===""?"auto":bv}}Z=aI||aX;function p(by,bw,bv){var bA=bw==="width"?by.offsetWidth:by.offsetHeight,bz=bw==="width"?an:a1,bx=0,e=bz.length;if(bA>0){if(bv!=="border"){for(;bx)<[^<]*)*<\/script>/gi,q=/^(?:select|textarea)/i,h=/\s+/,br=/([?&])_=[^&]*/,K=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,A=b.fn.load,aa={},r={},aE,s,aV=["*/"]+["*"];try{aE=bl.href}catch(aw){aE=av.createElement("a");aE.href="";aE=aE.href}s=K.exec(aE.toLowerCase())||[];function f(e){return function(by,bA){if(typeof by!=="string"){bA=by;by="*"}if(b.isFunction(bA)){var bx=by.toLowerCase().split(h),bw=0,bz=bx.length,bv,bB,bC;for(;bw=0){var e=bw.slice(by,bw.length);bw=bw.slice(0,by)}var bx="GET";if(bz){if(b.isFunction(bz)){bA=bz;bz=L}else{if(typeof bz==="object"){bz=b.param(bz,b.ajaxSettings.traditional);bx="POST"}}}var bv=this;b.ajax({url:bw,type:bx,dataType:"html",data:bz,complete:function(bC,bB,bD){bD=bC.responseText;if(bC.isResolved()){bC.done(function(bE){bD=bE});bv.html(e?b("").append(bD.replace(a6,"")).find(e):bD)}if(bA){bv.each(bA,[bD,bB,bC])}}});return this},serialize:function(){return b.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?b.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||q.test(this.nodeName)||aZ.test(this.type))}).map(function(e,bv){var bw=b(this).val();return bw==null?null:b.isArray(bw)?b.map(bw,function(by,bx){return{name:bv.name,value:by.replace(bs,"\r\n")}}):{name:bv.name,value:bw.replace(bs,"\r\n")}}).get()}});b.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,bv){b.fn[bv]=function(bw){return this.on(bv,bw)}});b.each(["get","post"],function(e,bv){b[bv]=function(bw,by,bz,bx){if(b.isFunction(by)){bx=bx||bz;bz=by;by=L}return b.ajax({type:bv,url:bw,data:by,success:bz,dataType:bx})}});b.extend({getScript:function(e,bv){return b.get(e,L,bv,"script")},getJSON:function(e,bv,bw){return b.get(e,bv,bw,"json")},ajaxSetup:function(bv,e){if(e){am(bv,b.ajaxSettings)}else{e=bv;bv=b.ajaxSettings}am(bv,e);return bv},ajaxSettings:{url:aE,isLocal:aM.test(s[1]),global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":aV},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":bb.String,"text html":true,"text json":b.parseJSON,"text xml":b.parseXML},flatOptions:{context:true,url:true}},ajaxPrefilter:f(aa),ajaxTransport:f(r),ajax:function(bz,bx){if(typeof bz==="object"){bx=bz;bz=L}bx=bx||{};var bD=b.ajaxSetup({},bx),bS=bD.context||bD,bG=bS!==bD&&(bS.nodeType||bS instanceof b)?b(bS):b.event,bR=b.Deferred(),bN=b.Callbacks("once memory"),bB=bD.statusCode||{},bC,bH={},bO={},bQ,by,bL,bE,bI,bA=0,bw,bK,bJ={readyState:0,setRequestHeader:function(bT,bU){if(!bA){var e=bT.toLowerCase();bT=bO[e]=bO[e]||bT;bH[bT]=bU}return this},getAllResponseHeaders:function(){return bA===2?bQ:null},getResponseHeader:function(bT){var e;if(bA===2){if(!by){by={};while((e=aD.exec(bQ))){by[e[1].toLowerCase()]=e[2]}}e=by[bT.toLowerCase()]}return e===L?null:e},overrideMimeType:function(e){if(!bA){bD.mimeType=e}return this},abort:function(e){e=e||"abort";if(bL){bL.abort(e)}bF(0,e);return this}};function bF(bZ,bU,b0,bW){if(bA===2){return}bA=2;if(bE){clearTimeout(bE)}bL=L;bQ=bW||"";bJ.readyState=bZ>0?4:0;var bT,b4,b3,bX=bU,bY=b0?bj(bD,bJ,b0):L,bV,b2;if(bZ>=200&&bZ<300||bZ===304){if(bD.ifModified){if((bV=bJ.getResponseHeader("Last-Modified"))){b.lastModified[bC]=bV}if((b2=bJ.getResponseHeader("Etag"))){b.etag[bC]=b2}}if(bZ===304){bX="notmodified";bT=true}else{try{b4=G(bD,bY);bX="success";bT=true}catch(b1){bX="parsererror";b3=b1}}}else{b3=bX;if(!bX||bZ){bX="error";if(bZ<0){bZ=0}}}bJ.status=bZ;bJ.statusText=""+(bU||bX);if(bT){bR.resolveWith(bS,[b4,bX,bJ])}else{bR.rejectWith(bS,[bJ,bX,b3])}bJ.statusCode(bB);bB=L;if(bw){bG.trigger("ajax"+(bT?"Success":"Error"),[bJ,bD,bT?b4:b3])}bN.fireWith(bS,[bJ,bX]);if(bw){bG.trigger("ajaxComplete",[bJ,bD]);if(!(--b.active)){b.event.trigger("ajaxStop")}}}bR.promise(bJ);bJ.success=bJ.done;bJ.error=bJ.fail;bJ.complete=bN.add;bJ.statusCode=function(bT){if(bT){var e;if(bA<2){for(e in bT){bB[e]=[bB[e],bT[e]]}}else{e=bT[bJ.status];bJ.then(e,e)}}return this};bD.url=((bz||bD.url)+"").replace(bq,"").replace(c,s[1]+"//");bD.dataTypes=b.trim(bD.dataType||"*").toLowerCase().split(h);if(bD.crossDomain==null){bI=K.exec(bD.url.toLowerCase());bD.crossDomain=!!(bI&&(bI[1]!=s[1]||bI[2]!=s[2]||(bI[3]||(bI[1]==="http:"?80:443))!=(s[3]||(s[1]==="http:"?80:443))))}if(bD.data&&bD.processData&&typeof bD.data!=="string"){bD.data=b.param(bD.data,bD.traditional)}aW(aa,bD,bx,bJ);if(bA===2){return false}bw=bD.global;bD.type=bD.type.toUpperCase();bD.hasContent=!aQ.test(bD.type);if(bw&&b.active++===0){b.event.trigger("ajaxStart")}if(!bD.hasContent){if(bD.data){bD.url+=(M.test(bD.url)?"&":"?")+bD.data;delete bD.data}bC=bD.url;if(bD.cache===false){var bv=b.now(),bP=bD.url.replace(br,"$1_="+bv);bD.url=bP+((bP===bD.url)?(M.test(bD.url)?"&":"?")+"_="+bv:"")}}if(bD.data&&bD.hasContent&&bD.contentType!==false||bx.contentType){bJ.setRequestHeader("Content-Type",bD.contentType)}if(bD.ifModified){bC=bC||bD.url;if(b.lastModified[bC]){bJ.setRequestHeader("If-Modified-Since",b.lastModified[bC])}if(b.etag[bC]){bJ.setRequestHeader("If-None-Match",b.etag[bC])}}bJ.setRequestHeader("Accept",bD.dataTypes[0]&&bD.accepts[bD.dataTypes[0]]?bD.accepts[bD.dataTypes[0]]+(bD.dataTypes[0]!=="*"?", "+aV+"; q=0.01":""):bD.accepts["*"]);for(bK in bD.headers){bJ.setRequestHeader(bK,bD.headers[bK])}if(bD.beforeSend&&(bD.beforeSend.call(bS,bJ,bD)===false||bA===2)){bJ.abort();return false}for(bK in {success:1,error:1,complete:1}){bJ[bK](bD[bK])}bL=aW(r,bD,bx,bJ);if(!bL){bF(-1,"No Transport")}else{bJ.readyState=1;if(bw){bG.trigger("ajaxSend",[bJ,bD])}if(bD.async&&bD.timeout>0){bE=setTimeout(function(){bJ.abort("timeout")},bD.timeout)}try{bA=1;bL.send(bH,bF)}catch(bM){if(bA<2){bF(-1,bM)}else{throw bM}}}return bJ},param:function(e,bw){var bv=[],by=function(bz,bA){bA=b.isFunction(bA)?bA():bA;bv[bv.length]=encodeURIComponent(bz)+"="+encodeURIComponent(bA)};if(bw===L){bw=b.ajaxSettings.traditional}if(b.isArray(e)||(e.jquery&&!b.isPlainObject(e))){b.each(e,function(){by(this.name,this.value)})}else{for(var bx in e){v(bx,e[bx],bw,by)}}return bv.join("&").replace(k,"+")}});function v(bw,by,bv,bx){if(b.isArray(by)){b.each(by,function(bA,bz){if(bv||ap.test(bw)){bx(bw,bz)}else{v(bw+"["+(typeof bz==="object"||b.isArray(bz)?bA:"")+"]",bz,bv,bx)}})}else{if(!bv&&by!=null&&typeof by==="object"){for(var e in by){v(bw+"["+e+"]",by[e],bv,bx)}}else{bx(bw,by)}}}b.extend({active:0,lastModified:{},etag:{}});function bj(bD,bC,bz){var bv=bD.contents,bB=bD.dataTypes,bw=bD.responseFields,by,bA,bx,e;for(bA in bw){if(bA in bz){bC[bw[bA]]=bz[bA]}}while(bB[0]==="*"){bB.shift();if(by===L){by=bD.mimeType||bC.getResponseHeader("content-type")}}if(by){for(bA in bv){if(bv[bA]&&bv[bA].test(by)){bB.unshift(bA);break}}}if(bB[0] in bz){bx=bB[0]}else{for(bA in bz){if(!bB[0]||bD.converters[bA+" "+bB[0]]){bx=bA;break}if(!e){e=bA}}bx=bx||e}if(bx){if(bx!==bB[0]){bB.unshift(bx)}return bz[bx]}}function G(bH,bz){if(bH.dataFilter){bz=bH.dataFilter(bz,bH.dataType)}var bD=bH.dataTypes,bG={},bA,bE,bw=bD.length,bB,bC=bD[0],bx,by,bF,bv,e;for(bA=1;bA
=bw.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();bw.animatedProperties[this.prop]=true;for(bA in bw.animatedProperties){if(bw.animatedProperties[bA]!==true){e=false}}if(e){if(bw.overflow!=null&&!b.support.shrinkWrapBlocks){b.each(["","X","Y"],function(bC,bD){bz.style["overflow"+bD]=bw.overflow[bC]})}if(bw.hide){b(bz).hide()}if(bw.hide||bw.show){for(bA in bw.animatedProperties){b.style(bz,bA,bw.orig[bA]);b.removeData(bz,"fxshow"+bA,true);b.removeData(bz,"toggle"+bA,true)}}bv=bw.complete;if(bv){bw.complete=false;bv.call(bz)}}return false}else{if(bw.duration==Infinity){this.now=bx}else{bB=bx-this.startTime;this.state=bB/bw.duration;this.pos=b.easing[bw.animatedProperties[this.prop]](this.state,bB,0,1,bw.duration);this.now=this.start+((this.end-this.start)*this.pos)}this.update()}return true}};b.extend(b.fx,{tick:function(){var bw,bv=b.timers,e=0;for(;e").appendTo(e),bw=bv.css("display");bv.remove();if(bw==="none"||bw===""){if(!a8){a8=av.createElement("iframe");a8.frameBorder=a8.width=a8.height=0}e.appendChild(a8);if(!m||!a8.createElement){m=(a8.contentWindow||a8.contentDocument).document;m.write((av.compatMode==="CSS1Compat"?"":"")+"");m.close()}bv=m.createElement(bx);m.body.appendChild(bv);bw=b.css(bv,"display");e.removeChild(a8)}Q[bx]=bw}return Q[bx]}var V=/^t(?:able|d|h)$/i,ad=/^(?:body|html)$/i;if("getBoundingClientRect" in av.documentElement){b.fn.offset=function(bI){var by=this[0],bB;if(bI){return this.each(function(e){b.offset.setOffset(this,bI,e)})}if(!by||!by.ownerDocument){return null}if(by===by.ownerDocument.body){return b.offset.bodyOffset(by)}try{bB=by.getBoundingClientRect()}catch(bF){}var bH=by.ownerDocument,bw=bH.documentElement;if(!bB||!b.contains(bw,by)){return bB?{top:bB.top,left:bB.left}:{top:0,left:0}}var bC=bH.body,bD=aK(bH),bA=bw.clientTop||bC.clientTop||0,bE=bw.clientLeft||bC.clientLeft||0,bv=bD.pageYOffset||b.support.boxModel&&bw.scrollTop||bC.scrollTop,bz=bD.pageXOffset||b.support.boxModel&&bw.scrollLeft||bC.scrollLeft,bG=bB.top+bv-bA,bx=bB.left+bz-bE;return{top:bG,left:bx}}}else{b.fn.offset=function(bF){var bz=this[0];if(bF){return this.each(function(bG){b.offset.setOffset(this,bF,bG)})}if(!bz||!bz.ownerDocument){return null}if(bz===bz.ownerDocument.body){return b.offset.bodyOffset(bz)}var bC,bw=bz.offsetParent,bv=bz,bE=bz.ownerDocument,bx=bE.documentElement,bA=bE.body,bB=bE.defaultView,e=bB?bB.getComputedStyle(bz,null):bz.currentStyle,bD=bz.offsetTop,by=bz.offsetLeft;while((bz=bz.parentNode)&&bz!==bA&&bz!==bx){if(b.support.fixedPosition&&e.position==="fixed"){break}bC=bB?bB.getComputedStyle(bz,null):bz.currentStyle;bD-=bz.scrollTop;by-=bz.scrollLeft;if(bz===bw){bD+=bz.offsetTop;by+=bz.offsetLeft;if(b.support.doesNotAddBorder&&!(b.support.doesAddBorderForTableAndCells&&V.test(bz.nodeName))){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}bv=bw;bw=bz.offsetParent}if(b.support.subtractsBorderForOverflowNotVisible&&bC.overflow!=="visible"){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}e=bC}if(e.position==="relative"||e.position==="static"){bD+=bA.offsetTop;by+=bA.offsetLeft}if(b.support.fixedPosition&&e.position==="fixed"){bD+=Math.max(bx.scrollTop,bA.scrollTop);by+=Math.max(bx.scrollLeft,bA.scrollLeft)}return{top:bD,left:by}}}b.offset={bodyOffset:function(e){var bw=e.offsetTop,bv=e.offsetLeft;if(b.support.doesNotIncludeMarginInBodyOffset){bw+=parseFloat(b.css(e,"marginTop"))||0;bv+=parseFloat(b.css(e,"marginLeft"))||0}return{top:bw,left:bv}},setOffset:function(bx,bG,bA){var bB=b.css(bx,"position");if(bB==="static"){bx.style.position="relative"}var bz=b(bx),bv=bz.offset(),e=b.css(bx,"top"),bE=b.css(bx,"left"),bF=(bB==="absolute"||bB==="fixed")&&b.inArray("auto",[e,bE])>-1,bD={},bC={},bw,by;if(bF){bC=bz.position();bw=bC.top;by=bC.left}else{bw=parseFloat(e)||0;by=parseFloat(bE)||0}if(b.isFunction(bG)){bG=bG.call(bx,bA,bv)}if(bG.top!=null){bD.top=(bG.top-bv.top)+bw}if(bG.left!=null){bD.left=(bG.left-bv.left)+by}if("using" in bG){bG.using.call(bx,bD)}else{bz.css(bD)}}};b.fn.extend({position:function(){if(!this[0]){return null}var bw=this[0],bv=this.offsetParent(),bx=this.offset(),e=ad.test(bv[0].nodeName)?{top:0,left:0}:bv.offset();bx.top-=parseFloat(b.css(bw,"marginTop"))||0;bx.left-=parseFloat(b.css(bw,"marginLeft"))||0;e.top+=parseFloat(b.css(bv[0],"borderTopWidth"))||0;e.left+=parseFloat(b.css(bv[0],"borderLeftWidth"))||0;return{top:bx.top-e.top,left:bx.left-e.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||av.body;while(e&&(!ad.test(e.nodeName)&&b.css(e,"position")==="static")){e=e.offsetParent}return e})}});b.each(["Left","Top"],function(bv,e){var bw="scroll"+e;b.fn[bw]=function(bz){var bx,by;if(bz===L){bx=this[0];if(!bx){return null}by=aK(bx);return by?("pageXOffset" in by)?by[bv?"pageYOffset":"pageXOffset"]:b.support.boxModel&&by.document.documentElement[bw]||by.document.body[bw]:bx[bw]}return this.each(function(){by=aK(this);if(by){by.scrollTo(!bv?bz:b(by).scrollLeft(),bv?bz:b(by).scrollTop())}else{this[bw]=bz}})}});function aK(e){return b.isWindow(e)?e:e.nodeType===9?e.defaultView||e.parentWindow:false}b.each(["Height","Width"],function(bv,e){var bw=e.toLowerCase();b.fn["inner"+e]=function(){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,"padding")):this[bw]():null};b.fn["outer"+e]=function(by){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,by?"margin":"border")):this[bw]():null};b.fn[bw]=function(bz){var bA=this[0];if(!bA){return bz==null?null:this}if(b.isFunction(bz)){return this.each(function(bE){var bD=b(this);bD[bw](bz.call(this,bE,bD[bw]()))})}if(b.isWindow(bA)){var bB=bA.document.documentElement["client"+e],bx=bA.document.body;return bA.document.compatMode==="CSS1Compat"&&bB||bx&&bx["client"+e]||bB}else{if(bA.nodeType===9){return Math.max(bA.documentElement["client"+e],bA.body["scroll"+e],bA.documentElement["scroll"+e],bA.body["offset"+e],bA.documentElement["offset"+e])}else{if(bz===L){var bC=b.css(bA,bw),by=parseFloat(bC);return b.isNumeric(by)?by:bC}else{return this.css(bw,typeof bz==="string"?bz:bz+"px")}}}}});bb.jQuery=bb.$=b;if(typeof define==="function"&&define.amd&&define.amd.jQuery){define("jquery",[],function(){return b})}})(window);/*!
+ * jQuery UI 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI
+ */
+(function(a,d){a.ui=a.ui||{};if(a.ui.version){return}a.extend(a.ui,{version:"1.8.18",keyCode:{ALT:18,BACKSPACE:8,CAPS_LOCK:20,COMMA:188,COMMAND:91,COMMAND_LEFT:91,COMMAND_RIGHT:93,CONTROL:17,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,INSERT:45,LEFT:37,MENU:93,NUMPAD_ADD:107,NUMPAD_DECIMAL:110,NUMPAD_DIVIDE:111,NUMPAD_ENTER:108,NUMPAD_MULTIPLY:106,NUMPAD_SUBTRACT:109,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SHIFT:16,SPACE:32,TAB:9,UP:38,WINDOWS:91}});a.fn.extend({propAttr:a.fn.prop||a.fn.attr,_focus:a.fn.focus,focus:function(e,f){return typeof e==="number"?this.each(function(){var g=this;setTimeout(function(){a(g).focus();if(f){f.call(g)}},e)}):this._focus.apply(this,arguments)},scrollParent:function(){var e;if((a.browser.msie&&(/(static|relative)/).test(this.css("position")))||(/absolute/).test(this.css("position"))){e=this.parents().filter(function(){return(/(relative|absolute|fixed)/).test(a.curCSS(this,"position",1))&&(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}else{e=this.parents().filter(function(){return(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}return(/fixed/).test(this.css("position"))||!e.length?a(document):e},zIndex:function(h){if(h!==d){return this.css("zIndex",h)}if(this.length){var f=a(this[0]),e,g;while(f.length&&f[0]!==document){e=f.css("position");if(e==="absolute"||e==="relative"||e==="fixed"){g=parseInt(f.css("zIndex"),10);if(!isNaN(g)&&g!==0){return g}}f=f.parent()}}return 0},disableSelection:function(){return this.bind((a.support.selectstart?"selectstart":"mousedown")+".ui-disableSelection",function(e){e.preventDefault()})},enableSelection:function(){return this.unbind(".ui-disableSelection")}});a.each(["Width","Height"],function(g,e){var f=e==="Width"?["Left","Right"]:["Top","Bottom"],h=e.toLowerCase(),k={innerWidth:a.fn.innerWidth,innerHeight:a.fn.innerHeight,outerWidth:a.fn.outerWidth,outerHeight:a.fn.outerHeight};function j(m,l,i,n){a.each(f,function(){l-=parseFloat(a.curCSS(m,"padding"+this,true))||0;if(i){l-=parseFloat(a.curCSS(m,"border"+this+"Width",true))||0}if(n){l-=parseFloat(a.curCSS(m,"margin"+this,true))||0}});return l}a.fn["inner"+e]=function(i){if(i===d){return k["inner"+e].call(this)}return this.each(function(){a(this).css(h,j(this,i)+"px")})};a.fn["outer"+e]=function(i,l){if(typeof i!=="number"){return k["outer"+e].call(this,i)}return this.each(function(){a(this).css(h,j(this,i,true,l)+"px")})}});function c(g,e){var j=g.nodeName.toLowerCase();if("area"===j){var i=g.parentNode,h=i.name,f;if(!g.href||!h||i.nodeName.toLowerCase()!=="map"){return false}f=a("img[usemap=#"+h+"]")[0];return !!f&&b(f)}return(/input|select|textarea|button|object/.test(j)?!g.disabled:"a"==j?g.href||e:e)&&b(g)}function b(e){return !a(e).parents().andSelf().filter(function(){return a.curCSS(this,"visibility")==="hidden"||a.expr.filters.hidden(this)}).length}a.extend(a.expr[":"],{data:function(g,f,e){return !!a.data(g,e[3])},focusable:function(e){return c(e,!isNaN(a.attr(e,"tabindex")))},tabbable:function(g){var e=a.attr(g,"tabindex"),f=isNaN(e);return(f||e>=0)&&c(g,!f)}});a(function(){var e=document.body,f=e.appendChild(f=document.createElement("div"));f.offsetHeight;a.extend(f.style,{minHeight:"100px",height:"auto",padding:0,borderWidth:0});a.support.minHeight=f.offsetHeight===100;a.support.selectstart="onselectstart" in f;e.removeChild(f).style.display="none"});a.extend(a.ui,{plugin:{add:function(f,g,j){var h=a.ui[f].prototype;for(var e in j){h.plugins[e]=h.plugins[e]||[];h.plugins[e].push([g,j[e]])}},call:function(e,g,f){var j=e.plugins[g];if(!j||!e.element[0].parentNode){return}for(var h=0;h0){return true}h[e]=1;g=(h[e]>0);h[e]=0;return g},isOverAxis:function(f,e,g){return(f>e)&&(f<(e+g))},isOver:function(j,f,i,h,e,g){return a.ui.isOverAxis(j,i,e)&&a.ui.isOverAxis(f,h,g)}})})(jQuery);/*!
+ * jQuery UI Widget 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI/Widget
+ */
+(function(b,d){if(b.cleanData){var c=b.cleanData;b.cleanData=function(f){for(var g=0,h;(h=f[g])!=null;g++){try{b(h).triggerHandler("remove")}catch(j){}}c(f)}}else{var a=b.fn.remove;b.fn.remove=function(e,f){return this.each(function(){if(!f){if(!e||b.filter(e,[this]).length){b("*",this).add([this]).each(function(){try{b(this).triggerHandler("remove")}catch(g){}})}}return a.call(b(this),e,f)})}}b.widget=function(f,h,e){var g=f.split(".")[0],j;f=f.split(".")[1];j=g+"-"+f;if(!e){e=h;h=b.Widget}b.expr[":"][j]=function(k){return !!b.data(k,f)};b[g]=b[g]||{};b[g][f]=function(k,l){if(arguments.length){this._createWidget(k,l)}};var i=new h();i.options=b.extend(true,{},i.options);b[g][f].prototype=b.extend(true,i,{namespace:g,widgetName:f,widgetEventPrefix:b[g][f].prototype.widgetEventPrefix||f,widgetBaseClass:j},e);b.widget.bridge(f,b[g][f])};b.widget.bridge=function(f,e){b.fn[f]=function(i){var g=typeof i==="string",h=Array.prototype.slice.call(arguments,1),j=this;i=!g&&h.length?b.extend.apply(null,[true,i].concat(h)):i;if(g&&i.charAt(0)==="_"){return j}if(g){this.each(function(){var k=b.data(this,f),l=k&&b.isFunction(k[i])?k[i].apply(k,h):k;if(l!==k&&l!==d){j=l;return false}})}else{this.each(function(){var k=b.data(this,f);if(k){k.option(i||{})._init()}else{b.data(this,f,new e(i,this))}})}return j}};b.Widget=function(e,f){if(arguments.length){this._createWidget(e,f)}};b.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",options:{disabled:false},_createWidget:function(f,g){b.data(g,this.widgetName,this);this.element=b(g);this.options=b.extend(true,{},this.options,this._getCreateOptions(),f);var e=this;this.element.bind("remove."+this.widgetName,function(){e.destroy()});this._create();this._trigger("create");this._init()},_getCreateOptions:function(){return b.metadata&&b.metadata.get(this.element[0])[this.widgetName]},_create:function(){},_init:function(){},destroy:function(){this.element.unbind("."+this.widgetName).removeData(this.widgetName);this.widget().unbind("."+this.widgetName).removeAttr("aria-disabled").removeClass(this.widgetBaseClass+"-disabled ui-state-disabled")},widget:function(){return this.element},option:function(f,g){var e=f;if(arguments.length===0){return b.extend({},this.options)}if(typeof f==="string"){if(g===d){return this.options[f]}e={};e[f]=g}this._setOptions(e);return this},_setOptions:function(f){var e=this;b.each(f,function(g,h){e._setOption(g,h)});return this},_setOption:function(e,f){this.options[e]=f;if(e==="disabled"){this.widget()[f?"addClass":"removeClass"](this.widgetBaseClass+"-disabled ui-state-disabled").attr("aria-disabled",f)}return this},enable:function(){return this._setOption("disabled",false)},disable:function(){return this._setOption("disabled",true)},_trigger:function(e,f,g){var j,i,h=this.options[e];g=g||{};f=b.Event(f);f.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase();f.target=this.element[0];i=f.originalEvent;if(i){for(j in i){if(!(j in f)){f[j]=i[j]}}}this.element.trigger(f,g);return !(b.isFunction(h)&&h.call(this.element[0],f,g)===false||f.isDefaultPrevented())}}})(jQuery);/*!
+ * jQuery UI Mouse 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI/Mouse
+ *
+ * Depends:
+ * jquery.ui.widget.js
+ */
+(function(b,c){var a=false;b(document).mouseup(function(d){a=false});b.widget("ui.mouse",{options:{cancel:":input,option",distance:1,delay:0},_mouseInit:function(){var d=this;this.element.bind("mousedown."+this.widgetName,function(e){return d._mouseDown(e)}).bind("click."+this.widgetName,function(e){if(true===b.data(e.target,d.widgetName+".preventClickEvent")){b.removeData(e.target,d.widgetName+".preventClickEvent");e.stopImmediatePropagation();return false}});this.started=false},_mouseDestroy:function(){this.element.unbind("."+this.widgetName)},_mouseDown:function(f){if(a){return}(this._mouseStarted&&this._mouseUp(f));this._mouseDownEvent=f;var e=this,g=(f.which==1),d=(typeof this.options.cancel=="string"&&f.target.nodeName?b(f.target).closest(this.options.cancel).length:false);if(!g||d||!this._mouseCapture(f)){return true}this.mouseDelayMet=!this.options.delay;if(!this.mouseDelayMet){this._mouseDelayTimer=setTimeout(function(){e.mouseDelayMet=true},this.options.delay)}if(this._mouseDistanceMet(f)&&this._mouseDelayMet(f)){this._mouseStarted=(this._mouseStart(f)!==false);if(!this._mouseStarted){f.preventDefault();return true}}if(true===b.data(f.target,this.widgetName+".preventClickEvent")){b.removeData(f.target,this.widgetName+".preventClickEvent")}this._mouseMoveDelegate=function(h){return e._mouseMove(h)};this._mouseUpDelegate=function(h){return e._mouseUp(h)};b(document).bind("mousemove."+this.widgetName,this._mouseMoveDelegate).bind("mouseup."+this.widgetName,this._mouseUpDelegate);f.preventDefault();a=true;return true},_mouseMove:function(d){if(b.browser.msie&&!(document.documentMode>=9)&&!d.button){return this._mouseUp(d)}if(this._mouseStarted){this._mouseDrag(d);return d.preventDefault()}if(this._mouseDistanceMet(d)&&this._mouseDelayMet(d)){this._mouseStarted=(this._mouseStart(this._mouseDownEvent,d)!==false);(this._mouseStarted?this._mouseDrag(d):this._mouseUp(d))}return !this._mouseStarted},_mouseUp:function(d){b(document).unbind("mousemove."+this.widgetName,this._mouseMoveDelegate).unbind("mouseup."+this.widgetName,this._mouseUpDelegate);if(this._mouseStarted){this._mouseStarted=false;if(d.target==this._mouseDownEvent.target){b.data(d.target,this.widgetName+".preventClickEvent",true)}this._mouseStop(d)}return false},_mouseDistanceMet:function(d){return(Math.max(Math.abs(this._mouseDownEvent.pageX-d.pageX),Math.abs(this._mouseDownEvent.pageY-d.pageY))>=this.options.distance)},_mouseDelayMet:function(d){return this.mouseDelayMet},_mouseStart:function(d){},_mouseDrag:function(d){},_mouseStop:function(d){},_mouseCapture:function(d){return true}})})(jQuery);(function(c,d){c.widget("ui.resizable",c.ui.mouse,{widgetEventPrefix:"resize",options:{alsoResize:false,animate:false,animateDuration:"slow",animateEasing:"swing",aspectRatio:false,autoHide:false,containment:false,ghost:false,grid:false,handles:"e,s,se",helper:false,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:1000},_create:function(){var f=this,k=this.options;this.element.addClass("ui-resizable");c.extend(this,{_aspectRatio:!!(k.aspectRatio),aspectRatio:k.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:k.helper||k.ghost||k.animate?k.helper||"ui-resizable-helper":null});if(this.element[0].nodeName.match(/canvas|textarea|input|select|button|img/i)){this.element.wrap(c('
').css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")}));this.element=this.element.parent().data("resizable",this.element.data("resizable"));this.elementIsWrapper=true;this.element.css({marginLeft:this.originalElement.css("marginLeft"),marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom")});this.originalElement.css({marginLeft:0,marginTop:0,marginRight:0,marginBottom:0});this.originalResizeStyle=this.originalElement.css("resize");this.originalElement.css("resize","none");this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"}));this.originalElement.css({margin:this.originalElement.css("margin")});this._proportionallyResize()}this.handles=k.handles||(!c(".ui-resizable-handle",this.element).length?"e,s,se":{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"});if(this.handles.constructor==String){if(this.handles=="all"){this.handles="n,e,s,w,se,sw,ne,nw"}var l=this.handles.split(",");this.handles={};for(var g=0;g l.width),s=a(l.height)&&i.minHeight&&(i.minHeight>l.height);if(h){l.width=i.minWidth}if(s){l.height=i.minHeight}if(t){l.width=i.maxWidth}if(m){l.height=i.maxHeight}var f=this.originalPosition.left+this.originalSize.width,p=this.position.top+this.size.height;var k=/sw|nw|w/.test(q),e=/nw|ne|n/.test(q);if(h&&k){l.left=f-i.minWidth}if(t&&k){l.left=f-i.maxWidth}if(s&&e){l.top=p-i.minHeight}if(m&&e){l.top=p-i.maxHeight}var n=!l.width&&!l.height;if(n&&!l.left&&l.top){l.top=null}else{if(n&&!l.top&&l.left){l.left=null}}return l},_proportionallyResize:function(){var k=this.options;if(!this._proportionallyResizeElements.length){return}var g=this.helper||this.element;for(var f=0;f');var e=c.browser.msie&&c.browser.version<7,g=(e?1:0),h=(e?2:-1);this.helper.addClass(this._helper).css({width:this.element.outerWidth()+h,height:this.element.outerHeight()+h,position:"absolute",left:this.elementOffset.left-g+"px",top:this.elementOffset.top-g+"px",zIndex:++i.zIndex});this.helper.appendTo("body").disableSelection()}else{this.helper=this.element}},_change:{e:function(g,f,e){return{width:this.originalSize.width+f}},w:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{left:i.left+f,width:g.width-f}},n:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{top:i.top+e,height:g.height-e}},s:function(g,f,e){return{height:this.originalSize.height+e}},se:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},sw:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[g,f,e]))},ne:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},nw:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[g,f,e]))}},_propagate:function(f,e){c.ui.plugin.call(this,f,[e,this.ui()]);(f!="resize"&&this._trigger(f,e,this.ui()))},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}});c.extend(c.ui.resizable,{version:"1.8.18"});c.ui.plugin.add("resizable","alsoResize",{start:function(f,g){var e=c(this).data("resizable"),i=e.options;var h=function(j){c(j).each(function(){var k=c(this);k.data("resizable-alsoresize",{width:parseInt(k.width(),10),height:parseInt(k.height(),10),left:parseInt(k.css("left"),10),top:parseInt(k.css("top"),10)})})};if(typeof(i.alsoResize)=="object"&&!i.alsoResize.parentNode){if(i.alsoResize.length){i.alsoResize=i.alsoResize[0];h(i.alsoResize)}else{c.each(i.alsoResize,function(j){h(j)})}}else{h(i.alsoResize)}},resize:function(g,i){var f=c(this).data("resizable"),j=f.options,h=f.originalSize,l=f.originalPosition;var k={height:(f.size.height-h.height)||0,width:(f.size.width-h.width)||0,top:(f.position.top-l.top)||0,left:(f.position.left-l.left)||0},e=function(m,n){c(m).each(function(){var q=c(this),r=c(this).data("resizable-alsoresize"),p={},o=n&&n.length?n:q.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];c.each(o,function(s,u){var t=(r[u]||0)+(k[u]||0);if(t&&t>=0){p[u]=t||null}});q.css(p)})};if(typeof(j.alsoResize)=="object"&&!j.alsoResize.nodeType){c.each(j.alsoResize,function(m,n){e(m,n)})}else{e(j.alsoResize)}},stop:function(e,f){c(this).removeData("resizable-alsoresize")}});c.ui.plugin.add("resizable","animate",{stop:function(i,n){var p=c(this).data("resizable"),j=p.options;var h=p._proportionallyResizeElements,e=h.length&&(/textarea/i).test(h[0].nodeName),f=e&&c.ui.hasScroll(h[0],"left")?0:p.sizeDiff.height,l=e?0:p.sizeDiff.width;var g={width:(p.size.width-l),height:(p.size.height-f)},k=(parseInt(p.element.css("left"),10)+(p.position.left-p.originalPosition.left))||null,m=(parseInt(p.element.css("top"),10)+(p.position.top-p.originalPosition.top))||null;p.element.animate(c.extend(g,m&&k?{top:m,left:k}:{}),{duration:j.animateDuration,easing:j.animateEasing,step:function(){var o={width:parseInt(p.element.css("width"),10),height:parseInt(p.element.css("height"),10),top:parseInt(p.element.css("top"),10),left:parseInt(p.element.css("left"),10)};if(h&&h.length){c(h[0]).css({width:o.width,height:o.height})}p._updateCache(o);p._propagate("resize",i)}})}});c.ui.plugin.add("resizable","containment",{start:function(f,r){var t=c(this).data("resizable"),j=t.options,l=t.element;var g=j.containment,k=(g instanceof c)?g.get(0):(/parent/.test(g))?l.parent().get(0):g;if(!k){return}t.containerElement=c(k);if(/document/.test(g)||g==document){t.containerOffset={left:0,top:0};t.containerPosition={left:0,top:0};t.parentData={element:c(document),left:0,top:0,width:c(document).width(),height:c(document).height()||document.body.parentNode.scrollHeight}}else{var n=c(k),i=[];c(["Top","Right","Left","Bottom"]).each(function(p,o){i[p]=b(n.css("padding"+o))});t.containerOffset=n.offset();t.containerPosition=n.position();t.containerSize={height:(n.innerHeight()-i[3]),width:(n.innerWidth()-i[1])};var q=t.containerOffset,e=t.containerSize.height,m=t.containerSize.width,h=(c.ui.hasScroll(k,"left")?k.scrollWidth:m),s=(c.ui.hasScroll(k)?k.scrollHeight:e);t.parentData={element:k,left:q.left,top:q.top,width:h,height:s}}},resize:function(g,q){var t=c(this).data("resizable"),i=t.options,f=t.containerSize,p=t.containerOffset,m=t.size,n=t.position,r=t._aspectRatio||g.shiftKey,e={top:0,left:0},h=t.containerElement;if(h[0]!=document&&(/static/).test(h.css("position"))){e=p}if(n.left<(t._helper?p.left:0)){t.size.width=t.size.width+(t._helper?(t.position.left-p.left):(t.position.left-e.left));if(r){t.size.height=t.size.width/i.aspectRatio}t.position.left=i.helper?p.left:0}if(n.top<(t._helper?p.top:0)){t.size.height=t.size.height+(t._helper?(t.position.top-p.top):t.position.top);if(r){t.size.width=t.size.height*i.aspectRatio}t.position.top=t._helper?p.top:0}t.offset.left=t.parentData.left+t.position.left;t.offset.top=t.parentData.top+t.position.top;var l=Math.abs((t._helper?t.offset.left-e.left:(t.offset.left-e.left))+t.sizeDiff.width),s=Math.abs((t._helper?t.offset.top-e.top:(t.offset.top-p.top))+t.sizeDiff.height);var k=t.containerElement.get(0)==t.element.parent().get(0),j=/relative|absolute/.test(t.containerElement.css("position"));if(k&&j){l-=t.parentData.left}if(l+t.size.width>=t.parentData.width){t.size.width=t.parentData.width-l;if(r){t.size.height=t.size.width/t.aspectRatio}}if(s+t.size.height>=t.parentData.height){t.size.height=t.parentData.height-s;if(r){t.size.width=t.size.height*t.aspectRatio}}},stop:function(f,n){var q=c(this).data("resizable"),g=q.options,l=q.position,m=q.containerOffset,e=q.containerPosition,i=q.containerElement;var j=c(q.helper),r=j.offset(),p=j.outerWidth()-q.sizeDiff.width,k=j.outerHeight()-q.sizeDiff.height;if(q._helper&&!g.animate&&(/relative/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}if(q._helper&&!g.animate&&(/static/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}}});c.ui.plugin.add("resizable","ghost",{start:function(g,h){var e=c(this).data("resizable"),i=e.options,f=e.size;e.ghost=e.originalElement.clone();e.ghost.css({opacity:0.25,display:"block",position:"relative",height:f.height,width:f.width,margin:0,left:0,top:0}).addClass("ui-resizable-ghost").addClass(typeof i.ghost=="string"?i.ghost:"");e.ghost.appendTo(e.helper)},resize:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost){e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})}},stop:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost&&e.helper){e.helper.get(0).removeChild(e.ghost.get(0))}}});c.ui.plugin.add("resizable","grid",{resize:function(e,m){var p=c(this).data("resizable"),h=p.options,k=p.size,i=p.originalSize,j=p.originalPosition,n=p.axis,l=h._aspectRatio||e.shiftKey;h.grid=typeof h.grid=="number"?[h.grid,h.grid]:h.grid;var g=Math.round((k.width-i.width)/(h.grid[0]||1))*(h.grid[0]||1),f=Math.round((k.height-i.height)/(h.grid[1]||1))*(h.grid[1]||1);if(/^(se|s|e)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f}else{if(/^(ne)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f}else{if(/^(sw)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.left=j.left-g}else{p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f;p.position.left=j.left-g}}}}});var b=function(e){return parseInt(e,10)||0};var a=function(e){return !isNaN(parseInt(e,10))}})(jQuery);/*!
+ * jQuery hashchange event - v1.3 - 7/21/2010
+ * http://benalman.com/projects/jquery-hashchange-plugin/
+ *
+ * Copyright (c) 2010 "Cowboy" Ben Alman
+ * Dual licensed under the MIT and GPL licenses.
+ * http://benalman.com/about/license/
+ */
+(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$('').hide().one("load",function(){r||l(a());n()}).attr("src",r||"javascript:0").insertAfter("body")[0].contentWindow;h.onpropertychange=function(){try{if(event.propertyName==="title"){q.document.title=h.title}}catch(s){}}}};j.stop=k;o=function(){return a(q.location.href)};l=function(v,s){var u=q.document,t=$.fn[c].domain;if(v!==s){u.title=h.title;u.open();t&&u.write('
+
+
+
+
+
+
+
+
+
+
diff --git a/SQCSim2021/external/sfml251-32/doc/html/menudata.js b/SQCSim2021/external/sfml251-32/doc/html/menudata.js
new file mode 100644
index 0000000..f9f10cb
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/menudata.js
@@ -0,0 +1,149 @@
+/*
+@ @licstart The following is the entire license notice for the
+JavaScript code in this file.
+
+Copyright (C) 1997-2017 by Dimitri van Heesch
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+@licend The above is the entire license notice
+for the JavaScript code in this file
+*/
+var menudata={children:[
+{text:"Main Page",url:"index.html"},
+{text:"Related Pages",url:"pages.html"},
+{text:"Modules",url:"modules.html"},
+{text:"Namespaces",url:"namespaces.html",children:[
+{text:"Namespace List",url:"namespaces.html"},
+{text:"Namespace Members",url:"namespacemembers.html",children:[
+{text:"All",url:"namespacemembers.html"},
+{text:"Typedefs",url:"namespacemembers_type.html"}]}]},
+{text:"Classes",url:"annotated.html",children:[
+{text:"Class List",url:"annotated.html"},
+{text:"Class Index",url:"classes.html"},
+{text:"Class Hierarchy",url:"hierarchy.html"},
+{text:"Class Members",url:"functions.html",children:[
+{text:"All",url:"functions.html",children:[
+{text:"a",url:"functions.html#index_a"},
+{text:"b",url:"functions_b.html#index_b"},
+{text:"c",url:"functions_c.html#index_c"},
+{text:"d",url:"functions_d.html#index_d"},
+{text:"e",url:"functions_e.html#index_e"},
+{text:"f",url:"functions_f.html#index_f"},
+{text:"g",url:"functions_g.html#index_g"},
+{text:"h",url:"functions_h.html#index_h"},
+{text:"i",url:"functions_i.html#index_i"},
+{text:"j",url:"functions_j.html#index_j"},
+{text:"k",url:"functions_k.html#index_k"},
+{text:"l",url:"functions_l.html#index_l"},
+{text:"m",url:"functions_m.html#index_m"},
+{text:"n",url:"functions_n.html#index_n"},
+{text:"o",url:"functions_o.html#index_o"},
+{text:"p",url:"functions_p.html#index_p"},
+{text:"q",url:"functions_q.html#index_q"},
+{text:"r",url:"functions_r.html#index_r"},
+{text:"s",url:"functions_s.html#index_s"},
+{text:"t",url:"functions_t.html#index_t"},
+{text:"u",url:"functions_u.html#index_u"},
+{text:"v",url:"functions_v.html#index_v"},
+{text:"w",url:"functions_w.html#index_w"},
+{text:"x",url:"functions_x.html#index_x"},
+{text:"y",url:"functions_y.html#index_y"},
+{text:"z",url:"functions_z.html#index_z"},
+{text:"~",url:"functions_0x7e.html#index_0x7e"}]},
+{text:"Functions",url:"functions_func.html",children:[
+{text:"a",url:"functions_func.html#index_a"},
+{text:"b",url:"functions_func_b.html#index_b"},
+{text:"c",url:"functions_func_c.html#index_c"},
+{text:"d",url:"functions_func_d.html#index_d"},
+{text:"e",url:"functions_func_e.html#index_e"},
+{text:"f",url:"functions_func_f.html#index_f"},
+{text:"g",url:"functions_func_g.html#index_g"},
+{text:"h",url:"functions_func_h.html#index_h"},
+{text:"i",url:"functions_func_i.html#index_i"},
+{text:"k",url:"functions_func_k.html#index_k"},
+{text:"l",url:"functions_func_l.html#index_l"},
+{text:"m",url:"functions_func_m.html#index_m"},
+{text:"n",url:"functions_func_n.html#index_n"},
+{text:"o",url:"functions_func_o.html#index_o"},
+{text:"p",url:"functions_func_p.html#index_p"},
+{text:"r",url:"functions_func_r.html#index_r"},
+{text:"s",url:"functions_func_s.html#index_s"},
+{text:"t",url:"functions_func_t.html#index_t"},
+{text:"u",url:"functions_func_u.html#index_u"},
+{text:"v",url:"functions_func_v.html#index_v"},
+{text:"w",url:"functions_func_w.html#index_w"},
+{text:"z",url:"functions_func_z.html#index_z"},
+{text:"~",url:"functions_func_0x7e.html#index_0x7e"}]},
+{text:"Variables",url:"functions_vars.html",children:[
+{text:"a",url:"functions_vars.html#index_a"},
+{text:"b",url:"functions_vars.html#index_b"},
+{text:"c",url:"functions_vars.html#index_c"},
+{text:"d",url:"functions_vars.html#index_d"},
+{text:"f",url:"functions_vars.html#index_f"},
+{text:"g",url:"functions_vars.html#index_g"},
+{text:"h",url:"functions_vars.html#index_h"},
+{text:"i",url:"functions_vars.html#index_i"},
+{text:"j",url:"functions_vars.html#index_j"},
+{text:"k",url:"functions_vars.html#index_k"},
+{text:"l",url:"functions_vars.html#index_l"},
+{text:"m",url:"functions_vars.html#index_m"},
+{text:"n",url:"functions_vars.html#index_n"},
+{text:"o",url:"functions_vars.html#index_o"},
+{text:"p",url:"functions_vars.html#index_p"},
+{text:"r",url:"functions_vars.html#index_r"},
+{text:"s",url:"functions_vars.html#index_s"},
+{text:"t",url:"functions_vars.html#index_t"},
+{text:"u",url:"functions_vars.html#index_u"},
+{text:"v",url:"functions_vars.html#index_v"},
+{text:"w",url:"functions_vars.html#index_w"},
+{text:"x",url:"functions_vars.html#index_x"},
+{text:"y",url:"functions_vars.html#index_y"},
+{text:"z",url:"functions_vars.html#index_z"}]},
+{text:"Typedefs",url:"functions_type.html"},
+{text:"Enumerations",url:"functions_enum.html"},
+{text:"Enumerator",url:"functions_eval.html",children:[
+{text:"a",url:"functions_eval.html#index_a"},
+{text:"b",url:"functions_eval_b.html#index_b"},
+{text:"c",url:"functions_eval_c.html#index_c"},
+{text:"d",url:"functions_eval_d.html#index_d"},
+{text:"e",url:"functions_eval_e.html#index_e"},
+{text:"f",url:"functions_eval_f.html#index_f"},
+{text:"g",url:"functions_eval_g.html#index_g"},
+{text:"h",url:"functions_eval_h.html#index_h"},
+{text:"i",url:"functions_eval_i.html#index_i"},
+{text:"j",url:"functions_eval_j.html#index_j"},
+{text:"k",url:"functions_eval_k.html#index_k"},
+{text:"l",url:"functions_eval_l.html#index_l"},
+{text:"m",url:"functions_eval_m.html#index_m"},
+{text:"n",url:"functions_eval_n.html#index_n"},
+{text:"o",url:"functions_eval_o.html#index_o"},
+{text:"p",url:"functions_eval_p.html#index_p"},
+{text:"q",url:"functions_eval_q.html#index_q"},
+{text:"r",url:"functions_eval_r.html#index_r"},
+{text:"s",url:"functions_eval_s.html#index_s"},
+{text:"t",url:"functions_eval_t.html#index_t"},
+{text:"u",url:"functions_eval_u.html#index_u"},
+{text:"v",url:"functions_eval_v.html#index_v"},
+{text:"w",url:"functions_eval_w.html#index_w"},
+{text:"x",url:"functions_eval_x.html#index_x"},
+{text:"y",url:"functions_eval_y.html#index_y"},
+{text:"z",url:"functions_eval_z.html#index_z"}]},
+{text:"Related Functions",url:"functions_rela.html"}]}]},
+{text:"Files",url:"files.html",children:[
+{text:"File List",url:"files.html"},
+{text:"File Members",url:"globals.html",children:[
+{text:"All",url:"globals.html"},
+{text:"Macros",url:"globals_defs.html"}]}]}]}
diff --git a/SQCSim2021/external/sfml251-32/doc/html/modules.html b/SQCSim2021/external/sfml251-32/doc/html/modules.html
new file mode 100644
index 0000000..1870bfa
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/doc/html/modules.html
@@ -0,0 +1,55 @@
+
+
+
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all modules:
+
+ Audio module Sounds, streaming (musics or custom sources), recording, spatialization Graphics module 2D graphics module: sprites, text, shapes, .. Network module Socket-based communication, utilities and higher-level network protocols (HTTP, FTP) System module Base module of SFML, defining various utilities Window module Provides OpenGL-based windows, and abstractions for events and input handling
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented namespace members with links to the namespaces they belong to:
+
SFML - Simple and Fast Multimedia Library
+ SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all documented namespaces with brief descriptions:
+
[detail level 1 2 ]
+ ▼ N sf N Glsl Namespace with GLSL types
+
+
SFML - Simple and Fast Multimedia Library
+
+
+
Namespace with GLSL types.
+More...
+
+typedef Vector2 < float > Vec2 2D float vector (vec2 in GLSL) More... typedef Vector2 < int > Ivec2 2D int vector (ivec2 in GLSL) More... typedef Vector2 < bool > Bvec2 2D bool vector (bvec2 in GLSL) More... typedef Vector3 < float > Vec3 3D float vector (vec3 in GLSL) More... typedef Vector3 < int > Ivec3 3D int vector (ivec3 in GLSL) More... typedef Vector3 < bool > Bvec3 3D bool vector (bvec3 in GLSL) More... typedef implementation defined Vec4 4D float vector (vec4 in GLSL) More... typedef implementation defined Ivec4 4D int vector (ivec4 in GLSL) More... typedef implementation defined Bvec4 4D bool vector (bvec4 in GLSL) More... typedef implementation defined Mat3 3x3 float matrix (mat3 in GLSL) More... typedef implementation defined Mat4 4x4 float matrix (mat4 in GLSL) More...
+
+
Namespace with GLSL types.
+
The sf::Glsl namespace contains types that match their equivalents in GLSL, the OpenGL shading language. These types are exclusively used by the sf::Shader class.
+
Types that already exist in SFML, such as sf::Vector2<T> and sf::Vector3<T> , are reused as typedefs, so you can use the types in this namespace as well as the original ones. Others are newly defined, such as Glsl::Vec4 or Glsl::Mat3 . Their actual type is an implementation detail and should not be used.
+
All vector types support a default constructor that initializes every component to zero, in addition to a constructor with one parameter for each component. The components are stored in member variables called x, y, z, and w.
+
All matrix types support a constructor with a float* parameter that points to a float array of the appropriate size (that is, 9 in a 3x3 matrix, 16 in a 4x4 matrix). Furthermore, they can be converted from sf::Transform objects.
+
See also sf::Shader
+
+
+
◆
+
+
+
+
+
2D bool vector (bvec2 in GLSL)
+
+
Definition at line 76 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
3D bool vector (bvec3 in GLSL)
+
+
Definition at line 94 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
4D bool vector (bvec4 in GLSL)
+
+
Definition at line 130 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
2D int vector (ivec2 in GLSL)
+
+
Definition at line 70 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
3D int vector (ivec3 in GLSL)
+
+
Definition at line 88 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
4D int vector (ivec4 in GLSL)
+
4D int vectors can be implicitly converted from sf::Color instances. Each color channel remains unchanged inside the integer interval [0, 255].
+
Definition at line 124 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
3x3 float matrix (mat3 in GLSL)
+
The matrix can be constructed from an array with 3x3 elements, aligned in column-major order. For example, a translation by (x, y) looks as follows:
float array[9] =
{
1, 0, 0,
0, 1, 0,
x, y, 1
};
Mat3 can also be implicitly converted from sf::Transform :
+
Definition at line 155 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
4x4 float matrix (mat4 in GLSL)
+
The matrix can be constructed from an array with 4x4 elements, aligned in column-major order. For example, a translation by (x, y, z) looks as follows:
float array[16] =
{
1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
x, y, z, 1
};
Mat4 can also be implicitly converted from sf::Transform :
+
Definition at line 181 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
2D float vector (vec2 in GLSL)
+
+
Definition at line 64 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
3D float vector (vec3 in GLSL)
+
+
Definition at line 82 of file Glsl.hpp .
+
+
+
+
+
◆
+
+
+
+
+
4D float vector (vec4 in GLSL)
+
4D float vectors can be implicitly converted from sf::Color instances. Each color channel is normalized from integers in [0, 255] to floating point values in [0, 1].
+
Definition at line 110 of file Glsl.hpp .
+
+
+
+
SFML - Simple and Fast Multimedia Library
+
+
Here is a list of all related documentation pages:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::BlendMode , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Blending modes for drawing.
+ More...
+
+
#include <BlendMode.hpp >
+
+enum Factor { Zero ,
+One ,
+SrcColor ,
+OneMinusSrcColor ,
+DstColor ,
+OneMinusDstColor ,
+SrcAlpha ,
+OneMinusSrcAlpha ,
+DstAlpha ,
+OneMinusDstAlpha
+ Enumeration of the blending factors. More... enum Equation { Add ,
+Subtract ,
+ReverseSubtract
+ } Enumeration of the blending equations. More...
+
+
Blending modes for drawing.
+
sf::BlendMode is a class that represents a blend mode.
+
A blend mode determines how the colors of an object you draw are mixed with the colors that are already in the buffer.
+
The class is composed of 6 components, each of which has its own public member variable:
+
The source factor specifies how the pixel you are drawing contributes to the final color. The destination factor specifies how the pixel already drawn in the buffer contributes to the final color.
+
The color channels RGB (red, green, blue; simply referred to as color) and A (alpha; the transparency) can be treated separately. This separation can be useful for specific blend modes, but most often you won't need it and will simply treat the color as a single unit.
+
The blend factors and equations correspond to their OpenGL equivalents. In general, the color of the resulting pixel is calculated according to the following formula (src is the color of the source pixel, dst the color of the destination pixel, the other variables correspond to the public members, with the equations being + or - operators):
All factors and colors are represented as floating point numbers between 0 and 1. Where necessary, the result is clamped to fit in that range.
+
The most common blending modes are defined as constants in the sf namespace:
+
In SFML, a blend mode can be specified every time you draw a sf::Drawable object to a render target. It is part of the sf::RenderStates compound that is passed to the member function sf::RenderTarget::draw() .
+
See also sf::RenderStates , sf::RenderTarget
+
+
Definition at line 41 of file BlendMode.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the blending equations.
+
The equations are mapped directly to their OpenGL equivalents, specified by glBlendEquation() or glBlendEquationSeparate().
+
+Enumerator Pixel = Src * SrcFactor + Dst * DstFactor.
+Pixel = Src * SrcFactor - Dst * DstFactor.
+Pixel = Dst * DstFactor - Src * SrcFactor.
+
+
+
Definition at line 69 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of the blending factors.
+
The factors are mapped directly to their OpenGL equivalents, specified by glBlendFunc() or glBlendFuncSeparate().
+
+Enumerator (0, 0, 0, 0)
+(1, 1, 1, 1)
+(src.r, src.g, src.b, src.a)
+(1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
+(dst.r, dst.g, dst.b, dst.a)
+(1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
+(src.a, src.a, src.a, src.a)
+(1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
+(dst.a, dst.a, dst.a, dst.a)
+(1, 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)
+
+
+
Definition at line 49 of file BlendMode.hpp .
+
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ sf::BlendMode::BlendMode
+ (
+ )
+
+
+
+
+
Default constructor.
+
Constructs a blending mode that does alpha blending.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ sf::BlendMode::BlendMode
+ (
+ Factor sourceFactor ,
+
+ Factor destinationFactor ,
+
+ Equation blendEquation = Add
+
+ )
+
+
+
+
+
Construct the blend mode given the factors and equation.
+
This constructor uses the same factors and equation for both color and alpha components. It also defaults to the Add equation.
+
Parameters
+
+ sourceFactor Specifies how to compute the source factor for the color and alpha channels. destinationFactor Specifies how to compute the destination factor for the color and alpha channels. blendEquation Specifies how to combine the source and destination colors and alpha.
+
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ sf::BlendMode::BlendMode
+ (
+ Factor colorSourceFactor ,
+
+ Factor colorDestinationFactor ,
+
+ Equation colorBlendEquation ,
+
+ Factor alphaSourceFactor ,
+
+ Factor alphaDestinationFactor ,
+
+ Equation alphaBlendEquation
+
+ )
+
+
+
+
+
Construct the blend mode given the factors and equation.
+
Parameters
+
+ colorSourceFactor Specifies how to compute the source factor for the color channels. colorDestinationFactor Specifies how to compute the destination factor for the color channels. colorBlendEquation Specifies how to combine the source and destination colors. alphaSourceFactor Specifies how to compute the source factor. alphaDestinationFactor Specifies how to compute the destination factor. alphaBlendEquation Specifies how to combine the source and destination alphas.
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator!=
+ (
+ const BlendMode &
+ left ,
+
+ const BlendMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the != operator.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns True if blending modes are different, false if they are equal
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool operator==
+ (
+ const BlendMode &
+ left ,
+
+ const BlendMode &
+ right
+
+ )
+
+
+
+
+related
+
+
+
+
+
Overload of the == operator.
+
Parameters
+
+ left Left operand right Right operand
+
+
+
Returns True if blending modes are equal, false if they are different
+
+
+
+
+
+
◆
+
+
+
+
+
+ Factor sf::BlendMode::alphaDstFactor
+
+
+
+
Destination blending factor for the alpha channel.
+
+
Definition at line 119 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Equation sf::BlendMode::alphaEquation
+
+
+
+
Blending equation for the alpha channel.
+
+
Definition at line 120 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Factor sf::BlendMode::alphaSrcFactor
+
+
+
+
Source blending factor for the alpha channel.
+
+
Definition at line 118 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Factor sf::BlendMode::colorDstFactor
+
+
+
+
Destination blending factor for the color channels.
+
+
Definition at line 116 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Equation sf::BlendMode::colorEquation
+
+
+
+
Blending equation for the color channels.
+
+
Definition at line 117 of file BlendMode.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Factor sf::BlendMode::colorSrcFactor
+
+
+
+
Source blending factor for the color channels.
+
+
Definition at line 115 of file BlendMode.hpp .
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::ContextSettings , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure defining the settings of the OpenGL context attached to a window.
+ More...
+
+
#include <ContextSettings.hpp >
+
+ ContextSettings (unsigned int depth=0, unsigned int stencil=0, unsigned int antialiasing=0, unsigned int major=1, unsigned int minor=1, unsigned int attributes=Default , bool sRgb=false) Default constructor. More...
+
+
Structure defining the settings of the OpenGL context attached to a window.
+
ContextSettings allows to define several advanced settings of the OpenGL context attached to a window.
+
All these settings with the exception of the compatibility flag and anti-aliasing level have no impact on the regular SFML rendering (graphics module), so you may need to use this structure only if you're using SFML as a windowing system for custom OpenGL rendering.
+
The depthBits and stencilBits members define the number of bits per pixel requested for the (respectively) depth and stencil buffers.
+
antialiasingLevel represents the requested number of multisampling levels for anti-aliasing.
+
majorVersion and minorVersion define the version of the OpenGL context that you want. Only versions greater or equal to 3.0 are relevant; versions lesser than 3.0 are all handled the same way (i.e. you can use any version < 3.0 if you don't want an OpenGL 3 context).
+
When requesting a context with a version greater or equal to 3.2, you have the option of specifying whether the context should follow the core or compatibility profile of all newer (>= 3.2) OpenGL specifications. For versions 3.0 and 3.1 there is only the core profile. By default a compatibility context is created. You only need to specify the core flag if you want a core profile context to use with your own OpenGL rendering. Warning: The graphics module will not function if you request a core profile context. Make sure the attributes are set to Default if you want to use the graphics module.
+
Setting the debug attribute flag will request a context with additional debugging features enabled. Depending on the system, this might be required for advanced OpenGL debugging. OpenGL debugging is disabled by default.
+
Special Note for OS X: Apple only supports choosing between either a legacy context (OpenGL 2.1) or a core context (OpenGL version depends on the operating system version but is at least 3.2). Compatibility contexts are not supported. Further information is available on the OpenGL Capabilities Tables page. OS X also currently does not support debug contexts.
+
Please note that these values are only a hint. No failure will be reported if one or more of these values are not supported by the system; instead, SFML will try to find the closest valid match. You can then retrieve the settings that the window actually used to create its context, with Window::getSettings() .
+
+
Definition at line 37 of file ContextSettings.hpp .
+
+
+
◆
+
+
+
+
+
Enumeration of the context attribute flags.
+
+Enumerator Non-debug, compatibility context (this and the core attribute are mutually exclusive)
+Core attribute.
+Debug attribute.
+
+
+
Definition at line 43 of file ContextSettings.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ sf::ContextSettings::ContextSettings
+ (
+ unsigned int
+ depth = 0,
+
+ unsigned int
+ stencil = 0,
+
+ unsigned int
+ antialiasing = 0,
+
+ unsigned int
+ major = 1,
+
+ unsigned int
+ minor = 1,
+
+ unsigned int
+ attributes = Default
+
+ bool
+ sRgb = false
+
+ )
+
+
+
+
+inline explicit
+
+
+
+
+
Default constructor.
+
Parameters
+
+ depth Depth buffer bits stencil Stencil buffer bits antialiasing Antialiasing level major Major number of the context version minor Minor number of the context version attributes Attribute flags of the context sRgb sRGB capable framebuffer
+
+
+
+
Definition at line 62 of file ContextSettings.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::ContextSettings::antialiasingLevel
+
+
+
+
+
+
◆
+
+
+
+
+
+ Uint32 sf::ContextSettings::attributeFlags
+
+
+
+
+
The attribute flags to create the context with.
+
+
Definition at line 81 of file ContextSettings.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::ContextSettings::depthBits
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::ContextSettings::majorVersion
+
+
+
+
+
Major number of the context version to create.
+
+
Definition at line 79 of file ContextSettings.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::ContextSettings::minorVersion
+
+
+
+
+
Minor number of the context version to create.
+
+
Definition at line 80 of file ContextSettings.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::ContextSettings::sRgbCapable
+
+
+
+
+
Whether the context framebuffer is sRGB capable.
+
+
Definition at line 82 of file ContextSettings.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::ContextSettings::stencilBits
+
+
+
+
+
The documentation for this class was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::JoystickButtonEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Joystick buttons events parameters (JoystickButtonPressed, JoystickButtonReleased)
+ More...
+
+
#include <Event.hpp >
+
+
+
Joystick buttons events parameters (JoystickButtonPressed, JoystickButtonReleased)
+
+
Definition at line 154 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::JoystickButtonEvent::button
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::JoystickButtonEvent::joystickId
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::JoystickConnectEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Joystick connection events parameters (JoystickConnected, JoystickDisconnected)
+ More...
+
+
#include <Event.hpp >
+
+
+
Joystick connection events parameters (JoystickConnected, JoystickDisconnected)
+
+
Definition at line 133 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::JoystickConnectEvent::joystickId
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::JoystickMoveEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Joystick axis move event parameters (JoystickMoved)
+ More...
+
+
#include <Event.hpp >
+
+
+
Joystick axis move event parameters (JoystickMoved)
+
+
Definition at line 142 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
Axis on which the joystick moved.
+
+
Definition at line 145 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::JoystickMoveEvent::joystickId
+
+
+
+
+
+
◆
+
+
+
+
+
+ float sf::Event::JoystickMoveEvent::position
+
+
+
+
+
New position on the axis (in range [-100 .. 100])
+
+
Definition at line 146 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::KeyEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Keyboard event parameters (KeyPressed, KeyReleased)
+ More...
+
+
#include <Event.hpp >
+
+
+
Keyboard event parameters (KeyPressed, KeyReleased)
+
+
Definition at line 62 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ bool sf::Event::KeyEvent::alt
+
+
+
+
+
Is the Alt key pressed?
+
+
Definition at line 65 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
Code of the key that has been pressed.
+
+
Definition at line 64 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Event::KeyEvent::control
+
+
+
+
+
Is the Control key pressed?
+
+
Definition at line 66 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Event::KeyEvent::shift
+
+
+
+
+
Is the Shift key pressed?
+
+
Definition at line 67 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ bool sf::Event::KeyEvent::system
+
+
+
+
+
Is the System key pressed?
+
+
Definition at line 68 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::MouseButtonEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Mouse buttons events parameters (MouseButtonPressed, MouseButtonReleased)
+ More...
+
+
#include <Event.hpp >
+
+Mouse::Button button Code of the button that has been pressed. More... int x X position of the mouse pointer, relative to the left of the owner window. More... int y Y position of the mouse pointer, relative to the top of the owner window. More...
+
+
Mouse buttons events parameters (MouseButtonPressed, MouseButtonReleased)
+
+
Definition at line 95 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
Code of the button that has been pressed.
+
+
Definition at line 97 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseButtonEvent::x
+
+
+
+
+
X position of the mouse pointer, relative to the left of the owner window.
+
+
Definition at line 98 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseButtonEvent::y
+
+
+
+
+
Y position of the mouse pointer, relative to the top of the owner window.
+
+
Definition at line 99 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::MouseMoveEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Mouse move event parameters (MouseMoved)
+ More...
+
+
#include <Event.hpp >
+
+int x X position of the mouse pointer, relative to the left of the owner window. More... int y Y position of the mouse pointer, relative to the top of the owner window. More...
+
+
Mouse move event parameters (MouseMoved)
+
+
Definition at line 84 of file Event.hpp .
+
+
+
+
+
+
+
+
+ int sf::Event::MouseMoveEvent::x
+
+
+
+
+
X position of the mouse pointer, relative to the left of the owner window.
+
+
Definition at line 86 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseMoveEvent::y
+
+
+
+
+
Y position of the mouse pointer, relative to the top of the owner window.
+
+
Definition at line 87 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::MouseWheelEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Mouse wheel events parameters (MouseWheelMoved)
+ More...
+
+
#include <Event.hpp >
+
+int delta Number of ticks the wheel has moved (positive is up, negative is down) More... int x X position of the mouse pointer, relative to the left of the owner window. More... int y Y position of the mouse pointer, relative to the top of the owner window. More...
+
+
Mouse wheel events parameters (MouseWheelMoved)
+
Deprecated: This event is deprecated and potentially inaccurate. Use MouseWheelScrollEvent instead.
+
+
Definition at line 109 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ int sf::Event::MouseWheelEvent::delta
+
+
+
+
+
Number of ticks the wheel has moved (positive is up, negative is down)
+
+
Definition at line 111 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseWheelEvent::x
+
+
+
+
+
X position of the mouse pointer, relative to the left of the owner window.
+
+
Definition at line 112 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseWheelEvent::y
+
+
+
+
+
Y position of the mouse pointer, relative to the top of the owner window.
+
+
Definition at line 113 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::MouseWheelScrollEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Mouse wheel events parameters (MouseWheelScrolled)
+ More...
+
+
#include <Event.hpp >
+
+Mouse::Wheel wheel Which wheel (for mice with multiple ones) More... float delta Wheel offset (positive is up/left, negative is down/right). High-precision mice may use non-integral offsets. More... int x X position of the mouse pointer, relative to the left of the owner window. More... int y Y position of the mouse pointer, relative to the top of the owner window. More...
+
+
Mouse wheel events parameters (MouseWheelScrolled)
+
+
Definition at line 120 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ float sf::Event::MouseWheelScrollEvent::delta
+
+
+
+
+
Wheel offset (positive is up/left, negative is down/right). High-precision mice may use non-integral offsets.
+
+
Definition at line 123 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ Mouse::Wheel sf::Event::MouseWheelScrollEvent::wheel
+
+
+
+
Which wheel (for mice with multiple ones)
+
+
Definition at line 122 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseWheelScrollEvent::x
+
+
+
+
+
X position of the mouse pointer, relative to the left of the owner window.
+
+
Definition at line 124 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::MouseWheelScrollEvent::y
+
+
+
+
+
Y position of the mouse pointer, relative to the top of the owner window.
+
+
Definition at line 125 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::SensorEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Sensor event parameters (SensorChanged)
+ More...
+
+
#include <Event.hpp >
+
+
+
Sensor event parameters (SensorChanged)
+
+
Definition at line 175 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
Type of the sensor.
+
+
Definition at line 177 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ float sf::Event::SensorEvent::x
+
+
+
+
+
Current value of the sensor on X axis.
+
+
Definition at line 178 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ float sf::Event::SensorEvent::y
+
+
+
+
+
Current value of the sensor on Y axis.
+
+
Definition at line 179 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ float sf::Event::SensorEvent::z
+
+
+
+
+
Current value of the sensor on Z axis.
+
+
Definition at line 180 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::SizeEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Size events parameters (Resized)
+ More...
+
+
#include <Event.hpp >
+
+
+
Size events parameters (Resized)
+
+
Definition at line 52 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::SizeEvent::height
+
+
+
+
+
New height, in pixels.
+
+
Definition at line 55 of file Event.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::SizeEvent::width
+
+
+
+
+
New width, in pixels.
+
+
Definition at line 54 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::TextEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Text event parameters (TextEntered)
+ More...
+
+
#include <Event.hpp >
+
+Uint32 unicode UTF-32 Unicode value of the character. More...
+
+
Text event parameters (TextEntered)
+
+
Definition at line 75 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ Uint32 sf::Event::TextEvent::unicode
+
+
+
+
+
UTF-32 Unicode value of the character.
+
+
Definition at line 77 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Event::TouchEvent , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Touch events parameters (TouchBegan, TouchMoved, TouchEnded)
+ More...
+
+
#include <Event.hpp >
+
+unsigned int finger Index of the finger in case of multi-touch events. More... int x X position of the touch, relative to the left of the owner window. More... int y Y position of the touch, relative to the top of the owner window. More...
+
+
Touch events parameters (TouchBegan, TouchMoved, TouchEnded)
+
+
Definition at line 164 of file Event.hpp .
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Event::TouchEvent::finger
+
+
+
+
+
Index of the finger in case of multi-touch events.
+
+
Definition at line 166 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::TouchEvent::x
+
+
+
+
+
X position of the touch, relative to the left of the owner window.
+
+
Definition at line 167 of file Event.hpp .
+
+
+
+
+
+
+
+
+
+
+ int sf::Event::TouchEvent::y
+
+
+
+
+
Y position of the touch, relative to the top of the owner window.
+
+
Definition at line 168 of file Event.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Font::Info , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Holds various information about a font.
+ More...
+
+
#include <Font.hpp >
+
+
+
Holds various information about a font.
+
+
Definition at line 58 of file Font.hpp .
+
+
+
◆
+
+
+
+
+
+ std::string sf::Font::Info::family
+
+
+
+
+
The font family.
+
+
Definition at line 60 of file Font.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Joystick::Identification , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure holding a joystick's identification.
+ More...
+
+
#include <Joystick.hpp >
+
+
+
Structure holding a joystick's identification.
+
+
Definition at line 76 of file Joystick.hpp .
+
+
+
◆
+
+
+
+
+
+ String sf::Joystick::Identification::name
+
+
+
+
Name of the joystick.
+
+
Definition at line 80 of file Joystick.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Joystick::Identification::productId
+
+
+
+
+
Product identifier.
+
+
Definition at line 82 of file Joystick.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::Joystick::Identification::vendorId
+
+
+
+
+
Manufacturer identifier.
+
+
Definition at line 81 of file Joystick.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::Music::Span< T > , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure defining a time range using the template type.
+ More...
+
+
#include <Music.hpp >
+
+
+
template<typename T>
+
+
Structure defining a time range using the template type.
+
+
Definition at line 57 of file Music.hpp .
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+
+
Default constructor.
+
+
Definition at line 63 of file Music.hpp .
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+
+
Initialization constructor.
+
Parameters
+
+ off Initial Offset len Initial Length
+
+
+
+
Definition at line 75 of file Music.hpp .
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
The length of the time range.
+
+
Definition at line 83 of file Music.hpp .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
The beginning offset of the time range.
+
+
Definition at line 82 of file Music.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
Special type that can be passed to setUniform() , and that represents the texture of the object being drawn.
+ More...
+
+
#include <Shader.hpp >
+
+
Special type that can be passed to setUniform() , and that represents the texture of the object being drawn.
+
See also setUniform(const std::string&, CurrentTextureType)
+
+
Definition at line 74 of file Shader.hpp .
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundFileReader::Info , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure holding the audio properties of a sound file.
+ More...
+
+
#include <SoundFileReader.hpp >
+
+
+
Structure holding the audio properties of a sound file.
+
+
Definition at line 51 of file SoundFileReader.hpp .
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundFileReader::Info::channelCount
+
+
+
+
+
+
◆
+
+
+
+
+
+ Uint64 sf::SoundFileReader::Info::sampleCount
+
+
+
+
+
+
◆
+
+
+
+
+
+ unsigned int sf::SoundFileReader::Info::sampleRate
+
+
+
+
+
Samples rate of the sound, in samples per second.
+
+
Definition at line 55 of file SoundFileReader.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
SFML - Simple and Fast Multimedia Library
+
+
+
This is the complete list of members for sf::SoundStream::Chunk , including all inherited members.
+
SFML - Simple and Fast Multimedia Library
+
+
+
Structure defining a chunk of audio data to stream.
+ More...
+
+
#include <SoundStream.hpp >
+
+
+
Structure defining a chunk of audio data to stream.
+
+
Definition at line 53 of file SoundStream.hpp .
+
+
+
◆
+
+
+
+
+
+ std::size_t sf::SoundStream::Chunk::sampleCount
+
+
+
+
+
Number of samples pointed by Samples.
+
+
Definition at line 56 of file SoundStream.hpp .
+
+
+
+
+
◆
+
+
+
+
+
+ const Int16* sf::SoundStream::Chunk::samples
+
+
+
+
+
Pointer to the audio samples.
+
+
Definition at line 55 of file SoundStream.hpp .
+
+
+
+
The documentation for this struct was generated from the following file:
+
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Print a FTP response into a standard output stream
+///
+////////////////////////////////////////////////////////////
+std::ostream& operator <<(std::ostream& stream, const sf::Ftp::Response& response)
+{
+ return stream << response.getStatus() << response.getMessage();
+}
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Choose the server address
+ sf::IpAddress address;
+ do
+ {
+ std::cout << "Enter the FTP server address: ";
+ std::cin >> address;
+ }
+ while (address == sf::IpAddress::None);
+
+ // Connect to the server
+ sf::Ftp server;
+ sf::Ftp::Response connectResponse = server.connect(address);
+ std::cout << connectResponse << std::endl;
+ if (!connectResponse.isOk())
+ return EXIT_FAILURE;
+
+ // Ask for user name and password
+ std::string user, password;
+ std::cout << "User name: ";
+ std::cin >> user;
+ std::cout << "Password: ";
+ std::cin >> password;
+
+ // Login to the server
+ sf::Ftp::Response loginResponse = server.login(user, password);
+ std::cout << loginResponse << std::endl;
+ if (!loginResponse.isOk())
+ return EXIT_FAILURE;
+
+ // Main menu
+ int choice = 0;
+ do
+ {
+ // Main FTP menu
+ std::cout << std::endl;
+ std::cout << "Choose an action:" << std::endl;
+ std::cout << "1. Print working directory" << std::endl;
+ std::cout << "2. Print contents of working directory" << std::endl;
+ std::cout << "3. Change directory" << std::endl;
+ std::cout << "4. Create directory" << std::endl;
+ std::cout << "5. Delete directory" << std::endl;
+ std::cout << "6. Rename file" << std::endl;
+ std::cout << "7. Remove file" << std::endl;
+ std::cout << "8. Download file" << std::endl;
+ std::cout << "9. Upload file" << std::endl;
+ std::cout << "0. Disconnect" << std::endl;
+ std::cout << std::endl;
+
+ std::cout << "Your choice: ";
+ std::cin >> choice;
+ std::cout << std::endl;
+
+ switch (choice)
+ {
+ default:
+ {
+ // Wrong choice
+ std::cout << "Invalid choice!" << std::endl;
+ std::cin.clear();
+ std::cin.ignore(10000, '\n');
+ break;
+ }
+
+ case 1:
+ {
+ // Print the current server directory
+ sf::Ftp::DirectoryResponse response = server.getWorkingDirectory();
+ std::cout << response << std::endl;
+ std::cout << "Current directory is " << response.getDirectory() << std::endl;
+ break;
+ }
+
+ case 2:
+ {
+ // Print the contents of the current server directory
+ sf::Ftp::ListingResponse response = server.getDirectoryListing();
+ std::cout << response << std::endl;
+ const std::vector& names = response.getListing();
+ for (std::vector::const_iterator it = names.begin(); it != names.end(); ++it)
+ std::cout << *it << std::endl;
+ break;
+ }
+
+ case 3:
+ {
+ // Change the current directory
+ std::string directory;
+ std::cout << "Choose a directory: ";
+ std::cin >> directory;
+ std::cout << server.changeDirectory(directory) << std::endl;
+ break;
+ }
+
+ case 4:
+ {
+ // Create a new directory
+ std::string directory;
+ std::cout << "Name of the directory to create: ";
+ std::cin >> directory;
+ std::cout << server.createDirectory(directory) << std::endl;
+ break;
+ }
+
+ case 5:
+ {
+ // Remove an existing directory
+ std::string directory;
+ std::cout << "Name of the directory to remove: ";
+ std::cin >> directory;
+ std::cout << server.deleteDirectory(directory) << std::endl;
+ break;
+ }
+
+ case 6:
+ {
+ // Rename a file
+ std::string source, destination;
+ std::cout << "Name of the file to rename: ";
+ std::cin >> source;
+ std::cout << "New name: ";
+ std::cin >> destination;
+ std::cout << server.renameFile(source, destination) << std::endl;
+ break;
+ }
+
+ case 7:
+ {
+ // Remove an existing directory
+ std::string filename;
+ std::cout << "Name of the file to remove: ";
+ std::cin >> filename;
+ std::cout << server.deleteFile(filename) << std::endl;
+ break;
+ }
+
+ case 8:
+ {
+ // Download a file from server
+ std::string filename, directory;
+ std::cout << "Filename of the file to download (relative to current directory): ";
+ std::cin >> filename;
+ std::cout << "Directory to download the file to: ";
+ std::cin >> directory;
+ std::cout << server.download(filename, directory) << std::endl;
+ break;
+ }
+
+ case 9:
+ {
+ // Upload a file to server
+ std::string filename, directory;
+ std::cout << "Path of the file to upload (absolute or relative to working directory): ";
+ std::cin >> filename;
+ std::cout << "Directory to upload the file to (relative to current directory): ";
+ std::cin >> directory;
+ std::cout << server.upload(filename, directory) << std::endl;
+ break;
+ }
+
+ case 0:
+ {
+ // Disconnect
+ break;
+ }
+ }
+
+ } while (choice != 0);
+
+ // Disconnect from the server
+ std::cout << "Disconnecting from server..." << std::endl;
+ std::cout << server.disconnect() << std::endl;
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to exit..." << std::endl;
+ std::cin.ignore(10000, '\n');
+ std::cin.ignore(10000, '\n');
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/ftp/ftp.exe b/SQCSim2021/external/sfml251-32/examples/ftp/ftp.exe
new file mode 100644
index 0000000..4b5073c
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/ftp/ftp.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/island/Island.cpp b/SQCSim2021/external/sfml251-32/examples/island/Island.cpp
new file mode 100644
index 0000000..50a8f1e
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/island/Island.cpp
@@ -0,0 +1,590 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#define STB_PERLIN_IMPLEMENTATION
+#include "stb_perlin.h"
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace
+{
+ // Width and height of the application window
+ const unsigned int windowWidth = 800;
+ const unsigned int windowHeight = 600;
+
+ // Resolution of the generated terrain
+ const unsigned int resolutionX = 800;
+ const unsigned int resolutionY = 600;
+
+ // Thread pool parameters
+ const unsigned int threadCount = 4;
+ const unsigned int blockCount = 32;
+
+ struct WorkItem
+ {
+ sf::Vertex* targetBuffer;
+ unsigned int index;
+ };
+
+ std::deque workQueue;
+ std::vector threads;
+ int pendingWorkCount = 0;
+ bool workPending = true;
+ bool bufferUploadPending = false;
+ sf::Mutex workQueueMutex;
+
+ struct Setting
+ {
+ const char* name;
+ float* value;
+ };
+
+ // Terrain noise parameters
+ const int perlinOctaves = 3;
+
+ float perlinFrequency = 7.0f;
+ float perlinFrequencyBase = 4.0f;
+
+ // Terrain generation parameters
+ float heightBase = 0.0f;
+ float edgeFactor = 0.9f;
+ float edgeDropoffExponent = 1.5f;
+
+ float snowcapHeight = 0.6f;
+
+ // Terrain lighting parameters
+ float heightFactor = windowHeight / 2.0f;
+ float heightFlatten = 3.0f;
+ float lightFactor = 0.7f;
+}
+
+
+// Forward declarations of the functions we define further down
+void threadFunction();
+void generateTerrain(sf::Vertex* vertexBuffer);
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Create the window of the application
+ sf::RenderWindow window(sf::VideoMode(windowWidth, windowHeight), "SFML Island",
+ sf::Style::Titlebar | sf::Style::Close);
+ window.setVerticalSyncEnabled(true);
+
+ sf::Font font;
+ if (!font.loadFromFile("resources/sansation.ttf"))
+ return EXIT_FAILURE;
+
+ // Create all of our graphics resources
+ sf::Text hudText;
+ sf::Text statusText;
+ sf::Shader terrainShader;
+ sf::RenderStates terrainStates(&terrainShader);
+ sf::VertexBuffer terrain(sf::Triangles, sf::VertexBuffer::Static);
+
+ // Set up our text drawables
+ statusText.setFont(font);
+ statusText.setCharacterSize(28);
+ statusText.setFillColor(sf::Color::White);
+ statusText.setOutlineColor(sf::Color::Black);
+ statusText.setOutlineThickness(2.0f);
+
+ hudText.setFont(font);
+ hudText.setCharacterSize(14);
+ hudText.setFillColor(sf::Color::White);
+ hudText.setOutlineColor(sf::Color::Black);
+ hudText.setOutlineThickness(2.0f);
+ hudText.setPosition(5.0f, 5.0f);
+
+ // Staging buffer for our terrain data that we will upload to our VertexBuffer
+ std::vector terrainStagingBuffer;
+
+ // Check whether the prerequisites are suppprted
+ bool prerequisitesSupported = sf::VertexBuffer::isAvailable() && sf::Shader::isAvailable();
+
+ // Set up our graphics resources and set the status text accordingly
+ if (!prerequisitesSupported)
+ {
+ statusText.setString("Shaders and/or Vertex Buffers Unsupported");
+ }
+ else if (!terrainShader.loadFromFile("resources/terrain.vert", "resources/terrain.frag"))
+ {
+ prerequisitesSupported = false;
+
+ statusText.setString("Failed to load shader program");
+ }
+ else
+ {
+ // Start up our thread pool
+ for (unsigned int i = 0; i < threadCount; i++)
+ {
+ threads.push_back(new sf::Thread(threadFunction));
+ threads.back()->launch();
+ }
+
+ // Create our VertexBuffer with enough space to hold all the terrain geometry
+ terrain.create(resolutionX * resolutionY * 6);
+
+ // Resize the staging buffer to be able to hold all the terrain geometry
+ terrainStagingBuffer.resize(resolutionX * resolutionY * 6);
+
+ // Generate the initial terrain
+ generateTerrain(&terrainStagingBuffer[0]);
+
+ statusText.setString("Generating Terrain...");
+ }
+
+ // Center the status text
+ statusText.setPosition((windowWidth - statusText.getLocalBounds().width) / 2.f, (windowHeight - statusText.getLocalBounds().height) / 2.f);
+
+ // Set up an array of pointers to our settings for arrow navigation
+ Setting settings[] =
+ {
+ {"perlinFrequency", &perlinFrequency},
+ {"perlinFrequencyBase", &perlinFrequencyBase},
+ {"heightBase", &heightBase},
+ {"edgeFactor", &edgeFactor},
+ {"edgeDropoffExponent", &edgeDropoffExponent},
+ {"snowcapHeight", &snowcapHeight},
+ {"heightFactor", &heightFactor},
+ {"heightFlatten", &heightFlatten},
+ {"lightFactor", &lightFactor}
+ };
+
+ const int settingCount = 9;
+ int currentSetting = 0;
+
+ std::ostringstream osstr;
+ sf::Clock clock;
+
+ while (window.isOpen())
+ {
+ // Handle events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Window closed or escape key pressed: exit
+ if ((event.type == sf::Event::Closed) ||
+ ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape)))
+ {
+ window.close();
+ break;
+ }
+
+ // Arrow key pressed:
+ if (prerequisitesSupported && (event.type == sf::Event::KeyPressed))
+ {
+ switch (event.key.code)
+ {
+ case sf::Keyboard::Return: generateTerrain(&terrainStagingBuffer[0]); break;
+ case sf::Keyboard::Down: currentSetting = (currentSetting + 1) % settingCount; break;
+ case sf::Keyboard::Up: currentSetting = (currentSetting + settingCount - 1) % settingCount; break;
+ case sf::Keyboard::Left: *(settings[currentSetting].value) -= 0.1f; break;
+ case sf::Keyboard::Right: *(settings[currentSetting].value) += 0.1f; break;
+ default: break;
+ }
+ }
+ }
+
+ // Clear, draw graphics objects and display
+ window.clear();
+
+ window.draw(statusText);
+
+ if (prerequisitesSupported)
+ {
+ {
+ sf::Lock lock(workQueueMutex);
+
+ // Don't bother updating/drawing the VertexBuffer while terrain is being regenerated
+ if (!pendingWorkCount)
+ {
+ // If there is new data pending to be uploaded to the VertexBuffer, do it now
+ if (bufferUploadPending)
+ {
+ terrain.update(&terrainStagingBuffer[0]);
+ bufferUploadPending = false;
+ }
+
+ terrainShader.setUniform("lightFactor", lightFactor);
+ window.draw(terrain, terrainStates);
+ }
+ }
+
+ // Update and draw the HUD text
+ osstr.str("");
+ osstr << "Frame: " << clock.restart().asMilliseconds() << "ms\n"
+ << "perlinOctaves: " << perlinOctaves << "\n\n"
+ << "Use the arrow keys to change the values.\nUse the return key to regenerate the terrain.\n\n";
+
+ for (int i = 0; i < settingCount; ++i)
+ osstr << ((i == currentSetting) ? ">> " : " ") << settings[i].name << ": " << *(settings[i].value) << "\n";
+
+ hudText.setString(osstr.str());
+
+ window.draw(hudText);
+ }
+
+ // Display things on screen
+ window.display();
+ }
+
+ // Shut down our thread pool
+ {
+ sf::Lock lock(workQueueMutex);
+ workPending = false;
+ }
+
+ while (!threads.empty())
+ {
+ threads.back()->wait();
+ delete threads.back();
+ threads.pop_back();
+ }
+
+ return EXIT_SUCCESS;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the terrain elevation at the given coordinates.
+///
+////////////////////////////////////////////////////////////
+float getElevation(float x, float y)
+{
+ x = x / resolutionX - 0.5f;
+ y = y / resolutionY - 0.5f;
+
+ float elevation = 0.0f;
+
+ for (int i = 0; i < perlinOctaves; i++)
+ {
+ elevation += stb_perlin_noise3(
+ x * perlinFrequency * std::pow(perlinFrequencyBase, i),
+ y * perlinFrequency * std::pow(perlinFrequencyBase, i),
+ 0, 0, 0, 0
+ ) * std::pow(perlinFrequencyBase, -i);
+ }
+
+ elevation = (elevation + 1.f) / 2.f;
+
+ float distance = 2.0f * std::sqrt(x * x + y * y);
+ elevation = (elevation + heightBase) * (1.0f - edgeFactor * std::pow(distance, edgeDropoffExponent));
+ elevation = std::min(std::max(elevation, 0.0f), 1.0f);
+
+ return elevation;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the terrain moisture at the given coordinates.
+///
+////////////////////////////////////////////////////////////
+float getMoisture(float x, float y)
+{
+ x = x / resolutionX - 0.5f;
+ y = y / resolutionY - 0.5f;
+
+ float moisture = stb_perlin_noise3(
+ x * 4.f + 0.5f,
+ y * 4.f + 0.5f,
+ 0, 0, 0, 0
+ );
+
+ return (moisture + 1.f) / 2.f;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the lowlands terrain color for the given moisture.
+///
+////////////////////////////////////////////////////////////
+sf::Color getLowlandsTerrainColor(float moisture)
+{
+ sf::Color color =
+ moisture < 0.27f ? sf::Color(240, 240, 180) :
+ moisture < 0.3f ? sf::Color(240 - 240 * (moisture - 0.27f) / 0.03f, 240 - 40 * (moisture - 0.27f) / 0.03f, 180 - 180 * (moisture - 0.27f) / 0.03f) :
+ moisture < 0.4f ? sf::Color(0, 200, 0) :
+ moisture < 0.48f ? sf::Color(0, 200 - 40 * (moisture - 0.4f) / 0.08f, 0) :
+ moisture < 0.6f ? sf::Color(0, 160, 0) :
+ moisture < 0.7f ? sf::Color(34 * (moisture - 0.6f) / 0.1f, 160 - 60 * (moisture - 0.6f) / 0.1f, 34 * (moisture - 0.6f) / 0.1f) :
+ sf::Color(34, 100, 34);
+
+ return color;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the highlands terrain color for the given elevation
+/// and moisture.
+///
+////////////////////////////////////////////////////////////
+sf::Color getHighlandsTerrainColor(float elevation, float moisture)
+{
+ sf::Color lowlandsColor = getLowlandsTerrainColor(moisture);
+
+ sf::Color color =
+ moisture < 0.6f ? sf::Color(112, 128, 144) :
+ sf::Color(112 + 110 * (moisture - 0.6f) / 0.4f, 128 + 56 * (moisture - 0.6f) / 0.4f, 144 - 9 * (moisture - 0.6f) / 0.4f);
+
+ float factor = std::min((elevation - 0.4f) / 0.1f, 1.f);
+
+ color.r = lowlandsColor.r * (1.f - factor) + color.r * factor;
+ color.g = lowlandsColor.g * (1.f - factor) + color.g * factor;
+ color.b = lowlandsColor.b * (1.f - factor) + color.b * factor;
+
+ return color;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the snowcap terrain color for the given elevation
+/// and moisture.
+///
+////////////////////////////////////////////////////////////
+sf::Color getSnowcapTerrainColor(float elevation, float moisture)
+{
+ sf::Color highlandsColor = getHighlandsTerrainColor(elevation, moisture);
+
+ sf::Color color = sf::Color::White;
+
+ float factor = std::min((elevation - snowcapHeight) / 0.05f, 1.f);
+
+ color.r = highlandsColor.r * (1.f - factor) + color.r * factor;
+ color.g = highlandsColor.g * (1.f - factor) + color.g * factor;
+ color.b = highlandsColor.b * (1.f - factor) + color.b * factor;
+
+ return color;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Get the terrain color for the given elevation and
+/// moisture.
+///
+////////////////////////////////////////////////////////////
+sf::Color getTerrainColor(float elevation, float moisture)
+{
+ sf::Color color =
+ elevation < 0.11f ? sf::Color(0, 0, elevation / 0.11f * 74.f + 181.0f) :
+ elevation < 0.14f ? sf::Color(std::pow((elevation - 0.11f) / 0.03f, 0.3f) * 48.f, std::pow((elevation - 0.11f) / 0.03f, 0.3f) * 48.f, 255) :
+ elevation < 0.16f ? sf::Color((elevation - 0.14f) * 128.f / 0.02f + 48.f, (elevation - 0.14f) * 128.f / 0.02f + 48.f, 127.0f + (0.16f - elevation) * 128.f / 0.02f) :
+ elevation < 0.17f ? sf::Color(240, 230, 140) :
+ elevation < 0.4f ? getLowlandsTerrainColor(moisture) :
+ elevation < snowcapHeight ? getHighlandsTerrainColor(elevation, moisture) :
+ getSnowcapTerrainColor(elevation, moisture);
+
+ return color;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Compute a compressed representation of the surface
+/// normal based on the given coordinates, and the elevation
+/// of the 4 adjacent neighbours.
+///
+////////////////////////////////////////////////////////////
+sf::Vector2f computeNormal(int x, int y, float left, float right, float bottom, float top)
+{
+ sf::Vector3f deltaX(1, 0, (std::pow(right, heightFlatten) - std::pow(left, heightFlatten)) * heightFactor);
+ sf::Vector3f deltaY(0, 1, (std::pow(top, heightFlatten) - std::pow(bottom, heightFlatten)) * heightFactor);
+
+ sf::Vector3f crossProduct(
+ deltaX.y * deltaY.z - deltaX.z * deltaY.y,
+ deltaX.z * deltaY.x - deltaX.x * deltaY.z,
+ deltaX.x * deltaY.y - deltaX.y * deltaY.x
+ );
+
+ // Scale cross product to make z component 1.0f so we can drop it
+ crossProduct /= crossProduct.z;
+
+ // Return "compressed" normal
+ return sf::Vector2f(crossProduct.x, crossProduct.y);
+}
+
+
+////////////////////////////////////////////////////////////
+/// Process a terrain generation work item. Use the vector
+/// of vertices as scratch memory and upload the data to
+/// the vertex buffer when done.
+///
+////////////////////////////////////////////////////////////
+void processWorkItem(std::vector& vertices, const WorkItem& workItem)
+{
+ unsigned int rowBlockSize = (resolutionY / blockCount) + 1;
+ unsigned int rowStart = rowBlockSize * workItem.index;
+
+ if (rowStart >= resolutionY)
+ return;
+
+ unsigned int rowEnd = std::min(rowStart + rowBlockSize, resolutionY);
+ unsigned int rowCount = rowEnd - rowStart;
+
+ const float scalingFactorX = static_cast(windowWidth) / static_cast(resolutionX);
+ const float scalingFactorY = static_cast(windowHeight) / static_cast(resolutionY);
+
+ for (unsigned int y = rowStart; y < rowEnd; y++)
+ {
+ for (int x = 0; x < resolutionX; x++)
+ {
+ int arrayIndexBase = ((y - rowStart) * resolutionX + x) * 6;
+
+ // Top left corner (first triangle)
+ if (x > 0)
+ {
+ vertices[arrayIndexBase + 0] = vertices[arrayIndexBase - 6 + 5];
+ }
+ else if (y > rowStart)
+ {
+ vertices[arrayIndexBase + 0] = vertices[arrayIndexBase - resolutionX * 6 + 1];
+ }
+ else
+ {
+ vertices[arrayIndexBase + 0].position = sf::Vector2f(x * scalingFactorX, y * scalingFactorY);
+ vertices[arrayIndexBase + 0].color = getTerrainColor(getElevation(x, y), getMoisture(x, y));
+ vertices[arrayIndexBase + 0].texCoords = computeNormal(x, y, getElevation(x - 1, y), getElevation(x + 1, y), getElevation(x, y + 1), getElevation(x, y - 1));
+ }
+
+ // Bottom left corner (first triangle)
+ if (x > 0)
+ {
+ vertices[arrayIndexBase + 1] = vertices[arrayIndexBase - 6 + 2];
+ }
+ else
+ {
+ vertices[arrayIndexBase + 1].position = sf::Vector2f(x * scalingFactorX, (y + 1) * scalingFactorY);
+ vertices[arrayIndexBase + 1].color = getTerrainColor(getElevation(x, y + 1), getMoisture(x, y + 1));
+ vertices[arrayIndexBase + 1].texCoords = computeNormal(x, y + 1, getElevation(x - 1, y + 1), getElevation(x + 1, y + 1), getElevation(x, y + 2), getElevation(x, y));
+ }
+
+ // Bottom right corner (first triangle)
+ vertices[arrayIndexBase + 2].position = sf::Vector2f((x + 1) * scalingFactorX, (y + 1) * scalingFactorY);
+ vertices[arrayIndexBase + 2].color = getTerrainColor(getElevation(x + 1, y + 1), getMoisture(x + 1, y + 1));
+ vertices[arrayIndexBase + 2].texCoords = computeNormal(x + 1, y + 1, getElevation(x, y + 1), getElevation(x + 2, y + 1), getElevation(x + 1, y + 2), getElevation(x + 1, y));
+
+ // Top left corner (second triangle)
+ vertices[arrayIndexBase + 3] = vertices[arrayIndexBase + 0];
+
+ // Bottom right corner (second triangle)
+ vertices[arrayIndexBase + 4] = vertices[arrayIndexBase + 2];
+
+ // Top right corner (second triangle)
+ if (y > rowStart)
+ {
+ vertices[arrayIndexBase + 5] = vertices[arrayIndexBase - resolutionX * 6 + 2];
+ }
+ else
+ {
+ vertices[arrayIndexBase + 5].position = sf::Vector2f((x + 1) * scalingFactorX, y * scalingFactorY);
+ vertices[arrayIndexBase + 5].color = getTerrainColor(getElevation(x + 1, y), getMoisture(x + 1, y));
+ vertices[arrayIndexBase + 5].texCoords = computeNormal(x + 1, y, getElevation(x, y), getElevation(x + 2, y), getElevation(x + 1, y + 1), getElevation(x + 1, y - 1));
+ }
+ }
+ }
+
+ // Copy the resulting geometry from our thread-local buffer into the target buffer
+ std::memcpy(workItem.targetBuffer + (resolutionX * rowStart * 6), &vertices[0], sizeof(sf::Vertex) * resolutionX * rowCount * 6);
+}
+
+
+////////////////////////////////////////////////////////////
+/// Worker thread entry point. We use a thread pool to avoid
+/// the heavy cost of constantly recreating and starting
+/// new threads whenever we need to regenerate the terrain.
+///
+////////////////////////////////////////////////////////////
+void threadFunction()
+{
+ unsigned int rowBlockSize = (resolutionY / blockCount) + 1;
+
+ std::vector vertices(resolutionX * rowBlockSize * 6);
+
+ WorkItem workItem = {0, 0};
+
+ // Loop until the application exits
+ for (;;)
+ {
+ workItem.targetBuffer = 0;
+
+ // Check if there are new work items in the queue
+ {
+ sf::Lock lock(workQueueMutex);
+
+ if (!workPending)
+ return;
+
+ if (!workQueue.empty())
+ {
+ workItem = workQueue.front();
+ workQueue.pop_front();
+ }
+ }
+
+ // If we didn't receive a new work item, keep looping
+ if (!workItem.targetBuffer)
+ {
+ sf::sleep(sf::milliseconds(10));
+
+ continue;
+ }
+
+ processWorkItem(vertices, workItem);
+
+ {
+ sf::Lock lock(workQueueMutex);
+
+ --pendingWorkCount;
+ }
+ }
+}
+
+
+////////////////////////////////////////////////////////////
+/// Terrain generation entry point. This queues up the
+/// generation work items which the worker threads dequeue
+/// and process.
+///
+////////////////////////////////////////////////////////////
+void generateTerrain(sf::Vertex* buffer)
+{
+ bufferUploadPending = true;
+
+ // Make sure the work queue is empty before queuing new work
+ for (;;)
+ {
+ {
+ sf::Lock lock(workQueueMutex);
+
+ if (workQueue.empty())
+ break;
+ }
+
+ sf::sleep(sf::milliseconds(10));
+ }
+
+ // Queue all the new work items
+ {
+ sf::Lock lock(workQueueMutex);
+
+ for (unsigned int i = 0; i < blockCount; i++)
+ {
+ WorkItem workItem = {buffer, i};
+ workQueue.push_back(workItem);
+ }
+
+ pendingWorkCount = blockCount;
+ }
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/island/island.exe b/SQCSim2021/external/sfml251-32/examples/island/island.exe
new file mode 100644
index 0000000..5597284
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/island/island.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/island/resources/sansation.ttf b/SQCSim2021/external/sfml251-32/examples/island/resources/sansation.ttf
new file mode 100644
index 0000000..d85fbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/island/resources/sansation.ttf differ
diff --git a/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.frag b/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.frag
new file mode 100644
index 0000000..ae18187
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.frag
@@ -0,0 +1,11 @@
+varying vec3 normal;
+uniform float lightFactor;
+
+void main()
+{
+ vec3 lightPosition = vec3(-1.0, 1.0, 1.0);
+ vec3 eyePosition = vec3(0.0, 0.0, 1.0);
+ vec3 halfVector = normalize(lightPosition + eyePosition);
+ float intensity = lightFactor + (1.0 - lightFactor) * dot(normalize(normal), normalize(halfVector));
+ gl_FragColor = gl_Color * vec4(intensity, intensity, intensity, 1.0);
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.vert b/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.vert
new file mode 100644
index 0000000..a06996d
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/island/resources/terrain.vert
@@ -0,0 +1,8 @@
+varying vec3 normal;
+
+void main()
+{
+ gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;
+ gl_FrontColor = gl_Color;
+ normal = vec3(gl_MultiTexCoord0.xy, 1.0);
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/joystick/Joystick.cpp b/SQCSim2021/external/sfml251-32/examples/joystick/Joystick.cpp
new file mode 100644
index 0000000..0ff7cf9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/joystick/Joystick.cpp
@@ -0,0 +1,238 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace
+{
+ struct JoystickObject
+ {
+ sf::Text label;
+ sf::Text value;
+ };
+
+ typedef std::map Texts;
+ Texts texts;
+ std::ostringstream sstr;
+ float threshold = 0.1f;
+
+ // Axes labels in as C strings
+ const char* axislabels[] = {"X", "Y", "Z", "R", "U", "V", "PovX", "PovY"};
+
+ // Helper to set text entries to a specified value
+ template
+ void set(const char* label, const T& value)
+ {
+ sstr.str("");
+ sstr << value;
+ texts[label].value.setString(sstr.str());
+ }
+
+ // Update joystick identification
+ void updateIdentification(unsigned int index)
+ {
+ sstr.str("");
+ sstr << "Joystick " << index << ":";
+ texts["ID"].label.setString(sstr.str());
+ texts["ID"].value.setString(sf::Joystick::getIdentification(index).name);
+ }
+
+ // Update joystick axes
+ void updateAxes(unsigned int index)
+ {
+ for (unsigned int j = 0; j < sf::Joystick::AxisCount; ++j)
+ {
+ if (sf::Joystick::hasAxis(index, static_cast(j)))
+ set(axislabels[j], sf::Joystick::getAxisPosition(index, static_cast(j)));
+ }
+ }
+
+ // Update joystick buttons
+ void updateButtons(unsigned int index)
+ {
+ for (unsigned int j = 0; j < sf::Joystick::getButtonCount(index); ++j)
+ {
+ sstr.str("");
+ sstr << "Button " << j;
+
+ set(sstr.str().c_str(), sf::Joystick::isButtonPressed(index, j));
+ }
+ }
+
+ // Helper to update displayed joystick values
+ void updateValues(unsigned int index)
+ {
+ if (sf::Joystick::isConnected(index)) {
+ // Update the label-value sf::Text objects based on the current joystick state
+ updateIdentification(index);
+ updateAxes(index);
+ updateButtons(index);
+ }
+ }
+}
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Create the window of the application
+ sf::RenderWindow window(sf::VideoMode(400, 680), "Joystick", sf::Style::Close);
+ window.setVerticalSyncEnabled(true);
+
+ // Load the text font
+ sf::Font font;
+ if (!font.loadFromFile("resources/sansation.ttf"))
+ return EXIT_FAILURE;
+
+ // Set up our string conversion parameters
+ sstr.precision(2);
+ sstr.setf(std::ios::fixed | std::ios::boolalpha);
+
+ // Set up our joystick identification sf::Text objects
+ texts["ID"].label.setPosition(5.f, 5.f);
+ texts["ID"].value.setPosition(80.f, 5.f);
+
+ texts["ID"].label.setString("");
+ texts["ID"].value.setString("");
+
+ // Set up our threshold sf::Text objects
+ sstr.str("");
+ sstr << threshold << " (Change with up/down arrow keys)";
+
+ texts["Threshold"].label.setPosition(5.f, 5.f + 2 * font.getLineSpacing(14));
+ texts["Threshold"].value.setPosition(80.f, 5.f + 2 * font.getLineSpacing(14));
+
+ texts["Threshold"].label.setString("Threshold:");
+ texts["Threshold"].value.setString(sstr.str());
+
+ // Set up our label-value sf::Text objects
+ for (unsigned int i = 0; i < sf::Joystick::AxisCount; ++i)
+ {
+ JoystickObject& object = texts[axislabels[i]];
+
+ object.label.setPosition(5.f, 5.f + ((i + 4) * font.getLineSpacing(14)));
+ object.label.setString(std::string(axislabels[i]) + ":");
+
+ object.value.setPosition(80.f, 5.f + ((i + 4) * font.getLineSpacing(14)));
+ object.value.setString("N/A");
+ }
+
+ for (unsigned int i = 0; i < sf::Joystick::ButtonCount; ++i)
+ {
+ sstr.str("");
+ sstr << "Button " << i;
+ JoystickObject& object = texts[sstr.str()];
+
+ object.label.setPosition(5.f, 5.f + ((sf::Joystick::AxisCount + i + 4) * font.getLineSpacing(14)));
+ object.label.setString(sstr.str() + ":");
+
+ object.value.setPosition(80.f, 5.f + ((sf::Joystick::AxisCount + i + 4) * font.getLineSpacing(14)));
+ object.value.setString("N/A");
+ }
+
+ for (Texts::iterator it = texts.begin(); it != texts.end(); ++it)
+ {
+ it->second.label.setFont(font);
+ it->second.label.setCharacterSize(14);
+ it->second.label.setFillColor(sf::Color::White);
+
+ it->second.value.setFont(font);
+ it->second.value.setCharacterSize(14);
+ it->second.value.setFillColor(sf::Color::White);
+ }
+
+ // Update initially displayed joystick values if a joystick is already connected on startup
+ for (unsigned int i = 0; i < sf::Joystick::Count; ++i)
+ {
+ if (sf::Joystick::isConnected(i))
+ {
+ updateValues(i);
+ break;
+ }
+ }
+
+ while (window.isOpen())
+ {
+ // Handle events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Window closed or escape key pressed: exit
+ if ((event.type == sf::Event::Closed) ||
+ ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape)))
+ {
+ window.close();
+ break;
+ }
+ else if ((event.type == sf::Event::JoystickButtonPressed) ||
+ (event.type == sf::Event::JoystickButtonReleased) ||
+ (event.type == sf::Event::JoystickMoved) ||
+ (event.type == sf::Event::JoystickConnected))
+ {
+ // Update displayed joystick values
+ updateValues(event.joystickConnect.joystickId);
+ }
+ else if (event.type == sf::Event::JoystickDisconnected)
+ {
+ // Reset displayed joystick values to empty
+ for (Texts::iterator it = texts.begin(); it != texts.end(); ++it)
+ it->second.value.setString("N/A");
+
+ texts["ID"].label.setString("");
+ texts["ID"].value.setString("");
+
+ sstr.str("");
+ sstr << threshold << " (Change with up/down arrow keys)";
+
+ texts["Threshold"].value.setString(sstr.str());
+ }
+ }
+
+ // Update threshold if the user wants to change it
+ float newThreshold = threshold;
+
+ if (sf::Keyboard::isKeyPressed(sf::Keyboard::Up))
+ newThreshold += 0.1f;
+
+ if (sf::Keyboard::isKeyPressed(sf::Keyboard::Down))
+ newThreshold -= 0.1f;
+
+ newThreshold = std::min(std::max(newThreshold, 0.1f), 100.0f);
+
+ if (newThreshold != threshold)
+ {
+ threshold = newThreshold;
+ window.setJoystickThreshold(threshold);
+
+ sstr.str("");
+ sstr << threshold << " (Change with up/down arrow keys)";
+
+ texts["Threshold"].value.setString(sstr.str());
+ }
+
+ // Clear the window
+ window.clear();
+
+ // Draw the label-value sf::Text objects
+ for (Texts::const_iterator it = texts.begin(); it != texts.end(); ++it)
+ {
+ window.draw(it->second.label);
+ window.draw(it->second.value);
+ }
+
+ // Display things on screen
+ window.display();
+ }
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/joystick/joystick.exe b/SQCSim2021/external/sfml251-32/examples/joystick/joystick.exe
new file mode 100644
index 0000000..2dacf13
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/joystick/joystick.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/joystick/resources/sansation.ttf b/SQCSim2021/external/sfml251-32/examples/joystick/resources/sansation.ttf
new file mode 100644
index 0000000..d85fbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/joystick/resources/sansation.ttf differ
diff --git a/SQCSim2021/external/sfml251-32/examples/opengl/OpenGL.cpp b/SQCSim2021/external/sfml251-32/examples/opengl/OpenGL.cpp
new file mode 100644
index 0000000..f2260d6
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/opengl/OpenGL.cpp
@@ -0,0 +1,258 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+#ifndef GL_SRGB8_ALPHA8
+#define GL_SRGB8_ALPHA8 0x8C43
+#endif
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ bool exit = false;
+ bool sRgb = false;
+
+ while (!exit)
+ {
+ // Request a 24-bits depth buffer when creating the window
+ sf::ContextSettings contextSettings;
+ contextSettings.depthBits = 24;
+ contextSettings.sRgbCapable = sRgb;
+
+ // Create the main window
+ sf::RenderWindow window(sf::VideoMode(800, 600), "SFML graphics with OpenGL", sf::Style::Default, contextSettings);
+ window.setVerticalSyncEnabled(true);
+
+ // Create a sprite for the background
+ sf::Texture backgroundTexture;
+ backgroundTexture.setSrgb(sRgb);
+ if (!backgroundTexture.loadFromFile("resources/background.jpg"))
+ return EXIT_FAILURE;
+ sf::Sprite background(backgroundTexture);
+
+ // Create some text to draw on top of our OpenGL object
+ sf::Font font;
+ if (!font.loadFromFile("resources/sansation.ttf"))
+ return EXIT_FAILURE;
+ sf::Text text("SFML / OpenGL demo", font);
+ sf::Text sRgbInstructions("Press space to toggle sRGB conversion", font);
+ sf::Text mipmapInstructions("Press return to toggle mipmapping", font);
+ text.setFillColor(sf::Color(255, 255, 255, 170));
+ sRgbInstructions.setFillColor(sf::Color(255, 255, 255, 170));
+ mipmapInstructions.setFillColor(sf::Color(255, 255, 255, 170));
+ text.setPosition(250.f, 450.f);
+ sRgbInstructions.setPosition(150.f, 500.f);
+ mipmapInstructions.setPosition(180.f, 550.f);
+
+ // Load a texture to apply to our 3D cube
+ sf::Texture texture;
+ if (!texture.loadFromFile("resources/texture.jpg"))
+ return EXIT_FAILURE;
+
+ // Attempt to generate a mipmap for our cube texture
+ // We don't check the return value here since
+ // mipmapping is purely optional in this example
+ texture.generateMipmap();
+
+ // Make the window the active window for OpenGL calls
+ window.setActive(true);
+
+ // Enable Z-buffer read and write
+ glEnable(GL_DEPTH_TEST);
+ glDepthMask(GL_TRUE);
+ glClearDepth(1.f);
+
+ // Disable lighting
+ glDisable(GL_LIGHTING);
+
+ // Configure the viewport (the same size as the window)
+ glViewport(0, 0, window.getSize().x, window.getSize().y);
+
+ // Setup a perspective projection
+ glMatrixMode(GL_PROJECTION);
+ glLoadIdentity();
+ GLfloat ratio = static_cast(window.getSize().x) / window.getSize().y;
+ glFrustum(-ratio, ratio, -1.f, 1.f, 1.f, 500.f);
+
+ // Bind the texture
+ glEnable(GL_TEXTURE_2D);
+ sf::Texture::bind(&texture);
+
+ // Define a 3D cube (6 faces made of 2 triangles composed by 3 vertices)
+ static const GLfloat cube[] =
+ {
+ // positions // texture coordinates
+ -20, -20, -20, 0, 0,
+ -20, 20, -20, 1, 0,
+ -20, -20, 20, 0, 1,
+ -20, -20, 20, 0, 1,
+ -20, 20, -20, 1, 0,
+ -20, 20, 20, 1, 1,
+
+ 20, -20, -20, 0, 0,
+ 20, 20, -20, 1, 0,
+ 20, -20, 20, 0, 1,
+ 20, -20, 20, 0, 1,
+ 20, 20, -20, 1, 0,
+ 20, 20, 20, 1, 1,
+
+ -20, -20, -20, 0, 0,
+ 20, -20, -20, 1, 0,
+ -20, -20, 20, 0, 1,
+ -20, -20, 20, 0, 1,
+ 20, -20, -20, 1, 0,
+ 20, -20, 20, 1, 1,
+
+ -20, 20, -20, 0, 0,
+ 20, 20, -20, 1, 0,
+ -20, 20, 20, 0, 1,
+ -20, 20, 20, 0, 1,
+ 20, 20, -20, 1, 0,
+ 20, 20, 20, 1, 1,
+
+ -20, -20, -20, 0, 0,
+ 20, -20, -20, 1, 0,
+ -20, 20, -20, 0, 1,
+ -20, 20, -20, 0, 1,
+ 20, -20, -20, 1, 0,
+ 20, 20, -20, 1, 1,
+
+ -20, -20, 20, 0, 0,
+ 20, -20, 20, 1, 0,
+ -20, 20, 20, 0, 1,
+ -20, 20, 20, 0, 1,
+ 20, -20, 20, 1, 0,
+ 20, 20, 20, 1, 1
+ };
+
+ // Enable position and texture coordinates vertex components
+ glEnableClientState(GL_VERTEX_ARRAY);
+ glEnableClientState(GL_TEXTURE_COORD_ARRAY);
+ glVertexPointer(3, GL_FLOAT, 5 * sizeof(GLfloat), cube);
+ glTexCoordPointer(2, GL_FLOAT, 5 * sizeof(GLfloat), cube + 3);
+
+ // Disable normal and color vertex components
+ glDisableClientState(GL_NORMAL_ARRAY);
+ glDisableClientState(GL_COLOR_ARRAY);
+
+ // Make the window no longer the active window for OpenGL calls
+ window.setActive(false);
+
+ // Create a clock for measuring the time elapsed
+ sf::Clock clock;
+
+ // Flag to track whether mipmapping is currently enabled
+ bool mipmapEnabled = true;
+
+ // Start game loop
+ while (window.isOpen())
+ {
+ // Process events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Close window: exit
+ if (event.type == sf::Event::Closed)
+ {
+ exit = true;
+ window.close();
+ }
+
+ // Escape key: exit
+ if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape))
+ {
+ exit = true;
+ window.close();
+ }
+
+ // Return key: toggle mipmapping
+ if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Enter))
+ {
+ if (mipmapEnabled)
+ {
+ // We simply reload the texture to disable mipmapping
+ if (!texture.loadFromFile("resources/texture.jpg"))
+ return EXIT_FAILURE;
+
+ mipmapEnabled = false;
+ }
+ else
+ {
+ texture.generateMipmap();
+
+ mipmapEnabled = true;
+ }
+ }
+
+ // Space key: toggle sRGB conversion
+ if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Space))
+ {
+ sRgb = !sRgb;
+ window.close();
+ }
+
+ // Adjust the viewport when the window is resized
+ if (event.type == sf::Event::Resized)
+ {
+ // Make the window the active window for OpenGL calls
+ window.setActive(true);
+
+ glViewport(0, 0, event.size.width, event.size.height);
+
+ // Make the window no longer the active window for OpenGL calls
+ window.setActive(false);
+ }
+ }
+
+ // Draw the background
+ window.pushGLStates();
+ window.draw(background);
+ window.popGLStates();
+
+ // Make the window the active window for OpenGL calls
+ window.setActive(true);
+
+ // Clear the depth buffer
+ glClear(GL_DEPTH_BUFFER_BIT);
+
+ // We get the position of the mouse cursor, so that we can move the box accordingly
+ float x = sf::Mouse::getPosition(window).x * 200.f / window.getSize().x - 100.f;
+ float y = -sf::Mouse::getPosition(window).y * 200.f / window.getSize().y + 100.f;
+
+ // Apply some transformations
+ glMatrixMode(GL_MODELVIEW);
+ glLoadIdentity();
+ glTranslatef(x, y, -100.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 50.f, 1.f, 0.f, 0.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 30.f, 0.f, 1.f, 0.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 90.f, 0.f, 0.f, 1.f);
+
+ // Draw the cube
+ glDrawArrays(GL_TRIANGLES, 0, 36);
+
+ // Make the window no longer the active window for OpenGL calls
+ window.setActive(false);
+
+ // Draw some text on top of our OpenGL object
+ window.pushGLStates();
+ window.draw(text);
+ window.draw(sRgbInstructions);
+ window.draw(mipmapInstructions);
+ window.popGLStates();
+
+ // Finally, display the rendered frame on screen
+ window.display();
+ }
+ }
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/opengl/opengl.exe b/SQCSim2021/external/sfml251-32/examples/opengl/opengl.exe
new file mode 100644
index 0000000..c6074b8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/opengl/opengl.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/opengl/resources/background.jpg b/SQCSim2021/external/sfml251-32/examples/opengl/resources/background.jpg
new file mode 100644
index 0000000..20724fa
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/opengl/resources/background.jpg differ
diff --git a/SQCSim2021/external/sfml251-32/examples/opengl/resources/sansation.ttf b/SQCSim2021/external/sfml251-32/examples/opengl/resources/sansation.ttf
new file mode 100644
index 0000000..d85fbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/opengl/resources/sansation.ttf differ
diff --git a/SQCSim2021/external/sfml251-32/examples/opengl/resources/texture.jpg b/SQCSim2021/external/sfml251-32/examples/opengl/resources/texture.jpg
new file mode 100644
index 0000000..6cf7528
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/opengl/resources/texture.jpg differ
diff --git a/SQCSim2021/external/sfml251-32/examples/pong/Pong.cpp b/SQCSim2021/external/sfml251-32/examples/pong/Pong.cpp
new file mode 100644
index 0000000..58c9fd7
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/pong/Pong.cpp
@@ -0,0 +1,242 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ std::srand(static_cast(std::time(NULL)));
+
+ // Define some constants
+ const float pi = 3.14159f;
+ const int gameWidth = 800;
+ const int gameHeight = 600;
+ sf::Vector2f paddleSize(25, 100);
+ float ballRadius = 10.f;
+
+ // Create the window of the application
+ sf::RenderWindow window(sf::VideoMode(gameWidth, gameHeight, 32), "SFML Pong",
+ sf::Style::Titlebar | sf::Style::Close);
+ window.setVerticalSyncEnabled(true);
+
+ // Load the sounds used in the game
+ sf::SoundBuffer ballSoundBuffer;
+ if (!ballSoundBuffer.loadFromFile("resources/ball.wav"))
+ return EXIT_FAILURE;
+ sf::Sound ballSound(ballSoundBuffer);
+
+ // Create the left paddle
+ sf::RectangleShape leftPaddle;
+ leftPaddle.setSize(paddleSize - sf::Vector2f(3, 3));
+ leftPaddle.setOutlineThickness(3);
+ leftPaddle.setOutlineColor(sf::Color::Black);
+ leftPaddle.setFillColor(sf::Color(100, 100, 200));
+ leftPaddle.setOrigin(paddleSize / 2.f);
+
+ // Create the right paddle
+ sf::RectangleShape rightPaddle;
+ rightPaddle.setSize(paddleSize - sf::Vector2f(3, 3));
+ rightPaddle.setOutlineThickness(3);
+ rightPaddle.setOutlineColor(sf::Color::Black);
+ rightPaddle.setFillColor(sf::Color(200, 100, 100));
+ rightPaddle.setOrigin(paddleSize / 2.f);
+
+ // Create the ball
+ sf::CircleShape ball;
+ ball.setRadius(ballRadius - 3);
+ ball.setOutlineThickness(3);
+ ball.setOutlineColor(sf::Color::Black);
+ ball.setFillColor(sf::Color::White);
+ ball.setOrigin(ballRadius / 2, ballRadius / 2);
+
+ // Load the text font
+ sf::Font font;
+ if (!font.loadFromFile("resources/sansation.ttf"))
+ return EXIT_FAILURE;
+
+ // Initialize the pause message
+ sf::Text pauseMessage;
+ pauseMessage.setFont(font);
+ pauseMessage.setCharacterSize(40);
+ pauseMessage.setPosition(170.f, 150.f);
+ pauseMessage.setFillColor(sf::Color::White);
+ pauseMessage.setString("Welcome to SFML pong!\nPress space to start the game");
+
+ // Define the paddles properties
+ sf::Clock AITimer;
+ const sf::Time AITime = sf::seconds(0.1f);
+ const float paddleSpeed = 400.f;
+ float rightPaddleSpeed = 0.f;
+ const float ballSpeed = 400.f;
+ float ballAngle = 0.f; // to be changed later
+
+ sf::Clock clock;
+ bool isPlaying = false;
+ while (window.isOpen())
+ {
+ // Handle events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Window closed or escape key pressed: exit
+ if ((event.type == sf::Event::Closed) ||
+ ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape)))
+ {
+ window.close();
+ break;
+ }
+
+ // Space key pressed: play
+ if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Space))
+ {
+ if (!isPlaying)
+ {
+ // (re)start the game
+ isPlaying = true;
+ clock.restart();
+
+ // Reset the position of the paddles and ball
+ leftPaddle.setPosition(10 + paddleSize.x / 2, gameHeight / 2);
+ rightPaddle.setPosition(gameWidth - 10 - paddleSize.x / 2, gameHeight / 2);
+ ball.setPosition(gameWidth / 2, gameHeight / 2);
+
+ // Reset the ball angle
+ do
+ {
+ // Make sure the ball initial angle is not too much vertical
+ ballAngle = (std::rand() % 360) * 2 * pi / 360;
+ }
+ while (std::abs(std::cos(ballAngle)) < 0.7f);
+ }
+ }
+ }
+
+ if (isPlaying)
+ {
+ float deltaTime = clock.restart().asSeconds();
+
+ // Move the player's paddle
+ if (sf::Keyboard::isKeyPressed(sf::Keyboard::Up) &&
+ (leftPaddle.getPosition().y - paddleSize.y / 2 > 5.f))
+ {
+ leftPaddle.move(0.f, -paddleSpeed * deltaTime);
+ }
+ if (sf::Keyboard::isKeyPressed(sf::Keyboard::Down) &&
+ (leftPaddle.getPosition().y + paddleSize.y / 2 < gameHeight - 5.f))
+ {
+ leftPaddle.move(0.f, paddleSpeed * deltaTime);
+ }
+
+ // Move the computer's paddle
+ if (((rightPaddleSpeed < 0.f) && (rightPaddle.getPosition().y - paddleSize.y / 2 > 5.f)) ||
+ ((rightPaddleSpeed > 0.f) && (rightPaddle.getPosition().y + paddleSize.y / 2 < gameHeight - 5.f)))
+ {
+ rightPaddle.move(0.f, rightPaddleSpeed * deltaTime);
+ }
+
+ // Update the computer's paddle direction according to the ball position
+ if (AITimer.getElapsedTime() > AITime)
+ {
+ AITimer.restart();
+ if (ball.getPosition().y + ballRadius > rightPaddle.getPosition().y + paddleSize.y / 2)
+ rightPaddleSpeed = paddleSpeed;
+ else if (ball.getPosition().y - ballRadius < rightPaddle.getPosition().y - paddleSize.y / 2)
+ rightPaddleSpeed = -paddleSpeed;
+ else
+ rightPaddleSpeed = 0.f;
+ }
+
+ // Move the ball
+ float factor = ballSpeed * deltaTime;
+ ball.move(std::cos(ballAngle) * factor, std::sin(ballAngle) * factor);
+
+ // Check collisions between the ball and the screen
+ if (ball.getPosition().x - ballRadius < 0.f)
+ {
+ isPlaying = false;
+ pauseMessage.setString("You lost!\nPress space to restart or\nescape to exit");
+ }
+ if (ball.getPosition().x + ballRadius > gameWidth)
+ {
+ isPlaying = false;
+ pauseMessage.setString("You won!\nPress space to restart or\nescape to exit");
+ }
+ if (ball.getPosition().y - ballRadius < 0.f)
+ {
+ ballSound.play();
+ ballAngle = -ballAngle;
+ ball.setPosition(ball.getPosition().x, ballRadius + 0.1f);
+ }
+ if (ball.getPosition().y + ballRadius > gameHeight)
+ {
+ ballSound.play();
+ ballAngle = -ballAngle;
+ ball.setPosition(ball.getPosition().x, gameHeight - ballRadius - 0.1f);
+ }
+
+ // Check the collisions between the ball and the paddles
+ // Left Paddle
+ if (ball.getPosition().x - ballRadius < leftPaddle.getPosition().x + paddleSize.x / 2 &&
+ ball.getPosition().x - ballRadius > leftPaddle.getPosition().x &&
+ ball.getPosition().y + ballRadius >= leftPaddle.getPosition().y - paddleSize.y / 2 &&
+ ball.getPosition().y - ballRadius <= leftPaddle.getPosition().y + paddleSize.y / 2)
+ {
+ if (ball.getPosition().y > leftPaddle.getPosition().y)
+ ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180;
+ else
+ ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180;
+
+ ballSound.play();
+ ball.setPosition(leftPaddle.getPosition().x + ballRadius + paddleSize.x / 2 + 0.1f, ball.getPosition().y);
+ }
+
+ // Right Paddle
+ if (ball.getPosition().x + ballRadius > rightPaddle.getPosition().x - paddleSize.x / 2 &&
+ ball.getPosition().x + ballRadius < rightPaddle.getPosition().x &&
+ ball.getPosition().y + ballRadius >= rightPaddle.getPosition().y - paddleSize.y / 2 &&
+ ball.getPosition().y - ballRadius <= rightPaddle.getPosition().y + paddleSize.y / 2)
+ {
+ if (ball.getPosition().y > rightPaddle.getPosition().y)
+ ballAngle = pi - ballAngle + (std::rand() % 20) * pi / 180;
+ else
+ ballAngle = pi - ballAngle - (std::rand() % 20) * pi / 180;
+
+ ballSound.play();
+ ball.setPosition(rightPaddle.getPosition().x - ballRadius - paddleSize.x / 2 - 0.1f, ball.getPosition().y);
+ }
+ }
+
+ // Clear the window
+ window.clear(sf::Color(50, 200, 50));
+
+ if (isPlaying)
+ {
+ // Draw the paddles and the ball
+ window.draw(leftPaddle);
+ window.draw(rightPaddle);
+ window.draw(ball);
+ }
+ else
+ {
+ // Draw the pause message
+ window.draw(pauseMessage);
+ }
+
+ // Display things on screen
+ window.display();
+ }
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/pong/pong.exe b/SQCSim2021/external/sfml251-32/examples/pong/pong.exe
new file mode 100644
index 0000000..986cefc
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/pong/pong.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/pong/resources/ball.wav b/SQCSim2021/external/sfml251-32/examples/pong/resources/ball.wav
new file mode 100644
index 0000000..8b3cfba
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/pong/resources/ball.wav differ
diff --git a/SQCSim2021/external/sfml251-32/examples/pong/resources/sansation.ttf b/SQCSim2021/external/sfml251-32/examples/pong/resources/sansation.ttf
new file mode 100644
index 0000000..d85fbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/pong/resources/sansation.ttf differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/Effect.hpp b/SQCSim2021/external/sfml251-32/examples/shader/Effect.hpp
new file mode 100644
index 0000000..0ff65b4
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/Effect.hpp
@@ -0,0 +1,88 @@
+#ifndef EFFECT_HPP
+#define EFFECT_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+// Base class for effects
+////////////////////////////////////////////////////////////
+class Effect : public sf::Drawable
+{
+public:
+
+ virtual ~Effect()
+ {
+ }
+
+ static void setFont(const sf::Font& font)
+ {
+ s_font = &font;
+ }
+
+ const std::string& getName() const
+ {
+ return m_name;
+ }
+
+ void load()
+ {
+ m_isLoaded = sf::Shader::isAvailable() && onLoad();
+ }
+
+ void update(float time, float x, float y)
+ {
+ if (m_isLoaded)
+ onUpdate(time, x, y);
+ }
+
+ void draw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ if (m_isLoaded)
+ {
+ onDraw(target, states);
+ }
+ else
+ {
+ sf::Text error("Shader not\nsupported", getFont());
+ error.setPosition(320.f, 200.f);
+ error.setCharacterSize(36);
+ target.draw(error, states);
+ }
+ }
+
+protected:
+
+ Effect(const std::string& name) :
+ m_name(name),
+ m_isLoaded(false)
+ {
+ }
+
+ static const sf::Font& getFont()
+ {
+ assert(s_font != NULL);
+ return *s_font;
+ }
+
+private:
+
+ // Virtual functions to be implemented in derived effects
+ virtual bool onLoad() = 0;
+ virtual void onUpdate(float time, float x, float y) = 0;
+ virtual void onDraw(sf::RenderTarget& target, sf::RenderStates states) const = 0;
+
+private:
+
+ std::string m_name;
+ bool m_isLoaded;
+
+ static const sf::Font* s_font;
+};
+
+#endif // EFFECT_HPP
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/Shader.cpp b/SQCSim2021/external/sfml251-32/examples/shader/Shader.cpp
new file mode 100644
index 0000000..8a81fde
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/Shader.cpp
@@ -0,0 +1,460 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include "Effect.hpp"
+#include
+#include
+
+
+const sf::Font* Effect::s_font = NULL;
+
+////////////////////////////////////////////////////////////
+// "Pixelate" fragment shader
+////////////////////////////////////////////////////////////
+class Pixelate : public Effect
+{
+public:
+
+ Pixelate() :
+ Effect("pixelate")
+ {
+ }
+
+ bool onLoad()
+ {
+ // Load the texture and initialize the sprite
+ if (!m_texture.loadFromFile("resources/background.jpg"))
+ return false;
+ m_sprite.setTexture(m_texture);
+
+ // Load the shader
+ if (!m_shader.loadFromFile("resources/pixelate.frag", sf::Shader::Fragment))
+ return false;
+ m_shader.setUniform("texture", sf::Shader::CurrentTexture);
+
+ return true;
+ }
+
+ void onUpdate(float, float x, float y)
+ {
+ m_shader.setUniform("pixel_threshold", (x + y) / 30);
+ }
+
+ void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ states.shader = &m_shader;
+ target.draw(m_sprite, states);
+ }
+
+private:
+
+ sf::Texture m_texture;
+ sf::Sprite m_sprite;
+ sf::Shader m_shader;
+};
+
+
+////////////////////////////////////////////////////////////
+// "Wave" vertex shader + "blur" fragment shader
+////////////////////////////////////////////////////////////
+class WaveBlur : public Effect
+{
+public:
+
+ WaveBlur() :
+ Effect("wave + blur")
+ {
+ }
+
+ bool onLoad()
+ {
+ // Create the text
+ m_text.setString("Praesent suscipit augue in velit pulvinar hendrerit varius purus aliquam.\n"
+ "Mauris mi odio, bibendum quis fringilla a, laoreet vel orci. Proin vitae vulputate tortor.\n"
+ "Praesent cursus ultrices justo, ut feugiat ante vehicula quis.\n"
+ "Donec fringilla scelerisque mauris et viverra.\n"
+ "Maecenas adipiscing ornare scelerisque. Nullam at libero elit.\n"
+ "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\n"
+ "Nullam leo urna, tincidunt id semper eget, ultricies sed mi.\n"
+ "Morbi mauris massa, commodo id dignissim vel, lobortis et elit.\n"
+ "Fusce vel libero sed neque scelerisque venenatis.\n"
+ "Integer mattis tincidunt quam vitae iaculis.\n"
+ "Vivamus fringilla sem non velit venenatis fermentum.\n"
+ "Vivamus varius tincidunt nisi id vehicula.\n"
+ "Integer ullamcorper, enim vitae euismod rutrum, massa nisl semper ipsum,\n"
+ "vestibulum sodales sem ante in massa.\n"
+ "Vestibulum in augue non felis convallis viverra.\n"
+ "Mauris ultricies dolor sed massa convallis sed aliquet augue fringilla.\n"
+ "Duis erat eros, porta in accumsan in, blandit quis sem.\n"
+ "In hac habitasse platea dictumst. Etiam fringilla est id odio dapibus sit amet semper dui laoreet.\n");
+ m_text.setFont(getFont());
+ m_text.setCharacterSize(22);
+ m_text.setPosition(30, 20);
+
+ // Load the shader
+ if (!m_shader.loadFromFile("resources/wave.vert", "resources/blur.frag"))
+ return false;
+
+ return true;
+ }
+
+ void onUpdate(float time, float x, float y)
+ {
+ m_shader.setUniform("wave_phase", time);
+ m_shader.setUniform("wave_amplitude", sf::Vector2f(x * 40, y * 40));
+ m_shader.setUniform("blur_radius", (x + y) * 0.008f);
+ }
+
+ void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ states.shader = &m_shader;
+ target.draw(m_text, states);
+ }
+
+private:
+
+ sf::Text m_text;
+ sf::Shader m_shader;
+};
+
+
+////////////////////////////////////////////////////////////
+// "Storm" vertex shader + "blink" fragment shader
+////////////////////////////////////////////////////////////
+class StormBlink : public Effect
+{
+public:
+
+ StormBlink() :
+ Effect("storm + blink")
+ {
+ }
+
+ bool onLoad()
+ {
+ // Create the points
+ m_points.setPrimitiveType(sf::Points);
+ for (int i = 0; i < 40000; ++i)
+ {
+ float x = static_cast(std::rand() % 800);
+ float y = static_cast(std::rand() % 600);
+ sf::Uint8 r = std::rand() % 255;
+ sf::Uint8 g = std::rand() % 255;
+ sf::Uint8 b = std::rand() % 255;
+ m_points.append(sf::Vertex(sf::Vector2f(x, y), sf::Color(r, g, b)));
+ }
+
+ // Load the shader
+ if (!m_shader.loadFromFile("resources/storm.vert", "resources/blink.frag"))
+ return false;
+
+ return true;
+ }
+
+ void onUpdate(float time, float x, float y)
+ {
+ float radius = 200 + std::cos(time) * 150;
+ m_shader.setUniform("storm_position", sf::Vector2f(x * 800, y * 600));
+ m_shader.setUniform("storm_inner_radius", radius / 3);
+ m_shader.setUniform("storm_total_radius", radius);
+ m_shader.setUniform("blink_alpha", 0.5f + std::cos(time * 3) * 0.25f);
+ }
+
+ void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ states.shader = &m_shader;
+ target.draw(m_points, states);
+ }
+
+private:
+
+ sf::VertexArray m_points;
+ sf::Shader m_shader;
+};
+
+
+////////////////////////////////////////////////////////////
+// "Edge" post-effect fragment shader
+////////////////////////////////////////////////////////////
+class Edge : public Effect
+{
+public:
+
+ Edge() :
+ Effect("edge post-effect")
+ {
+ }
+
+ bool onLoad()
+ {
+ // Create the off-screen surface
+ if (!m_surface.create(800, 600))
+ return false;
+ m_surface.setSmooth(true);
+
+ // Load the textures
+ if (!m_backgroundTexture.loadFromFile("resources/sfml.png"))
+ return false;
+ m_backgroundTexture.setSmooth(true);
+ if (!m_entityTexture.loadFromFile("resources/devices.png"))
+ return false;
+ m_entityTexture.setSmooth(true);
+
+ // Initialize the background sprite
+ m_backgroundSprite.setTexture(m_backgroundTexture);
+ m_backgroundSprite.setPosition(135, 100);
+
+ // Load the moving entities
+ for (int i = 0; i < 6; ++i)
+ {
+ sf::Sprite entity(m_entityTexture, sf::IntRect(96 * i, 0, 96, 96));
+ m_entities.push_back(entity);
+ }
+
+ // Load the shader
+ if (!m_shader.loadFromFile("resources/edge.frag", sf::Shader::Fragment))
+ return false;
+ m_shader.setUniform("texture", sf::Shader::CurrentTexture);
+
+ return true;
+ }
+
+ void onUpdate(float time, float x, float y)
+ {
+ m_shader.setUniform("edge_threshold", 1 - (x + y) / 2);
+
+ // Update the position of the moving entities
+ for (std::size_t i = 0; i < m_entities.size(); ++i)
+ {
+ sf::Vector2f position;
+ position.x = std::cos(0.25f * (time * i + (m_entities.size() - i))) * 300 + 350;
+ position.y = std::sin(0.25f * (time * (m_entities.size() - i) + i)) * 200 + 250;
+ m_entities[i].setPosition(position);
+ }
+
+ // Render the updated scene to the off-screen surface
+ m_surface.clear(sf::Color::White);
+ m_surface.draw(m_backgroundSprite);
+ for (std::size_t i = 0; i < m_entities.size(); ++i)
+ m_surface.draw(m_entities[i]);
+ m_surface.display();
+ }
+
+ void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ states.shader = &m_shader;
+ target.draw(sf::Sprite(m_surface.getTexture()), states);
+ }
+
+private:
+
+ sf::RenderTexture m_surface;
+ sf::Texture m_backgroundTexture;
+ sf::Texture m_entityTexture;
+ sf::Sprite m_backgroundSprite;
+ std::vector m_entities;
+ sf::Shader m_shader;
+};
+
+
+////////////////////////////////////////////////////////////
+// "Geometry" geometry shader example
+////////////////////////////////////////////////////////////
+class Geometry : public Effect
+{
+public:
+
+ Geometry() :
+ Effect("geometry shader billboards"),
+ m_pointCloud(sf::Points, 10000)
+ {
+ }
+
+ bool onLoad()
+ {
+ // Check if geometry shaders are supported
+ if (!sf::Shader::isGeometryAvailable())
+ return false;
+
+ // Move the points in the point cloud to random positions
+ for (std::size_t i = 0; i < 10000; i++)
+ {
+ // Spread the coordinates from -480 to +480
+ // So they'll always fill the viewport at 800x600
+ m_pointCloud[i].position.x = rand() % 960 - 480.f;
+ m_pointCloud[i].position.y = rand() % 960 - 480.f;
+ }
+
+ // Load the texture
+ if (!m_logoTexture.loadFromFile("resources/logo.png"))
+ return false;
+
+ // Load the shader
+ if (!m_shader.loadFromFile("resources/billboard.vert", "resources/billboard.geom", "resources/billboard.frag"))
+ return false;
+ m_shader.setUniform("texture", sf::Shader::CurrentTexture);
+
+ // Set the render resolution (used for proper scaling)
+ m_shader.setUniform("resolution", sf::Vector2f(800, 600));
+
+ return true;
+ }
+
+ void onUpdate(float time, float x, float y)
+ {
+ // Reset our transformation matrix
+ m_transform = sf::Transform::Identity;
+ // Move to the center of the window
+ m_transform.translate(400, 300);
+ // Rotate everything based on cursor position
+ m_transform.rotate(x * 360.f);
+
+ // Adjust billboard size to scale between 25 and 75
+ float size = 25 + std::abs(y) * 50;
+
+ // Update the shader parameter
+ m_shader.setUniform("size", sf::Vector2f(size, size));
+ }
+
+ void onDraw(sf::RenderTarget& target, sf::RenderStates states) const
+ {
+ // Prepare the render state
+ states.shader = &m_shader;
+ states.texture = &m_logoTexture;
+ states.transform = m_transform;
+
+ // Draw the point cloud
+ target.draw(m_pointCloud, states);
+ }
+
+private:
+
+ sf::Texture m_logoTexture;
+ sf::Transform m_transform;
+ sf::Shader m_shader;
+ sf::VertexArray m_pointCloud;
+};
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Create the main window
+ sf::RenderWindow window(sf::VideoMode(800, 600), "SFML Shader",
+ sf::Style::Titlebar | sf::Style::Close);
+ window.setVerticalSyncEnabled(true);
+
+ // Load the application font and pass it to the Effect class
+ sf::Font font;
+ if (!font.loadFromFile("resources/sansation.ttf"))
+ return EXIT_FAILURE;
+ Effect::setFont(font);
+
+ // Create the effects
+ std::vector effects;
+ effects.push_back(new Pixelate);
+ effects.push_back(new WaveBlur);
+ effects.push_back(new StormBlink);
+ effects.push_back(new Edge);
+ effects.push_back(new Geometry);
+ std::size_t current = 0;
+
+ // Initialize them
+ for (std::size_t i = 0; i < effects.size(); ++i)
+ effects[i]->load();
+
+ // Create the messages background
+ sf::Texture textBackgroundTexture;
+ if (!textBackgroundTexture.loadFromFile("resources/text-background.png"))
+ return EXIT_FAILURE;
+ sf::Sprite textBackground(textBackgroundTexture);
+ textBackground.setPosition(0, 520);
+ textBackground.setColor(sf::Color(255, 255, 255, 200));
+
+ // Create the description text
+ sf::Text description("Current effect: " + effects[current]->getName(), font, 20);
+ description.setPosition(10, 530);
+ description.setFillColor(sf::Color(80, 80, 80));
+
+ // Create the instructions text
+ sf::Text instructions("Press left and right arrows to change the current shader", font, 20);
+ instructions.setPosition(280, 555);
+ instructions.setFillColor(sf::Color(80, 80, 80));
+
+ // Start the game loop
+ sf::Clock clock;
+ while (window.isOpen())
+ {
+ // Process events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Close window: exit
+ if (event.type == sf::Event::Closed)
+ window.close();
+
+ if (event.type == sf::Event::KeyPressed)
+ {
+ switch (event.key.code)
+ {
+ // Escape key: exit
+ case sf::Keyboard::Escape:
+ window.close();
+ break;
+
+ // Left arrow key: previous shader
+ case sf::Keyboard::Left:
+ if (current == 0)
+ current = effects.size() - 1;
+ else
+ current--;
+ description.setString("Current effect: " + effects[current]->getName());
+ break;
+
+ // Right arrow key: next shader
+ case sf::Keyboard::Right:
+ if (current == effects.size() - 1)
+ current = 0;
+ else
+ current++;
+ description.setString("Current effect: " + effects[current]->getName());
+ break;
+
+ default:
+ break;
+ }
+ }
+ }
+
+ // Update the current example
+ float x = static_cast(sf::Mouse::getPosition(window).x) / window.getSize().x;
+ float y = static_cast(sf::Mouse::getPosition(window).y) / window.getSize().y;
+ effects[current]->update(clock.getElapsedTime().asSeconds(), x, y);
+
+ // Clear the window
+ window.clear(sf::Color(255, 128, 0));
+
+ // Draw the current example
+ window.draw(*effects[current]);
+
+ // Draw the text
+ window.draw(textBackground);
+ window.draw(instructions);
+ window.draw(description);
+
+ // Finally, display the rendered frame on screen
+ window.display();
+ }
+
+ // delete the effects
+ for (std::size_t i = 0; i < effects.size(); ++i)
+ delete effects[i];
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/background.jpg b/SQCSim2021/external/sfml251-32/examples/shader/resources/background.jpg
new file mode 100644
index 0000000..f37d7ae
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/background.jpg differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.frag b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.frag
new file mode 100644
index 0000000..3057f64
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.frag
@@ -0,0 +1,11 @@
+#version 150
+
+uniform sampler2D texture;
+
+in vec2 tex_coord;
+
+void main()
+{
+ // Read and apply a color from the texture
+ gl_FragColor = texture2D(texture, tex_coord);
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.geom b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.geom
new file mode 100644
index 0000000..2f47a1f
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.geom
@@ -0,0 +1,56 @@
+#version 150
+
+// The render target's resolution (used for scaling)
+uniform vec2 resolution;
+
+// The billboards' size
+uniform vec2 size;
+
+// Input is the passed point cloud
+layout (points) in;
+
+// The output will consist of triangle strips with four vertices each
+layout (triangle_strip, max_vertices = 4) out;
+
+// Output texture coordinates
+out vec2 tex_coord;
+
+// Main entry point
+void main()
+{
+ // Caculate the half width/height of the billboards
+ vec2 half_size = size / 2.f;
+
+ // Scale the size based on resolution (1 would be full width/height)
+ half_size /= resolution;
+
+ // Iterate over all vertices
+ for (int i = 0; i < gl_in.length(); i++)
+ {
+ // Retrieve the passed vertex position
+ vec2 pos = gl_in[i].gl_Position.xy;
+
+ // Bottom left vertex
+ gl_Position = vec4(pos - half_size, 0.f, 1.f);
+ tex_coord = vec2(1.f, 1.f);
+ EmitVertex();
+
+ // Bottom right vertex
+ gl_Position = vec4(pos.x + half_size.x, pos.y - half_size.y, 0.f, 1.f);
+ tex_coord = vec2(0.f, 1.f);
+ EmitVertex();
+
+ // Top left vertex
+ gl_Position = vec4(pos.x - half_size.x, pos.y + half_size.y, 0.f, 1.f);
+ tex_coord = vec2(1.f, 0.f);
+ EmitVertex();
+
+ // Top right vertex
+ gl_Position = vec4(pos + half_size, 0.f, 1.f);
+ tex_coord = vec2(0.f, 0.f);
+ EmitVertex();
+
+ // And finalize the primitive
+ EndPrimitive();
+ }
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.vert b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.vert
new file mode 100644
index 0000000..3a89905
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/billboard.vert
@@ -0,0 +1,5 @@
+void main()
+{
+ // Transform the vertex position
+ gl_Position = gl_ModelViewProjectionMatrix * gl_Vertex;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/blink.frag b/SQCSim2021/external/sfml251-32/examples/shader/resources/blink.frag
new file mode 100644
index 0000000..50a04a5
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/blink.frag
@@ -0,0 +1,9 @@
+uniform sampler2D texture;
+uniform float blink_alpha;
+
+void main()
+{
+ vec4 pixel = gl_Color;
+ pixel.a = blink_alpha;
+ gl_FragColor = pixel;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/blur.frag b/SQCSim2021/external/sfml251-32/examples/shader/resources/blur.frag
new file mode 100644
index 0000000..b8aba38
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/blur.frag
@@ -0,0 +1,20 @@
+uniform sampler2D texture;
+uniform float blur_radius;
+
+void main()
+{
+ vec2 offx = vec2(blur_radius, 0.0);
+ vec2 offy = vec2(0.0, blur_radius);
+
+ vec4 pixel = texture2D(texture, gl_TexCoord[0].xy) * 4.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offy) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offy) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx - offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx + offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx - offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx + offy) * 1.0;
+
+ gl_FragColor = gl_Color * (pixel / 16.0);
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/devices.png b/SQCSim2021/external/sfml251-32/examples/shader/resources/devices.png
new file mode 100644
index 0000000..6b1cbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/devices.png differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/edge.frag b/SQCSim2021/external/sfml251-32/examples/shader/resources/edge.frag
new file mode 100644
index 0000000..7f869f5
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/edge.frag
@@ -0,0 +1,32 @@
+uniform sampler2D texture;
+uniform float edge_threshold;
+
+void main()
+{
+ const float offset = 1.0 / 512.0;
+ vec2 offx = vec2(offset, 0.0);
+ vec2 offy = vec2(0.0, offset);
+
+ vec4 hEdge = texture2D(texture, gl_TexCoord[0].xy - offy) * -2.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offy) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx - offy) * -1.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx + offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx - offy) * -1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx + offy) * 1.0;
+
+ vec4 vEdge = texture2D(texture, gl_TexCoord[0].xy - offx) * 2.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx) * -2.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx - offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy - offx + offy) * -1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx - offy) * 1.0 +
+ texture2D(texture, gl_TexCoord[0].xy + offx + offy) * -1.0;
+
+ vec3 result = sqrt(hEdge.rgb * hEdge.rgb + vEdge.rgb * vEdge.rgb);
+ float edge = length(result);
+ vec4 pixel = gl_Color * texture2D(texture, gl_TexCoord[0].xy);
+ if (edge > (edge_threshold * 8.0))
+ pixel.rgb = vec3(0.0, 0.0, 0.0);
+ else
+ pixel.a = edge_threshold;
+ gl_FragColor = pixel;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/logo.png b/SQCSim2021/external/sfml251-32/examples/shader/resources/logo.png
new file mode 100644
index 0000000..29ba010
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/logo.png differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/pixelate.frag b/SQCSim2021/external/sfml251-32/examples/shader/resources/pixelate.frag
new file mode 100644
index 0000000..79f8868
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/pixelate.frag
@@ -0,0 +1,9 @@
+uniform sampler2D texture;
+uniform float pixel_threshold;
+
+void main()
+{
+ float factor = 1.0 / (pixel_threshold + 0.001);
+ vec2 pos = floor(gl_TexCoord[0].xy * factor + 0.5) / factor;
+ gl_FragColor = texture2D(texture, pos) * gl_Color;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/sansation.ttf b/SQCSim2021/external/sfml251-32/examples/shader/resources/sansation.ttf
new file mode 100644
index 0000000..d85fbc8
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/sansation.ttf differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/sfml.png b/SQCSim2021/external/sfml251-32/examples/shader/resources/sfml.png
new file mode 100644
index 0000000..1da719f
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/sfml.png differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/storm.vert b/SQCSim2021/external/sfml251-32/examples/shader/resources/storm.vert
new file mode 100644
index 0000000..fab9da4
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/storm.vert
@@ -0,0 +1,19 @@
+uniform vec2 storm_position;
+uniform float storm_total_radius;
+uniform float storm_inner_radius;
+
+void main()
+{
+ vec4 vertex = gl_ModelViewMatrix * gl_Vertex;
+ vec2 offset = vertex.xy - storm_position;
+ float len = length(offset);
+ if (len < storm_total_radius)
+ {
+ float push_distance = storm_inner_radius + len / storm_total_radius * (storm_total_radius - storm_inner_radius);
+ vertex.xy = storm_position + normalize(offset) * push_distance;
+ }
+
+ gl_Position = gl_ProjectionMatrix * vertex;
+ gl_TexCoord[0] = gl_TextureMatrix[0] * gl_MultiTexCoord0;
+ gl_FrontColor = gl_Color;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/text-background.png b/SQCSim2021/external/sfml251-32/examples/shader/resources/text-background.png
new file mode 100644
index 0000000..c86e9b6
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/resources/text-background.png differ
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/resources/wave.vert b/SQCSim2021/external/sfml251-32/examples/shader/resources/wave.vert
new file mode 100644
index 0000000..278a53b
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/shader/resources/wave.vert
@@ -0,0 +1,15 @@
+uniform float wave_phase;
+uniform vec2 wave_amplitude;
+
+void main()
+{
+ vec4 vertex = gl_Vertex;
+ vertex.x += cos(gl_Vertex.y * 0.02 + wave_phase * 3.8) * wave_amplitude.x
+ + sin(gl_Vertex.y * 0.02 + wave_phase * 6.3) * wave_amplitude.x * 0.3;
+ vertex.y += sin(gl_Vertex.x * 0.02 + wave_phase * 2.4) * wave_amplitude.y
+ + cos(gl_Vertex.x * 0.02 + wave_phase * 5.2) * wave_amplitude.y * 0.3;
+
+ gl_Position = gl_ModelViewProjectionMatrix * vertex;
+ gl_TexCoord[0] = gl_TextureMatrix[0] * gl_MultiTexCoord0;
+ gl_FrontColor = gl_Color;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/shader/shader.exe b/SQCSim2021/external/sfml251-32/examples/shader/shader.exe
new file mode 100644
index 0000000..dd74780
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/shader/shader.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sockets/Sockets.cpp b/SQCSim2021/external/sfml251-32/examples/sockets/Sockets.cpp
new file mode 100644
index 0000000..6bdd44b
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/sockets/Sockets.cpp
@@ -0,0 +1,59 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+void runTcpServer(unsigned short port);
+void runTcpClient(unsigned short port);
+void runUdpServer(unsigned short port);
+void runUdpClient(unsigned short port);
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Choose an arbitrary port for opening sockets
+ const unsigned short port = 50001;
+
+ // TCP, UDP or connected UDP ?
+ char protocol;
+ std::cout << "Do you want to use TCP (t) or UDP (u)? ";
+ std::cin >> protocol;
+
+ // Client or server ?
+ char who;
+ std::cout << "Do you want to be a server (s) or a client (c)? ";
+ std::cin >> who;
+
+ if (protocol == 't')
+ {
+ // Test the TCP protocol
+ if (who == 's')
+ runTcpServer(port);
+ else
+ runTcpClient(port);
+ }
+ else
+ {
+ // Test the unconnected UDP protocol
+ if (who == 's')
+ runUdpServer(port);
+ else
+ runUdpClient(port);
+ }
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to exit..." << std::endl;
+ std::cin.ignore(10000, '\n');
+ std::cin.ignore(10000, '\n');
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/sockets/TCP.cpp b/SQCSim2021/external/sfml251-32/examples/sockets/TCP.cpp
new file mode 100644
index 0000000..64fb7f9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/sockets/TCP.cpp
@@ -0,0 +1,81 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Launch a server, wait for an incoming connection,
+/// send a message and wait for the answer.
+///
+////////////////////////////////////////////////////////////
+void runTcpServer(unsigned short port)
+{
+ // Create a server socket to accept new connections
+ sf::TcpListener listener;
+
+ // Listen to the given port for incoming connections
+ if (listener.listen(port) != sf::Socket::Done)
+ return;
+ std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl;
+
+ // Wait for a connection
+ sf::TcpSocket socket;
+ if (listener.accept(socket) != sf::Socket::Done)
+ return;
+ std::cout << "Client connected: " << socket.getRemoteAddress() << std::endl;
+
+ // Send a message to the connected client
+ const char out[] = "Hi, I'm the server";
+ if (socket.send(out, sizeof(out)) != sf::Socket::Done)
+ return;
+ std::cout << "Message sent to the client: \"" << out << "\"" << std::endl;
+
+ // Receive a message back from the client
+ char in[128];
+ std::size_t received;
+ if (socket.receive(in, sizeof(in), received) != sf::Socket::Done)
+ return;
+ std::cout << "Answer received from the client: \"" << in << "\"" << std::endl;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Create a client, connect it to a server, display the
+/// welcome message and send an answer.
+///
+////////////////////////////////////////////////////////////
+void runTcpClient(unsigned short port)
+{
+ // Ask for the server address
+ sf::IpAddress server;
+ do
+ {
+ std::cout << "Type the address or name of the server to connect to: ";
+ std::cin >> server;
+ }
+ while (server == sf::IpAddress::None);
+
+ // Create a socket for communicating with the server
+ sf::TcpSocket socket;
+
+ // Connect to the server
+ if (socket.connect(server, port) != sf::Socket::Done)
+ return;
+ std::cout << "Connected to server " << server << std::endl;
+
+ // Receive a message from the server
+ char in[128];
+ std::size_t received;
+ if (socket.receive(in, sizeof(in), received) != sf::Socket::Done)
+ return;
+ std::cout << "Message received from the server: \"" << in << "\"" << std::endl;
+
+ // Send an answer to the server
+ const char out[] = "Hi, I'm a client";
+ if (socket.send(out, sizeof(out)) != sf::Socket::Done)
+ return;
+ std::cout << "Message sent to the server: \"" << out << "\"" << std::endl;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/sockets/UDP.cpp b/SQCSim2021/external/sfml251-32/examples/sockets/UDP.cpp
new file mode 100644
index 0000000..37a07c5
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/sockets/UDP.cpp
@@ -0,0 +1,72 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Launch a server, wait for a message, send an answer.
+///
+////////////////////////////////////////////////////////////
+void runUdpServer(unsigned short port)
+{
+ // Create a socket to receive a message from anyone
+ sf::UdpSocket socket;
+
+ // Listen to messages on the specified port
+ if (socket.bind(port) != sf::Socket::Done)
+ return;
+ std::cout << "Server is listening to port " << port << ", waiting for a message... " << std::endl;
+
+ // Wait for a message
+ char in[128];
+ std::size_t received;
+ sf::IpAddress sender;
+ unsigned short senderPort;
+ if (socket.receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done)
+ return;
+ std::cout << "Message received from client " << sender << ": \"" << in << "\"" << std::endl;
+
+ // Send an answer to the client
+ const char out[] = "Hi, I'm the server";
+ if (socket.send(out, sizeof(out), sender, senderPort) != sf::Socket::Done)
+ return;
+ std::cout << "Message sent to the client: \"" << out << "\"" << std::endl;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Send a message to the server, wait for the answer
+///
+////////////////////////////////////////////////////////////
+void runUdpClient(unsigned short port)
+{
+ // Ask for the server address
+ sf::IpAddress server;
+ do
+ {
+ std::cout << "Type the address or name of the server to connect to: ";
+ std::cin >> server;
+ }
+ while (server == sf::IpAddress::None);
+
+ // Create a socket for communicating with the server
+ sf::UdpSocket socket;
+
+ // Send a message to the server
+ const char out[] = "Hi, I'm a client";
+ if (socket.send(out, sizeof(out), server, port) != sf::Socket::Done)
+ return;
+ std::cout << "Message sent to the server: \"" << out << "\"" << std::endl;
+
+ // Receive an answer from anyone (but most likely from the server)
+ char in[128];
+ std::size_t received;
+ sf::IpAddress sender;
+ unsigned short senderPort;
+ if (socket.receive(in, sizeof(in), received, sender, senderPort) != sf::Socket::Done)
+ return;
+ std::cout << "Message received from " << sender << ": \"" << in << "\"" << std::endl;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/sockets/sockets.exe b/SQCSim2021/external/sfml251-32/examples/sockets/sockets.exe
new file mode 100644
index 0000000..4eb6188
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sockets/sockets.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sound-capture/SoundCapture.cpp b/SQCSim2021/external/sfml251-32/examples/sound-capture/SoundCapture.cpp
new file mode 100644
index 0000000..19f114b
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/sound-capture/SoundCapture.cpp
@@ -0,0 +1,94 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Check that the device can capture audio
+ if (sf::SoundRecorder::isAvailable() == false)
+ {
+ std::cout << "Sorry, audio capture is not supported by your system" << std::endl;
+ return EXIT_SUCCESS;
+ }
+
+ // Choose the sample rate
+ unsigned int sampleRate;
+ std::cout << "Please choose the sample rate for sound capture (44100 is CD quality): ";
+ std::cin >> sampleRate;
+ std::cin.ignore(10000, '\n');
+
+ // Wait for user input...
+ std::cout << "Press enter to start recording audio";
+ std::cin.ignore(10000, '\n');
+
+ // Here we'll use an integrated custom recorder, which saves the captured data into a SoundBuffer
+ sf::SoundBufferRecorder recorder;
+
+ // Audio capture is done in a separate thread, so we can block the main thread while it is capturing
+ recorder.start(sampleRate);
+ std::cout << "Recording... press enter to stop";
+ std::cin.ignore(10000, '\n');
+ recorder.stop();
+
+ // Get the buffer containing the captured data
+ const sf::SoundBuffer& buffer = recorder.getBuffer();
+
+ // Display captured sound informations
+ std::cout << "Sound information:" << std::endl;
+ std::cout << " " << buffer.getDuration().asSeconds() << " seconds" << std::endl;
+ std::cout << " " << buffer.getSampleRate() << " samples / seconds" << std::endl;
+ std::cout << " " << buffer.getChannelCount() << " channels" << std::endl;
+
+ // Choose what to do with the recorded sound data
+ char choice;
+ std::cout << "What do you want to do with captured sound (p = play, s = save) ? ";
+ std::cin >> choice;
+ std::cin.ignore(10000, '\n');
+
+ if (choice == 's')
+ {
+ // Choose the filename
+ std::string filename;
+ std::cout << "Choose the file to create: ";
+ std::getline(std::cin, filename);
+
+ // Save the buffer
+ buffer.saveToFile(filename);
+ }
+ else
+ {
+ // Create a sound instance and play it
+ sf::Sound sound(buffer);
+ sound.play();
+
+ // Wait until finished
+ while (sound.getStatus() == sf::Sound::Playing)
+ {
+ // Display the playing position
+ std::cout << "\rPlaying... " << sound.getPlayingOffset().asSeconds() << " sec ";
+ std::cout << std::flush;
+
+ // Leave some CPU time for other threads
+ sf::sleep(sf::milliseconds(100));
+ }
+ }
+
+ // Finished!
+ std::cout << std::endl << "Done!" << std::endl;
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to exit..." << std::endl;
+ std::cin.ignore(10000, '\n');
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/sound-capture/sound-capture.exe b/SQCSim2021/external/sfml251-32/examples/sound-capture/sound-capture.exe
new file mode 100644
index 0000000..8366770
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sound-capture/sound-capture.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sound/Sound.cpp b/SQCSim2021/external/sfml251-32/examples/sound/Sound.cpp
new file mode 100644
index 0000000..e71aa0d
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/sound/Sound.cpp
@@ -0,0 +1,101 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Play a sound
+///
+////////////////////////////////////////////////////////////
+void playSound()
+{
+ // Load a sound buffer from a wav file
+ sf::SoundBuffer buffer;
+ if (!buffer.loadFromFile("resources/canary.wav"))
+ return;
+
+ // Display sound informations
+ std::cout << "canary.wav:" << std::endl;
+ std::cout << " " << buffer.getDuration().asSeconds() << " seconds" << std::endl;
+ std::cout << " " << buffer.getSampleRate() << " samples / sec" << std::endl;
+ std::cout << " " << buffer.getChannelCount() << " channels" << std::endl;
+
+ // Create a sound instance and play it
+ sf::Sound sound(buffer);
+ sound.play();
+
+ // Loop while the sound is playing
+ while (sound.getStatus() == sf::Sound::Playing)
+ {
+ // Leave some CPU time for other processes
+ sf::sleep(sf::milliseconds(100));
+
+ // Display the playing position
+ std::cout << "\rPlaying... " << sound.getPlayingOffset().asSeconds() << " sec ";
+ std::cout << std::flush;
+ }
+ std::cout << std::endl << std::endl;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Play a music
+///
+////////////////////////////////////////////////////////////
+void playMusic(const std::string& filename)
+{
+ // Load an ogg music file
+ sf::Music music;
+ if (!music.openFromFile("resources/" + filename))
+ return;
+
+ // Display music informations
+ std::cout << filename << ":" << std::endl;
+ std::cout << " " << music.getDuration().asSeconds() << " seconds" << std::endl;
+ std::cout << " " << music.getSampleRate() << " samples / sec" << std::endl;
+ std::cout << " " << music.getChannelCount() << " channels" << std::endl;
+
+ // Play it
+ music.play();
+
+ // Loop while the music is playing
+ while (music.getStatus() == sf::Music::Playing)
+ {
+ // Leave some CPU time for other processes
+ sf::sleep(sf::milliseconds(100));
+
+ // Display the playing position
+ std::cout << "\rPlaying... " << music.getPlayingOffset().asSeconds() << " sec ";
+ std::cout << std::flush;
+ }
+ std::cout << std::endl << std::endl;
+}
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Play a sound
+ playSound();
+
+ // Play music from an ogg file
+ playMusic("orchestral.ogg");
+
+ // Play music from a flac file
+ playMusic("ding.flac");
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to exit..." << std::endl;
+ std::cin.ignore(10000, '\n');
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/sound/resources/canary.wav b/SQCSim2021/external/sfml251-32/examples/sound/resources/canary.wav
new file mode 100644
index 0000000..a0f3aec
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sound/resources/canary.wav differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sound/resources/ding.flac b/SQCSim2021/external/sfml251-32/examples/sound/resources/ding.flac
new file mode 100644
index 0000000..4e62c78
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sound/resources/ding.flac differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sound/resources/orchestral.ogg b/SQCSim2021/external/sfml251-32/examples/sound/resources/orchestral.ogg
new file mode 100644
index 0000000..f764d61
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sound/resources/orchestral.ogg differ
diff --git a/SQCSim2021/external/sfml251-32/examples/sound/sound.exe b/SQCSim2021/external/sfml251-32/examples/sound/sound.exe
new file mode 100644
index 0000000..34bc3d3
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/sound/sound.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/voip/Client.cpp b/SQCSim2021/external/sfml251-32/examples/voip/Client.cpp
new file mode 100644
index 0000000..d66e0e2
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/voip/Client.cpp
@@ -0,0 +1,141 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+const sf::Uint8 audioData = 1;
+const sf::Uint8 endOfStream = 2;
+
+
+////////////////////////////////////////////////////////////
+/// Specialization of audio recorder for sending recorded audio
+/// data through the network
+////////////////////////////////////////////////////////////
+class NetworkRecorder : public sf::SoundRecorder
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// Constructor
+ ///
+ /// \param host Remote host to which send the recording data
+ /// \param port Port of the remote host
+ ///
+ ////////////////////////////////////////////////////////////
+ NetworkRecorder(const sf::IpAddress& host, unsigned short port) :
+ m_host(host),
+ m_port(port)
+ {
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// Destructor
+ ///
+ /// \see SoundRecorder::~SoundRecorder()
+ ///
+ ////////////////////////////////////////////////////////////
+ ~NetworkRecorder()
+ {
+ // Make sure to stop the recording thread
+ stop();
+ }
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \see SoundRecorder::onStart
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onStart()
+ {
+ if (m_socket.connect(m_host, m_port) == sf::Socket::Done)
+ {
+ std::cout << "Connected to server " << m_host << std::endl;
+ return true;
+ }
+ else
+ {
+ return false;
+ }
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// \see SoundRecorder::onProcessSamples
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onProcessSamples(const sf::Int16* samples, std::size_t sampleCount)
+ {
+ // Pack the audio samples into a network packet
+ sf::Packet packet;
+ packet << audioData;
+ packet.append(samples, sampleCount * sizeof(sf::Int16));
+
+ // Send the audio packet to the server
+ return m_socket.send(packet) == sf::Socket::Done;
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// \see SoundRecorder::onStop
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onStop()
+ {
+ // Send a "end-of-stream" packet
+ sf::Packet packet;
+ packet << endOfStream;
+ m_socket.send(packet);
+
+ // Close the socket
+ m_socket.disconnect();
+ }
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ sf::IpAddress m_host; ///< Address of the remote host
+ unsigned short m_port; ///< Remote port
+ sf::TcpSocket m_socket; ///< Socket used to communicate with the server
+};
+
+
+////////////////////////////////////////////////////////////
+/// Create a client, connect it to a running server and
+/// start sending him audio data
+///
+////////////////////////////////////////////////////////////
+void doClient(unsigned short port)
+{
+ // Check that the device can capture audio
+ if (!sf::SoundRecorder::isAvailable())
+ {
+ std::cout << "Sorry, audio capture is not supported by your system" << std::endl;
+ return;
+ }
+
+ // Ask for server address
+ sf::IpAddress server;
+ do
+ {
+ std::cout << "Type address or name of the server to connect to: ";
+ std::cin >> server;
+ }
+ while (server == sf::IpAddress::None);
+
+ // Create an instance of our custom recorder
+ NetworkRecorder recorder(server, port);
+
+ // Wait for user input...
+ std::cin.ignore(10000, '\n');
+ std::cout << "Press enter to start recording audio";
+ std::cin.ignore(10000, '\n');
+
+ // Start capturing audio data
+ recorder.start(44100);
+ std::cout << "Recording... press enter to stop";
+ std::cin.ignore(10000, '\n');
+ recorder.stop();
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/voip/Server.cpp b/SQCSim2021/external/sfml251-32/examples/voip/Server.cpp
new file mode 100644
index 0000000..0875bf9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/voip/Server.cpp
@@ -0,0 +1,200 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+
+
+const sf::Uint8 audioData = 1;
+const sf::Uint8 endOfStream = 2;
+
+
+////////////////////////////////////////////////////////////
+/// Customized sound stream for acquiring audio data
+/// from the network
+////////////////////////////////////////////////////////////
+class NetworkAudioStream : public sf::SoundStream
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ NetworkAudioStream() :
+ m_offset (0),
+ m_hasFinished(false)
+ {
+ // Set the sound parameters
+ initialize(1, 44100);
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// Run the server, stream audio data from the client
+ ///
+ ////////////////////////////////////////////////////////////
+ void start(unsigned short port)
+ {
+ if (!m_hasFinished)
+ {
+ // Listen to the given port for incoming connections
+ if (m_listener.listen(port) != sf::Socket::Done)
+ return;
+ std::cout << "Server is listening to port " << port << ", waiting for connections... " << std::endl;
+
+ // Wait for a connection
+ if (m_listener.accept(m_client) != sf::Socket::Done)
+ return;
+ std::cout << "Client connected: " << m_client.getRemoteAddress() << std::endl;
+
+ // Start playback
+ play();
+
+ // Start receiving audio data
+ receiveLoop();
+ }
+ else
+ {
+ // Start playback
+ play();
+ }
+ }
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// /see SoundStream::OnGetData
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onGetData(sf::SoundStream::Chunk& data)
+ {
+ // We have reached the end of the buffer and all audio data have been played: we can stop playback
+ if ((m_offset >= m_samples.size()) && m_hasFinished)
+ return false;
+
+ // No new data has arrived since last update: wait until we get some
+ while ((m_offset >= m_samples.size()) && !m_hasFinished)
+ sf::sleep(sf::milliseconds(10));
+
+ // Copy samples into a local buffer to avoid synchronization problems
+ // (don't forget that we run in two separate threads)
+ {
+ sf::Lock lock(m_mutex);
+ m_tempBuffer.assign(m_samples.begin() + m_offset, m_samples.end());
+ }
+
+ // Fill audio data to pass to the stream
+ data.samples = &m_tempBuffer[0];
+ data.sampleCount = m_tempBuffer.size();
+
+ // Update the playing offset
+ m_offset += m_tempBuffer.size();
+
+ return true;
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// /see SoundStream::OnSeek
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onSeek(sf::Time timeOffset)
+ {
+ m_offset = timeOffset.asMilliseconds() * getSampleRate() * getChannelCount() / 1000;
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// Get audio data from the client until playback is stopped
+ ///
+ ////////////////////////////////////////////////////////////
+ void receiveLoop()
+ {
+ while (!m_hasFinished)
+ {
+ // Get waiting audio data from the network
+ sf::Packet packet;
+ if (m_client.receive(packet) != sf::Socket::Done)
+ break;
+
+ // Extract the message ID
+ sf::Uint8 id;
+ packet >> id;
+
+ if (id == audioData)
+ {
+ // Extract audio samples from the packet, and append it to our samples buffer
+ const sf::Int16* samples = reinterpret_cast(static_cast(packet.getData()) + 1);
+ std::size_t sampleCount = (packet.getDataSize() - 1) / sizeof(sf::Int16);
+
+ // Don't forget that the other thread can access the sample array at any time
+ // (so we protect any operation on it with the mutex)
+ {
+ sf::Lock lock(m_mutex);
+ std::copy(samples, samples + sampleCount, std::back_inserter(m_samples));
+ }
+ }
+ else if (id == endOfStream)
+ {
+ // End of stream reached: we stop receiving audio data
+ std::cout << "Audio data has been 100% received!" << std::endl;
+ m_hasFinished = true;
+ }
+ else
+ {
+ // Something's wrong...
+ std::cout << "Invalid packet received..." << std::endl;
+ m_hasFinished = true;
+ }
+ }
+ }
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ sf::TcpListener m_listener;
+ sf::TcpSocket m_client;
+ sf::Mutex m_mutex;
+ std::vector m_samples;
+ std::vector m_tempBuffer;
+ std::size_t m_offset;
+ bool m_hasFinished;
+};
+
+
+////////////////////////////////////////////////////////////
+/// Launch a server and wait for incoming audio data from
+/// a connected client
+///
+////////////////////////////////////////////////////////////
+void doServer(unsigned short port)
+{
+ // Build an audio stream to play sound data as it is received through the network
+ NetworkAudioStream audioStream;
+ audioStream.start(port);
+
+ // Loop until the sound playback is finished
+ while (audioStream.getStatus() != sf::SoundStream::Stopped)
+ {
+ // Leave some CPU time for other threads
+ sf::sleep(sf::milliseconds(100));
+ }
+
+ std::cin.ignore(10000, '\n');
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to replay the sound..." << std::endl;
+ std::cin.ignore(10000, '\n');
+
+ // Replay the sound (just to make sure replaying the received data is OK)
+ audioStream.play();
+
+ // Loop until the sound playback is finished
+ while (audioStream.getStatus() != sf::SoundStream::Stopped)
+ {
+ // Leave some CPU time for other threads
+ sf::sleep(sf::milliseconds(100));
+ }
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/voip/VoIP.cpp b/SQCSim2021/external/sfml251-32/examples/voip/VoIP.cpp
new file mode 100644
index 0000000..06c37b7
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/voip/VoIP.cpp
@@ -0,0 +1,50 @@
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+// Function prototypes
+// (I'm too lazy to put them into separate headers...)
+////////////////////////////////////////////////////////////
+void doClient(unsigned short port);
+void doServer(unsigned short port);
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Choose a random port for opening sockets (ports < 1024 are reserved)
+ const unsigned short port = 2435;
+
+ // Client or server ?
+ char who;
+ std::cout << "Do you want to be a server ('s') or a client ('c')? ";
+ std::cin >> who;
+
+ if (who == 's')
+ {
+ // Run as a server
+ doServer(port);
+ }
+ else
+ {
+ // Run as a client
+ doClient(port);
+ }
+
+ // Wait until the user presses 'enter' key
+ std::cout << "Press enter to exit..." << std::endl;
+ std::cin.ignore(10000, '\n');
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/voip/voip.exe b/SQCSim2021/external/sfml251-32/examples/voip/voip.exe
new file mode 100644
index 0000000..acb6a12
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/voip/voip.exe differ
diff --git a/SQCSim2021/external/sfml251-32/examples/window/Window.cpp b/SQCSim2021/external/sfml251-32/examples/window/Window.cpp
new file mode 100644
index 0000000..3fcea52
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/examples/window/Window.cpp
@@ -0,0 +1,146 @@
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+////////////////////////////////////////////////////////////
+/// Entry point of application
+///
+/// \return Application exit code
+///
+////////////////////////////////////////////////////////////
+int main()
+{
+ // Request a 24-bits depth buffer when creating the window
+ sf::ContextSettings contextSettings;
+ contextSettings.depthBits = 24;
+
+ // Create the main window
+ sf::Window window(sf::VideoMode(640, 480), "SFML window with OpenGL", sf::Style::Default, contextSettings);
+
+ // Make it the active window for OpenGL calls
+ window.setActive();
+
+ // Set the color and depth clear values
+ glClearDepth(1.f);
+ glClearColor(0.f, 0.f, 0.f, 1.f);
+
+ // Enable Z-buffer read and write
+ glEnable(GL_DEPTH_TEST);
+ glDepthMask(GL_TRUE);
+
+ // Disable lighting and texturing
+ glDisable(GL_LIGHTING);
+ glDisable(GL_TEXTURE_2D);
+
+ // Configure the viewport (the same size as the window)
+ glViewport(0, 0, window.getSize().x, window.getSize().y);
+
+ // Setup a perspective projection
+ glMatrixMode(GL_PROJECTION);
+ glLoadIdentity();
+ GLfloat ratio = static_cast(window.getSize().x) / window.getSize().y;
+ glFrustum(-ratio, ratio, -1.f, 1.f, 1.f, 500.f);
+
+ // Define a 3D cube (6 faces made of 2 triangles composed by 3 vertices)
+ GLfloat cube[] =
+ {
+ // positions // colors (r, g, b, a)
+ -50, -50, -50, 0, 0, 1, 1,
+ -50, 50, -50, 0, 0, 1, 1,
+ -50, -50, 50, 0, 0, 1, 1,
+ -50, -50, 50, 0, 0, 1, 1,
+ -50, 50, -50, 0, 0, 1, 1,
+ -50, 50, 50, 0, 0, 1, 1,
+
+ 50, -50, -50, 0, 1, 0, 1,
+ 50, 50, -50, 0, 1, 0, 1,
+ 50, -50, 50, 0, 1, 0, 1,
+ 50, -50, 50, 0, 1, 0, 1,
+ 50, 50, -50, 0, 1, 0, 1,
+ 50, 50, 50, 0, 1, 0, 1,
+
+ -50, -50, -50, 1, 0, 0, 1,
+ 50, -50, -50, 1, 0, 0, 1,
+ -50, -50, 50, 1, 0, 0, 1,
+ -50, -50, 50, 1, 0, 0, 1,
+ 50, -50, -50, 1, 0, 0, 1,
+ 50, -50, 50, 1, 0, 0, 1,
+
+ -50, 50, -50, 0, 1, 1, 1,
+ 50, 50, -50, 0, 1, 1, 1,
+ -50, 50, 50, 0, 1, 1, 1,
+ -50, 50, 50, 0, 1, 1, 1,
+ 50, 50, -50, 0, 1, 1, 1,
+ 50, 50, 50, 0, 1, 1, 1,
+
+ -50, -50, -50, 1, 0, 1, 1,
+ 50, -50, -50, 1, 0, 1, 1,
+ -50, 50, -50, 1, 0, 1, 1,
+ -50, 50, -50, 1, 0, 1, 1,
+ 50, -50, -50, 1, 0, 1, 1,
+ 50, 50, -50, 1, 0, 1, 1,
+
+ -50, -50, 50, 1, 1, 0, 1,
+ 50, -50, 50, 1, 1, 0, 1,
+ -50, 50, 50, 1, 1, 0, 1,
+ -50, 50, 50, 1, 1, 0, 1,
+ 50, -50, 50, 1, 1, 0, 1,
+ 50, 50, 50, 1, 1, 0, 1,
+ };
+
+ // Enable position and color vertex components
+ glEnableClientState(GL_VERTEX_ARRAY);
+ glEnableClientState(GL_COLOR_ARRAY);
+ glVertexPointer(3, GL_FLOAT, 7 * sizeof(GLfloat), cube);
+ glColorPointer(4, GL_FLOAT, 7 * sizeof(GLfloat), cube + 3);
+
+ // Disable normal and texture coordinates vertex components
+ glDisableClientState(GL_NORMAL_ARRAY);
+ glDisableClientState(GL_TEXTURE_COORD_ARRAY);
+
+ // Create a clock for measuring the time elapsed
+ sf::Clock clock;
+
+ // Start the game loop
+ while (window.isOpen())
+ {
+ // Process events
+ sf::Event event;
+ while (window.pollEvent(event))
+ {
+ // Close window: exit
+ if (event.type == sf::Event::Closed)
+ window.close();
+
+ // Escape key: exit
+ if ((event.type == sf::Event::KeyPressed) && (event.key.code == sf::Keyboard::Escape))
+ window.close();
+
+ // Resize event: adjust the viewport
+ if (event.type == sf::Event::Resized)
+ glViewport(0, 0, event.size.width, event.size.height);
+ }
+
+ // Clear the color and depth buffers
+ glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
+
+ // Apply some transformations to rotate the cube
+ glMatrixMode(GL_MODELVIEW);
+ glLoadIdentity();
+ glTranslatef(0.f, 0.f, -200.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 50, 1.f, 0.f, 0.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 30, 0.f, 1.f, 0.f);
+ glRotatef(clock.getElapsedTime().asSeconds() * 90, 0.f, 0.f, 1.f);
+
+ // Draw the cube
+ glDrawArrays(GL_TRIANGLES, 0, 36);
+
+ // Finally, display the rendered frame on screen
+ window.display();
+ }
+
+ return EXIT_SUCCESS;
+}
diff --git a/SQCSim2021/external/sfml251-32/examples/window/window.exe b/SQCSim2021/external/sfml251-32/examples/window/window.exe
new file mode 100644
index 0000000..c234c1d
Binary files /dev/null and b/SQCSim2021/external/sfml251-32/examples/window/window.exe differ
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio.hpp
new file mode 100644
index 0000000..3167927
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio.hpp
@@ -0,0 +1,56 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_AUDIO_HPP
+#define SFML_AUDIO_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+#endif // SFML_AUDIO_HPP
+
+////////////////////////////////////////////////////////////
+/// \defgroup audio Audio module
+///
+/// Sounds, streaming (musics or custom sources), recording,
+/// spatialization.
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/AlResource.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/AlResource.hpp
new file mode 100644
index 0000000..dd7d44c
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/AlResource.hpp
@@ -0,0 +1,70 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_ALRESOURCE_HPP
+#define SFML_ALRESOURCE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Base class for classes that require an OpenAL context
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API AlResource
+{
+protected:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ AlResource();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~AlResource();
+};
+
+} // namespace sf
+
+
+#endif // SFML_ALRESOURCE_HPP
+
+////////////////////////////////////////////////////////////
+/// \class sf::AlResource
+/// \ingroup audio
+///
+/// This class is for internal use only, it must be the base
+/// of every class that requires a valid OpenAL context in
+/// order to work.
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/Export.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Export.hpp
new file mode 100644
index 0000000..9e5e09c
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Export.hpp
@@ -0,0 +1,48 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_AUDIO_EXPORT_HPP
+#define SFML_AUDIO_EXPORT_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+
+
+////////////////////////////////////////////////////////////
+// Define portable import / export macros
+////////////////////////////////////////////////////////////
+#if defined(SFML_AUDIO_EXPORTS)
+
+ #define SFML_AUDIO_API SFML_API_EXPORT
+
+#else
+
+ #define SFML_AUDIO_API SFML_API_IMPORT
+
+#endif
+
+
+#endif // SFML_AUDIO_EXPORT_HPP
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/InputSoundFile.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/InputSoundFile.hpp
new file mode 100644
index 0000000..317b952
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/InputSoundFile.hpp
@@ -0,0 +1,263 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_INPUTSOUNDFILE_HPP
+#define SFML_INPUTSOUNDFILE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+class InputStream;
+class SoundFileReader;
+
+////////////////////////////////////////////////////////////
+/// \brief Provide read access to sound files
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API InputSoundFile : NonCopyable
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ InputSoundFile();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~InputSoundFile();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a sound file from the disk for reading
+ ///
+ /// The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC.
+ /// The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+ ///
+ /// \param filename Path of the sound file to load
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromFile(const std::string& filename);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a sound file in memory for reading
+ ///
+ /// The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC.
+ /// The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+ ///
+ /// \param data Pointer to the file data in memory
+ /// \param sizeInBytes Size of the data to load, in bytes
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromMemory(const void* data, std::size_t sizeInBytes);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a sound file from a custom stream for reading
+ ///
+ /// The supported audio formats are: WAV (PCM only), OGG/Vorbis, FLAC.
+ /// The supported sample sizes for FLAC and WAV are 8, 16, 24 and 32 bit.
+ ///
+ /// \param stream Source stream to read from
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromStream(InputStream& stream);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the total number of audio samples in the file
+ ///
+ /// \return Number of samples
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint64 getSampleCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of channels used by the sound
+ ///
+ /// \return Number of channels (1 = mono, 2 = stereo)
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getChannelCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the sample rate of the sound
+ ///
+ /// \return Sample rate, in samples per second
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getSampleRate() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the total duration of the sound file
+ ///
+ /// This function is provided for convenience, the duration is
+ /// deduced from the other sound file attributes.
+ ///
+ /// \return Duration of the sound file
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getDuration() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the read offset of the file in time
+ ///
+ /// \return Time position
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getTimeOffset() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the read offset of the file in samples
+ ///
+ /// \return Sample position
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint64 getSampleOffset() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current read position to the given sample offset
+ ///
+ /// This function takes a sample offset to provide maximum
+ /// precision. If you need to jump to a given time, use the
+ /// other overload.
+ ///
+ /// The sample offset takes the channels into account.
+ /// If you have a time offset instead, you can easily find
+ /// the corresponding sample offset with the following formula:
+ /// `timeInSeconds * sampleRate * channelCount`
+ /// If the given offset exceeds to total number of samples,
+ /// this function jumps to the end of the sound file.
+ ///
+ /// \param sampleOffset Index of the sample to jump to, relative to the beginning
+ ///
+ ////////////////////////////////////////////////////////////
+ void seek(Uint64 sampleOffset);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current read position to the given time offset
+ ///
+ /// Using a time offset is handy but imprecise. If you need an accurate
+ /// result, consider using the overload which takes a sample offset.
+ ///
+ /// If the given time exceeds to total duration, this function jumps
+ /// to the end of the sound file.
+ ///
+ /// \param timeOffset Time to jump to, relative to the beginning
+ ///
+ ////////////////////////////////////////////////////////////
+ void seek(Time timeOffset);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Read audio samples from the open file
+ ///
+ /// \param samples Pointer to the sample array to fill
+ /// \param maxCount Maximum number of samples to read
+ ///
+ /// \return Number of samples actually read (may be less than \a maxCount)
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint64 read(Int16* samples, Uint64 maxCount);
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Close the current file
+ ///
+ ////////////////////////////////////////////////////////////
+ void close();
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ SoundFileReader* m_reader; ///< Reader that handles I/O on the file's format
+ InputStream* m_stream; ///< Input stream used to access the file's data
+ bool m_streamOwned; ///< Is the stream internal or external?
+ Uint64 m_sampleOffset; ///< Sample Read Position
+ Uint64 m_sampleCount; ///< Total number of samples in the file
+ unsigned int m_channelCount; ///< Number of channels of the sound
+ unsigned int m_sampleRate; ///< Number of samples per second
+};
+
+} // namespace sf
+
+
+#endif // SFML_INPUTSOUNDFILE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::InputSoundFile
+/// \ingroup audio
+///
+/// This class decodes audio samples from a sound file. It is
+/// used internally by higher-level classes such as sf::SoundBuffer
+/// and sf::Music, but can also be useful if you want to process
+/// or analyze audio files without playing them, or if you want to
+/// implement your own version of sf::Music with more specific
+/// features.
+///
+/// Usage example:
+/// \code
+/// // Open a sound file
+/// sf::InputSoundFile file;
+/// if (!file.openFromFile("music.ogg"))
+/// /* error */;
+///
+/// // Print the sound attributes
+/// std::cout << "duration: " << file.getDuration().asSeconds() << std::endl;
+/// std::cout << "channels: " << file.getChannelCount() << std::endl;
+/// std::cout << "sample rate: " << file.getSampleRate() << std::endl;
+/// std::cout << "sample count: " << file.getSampleCount() << std::endl;
+///
+/// // Read and process batches of samples until the end of file is reached
+/// sf::Int16 samples[1024];
+/// sf::Uint64 count;
+/// do
+/// {
+/// count = file.read(samples, 1024);
+///
+/// // process, analyze, play, convert, or whatever
+/// // you want to do with the samples...
+/// }
+/// while (count > 0);
+/// \endcode
+///
+/// \see sf::SoundFileReader, sf::OutputSoundFile
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/Listener.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Listener.hpp
new file mode 100644
index 0000000..9fb7fff
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Listener.hpp
@@ -0,0 +1,234 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_LISTENER_HPP
+#define SFML_LISTENER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief The audio listener is the point in the scene
+/// from where all the sounds are heard
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API Listener
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the global volume of all the sounds and musics
+ ///
+ /// The volume is a number between 0 and 100; it is combined with
+ /// the individual volume of each sound / music.
+ /// The default value for the volume is 100 (maximum).
+ ///
+ /// \param volume New global volume, in the range [0, 100]
+ ///
+ /// \see getGlobalVolume
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setGlobalVolume(float volume);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current value of the global volume
+ ///
+ /// \return Current global volume, in the range [0, 100]
+ ///
+ /// \see setGlobalVolume
+ ///
+ ////////////////////////////////////////////////////////////
+ static float getGlobalVolume();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the position of the listener in the scene
+ ///
+ /// The default listener's position is (0, 0, 0).
+ ///
+ /// \param x X coordinate of the listener's position
+ /// \param y Y coordinate of the listener's position
+ /// \param z Z coordinate of the listener's position
+ ///
+ /// \see getPosition, setDirection
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setPosition(float x, float y, float z);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the position of the listener in the scene
+ ///
+ /// The default listener's position is (0, 0, 0).
+ ///
+ /// \param position New listener's position
+ ///
+ /// \see getPosition, setDirection
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setPosition(const Vector3f& position);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current position of the listener in the scene
+ ///
+ /// \return Listener's position
+ ///
+ /// \see setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ static Vector3f getPosition();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the forward vector of the listener in the scene
+ ///
+ /// The direction (also called "at vector") is the vector
+ /// pointing forward from the listener's perspective. Together
+ /// with the up vector, it defines the 3D orientation of the
+ /// listener in the scene. The direction vector doesn't
+ /// have to be normalized.
+ /// The default listener's direction is (0, 0, -1).
+ ///
+ /// \param x X coordinate of the listener's direction
+ /// \param y Y coordinate of the listener's direction
+ /// \param z Z coordinate of the listener's direction
+ ///
+ /// \see getDirection, setUpVector, setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setDirection(float x, float y, float z);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the forward vector of the listener in the scene
+ ///
+ /// The direction (also called "at vector") is the vector
+ /// pointing forward from the listener's perspective. Together
+ /// with the up vector, it defines the 3D orientation of the
+ /// listener in the scene. The direction vector doesn't
+ /// have to be normalized.
+ /// The default listener's direction is (0, 0, -1).
+ ///
+ /// \param direction New listener's direction
+ ///
+ /// \see getDirection, setUpVector, setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setDirection(const Vector3f& direction);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current forward vector of the listener in the scene
+ ///
+ /// \return Listener's forward vector (not normalized)
+ ///
+ /// \see setDirection
+ ///
+ ////////////////////////////////////////////////////////////
+ static Vector3f getDirection();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the upward vector of the listener in the scene
+ ///
+ /// The up vector is the vector that points upward from the
+ /// listener's perspective. Together with the direction, it
+ /// defines the 3D orientation of the listener in the scene.
+ /// The up vector doesn't have to be normalized.
+ /// The default listener's up vector is (0, 1, 0). It is usually
+ /// not necessary to change it, especially in 2D scenarios.
+ ///
+ /// \param x X coordinate of the listener's up vector
+ /// \param y Y coordinate of the listener's up vector
+ /// \param z Z coordinate of the listener's up vector
+ ///
+ /// \see getUpVector, setDirection, setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setUpVector(float x, float y, float z);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the upward vector of the listener in the scene
+ ///
+ /// The up vector is the vector that points upward from the
+ /// listener's perspective. Together with the direction, it
+ /// defines the 3D orientation of the listener in the scene.
+ /// The up vector doesn't have to be normalized.
+ /// The default listener's up vector is (0, 1, 0). It is usually
+ /// not necessary to change it, especially in 2D scenarios.
+ ///
+ /// \param upVector New listener's up vector
+ ///
+ /// \see getUpVector, setDirection, setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ static void setUpVector(const Vector3f& upVector);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current upward vector of the listener in the scene
+ ///
+ /// \return Listener's upward vector (not normalized)
+ ///
+ /// \see setUpVector
+ ///
+ ////////////////////////////////////////////////////////////
+ static Vector3f getUpVector();
+};
+
+} // namespace sf
+
+
+#endif // SFML_LISTENER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::Listener
+/// \ingroup audio
+///
+/// The audio listener defines the global properties of the
+/// audio environment, it defines where and how sounds and musics
+/// are heard. If sf::View is the eyes of the user, then sf::Listener
+/// is his ears (by the way, they are often linked together --
+/// same position, orientation, etc.).
+///
+/// sf::Listener is a simple interface, which allows to setup the
+/// listener in the 3D audio environment (position, direction and
+/// up vector), and to adjust the global volume.
+///
+/// Because the listener is unique in the scene, sf::Listener only
+/// contains static functions and doesn't have to be instantiated.
+///
+/// Usage example:
+/// \code
+/// // Move the listener to the position (1, 0, -5)
+/// sf::Listener::setPosition(1, 0, -5);
+///
+/// // Make it face the right axis (1, 0, 0)
+/// sf::Listener::setDirection(1, 0, 0);
+///
+/// // Reduce the global volume
+/// sf::Listener::setGlobalVolume(50);
+/// \endcode
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/Music.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Music.hpp
new file mode 100644
index 0000000..5351905
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Music.hpp
@@ -0,0 +1,337 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_MUSIC_HPP
+#define SFML_MUSIC_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+class InputStream;
+
+////////////////////////////////////////////////////////////
+/// \brief Streamed music played from an audio file
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API Music : public SoundStream
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Structure defining a time range using the template type
+ ///
+ ////////////////////////////////////////////////////////////
+ template
+ struct Span
+ {
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ Span()
+ {
+
+ }
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Initialization constructor
+ ///
+ /// \param off Initial Offset
+ /// \param len Initial Length
+ ///
+ ////////////////////////////////////////////////////////////
+ Span(T off, T len):
+ offset(off),
+ length(len)
+ {
+
+ }
+
+ T offset; ///< The beginning offset of the time range
+ T length; ///< The length of the time range
+ };
+
+ // Define the relevant Span types
+ typedef Span TimeSpan;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ Music();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~Music();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a music from an audio file
+ ///
+ /// This function doesn't start playing the music (call play()
+ /// to do so).
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \warning Since the music is not loaded at once but rather
+ /// streamed continuously, the file must remain accessible until
+ /// the sf::Music object loads a new music or is destroyed.
+ ///
+ /// \param filename Path of the music file to open
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see openFromMemory, openFromStream
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromFile(const std::string& filename);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a music from an audio file in memory
+ ///
+ /// This function doesn't start playing the music (call play()
+ /// to do so).
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \warning Since the music is not loaded at once but rather streamed
+ /// continuously, the \a data buffer must remain accessible until
+ /// the sf::Music object loads a new music or is destroyed. That is,
+ /// you can't deallocate the buffer right after calling this function.
+ ///
+ /// \param data Pointer to the file data in memory
+ /// \param sizeInBytes Size of the data to load, in bytes
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see openFromFile, openFromStream
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromMemory(const void* data, std::size_t sizeInBytes);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a music from an audio file in a custom stream
+ ///
+ /// This function doesn't start playing the music (call play()
+ /// to do so).
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \warning Since the music is not loaded at once but rather
+ /// streamed continuously, the \a stream must remain accessible
+ /// until the sf::Music object loads a new music or is destroyed.
+ ///
+ /// \param stream Source stream to read from
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see openFromFile, openFromMemory
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromStream(InputStream& stream);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the total duration of the music
+ ///
+ /// \return Music duration
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getDuration() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the positions of the of the sound's looping sequence
+ ///
+ /// \return Loop Time position class.
+ ///
+ /// \warning Since setLoopPoints() performs some adjustments on the
+ /// provided values and rounds them to internal samples, a call to
+ /// getLoopPoints() is not guaranteed to return the same times passed
+ /// into a previous call to setLoopPoints(). However, it is guaranteed
+ /// to return times that will map to the valid internal samples of
+ /// this Music if they are later passed to setLoopPoints().
+ ///
+ /// \see setLoopPoints
+ ///
+ ////////////////////////////////////////////////////////////
+ TimeSpan getLoopPoints() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Sets the beginning and end of the sound's looping sequence using sf::Time
+ ///
+ /// Loop points allow one to specify a pair of positions such that, when the music
+ /// is enabled for looping, it will seamlessly seek to the beginning whenever it
+ /// encounters the end. Valid ranges for timePoints.offset and timePoints.length are
+ /// [0, Dur) and (0, Dur-offset] respectively, where Dur is the value returned by getDuration().
+ /// Note that the EOF "loop point" from the end to the beginning of the stream is still honored,
+ /// in case the caller seeks to a point after the end of the loop range. This function can be
+ /// safely called at any point after a stream is opened, and will be applied to a playing sound
+ /// without affecting the current playing offset.
+ ///
+ /// \warning Setting the loop points while the stream's status is Paused
+ /// will set its status to Stopped. The playing offset will be unaffected.
+ ///
+ /// \param timePoints The definition of the loop. Can be any time points within the sound's length
+ ///
+ /// \see getLoopPoints
+ ///
+ ////////////////////////////////////////////////////////////
+ void setLoopPoints(TimeSpan timePoints);
+
+protected:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Request a new chunk of audio samples from the stream source
+ ///
+ /// This function fills the chunk from the next samples
+ /// to read from the audio file.
+ ///
+ /// \param data Chunk of data to fill
+ ///
+ /// \return True to continue playback, false to stop
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onGetData(Chunk& data);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position in the stream source
+ ///
+ /// \param timeOffset New playing position, from the beginning of the music
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onSeek(Time timeOffset);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position in the stream source to the loop offset
+ ///
+ /// This is called by the underlying SoundStream whenever it needs us to reset
+ /// the seek position for a loop. We then determine whether we are looping on a
+ /// loop point or the end-of-file, perform the seek, and return the new position.
+ ///
+ /// \return The seek position after looping (or -1 if there's no loop)
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Int64 onLoop();
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Initialize the internal state after loading a new music
+ ///
+ ////////////////////////////////////////////////////////////
+ void initialize();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Helper to convert an sf::Time to a sample position
+ ///
+ /// \param position Time to convert to samples
+ ///
+ /// \return The number of samples elapsed at the given time
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint64 timeToSamples(Time position) const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Helper to convert a sample position to an sf::Time
+ ///
+ /// \param samples Sample count to convert to Time
+ ///
+ /// \return The Time position of the given sample
+ ///
+ ////////////////////////////////////////////////////////////
+ Time samplesToTime(Uint64 samples) const;
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ InputSoundFile m_file; ///< The streamed music file
+ std::vector m_samples; ///< Temporary buffer of samples
+ Mutex m_mutex; ///< Mutex protecting the data
+ Span m_loopSpan; ///< Loop Range Specifier
+};
+
+} // namespace sf
+
+
+#endif // SFML_MUSIC_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::Music
+/// \ingroup audio
+///
+/// Musics are sounds that are streamed rather than completely
+/// loaded in memory. This is especially useful for compressed
+/// musics that usually take hundreds of MB when they are
+/// uncompressed: by streaming it instead of loading it entirely,
+/// you avoid saturating the memory and have almost no loading delay.
+/// This implies that the underlying resource (file, stream or
+/// memory buffer) must remain valid for the lifetime of the
+/// sf::Music object.
+///
+/// Apart from that, a sf::Music has almost the same features as
+/// the sf::SoundBuffer / sf::Sound pair: you can play/pause/stop
+/// it, request its parameters (channels, sample rate), change
+/// the way it is played (pitch, volume, 3D position, ...), etc.
+///
+/// As a sound stream, a music is played in its own thread in order
+/// not to block the rest of the program. This means that you can
+/// leave the music alone after calling play(), it will manage itself
+/// very well.
+///
+/// Usage example:
+/// \code
+/// // Declare a new music
+/// sf::Music music;
+///
+/// // Open it from an audio file
+/// if (!music.openFromFile("music.ogg"))
+/// {
+/// // error...
+/// }
+///
+/// // Change some parameters
+/// music.setPosition(0, 1, 10); // change its 3D position
+/// music.setPitch(2); // increase the pitch
+/// music.setVolume(50); // reduce the volume
+/// music.setLoop(true); // make it loop
+///
+/// // Play it
+/// music.play();
+/// \endcode
+///
+/// \see sf::Sound, sf::SoundStream
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/OutputSoundFile.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/OutputSoundFile.hpp
new file mode 100644
index 0000000..5da374b
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/OutputSoundFile.hpp
@@ -0,0 +1,133 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_OUTPUTSOUNDFILE_HPP
+#define SFML_OUTPUTSOUNDFILE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+namespace sf
+{
+class SoundFileWriter;
+
+////////////////////////////////////////////////////////////
+/// \brief Provide write access to sound files
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API OutputSoundFile : NonCopyable
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ OutputSoundFile();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ /// Closes the file if it was still open.
+ ///
+ ////////////////////////////////////////////////////////////
+ ~OutputSoundFile();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open the sound file from the disk for writing
+ ///
+ /// The supported audio formats are: WAV, OGG/Vorbis, FLAC.
+ ///
+ /// \param filename Path of the sound file to write
+ /// \param sampleRate Sample rate of the sound
+ /// \param channelCount Number of channels in the sound
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ bool openFromFile(const std::string& filename, unsigned int sampleRate, unsigned int channelCount);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Write audio samples to the file
+ ///
+ /// \param samples Pointer to the sample array to write
+ /// \param count Number of samples to write
+ ///
+ ////////////////////////////////////////////////////////////
+ void write(const Int16* samples, Uint64 count);
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Close the current file
+ ///
+ ////////////////////////////////////////////////////////////
+ void close();
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ SoundFileWriter* m_writer; ///< Writer that handles I/O on the file's format
+};
+
+} // namespace sf
+
+
+#endif // SFML_OUTPUTSOUNDFILE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::OutputSoundFile
+/// \ingroup audio
+///
+/// This class encodes audio samples to a sound file. It is
+/// used internally by higher-level classes such as sf::SoundBuffer,
+/// but can also be useful if you want to create audio files from
+/// custom data sources, like generated audio samples.
+///
+/// Usage example:
+/// \code
+/// // Create a sound file, ogg/vorbis format, 44100 Hz, stereo
+/// sf::OutputSoundFile file;
+/// if (!file.openFromFile("music.ogg", 44100, 2))
+/// /* error */;
+///
+/// while (...)
+/// {
+/// // Read or generate audio samples from your custom source
+/// std::vector samples = ...;
+///
+/// // Write them to the file
+/// file.write(samples.data(), samples.size());
+/// }
+/// \endcode
+///
+/// \see sf::SoundFileWriter, sf::InputSoundFile
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/Sound.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Sound.hpp
new file mode 100644
index 0000000..f8e2e14
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/Sound.hpp
@@ -0,0 +1,264 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUND_HPP
+#define SFML_SOUND_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+class SoundBuffer;
+
+////////////////////////////////////////////////////////////
+/// \brief Regular sound that can be played in the audio environment
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API Sound : public SoundSource
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ Sound();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Construct the sound with a buffer
+ ///
+ /// \param buffer Sound buffer containing the audio data to play with the sound
+ ///
+ ////////////////////////////////////////////////////////////
+ explicit Sound(const SoundBuffer& buffer);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Copy constructor
+ ///
+ /// \param copy Instance to copy
+ ///
+ ////////////////////////////////////////////////////////////
+ Sound(const Sound& copy);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~Sound();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start or resume playing the sound
+ ///
+ /// This function starts the stream if it was stopped, resumes
+ /// it if it was paused, and restarts it from beginning if it
+ /// was it already playing.
+ /// This function uses its own thread so that it doesn't block
+ /// the rest of the program while the sound is played.
+ ///
+ /// \see pause, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ void play();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Pause the sound
+ ///
+ /// This function pauses the sound if it was playing,
+ /// otherwise (sound already paused or stopped) it has no effect.
+ ///
+ /// \see play, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ void pause();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief stop playing the sound
+ ///
+ /// This function stops the sound if it was playing or paused,
+ /// and does nothing if it was already stopped.
+ /// It also resets the playing position (unlike pause()).
+ ///
+ /// \see play, pause
+ ///
+ ////////////////////////////////////////////////////////////
+ void stop();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the source buffer containing the audio data to play
+ ///
+ /// It is important to note that the sound buffer is not copied,
+ /// thus the sf::SoundBuffer instance must remain alive as long
+ /// as it is attached to the sound.
+ ///
+ /// \param buffer Sound buffer to attach to the sound
+ ///
+ /// \see getBuffer
+ ///
+ ////////////////////////////////////////////////////////////
+ void setBuffer(const SoundBuffer& buffer);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set whether or not the sound should loop after reaching the end
+ ///
+ /// If set, the sound will restart from beginning after
+ /// reaching the end and so on, until it is stopped or
+ /// setLoop(false) is called.
+ /// The default looping state for sound is false.
+ ///
+ /// \param loop True to play in loop, false to play once
+ ///
+ /// \see getLoop
+ ///
+ ////////////////////////////////////////////////////////////
+ void setLoop(bool loop);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position of the sound
+ ///
+ /// The playing position can be changed when the sound is
+ /// either paused or playing. Changing the playing position
+ /// when the sound is stopped has no effect, since playing
+ /// the sound will reset its position.
+ ///
+ /// \param timeOffset New playing position, from the beginning of the sound
+ ///
+ /// \see getPlayingOffset
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPlayingOffset(Time timeOffset);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the audio buffer attached to the sound
+ ///
+ /// \return Sound buffer attached to the sound (can be NULL)
+ ///
+ ////////////////////////////////////////////////////////////
+ const SoundBuffer* getBuffer() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Tell whether or not the sound is in loop mode
+ ///
+ /// \return True if the sound is looping, false otherwise
+ ///
+ /// \see setLoop
+ ///
+ ////////////////////////////////////////////////////////////
+ bool getLoop() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current playing position of the sound
+ ///
+ /// \return Current playing position, from the beginning of the sound
+ ///
+ /// \see setPlayingOffset
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getPlayingOffset() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current status of the sound (stopped, paused, playing)
+ ///
+ /// \return Current status of the sound
+ ///
+ ////////////////////////////////////////////////////////////
+ Status getStatus() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Overload of assignment operator
+ ///
+ /// \param right Instance to assign
+ ///
+ /// \return Reference to self
+ ///
+ ////////////////////////////////////////////////////////////
+ Sound& operator =(const Sound& right);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Reset the internal buffer of the sound
+ ///
+ /// This function is for internal use only, you don't have
+ /// to use it. It is called by the sf::SoundBuffer that
+ /// this sound uses, when it is destroyed in order to prevent
+ /// the sound from using a dead buffer.
+ ///
+ ////////////////////////////////////////////////////////////
+ void resetBuffer();
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ const SoundBuffer* m_buffer; ///< Sound buffer bound to the source
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUND_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::Sound
+/// \ingroup audio
+///
+/// sf::Sound is the class to use to play sounds.
+/// It provides:
+/// \li Control (play, pause, stop)
+/// \li Ability to modify output parameters in real-time (pitch, volume, ...)
+/// \li 3D spatial features (position, attenuation, ...).
+///
+/// sf::Sound is perfect for playing short sounds that can
+/// fit in memory and require no latency, like foot steps or
+/// gun shots. For longer sounds, like background musics
+/// or long speeches, rather see sf::Music (which is based
+/// on streaming).
+///
+/// In order to work, a sound must be given a buffer of audio
+/// data to play. Audio data (samples) is stored in sf::SoundBuffer,
+/// and attached to a sound with the setBuffer() function.
+/// The buffer object attached to a sound must remain alive
+/// as long as the sound uses it. Note that multiple sounds
+/// can use the same sound buffer at the same time.
+///
+/// Usage example:
+/// \code
+/// sf::SoundBuffer buffer;
+/// buffer.loadFromFile("sound.wav");
+///
+/// sf::Sound sound;
+/// sound.setBuffer(buffer);
+/// sound.play();
+/// \endcode
+///
+/// \see sf::SoundBuffer, sf::Music
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBuffer.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBuffer.hpp
new file mode 100644
index 0000000..5aaa4ca
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBuffer.hpp
@@ -0,0 +1,352 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDBUFFER_HPP
+#define SFML_SOUNDBUFFER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+class Sound;
+class InputSoundFile;
+class InputStream;
+
+////////////////////////////////////////////////////////////
+/// \brief Storage for audio samples defining a sound
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundBuffer : AlResource
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundBuffer();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Copy constructor
+ ///
+ /// \param copy Instance to copy
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundBuffer(const SoundBuffer& copy);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~SoundBuffer();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Load the sound buffer from a file
+ ///
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \param filename Path of the sound file to load
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see loadFromMemory, loadFromStream, loadFromSamples, saveToFile
+ ///
+ ////////////////////////////////////////////////////////////
+ bool loadFromFile(const std::string& filename);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Load the sound buffer from a file in memory
+ ///
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \param data Pointer to the file data in memory
+ /// \param sizeInBytes Size of the data to load, in bytes
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see loadFromFile, loadFromStream, loadFromSamples
+ ///
+ ////////////////////////////////////////////////////////////
+ bool loadFromMemory(const void* data, std::size_t sizeInBytes);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Load the sound buffer from a custom stream
+ ///
+ /// See the documentation of sf::InputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \param stream Source stream to read from
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see loadFromFile, loadFromMemory, loadFromSamples
+ ///
+ ////////////////////////////////////////////////////////////
+ bool loadFromStream(InputStream& stream);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Load the sound buffer from an array of audio samples
+ ///
+ /// The assumed format of the audio samples is 16 bits signed integer
+ /// (sf::Int16).
+ ///
+ /// \param samples Pointer to the array of samples in memory
+ /// \param sampleCount Number of samples in the array
+ /// \param channelCount Number of channels (1 = mono, 2 = stereo, ...)
+ /// \param sampleRate Sample rate (number of samples to play per second)
+ ///
+ /// \return True if loading succeeded, false if it failed
+ ///
+ /// \see loadFromFile, loadFromMemory, saveToFile
+ ///
+ ////////////////////////////////////////////////////////////
+ bool loadFromSamples(const Int16* samples, Uint64 sampleCount, unsigned int channelCount, unsigned int sampleRate);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Save the sound buffer to an audio file
+ ///
+ /// See the documentation of sf::OutputSoundFile for the list
+ /// of supported formats.
+ ///
+ /// \param filename Path of the sound file to write
+ ///
+ /// \return True if saving succeeded, false if it failed
+ ///
+ /// \see loadFromFile, loadFromMemory, loadFromSamples
+ ///
+ ////////////////////////////////////////////////////////////
+ bool saveToFile(const std::string& filename) const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the array of audio samples stored in the buffer
+ ///
+ /// The format of the returned samples is 16 bits signed integer
+ /// (sf::Int16). The total number of samples in this array
+ /// is given by the getSampleCount() function.
+ ///
+ /// \return Read-only pointer to the array of sound samples
+ ///
+ /// \see getSampleCount
+ ///
+ ////////////////////////////////////////////////////////////
+ const Int16* getSamples() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of samples stored in the buffer
+ ///
+ /// The array of samples can be accessed with the getSamples()
+ /// function.
+ ///
+ /// \return Number of samples
+ ///
+ /// \see getSamples
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint64 getSampleCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the sample rate of the sound
+ ///
+ /// The sample rate is the number of samples played per second.
+ /// The higher, the better the quality (for example, 44100
+ /// samples/s is CD quality).
+ ///
+ /// \return Sample rate (number of samples per second)
+ ///
+ /// \see getChannelCount, getDuration
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getSampleRate() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of channels used by the sound
+ ///
+ /// If the sound is mono then the number of channels will
+ /// be 1, 2 for stereo, etc.
+ ///
+ /// \return Number of channels
+ ///
+ /// \see getSampleRate, getDuration
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getChannelCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the total duration of the sound
+ ///
+ /// \return Sound duration
+ ///
+ /// \see getSampleRate, getChannelCount
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getDuration() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Overload of assignment operator
+ ///
+ /// \param right Instance to assign
+ ///
+ /// \return Reference to self
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundBuffer& operator =(const SoundBuffer& right);
+
+private:
+
+ friend class Sound;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Initialize the internal state after loading a new sound
+ ///
+ /// \param file Sound file providing access to the new loaded sound
+ ///
+ /// \return True on successful initialization, false on failure
+ ///
+ ////////////////////////////////////////////////////////////
+ bool initialize(InputSoundFile& file);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Update the internal buffer with the cached audio samples
+ ///
+ /// \param channelCount Number of channels
+ /// \param sampleRate Sample rate (number of samples per second)
+ ///
+ /// \return True on success, false if any error happened
+ ///
+ ////////////////////////////////////////////////////////////
+ bool update(unsigned int channelCount, unsigned int sampleRate);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Add a sound to the list of sounds that use this buffer
+ ///
+ /// \param sound Sound instance to attach
+ ///
+ ////////////////////////////////////////////////////////////
+ void attachSound(Sound* sound) const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Remove a sound from the list of sounds that use this buffer
+ ///
+ /// \param sound Sound instance to detach
+ ///
+ ////////////////////////////////////////////////////////////
+ void detachSound(Sound* sound) const;
+
+ ////////////////////////////////////////////////////////////
+ // Types
+ ////////////////////////////////////////////////////////////
+ typedef std::set SoundList; ///< Set of unique sound instances
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ unsigned int m_buffer; ///< OpenAL buffer identifier
+ std::vector m_samples; ///< Samples buffer
+ Time m_duration; ///< Sound duration
+ mutable SoundList m_sounds; ///< List of sounds that are using this buffer
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDBUFFER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundBuffer
+/// \ingroup audio
+///
+/// A sound buffer holds the data of a sound, which is
+/// an array of audio samples. A sample is a 16 bits signed integer
+/// that defines the amplitude of the sound at a given time.
+/// The sound is then reconstituted by playing these samples at
+/// a high rate (for example, 44100 samples per second is the
+/// standard rate used for playing CDs). In short, audio samples
+/// are like texture pixels, and a sf::SoundBuffer is similar to
+/// a sf::Texture.
+///
+/// A sound buffer can be loaded from a file (see loadFromFile()
+/// for the complete list of supported formats), from memory, from
+/// a custom stream (see sf::InputStream) or directly from an array
+/// of samples. It can also be saved back to a file.
+///
+/// Sound buffers alone are not very useful: they hold the audio data
+/// but cannot be played. To do so, you need to use the sf::Sound class,
+/// which provides functions to play/pause/stop the sound as well as
+/// changing the way it is outputted (volume, pitch, 3D position, ...).
+/// This separation allows more flexibility and better performances:
+/// indeed a sf::SoundBuffer is a heavy resource, and any operation on it
+/// is slow (often too slow for real-time applications). On the other
+/// side, a sf::Sound is a lightweight object, which can use the audio data
+/// of a sound buffer and change the way it is played without actually
+/// modifying that data. Note that it is also possible to bind
+/// several sf::Sound instances to the same sf::SoundBuffer.
+///
+/// It is important to note that the sf::Sound instance doesn't
+/// copy the buffer that it uses, it only keeps a reference to it.
+/// Thus, a sf::SoundBuffer must not be destructed while it is
+/// used by a sf::Sound (i.e. never write a function that
+/// uses a local sf::SoundBuffer instance for loading a sound).
+///
+/// Usage example:
+/// \code
+/// // Declare a new sound buffer
+/// sf::SoundBuffer buffer;
+///
+/// // Load it from a file
+/// if (!buffer.loadFromFile("sound.wav"))
+/// {
+/// // error...
+/// }
+///
+/// // Create a sound source and bind it to the buffer
+/// sf::Sound sound1;
+/// sound1.setBuffer(buffer);
+///
+/// // Play the sound
+/// sound1.play();
+///
+/// // Create another sound source bound to the same buffer
+/// sf::Sound sound2;
+/// sound2.setBuffer(buffer);
+///
+/// // Play it with a higher pitch -- the first sound remains unchanged
+/// sound2.setPitch(2);
+/// sound2.play();
+/// \endcode
+///
+/// \see sf::Sound, sf::SoundBufferRecorder
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBufferRecorder.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBufferRecorder.hpp
new file mode 100644
index 0000000..266603d
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundBufferRecorder.hpp
@@ -0,0 +1,144 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDBUFFERRECORDER_HPP
+#define SFML_SOUNDBUFFERRECORDER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Specialized SoundRecorder which stores the captured
+/// audio data into a sound buffer
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundBufferRecorder : public SoundRecorder
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ ~SoundBufferRecorder();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the sound buffer containing the captured audio data
+ ///
+ /// The sound buffer is valid only after the capture has ended.
+ /// This function provides a read-only access to the internal
+ /// sound buffer, but it can be copied if you need to
+ /// make any modification to it.
+ ///
+ /// \return Read-only access to the sound buffer
+ ///
+ ////////////////////////////////////////////////////////////
+ const SoundBuffer& getBuffer() const;
+
+protected:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start capturing audio data
+ ///
+ /// \return True to start the capture, or false to abort it
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onStart();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Process a new chunk of recorded samples
+ ///
+ /// \param samples Pointer to the new chunk of recorded samples
+ /// \param sampleCount Number of samples pointed by \a samples
+ ///
+ /// \return True to continue the capture, or false to stop it
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Stop capturing audio data
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onStop();
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ std::vector m_samples; ///< Temporary sample buffer to hold the recorded data
+ SoundBuffer m_buffer; ///< Sound buffer that will contain the recorded data
+};
+
+} // namespace sf
+
+#endif // SFML_SOUNDBUFFERRECORDER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundBufferRecorder
+/// \ingroup audio
+///
+/// sf::SoundBufferRecorder allows to access a recorded sound
+/// through a sf::SoundBuffer, so that it can be played, saved
+/// to a file, etc.
+///
+/// It has the same simple interface as its base class (start(), stop())
+/// and adds a function to retrieve the recorded sound buffer
+/// (getBuffer()).
+///
+/// As usual, don't forget to call the isAvailable() function
+/// before using this class (see sf::SoundRecorder for more details
+/// about this).
+///
+/// Usage example:
+/// \code
+/// if (sf::SoundBufferRecorder::isAvailable())
+/// {
+/// // Record some audio data
+/// sf::SoundBufferRecorder recorder;
+/// recorder.start();
+/// ...
+/// recorder.stop();
+///
+/// // Get the buffer containing the captured audio data
+/// const sf::SoundBuffer& buffer = recorder.getBuffer();
+///
+/// // Save it to a file (for example...)
+/// buffer.saveToFile("my_record.ogg");
+/// }
+/// \endcode
+///
+/// \see sf::SoundRecorder
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.hpp
new file mode 100644
index 0000000..e3719c8
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.hpp
@@ -0,0 +1,197 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDFILEFACTORY_HPP
+#define SFML_SOUNDFILEFACTORY_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+namespace sf
+{
+class InputStream;
+class SoundFileReader;
+class SoundFileWriter;
+
+////////////////////////////////////////////////////////////
+/// \brief Manages and instantiates sound file readers and writers
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundFileFactory
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Register a new reader
+ ///
+ /// \see unregisterReader
+ ///
+ ////////////////////////////////////////////////////////////
+ template
+ static void registerReader();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Unregister a reader
+ ///
+ /// \see registerReader
+ ///
+ ////////////////////////////////////////////////////////////
+ template
+ static void unregisterReader();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Register a new writer
+ ///
+ /// \see unregisterWriter
+ ///
+ ////////////////////////////////////////////////////////////
+ template
+ static void registerWriter();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Unregister a writer
+ ///
+ /// \see registerWriter
+ ///
+ ////////////////////////////////////////////////////////////
+ template
+ static void unregisterWriter();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Instantiate the right reader for the given file on disk
+ ///
+ /// It's up to the caller to release the returned reader
+ ///
+ /// \param filename Path of the sound file
+ ///
+ /// \return A new sound file reader that can read the given file, or null if no reader can handle it
+ ///
+ /// \see createReaderFromMemory, createReaderFromStream
+ ///
+ ////////////////////////////////////////////////////////////
+ static SoundFileReader* createReaderFromFilename(const std::string& filename);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Instantiate the right codec for the given file in memory
+ ///
+ /// It's up to the caller to release the returned reader
+ ///
+ /// \param data Pointer to the file data in memory
+ /// \param sizeInBytes Total size of the file data, in bytes
+ ///
+ /// \return A new sound file codec that can read the given file, or null if no codec can handle it
+ ///
+ /// \see createReaderFromFilename, createReaderFromStream
+ ///
+ ////////////////////////////////////////////////////////////
+ static SoundFileReader* createReaderFromMemory(const void* data, std::size_t sizeInBytes);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Instantiate the right codec for the given file in stream
+ ///
+ /// It's up to the caller to release the returned reader
+ ///
+ /// \param stream Source stream to read from
+ ///
+ /// \return A new sound file codec that can read the given file, or null if no codec can handle it
+ ///
+ /// \see createReaderFromFilename, createReaderFromMemory
+ ///
+ ////////////////////////////////////////////////////////////
+ static SoundFileReader* createReaderFromStream(InputStream& stream);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Instantiate the right writer for the given file on disk
+ ///
+ /// It's up to the caller to release the returned writer
+ ///
+ /// \param filename Path of the sound file
+ ///
+ /// \return A new sound file writer that can write given file, or null if no writer can handle it
+ ///
+ ////////////////////////////////////////////////////////////
+ static SoundFileWriter* createWriterFromFilename(const std::string& filename);
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ // Types
+ ////////////////////////////////////////////////////////////
+ struct ReaderFactory
+ {
+ bool (*check)(InputStream&);
+ SoundFileReader* (*create)();
+ };
+ typedef std::vector ReaderFactoryArray;
+
+ struct WriterFactory
+ {
+ bool (*check)(const std::string&);
+ SoundFileWriter* (*create)();
+ };
+ typedef std::vector WriterFactoryArray;
+
+ ////////////////////////////////////////////////////////////
+ // Static member data
+ ////////////////////////////////////////////////////////////
+ static ReaderFactoryArray s_readers; ///< List of all registered readers
+ static WriterFactoryArray s_writers; ///< List of all registered writers
+};
+
+} // namespace sf
+
+#include
+
+#endif // SFML_SOUNDFILEFACTORY_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundFileFactory
+/// \ingroup audio
+///
+/// This class is where all the sound file readers and writers are
+/// registered. You should normally only need to use its registration
+/// and unregistration functions; readers/writers creation and manipulation
+/// are wrapped into the higher-level classes sf::InputSoundFile and
+/// sf::OutputSoundFile.
+///
+/// To register a new reader (writer) use the sf::SoundFileFactory::registerReader
+/// (registerWriter) static function. You don't have to call the unregisterReader
+/// (unregisterWriter) function, unless you want to unregister a format before your
+/// application ends (typically, when a plugin is unloaded).
+///
+/// Usage example:
+/// \code
+/// sf::SoundFileFactory::registerReader();
+/// sf::SoundFileFactory::registerWriter();
+/// \endcode
+///
+/// \see sf::InputSoundFile, sf::OutputSoundFile, sf::SoundFileReader, sf::SoundFileWriter
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.inl b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.inl
new file mode 100644
index 0000000..6c499f3
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileFactory.inl
@@ -0,0 +1,100 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+
+
+namespace sf
+{
+namespace priv
+{
+ template SoundFileReader* createReader() {return new T;}
+ template SoundFileWriter* createWriter() {return new T;}
+}
+
+////////////////////////////////////////////////////////////
+template
+void SoundFileFactory::registerReader()
+{
+ // Make sure the same class won't be registered twice
+ unregisterReader();
+
+ // Create a new factory with the functions provided by the class
+ ReaderFactory factory;
+ factory.check = &T::check;
+ factory.create = &priv::createReader;
+
+ // Add it
+ s_readers.push_back(factory);
+}
+
+
+////////////////////////////////////////////////////////////
+template
+void SoundFileFactory::unregisterReader()
+{
+ // Remove the instance(s) of the reader from the array of factories
+ for (ReaderFactoryArray::iterator it = s_readers.begin(); it != s_readers.end(); )
+ {
+ if (it->create == &priv::createReader)
+ it = s_readers.erase(it);
+ else
+ ++it;
+ }
+}
+
+////////////////////////////////////////////////////////////
+template
+void SoundFileFactory::registerWriter()
+{
+ // Make sure the same class won't be registered twice
+ unregisterWriter();
+
+ // Create a new factory with the functions provided by the class
+ WriterFactory factory;
+ factory.check = &T::check;
+ factory.create = &priv::createWriter;
+
+ // Add it
+ s_writers.push_back(factory);
+}
+
+
+////////////////////////////////////////////////////////////
+template
+void SoundFileFactory::unregisterWriter()
+{
+ // Remove the instance(s) of the writer from the array of factories
+ for (WriterFactoryArray::iterator it = s_writers.begin(); it != s_writers.end(); )
+ {
+ if (it->create == &priv::createWriter)
+ it = s_writers.erase(it);
+ else
+ ++it;
+ }
+}
+
+} // namespace sf
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileReader.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileReader.hpp
new file mode 100644
index 0000000..a040db9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileReader.hpp
@@ -0,0 +1,165 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDFILEREADER_HPP
+#define SFML_SOUNDFILEREADER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+namespace sf
+{
+class InputStream;
+
+////////////////////////////////////////////////////////////
+/// \brief Abstract base class for sound file decoding
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundFileReader
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Structure holding the audio properties of a sound file
+ ///
+ ////////////////////////////////////////////////////////////
+ struct Info
+ {
+ Uint64 sampleCount; ///< Total number of samples in the file
+ unsigned int channelCount; ///< Number of channels of the sound
+ unsigned int sampleRate; ///< Samples rate of the sound, in samples per second
+ };
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Virtual destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~SoundFileReader() {}
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a sound file for reading
+ ///
+ /// The provided stream reference is valid as long as the
+ /// SoundFileReader is alive, so it is safe to use/store it
+ /// during the whole lifetime of the reader.
+ ///
+ /// \param stream Source stream to read from
+ /// \param info Structure to fill with the properties of the loaded sound
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool open(InputStream& stream, Info& info) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current read position to the given sample offset
+ ///
+ /// The sample offset takes the channels into account.
+ /// If you have a time offset instead, you can easily find
+ /// the corresponding sample offset with the following formula:
+ /// `timeInSeconds * sampleRate * channelCount`
+ /// If the given offset exceeds to total number of samples,
+ /// this function must jump to the end of the file.
+ ///
+ /// \param sampleOffset Index of the sample to jump to, relative to the beginning
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void seek(Uint64 sampleOffset) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Read audio samples from the open file
+ ///
+ /// \param samples Pointer to the sample array to fill
+ /// \param maxCount Maximum number of samples to read
+ ///
+ /// \return Number of samples actually read (may be less than \a maxCount)
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Uint64 read(Int16* samples, Uint64 maxCount) = 0;
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDFILEREADER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundFileReader
+/// \ingroup audio
+///
+/// This class allows users to read audio file formats not natively
+/// supported by SFML, and thus extend the set of supported readable
+/// audio formats.
+///
+/// A valid sound file reader must override the open, seek and write functions,
+/// as well as providing a static check function; the latter is used by
+/// SFML to find a suitable writer for a given input file.
+///
+/// To register a new reader, use the sf::SoundFileFactory::registerReader
+/// template function.
+///
+/// Usage example:
+/// \code
+/// class MySoundFileReader : public sf::SoundFileReader
+/// {
+/// public:
+///
+/// static bool check(sf::InputStream& stream)
+/// {
+/// // typically, read the first few header bytes and check fields that identify the format
+/// // return true if the reader can handle the format
+/// }
+///
+/// virtual bool open(sf::InputStream& stream, Info& info)
+/// {
+/// // read the sound file header and fill the sound attributes
+/// // (channel count, sample count and sample rate)
+/// // return true on success
+/// }
+///
+/// virtual void seek(sf::Uint64 sampleOffset)
+/// {
+/// // advance to the sampleOffset-th sample from the beginning of the sound
+/// }
+///
+/// virtual sf::Uint64 read(sf::Int16* samples, sf::Uint64 maxCount)
+/// {
+/// // read up to 'maxCount' samples into the 'samples' array,
+/// // convert them (for example from normalized float) if they are not stored
+/// // as 16-bits signed integers in the file
+/// // return the actual number of samples read
+/// }
+/// };
+///
+/// sf::SoundFileFactory::registerReader();
+/// \endcode
+///
+/// \see sf::InputSoundFile, sf::SoundFileFactory, sf::SoundFileWriter
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileWriter.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileWriter.hpp
new file mode 100644
index 0000000..8651ddc
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundFileWriter.hpp
@@ -0,0 +1,125 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDFILEWRITER_HPP
+#define SFML_SOUNDFILEWRITER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Abstract base class for sound file encoding
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundFileWriter
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Virtual destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~SoundFileWriter() {}
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Open a sound file for writing
+ ///
+ /// \param filename Path of the file to open
+ /// \param sampleRate Sample rate of the sound
+ /// \param channelCount Number of channels of the sound
+ ///
+ /// \return True if the file was successfully opened
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Write audio samples to the open file
+ ///
+ /// \param samples Pointer to the sample array to write
+ /// \param count Number of samples to write
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void write(const Int16* samples, Uint64 count) = 0;
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDFILEWRITER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundFileWriter
+/// \ingroup audio
+///
+/// This class allows users to write audio file formats not natively
+/// supported by SFML, and thus extend the set of supported writable
+/// audio formats.
+///
+/// A valid sound file writer must override the open and write functions,
+/// as well as providing a static check function; the latter is used by
+/// SFML to find a suitable writer for a given filename.
+///
+/// To register a new writer, use the sf::SoundFileFactory::registerWriter
+/// template function.
+///
+/// Usage example:
+/// \code
+/// class MySoundFileWriter : public sf::SoundFileWriter
+/// {
+/// public:
+///
+/// static bool check(const std::string& filename)
+/// {
+/// // typically, check the extension
+/// // return true if the writer can handle the format
+/// }
+///
+/// virtual bool open(const std::string& filename, unsigned int sampleRate, unsigned int channelCount)
+/// {
+/// // open the file 'filename' for writing,
+/// // write the given sample rate and channel count to the file header
+/// // return true on success
+/// }
+///
+/// virtual void write(const sf::Int16* samples, sf::Uint64 count)
+/// {
+/// // write 'count' samples stored at address 'samples',
+/// // convert them (for example to normalized float) if the format requires it
+/// }
+/// };
+///
+/// sf::SoundFileFactory::registerWriter();
+/// \endcode
+///
+/// \see sf::OutputSoundFile, sf::SoundFileFactory, sf::SoundFileReader
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundRecorder.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundRecorder.hpp
new file mode 100644
index 0000000..d4dc74f
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundRecorder.hpp
@@ -0,0 +1,408 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDRECORDER_HPP
+#define SFML_SOUNDRECORDER_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Abstract base class for capturing sound data
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundRecorder : AlResource
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~SoundRecorder();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start the capture
+ ///
+ /// The \a sampleRate parameter defines the number of audio samples
+ /// captured per second. The higher, the better the quality
+ /// (for example, 44100 samples/sec is CD quality).
+ /// This function uses its own thread so that it doesn't block
+ /// the rest of the program while the capture runs.
+ /// Please note that only one capture can happen at the same time.
+ /// You can select which capture device will be used, by passing
+ /// the name to the setDevice() method. If none was selected
+ /// before, the default capture device will be used. You can get a
+ /// list of the names of all available capture devices by calling
+ /// getAvailableDevices().
+ ///
+ /// \param sampleRate Desired capture rate, in number of samples per second
+ ///
+ /// \return True, if start of capture was successful
+ ///
+ /// \see stop, getAvailableDevices
+ ///
+ ////////////////////////////////////////////////////////////
+ bool start(unsigned int sampleRate = 44100);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Stop the capture
+ ///
+ /// \see start
+ ///
+ ////////////////////////////////////////////////////////////
+ void stop();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the sample rate
+ ///
+ /// The sample rate defines the number of audio samples
+ /// captured per second. The higher, the better the quality
+ /// (for example, 44100 samples/sec is CD quality).
+ ///
+ /// \return Sample rate, in samples per second
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getSampleRate() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get a list of the names of all available audio capture devices
+ ///
+ /// This function returns a vector of strings, containing
+ /// the names of all available audio capture devices.
+ ///
+ /// \return A vector of strings containing the names
+ ///
+ ////////////////////////////////////////////////////////////
+ static std::vector getAvailableDevices();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the name of the default audio capture device
+ ///
+ /// This function returns the name of the default audio
+ /// capture device. If none is available, an empty string
+ /// is returned.
+ ///
+ /// \return The name of the default audio capture device
+ ///
+ ////////////////////////////////////////////////////////////
+ static std::string getDefaultDevice();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the audio capture device
+ ///
+ /// This function sets the audio capture device to the device
+ /// with the given \a name. It can be called on the fly (i.e:
+ /// while recording). If you do so while recording and
+ /// opening the device fails, it stops the recording.
+ ///
+ /// \param name The name of the audio capture device
+ ///
+ /// \return True, if it was able to set the requested device
+ ///
+ /// \see getAvailableDevices, getDefaultDevice
+ ///
+ ////////////////////////////////////////////////////////////
+ bool setDevice(const std::string& name);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the name of the current audio capture device
+ ///
+ /// \return The name of the current audio capture device
+ ///
+ ////////////////////////////////////////////////////////////
+ const std::string& getDevice() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the channel count of the audio capture device
+ ///
+ /// This method allows you to specify the number of channels
+ /// used for recording. Currently only 16-bit mono and
+ /// 16-bit stereo are supported.
+ ///
+ /// \param channelCount Number of channels. Currently only
+ /// mono (1) and stereo (2) are supported.
+ ///
+ /// \see getChannelCount
+ ///
+ ////////////////////////////////////////////////////////////
+ void setChannelCount(unsigned int channelCount);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of channels used by this recorder
+ ///
+ /// Currently only mono and stereo are supported, so the
+ /// value is either 1 (for mono) or 2 (for stereo).
+ ///
+ /// \return Number of channels
+ ///
+ /// \see setChannelCount
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getChannelCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Check if the system supports audio capture
+ ///
+ /// This function should always be called before using
+ /// the audio capture features. If it returns false, then
+ /// any attempt to use sf::SoundRecorder or one of its derived
+ /// classes will fail.
+ ///
+ /// \return True if audio capture is supported, false otherwise
+ ///
+ ////////////////////////////////////////////////////////////
+ static bool isAvailable();
+
+protected:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// This constructor is only meant to be called by derived classes.
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundRecorder();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the processing interval
+ ///
+ /// The processing interval controls the period
+ /// between calls to the onProcessSamples function. You may
+ /// want to use a small interval if you want to process the
+ /// recorded data in real time, for example.
+ ///
+ /// Note: this is only a hint, the actual period may vary.
+ /// So don't rely on this parameter to implement precise timing.
+ ///
+ /// The default processing interval is 100 ms.
+ ///
+ /// \param interval Processing interval
+ ///
+ ////////////////////////////////////////////////////////////
+ void setProcessingInterval(Time interval);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start capturing audio data
+ ///
+ /// This virtual function may be overridden by a derived class
+ /// if something has to be done every time a new capture
+ /// starts. If not, this function can be ignored; the default
+ /// implementation does nothing.
+ ///
+ /// \return True to start the capture, or false to abort it
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onStart();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Process a new chunk of recorded samples
+ ///
+ /// This virtual function is called every time a new chunk of
+ /// recorded data is available. The derived class can then do
+ /// whatever it wants with it (storing it, playing it, sending
+ /// it over the network, etc.).
+ ///
+ /// \param samples Pointer to the new chunk of recorded samples
+ /// \param sampleCount Number of samples pointed by \a samples
+ ///
+ /// \return True to continue the capture, or false to stop it
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Stop capturing audio data
+ ///
+ /// This virtual function may be overridden by a derived class
+ /// if something has to be done every time the capture
+ /// ends. If not, this function can be ignored; the default
+ /// implementation does nothing.
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onStop();
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Function called as the entry point of the thread
+ ///
+ /// This function starts the recording loop, and returns
+ /// only when the capture is stopped.
+ ///
+ ////////////////////////////////////////////////////////////
+ void record();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the new available audio samples and process them
+ ///
+ /// This function is called continuously during the
+ /// capture loop. It retrieves the captured samples and
+ /// forwards them to the derived class.
+ ///
+ ////////////////////////////////////////////////////////////
+ void processCapturedSamples();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Clean up the recorder's internal resources
+ ///
+ /// This function is called when the capture stops.
+ ///
+ ////////////////////////////////////////////////////////////
+ void cleanup();
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ Thread m_thread; ///< Thread running the background recording task
+ std::vector m_samples; ///< Buffer to store captured samples
+ unsigned int m_sampleRate; ///< Sample rate
+ Time m_processingInterval; ///< Time period between calls to onProcessSamples
+ bool m_isCapturing; ///< Capturing state
+ std::string m_deviceName; ///< Name of the audio capture device
+ unsigned int m_channelCount; ///< Number of recording channels
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDRECORDER_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundRecorder
+/// \ingroup audio
+///
+/// sf::SoundBuffer provides a simple interface to access
+/// the audio recording capabilities of the computer
+/// (the microphone). As an abstract base class, it only cares
+/// about capturing sound samples, the task of making something
+/// useful with them is left to the derived class. Note that
+/// SFML provides a built-in specialization for saving the
+/// captured data to a sound buffer (see sf::SoundBufferRecorder).
+///
+/// A derived class has only one virtual function to override:
+/// \li onProcessSamples provides the new chunks of audio samples while the capture happens
+///
+/// Moreover, two additional virtual functions can be overridden
+/// as well if necessary:
+/// \li onStart is called before the capture happens, to perform custom initializations
+/// \li onStop is called after the capture ends, to perform custom cleanup
+///
+/// A derived class can also control the frequency of the onProcessSamples
+/// calls, with the setProcessingInterval protected function. The default
+/// interval is chosen so that recording thread doesn't consume too much
+/// CPU, but it can be changed to a smaller value if you need to process
+/// the recorded data in real time, for example.
+///
+/// The audio capture feature may not be supported or activated
+/// on every platform, thus it is recommended to check its
+/// availability with the isAvailable() function. If it returns
+/// false, then any attempt to use an audio recorder will fail.
+///
+/// If you have multiple sound input devices connected to your
+/// computer (for example: microphone, external soundcard, webcam mic, ...)
+/// you can get a list of all available devices through the
+/// getAvailableDevices() function. You can then select a device
+/// by calling setDevice() with the appropriate device. Otherwise
+/// the default capturing device will be used.
+///
+/// By default the recording is in 16-bit mono. Using the
+/// setChannelCount method you can change the number of channels
+/// used by the audio capture device to record. Note that you
+/// have to decide whether you want to record in mono or stereo
+/// before starting the recording.
+///
+/// It is important to note that the audio capture happens in a
+/// separate thread, so that it doesn't block the rest of the
+/// program. In particular, the onProcessSamples virtual function
+/// (but not onStart and not onStop) will be called
+/// from this separate thread. It is important to keep this in
+/// mind, because you may have to take care of synchronization
+/// issues if you share data between threads.
+/// Another thing to bear in mind is that you must call stop()
+/// in the destructor of your derived class, so that the recording
+/// thread finishes before your object is destroyed.
+///
+/// Usage example:
+/// \code
+/// class CustomRecorder : public sf::SoundRecorder
+/// {
+/// ~CustomRecorder()
+/// {
+/// // Make sure to stop the recording thread
+/// stop();
+/// }
+///
+/// virtual bool onStart() // optional
+/// {
+/// // Initialize whatever has to be done before the capture starts
+/// ...
+///
+/// // Return true to start playing
+/// return true;
+/// }
+///
+/// virtual bool onProcessSamples(const Int16* samples, std::size_t sampleCount)
+/// {
+/// // Do something with the new chunk of samples (store them, send them, ...)
+/// ...
+///
+/// // Return true to continue playing
+/// return true;
+/// }
+///
+/// virtual void onStop() // optional
+/// {
+/// // Clean up whatever has to be done after the capture ends
+/// ...
+/// }
+/// }
+///
+/// // Usage
+/// if (CustomRecorder::isAvailable())
+/// {
+/// CustomRecorder recorder;
+///
+/// if (!recorder.start())
+/// return -1;
+///
+/// ...
+/// recorder.stop();
+/// }
+/// \endcode
+///
+/// \see sf::SoundBufferRecorder
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundSource.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundSource.hpp
new file mode 100644
index 0000000..fcc9c79
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundSource.hpp
@@ -0,0 +1,332 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDSOURCE_HPP
+#define SFML_SOUNDSOURCE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Base class defining a sound's properties
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundSource : AlResource
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Enumeration of the sound source states
+ ///
+ ////////////////////////////////////////////////////////////
+ enum Status
+ {
+ Stopped, ///< Sound is not playing
+ Paused, ///< Sound is paused
+ Playing ///< Sound is playing
+ };
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Copy constructor
+ ///
+ /// \param copy Instance to copy
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundSource(const SoundSource& copy);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~SoundSource();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the pitch of the sound
+ ///
+ /// The pitch represents the perceived fundamental frequency
+ /// of a sound; thus you can make a sound more acute or grave
+ /// by changing its pitch. A side effect of changing the pitch
+ /// is to modify the playing speed of the sound as well.
+ /// The default value for the pitch is 1.
+ ///
+ /// \param pitch New pitch to apply to the sound
+ ///
+ /// \see getPitch
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPitch(float pitch);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the volume of the sound
+ ///
+ /// The volume is a value between 0 (mute) and 100 (full volume).
+ /// The default value for the volume is 100.
+ ///
+ /// \param volume Volume of the sound
+ ///
+ /// \see getVolume
+ ///
+ ////////////////////////////////////////////////////////////
+ void setVolume(float volume);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the 3D position of the sound in the audio scene
+ ///
+ /// Only sounds with one channel (mono sounds) can be
+ /// spatialized.
+ /// The default position of a sound is (0, 0, 0).
+ ///
+ /// \param x X coordinate of the position of the sound in the scene
+ /// \param y Y coordinate of the position of the sound in the scene
+ /// \param z Z coordinate of the position of the sound in the scene
+ ///
+ /// \see getPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPosition(float x, float y, float z);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the 3D position of the sound in the audio scene
+ ///
+ /// Only sounds with one channel (mono sounds) can be
+ /// spatialized.
+ /// The default position of a sound is (0, 0, 0).
+ ///
+ /// \param position Position of the sound in the scene
+ ///
+ /// \see getPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPosition(const Vector3f& position);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Make the sound's position relative to the listener or absolute
+ ///
+ /// Making a sound relative to the listener will ensure that it will always
+ /// be played the same way regardless of the position of the listener.
+ /// This can be useful for non-spatialized sounds, sounds that are
+ /// produced by the listener, or sounds attached to it.
+ /// The default value is false (position is absolute).
+ ///
+ /// \param relative True to set the position relative, false to set it absolute
+ ///
+ /// \see isRelativeToListener
+ ///
+ ////////////////////////////////////////////////////////////
+ void setRelativeToListener(bool relative);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the minimum distance of the sound
+ ///
+ /// The "minimum distance" of a sound is the maximum
+ /// distance at which it is heard at its maximum volume. Further
+ /// than the minimum distance, it will start to fade out according
+ /// to its attenuation factor. A value of 0 ("inside the head
+ /// of the listener") is an invalid value and is forbidden.
+ /// The default value of the minimum distance is 1.
+ ///
+ /// \param distance New minimum distance of the sound
+ ///
+ /// \see getMinDistance, setAttenuation
+ ///
+ ////////////////////////////////////////////////////////////
+ void setMinDistance(float distance);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the attenuation factor of the sound
+ ///
+ /// The attenuation is a multiplicative factor which makes
+ /// the sound more or less loud according to its distance
+ /// from the listener. An attenuation of 0 will produce a
+ /// non-attenuated sound, i.e. its volume will always be the same
+ /// whether it is heard from near or from far. On the other hand,
+ /// an attenuation value such as 100 will make the sound fade out
+ /// very quickly as it gets further from the listener.
+ /// The default value of the attenuation is 1.
+ ///
+ /// \param attenuation New attenuation factor of the sound
+ ///
+ /// \see getAttenuation, setMinDistance
+ ///
+ ////////////////////////////////////////////////////////////
+ void setAttenuation(float attenuation);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the pitch of the sound
+ ///
+ /// \return Pitch of the sound
+ ///
+ /// \see setPitch
+ ///
+ ////////////////////////////////////////////////////////////
+ float getPitch() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the volume of the sound
+ ///
+ /// \return Volume of the sound, in the range [0, 100]
+ ///
+ /// \see setVolume
+ ///
+ ////////////////////////////////////////////////////////////
+ float getVolume() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the 3D position of the sound in the audio scene
+ ///
+ /// \return Position of the sound
+ ///
+ /// \see setPosition
+ ///
+ ////////////////////////////////////////////////////////////
+ Vector3f getPosition() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Tell whether the sound's position is relative to the
+ /// listener or is absolute
+ ///
+ /// \return True if the position is relative, false if it's absolute
+ ///
+ /// \see setRelativeToListener
+ ///
+ ////////////////////////////////////////////////////////////
+ bool isRelativeToListener() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the minimum distance of the sound
+ ///
+ /// \return Minimum distance of the sound
+ ///
+ /// \see setMinDistance, getAttenuation
+ ///
+ ////////////////////////////////////////////////////////////
+ float getMinDistance() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the attenuation factor of the sound
+ ///
+ /// \return Attenuation factor of the sound
+ ///
+ /// \see setAttenuation, getMinDistance
+ ///
+ ////////////////////////////////////////////////////////////
+ float getAttenuation() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Overload of assignment operator
+ ///
+ /// \param right Instance to assign
+ ///
+ /// \return Reference to self
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundSource& operator =(const SoundSource& right);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start or resume playing the sound source
+ ///
+ /// This function starts the source if it was stopped, resumes
+ /// it if it was paused, and restarts it from the beginning if
+ /// it was already playing.
+ ///
+ /// \see pause, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void play() = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Pause the sound source
+ ///
+ /// This function pauses the source if it was playing,
+ /// otherwise (source already paused or stopped) it has no effect.
+ ///
+ /// \see play, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void pause() = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Stop playing the sound source
+ ///
+ /// This function stops the source if it was playing or paused,
+ /// and does nothing if it was already stopped.
+ /// It also resets the playing position (unlike pause()).
+ ///
+ /// \see play, pause
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void stop() = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current status of the sound (stopped, paused, playing)
+ ///
+ /// \return Current status of the sound
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Status getStatus() const;
+
+protected:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// This constructor is meant to be called by derived classes only.
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundSource();
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ unsigned int m_source; ///< OpenAL source identifier
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDSOURCE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundSource
+/// \ingroup audio
+///
+/// sf::SoundSource is not meant to be used directly, it
+/// only serves as a common base for all audio objects
+/// that can live in the audio environment.
+///
+/// It defines several properties for the sound: pitch,
+/// volume, position, attenuation, etc. All of them can be
+/// changed at any time with no impact on performances.
+///
+/// \see sf::Sound, sf::SoundStream
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundStream.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundStream.hpp
new file mode 100644
index 0000000..bed8311
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Audio/SoundStream.hpp
@@ -0,0 +1,405 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_SOUNDSTREAM_HPP
+#define SFML_SOUNDSTREAM_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Abstract base class for streamed audio sources
+///
+////////////////////////////////////////////////////////////
+class SFML_AUDIO_API SoundStream : public SoundSource
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Structure defining a chunk of audio data to stream
+ ///
+ ////////////////////////////////////////////////////////////
+ struct Chunk
+ {
+ const Int16* samples; ///< Pointer to the audio samples
+ std::size_t sampleCount; ///< Number of samples pointed by Samples
+ };
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~SoundStream();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Start or resume playing the audio stream
+ ///
+ /// This function starts the stream if it was stopped, resumes
+ /// it if it was paused, and restarts it from the beginning if
+ /// it was already playing.
+ /// This function uses its own thread so that it doesn't block
+ /// the rest of the program while the stream is played.
+ ///
+ /// \see pause, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ void play();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Pause the audio stream
+ ///
+ /// This function pauses the stream if it was playing,
+ /// otherwise (stream already paused or stopped) it has no effect.
+ ///
+ /// \see play, stop
+ ///
+ ////////////////////////////////////////////////////////////
+ void pause();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Stop playing the audio stream
+ ///
+ /// This function stops the stream if it was playing or paused,
+ /// and does nothing if it was already stopped.
+ /// It also resets the playing position (unlike pause()).
+ ///
+ /// \see play, pause
+ ///
+ ////////////////////////////////////////////////////////////
+ void stop();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Return the number of channels of the stream
+ ///
+ /// 1 channel means a mono sound, 2 means stereo, etc.
+ ///
+ /// \return Number of channels
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getChannelCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the stream sample rate of the stream
+ ///
+ /// The sample rate is the number of audio samples played per
+ /// second. The higher, the better the quality.
+ ///
+ /// \return Sample rate, in number of samples per second
+ ///
+ ////////////////////////////////////////////////////////////
+ unsigned int getSampleRate() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current status of the stream (stopped, paused, playing)
+ ///
+ /// \return Current status
+ ///
+ ////////////////////////////////////////////////////////////
+ Status getStatus() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position of the stream
+ ///
+ /// The playing position can be changed when the stream is
+ /// either paused or playing. Changing the playing position
+ /// when the stream is stopped has no effect, since playing
+ /// the stream would reset its position.
+ ///
+ /// \param timeOffset New playing position, from the beginning of the stream
+ ///
+ /// \see getPlayingOffset
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPlayingOffset(Time timeOffset);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the current playing position of the stream
+ ///
+ /// \return Current playing position, from the beginning of the stream
+ ///
+ /// \see setPlayingOffset
+ ///
+ ////////////////////////////////////////////////////////////
+ Time getPlayingOffset() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set whether or not the stream should loop after reaching the end
+ ///
+ /// If set, the stream will restart from beginning after
+ /// reaching the end and so on, until it is stopped or
+ /// setLoop(false) is called.
+ /// The default looping state for streams is false.
+ ///
+ /// \param loop True to play in loop, false to play once
+ ///
+ /// \see getLoop
+ ///
+ ////////////////////////////////////////////////////////////
+ void setLoop(bool loop);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Tell whether or not the stream is in loop mode
+ ///
+ /// \return True if the stream is looping, false otherwise
+ ///
+ /// \see setLoop
+ ///
+ ////////////////////////////////////////////////////////////
+ bool getLoop() const;
+
+protected:
+
+ enum
+ {
+ NoLoop = -1 ///< "Invalid" endSeeks value, telling us to continue uninterrupted
+ };
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// This constructor is only meant to be called by derived classes.
+ ///
+ ////////////////////////////////////////////////////////////
+ SoundStream();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Define the audio stream parameters
+ ///
+ /// This function must be called by derived classes as soon
+ /// as they know the audio settings of the stream to play.
+ /// Any attempt to manipulate the stream (play(), ...) before
+ /// calling this function will fail.
+ /// It can be called multiple times if the settings of the
+ /// audio stream change, but only when the stream is stopped.
+ ///
+ /// \param channelCount Number of channels of the stream
+ /// \param sampleRate Sample rate, in samples per second
+ ///
+ ////////////////////////////////////////////////////////////
+ void initialize(unsigned int channelCount, unsigned int sampleRate);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Request a new chunk of audio samples from the stream source
+ ///
+ /// This function must be overridden by derived classes to provide
+ /// the audio samples to play. It is called continuously by the
+ /// streaming loop, in a separate thread.
+ /// The source can choose to stop the streaming loop at any time, by
+ /// returning false to the caller.
+ /// If you return true (i.e. continue streaming) it is important that
+ /// the returned array of samples is not empty; this would stop the stream
+ /// due to an internal limitation.
+ ///
+ /// \param data Chunk of data to fill
+ ///
+ /// \return True to continue playback, false to stop
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual bool onGetData(Chunk& data) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position in the stream source
+ ///
+ /// This function must be overridden by derived classes to
+ /// allow random seeking into the stream source.
+ ///
+ /// \param timeOffset New playing position, relative to the beginning of the stream
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void onSeek(Time timeOffset) = 0;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Change the current playing position in the stream source to the beginning of the loop
+ ///
+ /// This function can be overridden by derived classes to
+ /// allow implementation of custom loop points. Otherwise,
+ /// it just calls onSeek(Time::Zero) and returns 0.
+ ///
+ /// \return The seek position after looping (or -1 if there's no loop)
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Int64 onLoop();
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Function called as the entry point of the thread
+ ///
+ /// This function starts the streaming loop, and returns
+ /// only when the sound is stopped.
+ ///
+ ////////////////////////////////////////////////////////////
+ void streamData();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Fill a new buffer with audio samples, and append
+ /// it to the playing queue
+ ///
+ /// This function is called as soon as a buffer has been fully
+ /// consumed; it fills it again and inserts it back into the
+ /// playing queue.
+ ///
+ /// \param bufferNum Number of the buffer to fill (in [0, BufferCount])
+ /// \param immediateLoop Treat empty buffers as spent, and act on loops immediately
+ ///
+ /// \return True if the stream source has requested to stop, false otherwise
+ ///
+ ////////////////////////////////////////////////////////////
+ bool fillAndPushBuffer(unsigned int bufferNum, bool immediateLoop = false);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Fill the audio buffers and put them all into the playing queue
+ ///
+ /// This function is called when playing starts and the
+ /// playing queue is empty.
+ ///
+ /// \return True if the derived class has requested to stop, false otherwise
+ ///
+ ////////////////////////////////////////////////////////////
+ bool fillQueue();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Clear all the audio buffers and empty the playing queue
+ ///
+ /// This function is called when the stream is stopped.
+ ///
+ ////////////////////////////////////////////////////////////
+ void clearQueue();
+
+ enum
+ {
+ BufferCount = 3, ///< Number of audio buffers used by the streaming loop
+ BufferRetries = 2 ///< Number of retries (excluding initial try) for onGetData()
+ };
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ Thread m_thread; ///< Thread running the background tasks
+ mutable Mutex m_threadMutex; ///< Thread mutex
+ Status m_threadStartState; ///< State the thread starts in (Playing, Paused, Stopped)
+ bool m_isStreaming; ///< Streaming state (true = playing, false = stopped)
+ unsigned int m_buffers[BufferCount]; ///< Sound buffers used to store temporary audio data
+ unsigned int m_channelCount; ///< Number of channels (1 = mono, 2 = stereo, ...)
+ unsigned int m_sampleRate; ///< Frequency (samples / second)
+ Uint32 m_format; ///< Format of the internal sound buffers
+ bool m_loop; ///< Loop flag (true to loop, false to play once)
+ Uint64 m_samplesProcessed; ///< Number of buffers processed since beginning of the stream
+ Int64 m_bufferSeeks[BufferCount]; ///< If buffer is an "end buffer", holds next seek position, else NoLoop. For play offset calculation.
+};
+
+} // namespace sf
+
+
+#endif // SFML_SOUNDSTREAM_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::SoundStream
+/// \ingroup audio
+///
+/// Unlike audio buffers (see sf::SoundBuffer), audio streams
+/// are never completely loaded in memory. Instead, the audio
+/// data is acquired continuously while the stream is playing.
+/// This behavior allows to play a sound with no loading delay,
+/// and keeps the memory consumption very low.
+///
+/// Sound sources that need to be streamed are usually big files
+/// (compressed audio musics that would eat hundreds of MB in memory)
+/// or files that would take a lot of time to be received
+/// (sounds played over the network).
+///
+/// sf::SoundStream is a base class that doesn't care about the
+/// stream source, which is left to the derived class. SFML provides
+/// a built-in specialization for big files (see sf::Music).
+/// No network stream source is provided, but you can write your own
+/// by combining this class with the network module.
+///
+/// A derived class has to override two virtual functions:
+/// \li onGetData fills a new chunk of audio data to be played
+/// \li onSeek changes the current playing position in the source
+///
+/// It is important to note that each SoundStream is played in its
+/// own separate thread, so that the streaming loop doesn't block the
+/// rest of the program. In particular, the OnGetData and OnSeek
+/// virtual functions may sometimes be called from this separate thread.
+/// It is important to keep this in mind, because you may have to take
+/// care of synchronization issues if you share data between threads.
+///
+/// Usage example:
+/// \code
+/// class CustomStream : public sf::SoundStream
+/// {
+/// public:
+///
+/// bool open(const std::string& location)
+/// {
+/// // Open the source and get audio settings
+/// ...
+/// unsigned int channelCount = ...;
+/// unsigned int sampleRate = ...;
+///
+/// // Initialize the stream -- important!
+/// initialize(channelCount, sampleRate);
+/// }
+///
+/// private:
+///
+/// virtual bool onGetData(Chunk& data)
+/// {
+/// // Fill the chunk with audio data from the stream source
+/// // (note: must not be empty if you want to continue playing)
+/// data.samples = ...;
+/// data.sampleCount = ...;
+///
+/// // Return true to continue playing
+/// return true;
+/// }
+///
+/// virtual void onSeek(Uint32 timeOffset)
+/// {
+/// // Change the current position in the stream source
+/// ...
+/// }
+/// }
+///
+/// // Usage
+/// CustomStream stream;
+/// stream.open("path/to/stream");
+/// stream.play();
+/// \endcode
+///
+/// \see sf::Music
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Config.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Config.hpp
new file mode 100644
index 0000000..40b677e
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Config.hpp
@@ -0,0 +1,236 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_CONFIG_HPP
+#define SFML_CONFIG_HPP
+
+
+////////////////////////////////////////////////////////////
+// Define the SFML version
+////////////////////////////////////////////////////////////
+#define SFML_VERSION_MAJOR 2
+#define SFML_VERSION_MINOR 5
+#define SFML_VERSION_PATCH 1
+
+
+////////////////////////////////////////////////////////////
+// Identify the operating system
+// see http://nadeausoftware.com/articles/2012/01/c_c_tip_how_use_compiler_predefined_macros_detect_operating_system
+////////////////////////////////////////////////////////////
+#if defined(_WIN32)
+
+ // Windows
+ #define SFML_SYSTEM_WINDOWS
+ #ifndef NOMINMAX
+ #define NOMINMAX
+ #endif
+
+#elif defined(__APPLE__) && defined(__MACH__)
+
+ // Apple platform, see which one it is
+ #include "TargetConditionals.h"
+
+ #if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
+
+ // iOS
+ #define SFML_SYSTEM_IOS
+
+ #elif TARGET_OS_MAC
+
+ // MacOS
+ #define SFML_SYSTEM_MACOS
+
+ #else
+
+ // Unsupported Apple system
+ #error This Apple operating system is not supported by SFML library
+
+ #endif
+
+#elif defined(__unix__)
+
+ // UNIX system, see which one it is
+ #if defined(__ANDROID__)
+
+ // Android
+ #define SFML_SYSTEM_ANDROID
+
+ #elif defined(__linux__)
+
+ // Linux
+ #define SFML_SYSTEM_LINUX
+
+ #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
+
+ // FreeBSD
+ #define SFML_SYSTEM_FREEBSD
+
+ #elif defined(__OpenBSD__)
+
+ // OpenBSD
+ #define SFML_SYSTEM_OPENBSD
+
+ #else
+
+ // Unsupported UNIX system
+ #error This UNIX operating system is not supported by SFML library
+
+ #endif
+
+#else
+
+ // Unsupported system
+ #error This operating system is not supported by SFML library
+
+#endif
+
+
+////////////////////////////////////////////////////////////
+// Define a portable debug macro
+////////////////////////////////////////////////////////////
+#if !defined(NDEBUG)
+
+ #define SFML_DEBUG
+
+#endif
+
+
+////////////////////////////////////////////////////////////
+// Define helpers to create portable import / export macros for each module
+////////////////////////////////////////////////////////////
+#if !defined(SFML_STATIC)
+
+ #if defined(SFML_SYSTEM_WINDOWS)
+
+ // Windows compilers need specific (and different) keywords for export and import
+ #define SFML_API_EXPORT __declspec(dllexport)
+ #define SFML_API_IMPORT __declspec(dllimport)
+
+ // For Visual C++ compilers, we also need to turn off this annoying C4251 warning
+ #ifdef _MSC_VER
+
+ #pragma warning(disable: 4251)
+
+ #endif
+
+ #else // Linux, FreeBSD, Mac OS X
+
+ #if __GNUC__ >= 4
+
+ // GCC 4 has special keywords for showing/hidding symbols,
+ // the same keyword is used for both importing and exporting
+ #define SFML_API_EXPORT __attribute__ ((__visibility__ ("default")))
+ #define SFML_API_IMPORT __attribute__ ((__visibility__ ("default")))
+
+ #else
+
+ // GCC < 4 has no mechanism to explicitely hide symbols, everything's exported
+ #define SFML_API_EXPORT
+ #define SFML_API_IMPORT
+
+ #endif
+
+ #endif
+
+#else
+
+ // Static build doesn't need import/export macros
+ #define SFML_API_EXPORT
+ #define SFML_API_IMPORT
+
+#endif
+
+
+////////////////////////////////////////////////////////////
+// Cross-platform warning for deprecated functions and classes
+//
+// Usage:
+// class SFML_DEPRECATED MyClass
+// {
+// SFML_DEPRECATED void memberFunc();
+// };
+//
+// SFML_DEPRECATED void globalFunc();
+////////////////////////////////////////////////////////////
+#if defined(SFML_NO_DEPRECATED_WARNINGS)
+
+ // User explicitly requests to disable deprecation warnings
+ #define SFML_DEPRECATED
+
+#elif defined(_MSC_VER)
+
+ // Microsoft C++ compiler
+ // Note: On newer MSVC versions, using deprecated functions causes a compiler error. In order to
+ // trigger a warning instead of an error, the compiler flag /sdl- (instead of /sdl) must be specified.
+ #define SFML_DEPRECATED __declspec(deprecated)
+
+#elif defined(__GNUC__)
+
+ // g++ and Clang
+ #define SFML_DEPRECATED __attribute__ ((deprecated))
+
+#else
+
+ // Other compilers are not supported, leave class or function as-is.
+ // With a bit of luck, the #pragma directive works, otherwise users get a warning (no error!) for unrecognized #pragma.
+ #pragma message("SFML_DEPRECATED is not supported for your compiler, please contact the SFML team")
+ #define SFML_DEPRECATED
+
+#endif
+
+
+////////////////////////////////////////////////////////////
+// Define portable fixed-size types
+////////////////////////////////////////////////////////////
+namespace sf
+{
+ // All "common" platforms use the same size for char, short and int
+ // (basically there are 3 types for 3 sizes, so no other match is possible),
+ // we can use them without doing any kind of check
+
+ // 8 bits integer types
+ typedef signed char Int8;
+ typedef unsigned char Uint8;
+
+ // 16 bits integer types
+ typedef signed short Int16;
+ typedef unsigned short Uint16;
+
+ // 32 bits integer types
+ typedef signed int Int32;
+ typedef unsigned int Uint32;
+
+ // 64 bits integer types
+ #if defined(_MSC_VER)
+ typedef signed __int64 Int64;
+ typedef unsigned __int64 Uint64;
+ #else
+ typedef signed long long Int64;
+ typedef unsigned long long Uint64;
+ #endif
+
+} // namespace sf
+
+
+#endif // SFML_CONFIG_HPP
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/GpuPreference.hpp b/SQCSim2021/external/sfml251-32/include/SFML/GpuPreference.hpp
new file mode 100644
index 0000000..cde4f9f
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/GpuPreference.hpp
@@ -0,0 +1,74 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_GPUPREFERENCE_HPP
+#define SFML_GPUPREFERENCE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// Headers
+////////////////////////////////////////////////////////////
+#include
+
+
+////////////////////////////////////////////////////////////
+/// \file
+///
+/// \brief File containing SFML_DEFINE_DISCRETE_GPU_PREFERENCE
+///
+////////////////////////////////////////////////////////////
+
+
+////////////////////////////////////////////////////////////
+/// \def SFML_DEFINE_DISCRETE_GPU_PREFERENCE
+///
+/// \brief A macro to encourage usage of the discrete GPU
+///
+/// In order to inform the Nvidia/AMD driver that an SFML
+/// application could benefit from using the more powerful
+/// discrete GPU, special symbols have to be publicly
+/// exported from the final executable.
+///
+/// SFML defines a helper macro to easily do this.
+///
+/// Place SFML_DEFINE_DISCRETE_GPU_PREFERENCE in the
+/// global scope of a source file that will be linked into
+/// the final executable. Typically it is best to place it
+/// where the main function is also defined.
+///
+////////////////////////////////////////////////////////////
+#if defined(SFML_SYSTEM_WINDOWS)
+
+ #define SFML_DEFINE_DISCRETE_GPU_PREFERENCE \
+ extern "C" __declspec(dllexport) unsigned long NvOptimusEnablement = 1; \
+ extern "C" __declspec(dllexport) unsigned long AmdPowerXpressRequestHighPerformance = 1;
+
+#else
+
+ #define SFML_DEFINE_DISCRETE_GPU_PREFERENCE
+
+#endif
+
+
+#endif // SFML_GPUPREFERENCE_HPP
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics.hpp
new file mode 100644
index 0000000..252c6e9
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics.hpp
@@ -0,0 +1,68 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_GRAPHICS_HPP
+#define SFML_GRAPHICS_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+#include
+
+
+#endif // SFML_GRAPHICS_HPP
+
+////////////////////////////////////////////////////////////
+/// \defgroup graphics Graphics module
+///
+/// 2D graphics module: sprites, text, shapes, ...
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/BlendMode.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/BlendMode.hpp
new file mode 100644
index 0000000..15da7d1
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/BlendMode.hpp
@@ -0,0 +1,215 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_BLENDMODE_HPP
+#define SFML_BLENDMODE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+
+
+namespace sf
+{
+
+////////////////////////////////////////////////////////////
+/// \brief Blending modes for drawing
+///
+////////////////////////////////////////////////////////////
+struct SFML_GRAPHICS_API BlendMode
+{
+ ////////////////////////////////////////////////////////
+ /// \brief Enumeration of the blending factors
+ ///
+ /// The factors are mapped directly to their OpenGL equivalents,
+ /// specified by glBlendFunc() or glBlendFuncSeparate().
+ ////////////////////////////////////////////////////////
+ enum Factor
+ {
+ Zero, ///< (0, 0, 0, 0)
+ One, ///< (1, 1, 1, 1)
+ SrcColor, ///< (src.r, src.g, src.b, src.a)
+ OneMinusSrcColor, ///< (1, 1, 1, 1) - (src.r, src.g, src.b, src.a)
+ DstColor, ///< (dst.r, dst.g, dst.b, dst.a)
+ OneMinusDstColor, ///< (1, 1, 1, 1) - (dst.r, dst.g, dst.b, dst.a)
+ SrcAlpha, ///< (src.a, src.a, src.a, src.a)
+ OneMinusSrcAlpha, ///< (1, 1, 1, 1) - (src.a, src.a, src.a, src.a)
+ DstAlpha, ///< (dst.a, dst.a, dst.a, dst.a)
+ OneMinusDstAlpha ///< (1, 1, 1, 1) - (dst.a, dst.a, dst.a, dst.a)
+ };
+
+ ////////////////////////////////////////////////////////
+ /// \brief Enumeration of the blending equations
+ ///
+ /// The equations are mapped directly to their OpenGL equivalents,
+ /// specified by glBlendEquation() or glBlendEquationSeparate().
+ ////////////////////////////////////////////////////////
+ enum Equation
+ {
+ Add, ///< Pixel = Src * SrcFactor + Dst * DstFactor
+ Subtract, ///< Pixel = Src * SrcFactor - Dst * DstFactor
+ ReverseSubtract ///< Pixel = Dst * DstFactor - Src * SrcFactor
+ };
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// Constructs a blending mode that does alpha blending.
+ ///
+ ////////////////////////////////////////////////////////////
+ BlendMode();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Construct the blend mode given the factors and equation.
+ ///
+ /// This constructor uses the same factors and equation for both
+ /// color and alpha components. It also defaults to the Add equation.
+ ///
+ /// \param sourceFactor Specifies how to compute the source factor for the color and alpha channels.
+ /// \param destinationFactor Specifies how to compute the destination factor for the color and alpha channels.
+ /// \param blendEquation Specifies how to combine the source and destination colors and alpha.
+ ///
+ ////////////////////////////////////////////////////////////
+ BlendMode(Factor sourceFactor, Factor destinationFactor, Equation blendEquation = Add);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Construct the blend mode given the factors and equation.
+ ///
+ /// \param colorSourceFactor Specifies how to compute the source factor for the color channels.
+ /// \param colorDestinationFactor Specifies how to compute the destination factor for the color channels.
+ /// \param colorBlendEquation Specifies how to combine the source and destination colors.
+ /// \param alphaSourceFactor Specifies how to compute the source factor.
+ /// \param alphaDestinationFactor Specifies how to compute the destination factor.
+ /// \param alphaBlendEquation Specifies how to combine the source and destination alphas.
+ ///
+ ////////////////////////////////////////////////////////////
+ BlendMode(Factor colorSourceFactor, Factor colorDestinationFactor,
+ Equation colorBlendEquation, Factor alphaSourceFactor,
+ Factor alphaDestinationFactor, Equation alphaBlendEquation);
+
+ ////////////////////////////////////////////////////////////
+ // Member Data
+ ////////////////////////////////////////////////////////////
+ Factor colorSrcFactor; ///< Source blending factor for the color channels
+ Factor colorDstFactor; ///< Destination blending factor for the color channels
+ Equation colorEquation; ///< Blending equation for the color channels
+ Factor alphaSrcFactor; ///< Source blending factor for the alpha channel
+ Factor alphaDstFactor; ///< Destination blending factor for the alpha channel
+ Equation alphaEquation; ///< Blending equation for the alpha channel
+};
+
+////////////////////////////////////////////////////////////
+/// \relates BlendMode
+/// \brief Overload of the == operator
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return True if blending modes are equal, false if they are different
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API bool operator ==(const BlendMode& left, const BlendMode& right);
+
+////////////////////////////////////////////////////////////
+/// \relates BlendMode
+/// \brief Overload of the != operator
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return True if blending modes are different, false if they are equal
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API bool operator !=(const BlendMode& left, const BlendMode& right);
+
+////////////////////////////////////////////////////////////
+// Commonly used blending modes
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API extern const BlendMode BlendAlpha; ///< Blend source and dest according to dest alpha
+SFML_GRAPHICS_API extern const BlendMode BlendAdd; ///< Add source to dest
+SFML_GRAPHICS_API extern const BlendMode BlendMultiply; ///< Multiply source and dest
+SFML_GRAPHICS_API extern const BlendMode BlendNone; ///< Overwrite dest with source
+
+} // namespace sf
+
+
+#endif // SFML_BLENDMODE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::BlendMode
+/// \ingroup graphics
+///
+/// sf::BlendMode is a class that represents a blend mode. A blend
+/// mode determines how the colors of an object you draw are
+/// mixed with the colors that are already in the buffer.
+///
+/// The class is composed of 6 components, each of which has its
+/// own public member variable:
+/// \li %Color Source Factor (@ref colorSrcFactor)
+/// \li %Color Destination Factor (@ref colorDstFactor)
+/// \li %Color Blend Equation (@ref colorEquation)
+/// \li Alpha Source Factor (@ref alphaSrcFactor)
+/// \li Alpha Destination Factor (@ref alphaDstFactor)
+/// \li Alpha Blend Equation (@ref alphaEquation)
+///
+/// The source factor specifies how the pixel you are drawing contributes
+/// to the final color. The destination factor specifies how the pixel
+/// already drawn in the buffer contributes to the final color.
+///
+/// The color channels RGB (red, green, blue; simply referred to as
+/// color) and A (alpha; the transparency) can be treated separately. This
+/// separation can be useful for specific blend modes, but most often you
+/// won't need it and will simply treat the color as a single unit.
+///
+/// The blend factors and equations correspond to their OpenGL equivalents.
+/// In general, the color of the resulting pixel is calculated according
+/// to the following formula (\a src is the color of the source pixel, \a dst
+/// the color of the destination pixel, the other variables correspond to the
+/// public members, with the equations being + or - operators):
+/// \code
+/// dst.rgb = colorSrcFactor * src.rgb (colorEquation) colorDstFactor * dst.rgb
+/// dst.a = alphaSrcFactor * src.a (alphaEquation) alphaDstFactor * dst.a
+/// \endcode
+/// All factors and colors are represented as floating point numbers between
+/// 0 and 1. Where necessary, the result is clamped to fit in that range.
+///
+/// The most common blending modes are defined as constants
+/// in the sf namespace:
+///
+/// \code
+/// sf::BlendMode alphaBlending = sf::BlendAlpha;
+/// sf::BlendMode additiveBlending = sf::BlendAdd;
+/// sf::BlendMode multiplicativeBlending = sf::BlendMultiply;
+/// sf::BlendMode noBlending = sf::BlendNone;
+/// \endcode
+///
+/// In SFML, a blend mode can be specified every time you draw a sf::Drawable
+/// object to a render target. It is part of the sf::RenderStates compound
+/// that is passed to the member function sf::RenderTarget::draw().
+///
+/// \see sf::RenderStates, sf::RenderTarget
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/CircleShape.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/CircleShape.hpp
new file mode 100644
index 0000000..896c893
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/CircleShape.hpp
@@ -0,0 +1,154 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_CIRCLESHAPE_HPP
+#define SFML_CIRCLESHAPE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Specialized shape representing a circle
+///
+////////////////////////////////////////////////////////////
+class SFML_GRAPHICS_API CircleShape : public Shape
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// \param radius Radius of the circle
+ /// \param pointCount Number of points composing the circle
+ ///
+ ////////////////////////////////////////////////////////////
+ explicit CircleShape(float radius = 0, std::size_t pointCount = 30);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the radius of the circle
+ ///
+ /// \param radius New radius of the circle
+ ///
+ /// \see getRadius
+ ///
+ ////////////////////////////////////////////////////////////
+ void setRadius(float radius);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the radius of the circle
+ ///
+ /// \return Radius of the circle
+ ///
+ /// \see setRadius
+ ///
+ ////////////////////////////////////////////////////////////
+ float getRadius() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the number of points of the circle
+ ///
+ /// \param count New number of points of the circle
+ ///
+ /// \see getPointCount
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPointCount(std::size_t count);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of points of the circle
+ ///
+ /// \return Number of points of the circle
+ ///
+ /// \see setPointCount
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual std::size_t getPointCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get a point of the circle
+ ///
+ /// The returned point is in local coordinates, that is,
+ /// the shape's transforms (position, rotation, scale) are
+ /// not taken into account.
+ /// The result is undefined if \a index is out of the valid range.
+ ///
+ /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
+ ///
+ /// \return index-th point of the shape
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Vector2f getPoint(std::size_t index) const;
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ float m_radius; ///< Radius of the circle
+ std::size_t m_pointCount; ///< Number of points composing the circle
+};
+
+} // namespace sf
+
+
+#endif // SFML_CIRCLESHAPE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::CircleShape
+/// \ingroup graphics
+///
+/// This class inherits all the functions of sf::Transformable
+/// (position, rotation, scale, bounds, ...) as well as the
+/// functions of sf::Shape (outline, color, texture, ...).
+///
+/// Usage example:
+/// \code
+/// sf::CircleShape circle;
+/// circle.setRadius(150);
+/// circle.setOutlineColor(sf::Color::Red);
+/// circle.setOutlineThickness(5);
+/// circle.setPosition(10, 20);
+/// ...
+/// window.draw(circle);
+/// \endcode
+///
+/// Since the graphics card can't draw perfect circles, we have to
+/// fake them with multiple triangles connected to each other. The
+/// "points count" property of sf::CircleShape defines how many of these
+/// triangles to use, and therefore defines the quality of the circle.
+///
+/// The number of points can also be used for another purpose; with
+/// small numbers you can create any regular polygon shape:
+/// equilateral triangle, square, pentagon, hexagon, ...
+///
+/// \see sf::Shape, sf::RectangleShape, sf::ConvexShape
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Color.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Color.hpp
new file mode 100644
index 0000000..43357aa
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Color.hpp
@@ -0,0 +1,275 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_COLOR_HPP
+#define SFML_COLOR_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Utility class for manipulating RGBA colors
+///
+////////////////////////////////////////////////////////////
+class SFML_GRAPHICS_API Color
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// Constructs an opaque black color. It is equivalent to
+ /// sf::Color(0, 0, 0, 255).
+ ///
+ ////////////////////////////////////////////////////////////
+ Color();
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Construct the color from its 4 RGBA components
+ ///
+ /// \param red Red component (in the range [0, 255])
+ /// \param green Green component (in the range [0, 255])
+ /// \param blue Blue component (in the range [0, 255])
+ /// \param alpha Alpha (opacity) component (in the range [0, 255])
+ ///
+ ////////////////////////////////////////////////////////////
+ Color(Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha = 255);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Construct the color from 32-bit unsigned integer
+ ///
+ /// \param color Number containing the RGBA components (in that order)
+ ///
+ ////////////////////////////////////////////////////////////
+ explicit Color(Uint32 color);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Retrieve the color as a 32-bit unsigned integer
+ ///
+ /// \return Color represented as a 32-bit unsigned integer
+ ///
+ ////////////////////////////////////////////////////////////
+ Uint32 toInteger() const;
+
+ ////////////////////////////////////////////////////////////
+ // Static member data
+ ////////////////////////////////////////////////////////////
+ static const Color Black; ///< Black predefined color
+ static const Color White; ///< White predefined color
+ static const Color Red; ///< Red predefined color
+ static const Color Green; ///< Green predefined color
+ static const Color Blue; ///< Blue predefined color
+ static const Color Yellow; ///< Yellow predefined color
+ static const Color Magenta; ///< Magenta predefined color
+ static const Color Cyan; ///< Cyan predefined color
+ static const Color Transparent; ///< Transparent (black) predefined color
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ Uint8 r; ///< Red component
+ Uint8 g; ///< Green component
+ Uint8 b; ///< Blue component
+ Uint8 a; ///< Alpha (opacity) component
+};
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the == operator
+///
+/// This operator compares two colors and check if they are equal.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return True if colors are equal, false if they are different
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API bool operator ==(const Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the != operator
+///
+/// This operator compares two colors and check if they are different.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return True if colors are different, false if they are equal
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API bool operator !=(const Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary + operator
+///
+/// This operator returns the component-wise sum of two colors.
+/// Components that exceed 255 are clamped to 255.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Result of \a left + \a right
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color operator +(const Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary - operator
+///
+/// This operator returns the component-wise subtraction of two colors.
+/// Components below 0 are clamped to 0.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Result of \a left - \a right
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color operator -(const Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary * operator
+///
+/// This operator returns the component-wise multiplication
+/// (also called "modulation") of two colors.
+/// Components are then divided by 255 so that the result is
+/// still in the range [0, 255].
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Result of \a left * \a right
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color operator *(const Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary += operator
+///
+/// This operator computes the component-wise sum of two colors,
+/// and assigns the result to the left operand.
+/// Components that exceed 255 are clamped to 255.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Reference to \a left
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color& operator +=(Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary -= operator
+///
+/// This operator computes the component-wise subtraction of two colors,
+/// and assigns the result to the left operand.
+/// Components below 0 are clamped to 0.
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Reference to \a left
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color& operator -=(Color& left, const Color& right);
+
+////////////////////////////////////////////////////////////
+/// \relates Color
+/// \brief Overload of the binary *= operator
+///
+/// This operator returns the component-wise multiplication
+/// (also called "modulation") of two colors, and assigns
+/// the result to the left operand.
+/// Components are then divided by 255 so that the result is
+/// still in the range [0, 255].
+///
+/// \param left Left operand
+/// \param right Right operand
+///
+/// \return Reference to \a left
+///
+////////////////////////////////////////////////////////////
+SFML_GRAPHICS_API Color& operator *=(Color& left, const Color& right);
+
+} // namespace sf
+
+
+#endif // SFML_COLOR_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::Color
+/// \ingroup graphics
+///
+/// sf::Color is a simple color class composed of 4 components:
+/// \li Red
+/// \li Green
+/// \li Blue
+/// \li Alpha (opacity)
+///
+/// Each component is a public member, an unsigned integer in
+/// the range [0, 255]. Thus, colors can be constructed and
+/// manipulated very easily:
+///
+/// \code
+/// sf::Color color(255, 0, 0); // red
+/// color.r = 0; // make it black
+/// color.b = 128; // make it dark blue
+/// \endcode
+///
+/// The fourth component of colors, named "alpha", represents
+/// the opacity of the color. A color with an alpha value of
+/// 255 will be fully opaque, while an alpha value of 0 will
+/// make a color fully transparent, whatever the value of the
+/// other components is.
+///
+/// The most common colors are already defined as static variables:
+/// \code
+/// sf::Color black = sf::Color::Black;
+/// sf::Color white = sf::Color::White;
+/// sf::Color red = sf::Color::Red;
+/// sf::Color green = sf::Color::Green;
+/// sf::Color blue = sf::Color::Blue;
+/// sf::Color yellow = sf::Color::Yellow;
+/// sf::Color magenta = sf::Color::Magenta;
+/// sf::Color cyan = sf::Color::Cyan;
+/// sf::Color transparent = sf::Color::Transparent;
+/// \endcode
+///
+/// Colors can also be added and modulated (multiplied) using the
+/// overloaded operators + and *.
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/ConvexShape.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/ConvexShape.hpp
new file mode 100644
index 0000000..e770299
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/ConvexShape.hpp
@@ -0,0 +1,153 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_CONVEXSHAPE_HPP
+#define SFML_CONVEXSHAPE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+#include
+
+
+namespace sf
+{
+////////////////////////////////////////////////////////////
+/// \brief Specialized shape representing a convex polygon
+///
+////////////////////////////////////////////////////////////
+class SFML_GRAPHICS_API ConvexShape : public Shape
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Default constructor
+ ///
+ /// \param pointCount Number of points of the polygon
+ ///
+ ////////////////////////////////////////////////////////////
+ explicit ConvexShape(std::size_t pointCount = 0);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the number of points of the polygon
+ ///
+ /// \a count must be greater than 2 to define a valid shape.
+ ///
+ /// \param count New number of points of the polygon
+ ///
+ /// \see getPointCount
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPointCount(std::size_t count);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the number of points of the polygon
+ ///
+ /// \return Number of points of the polygon
+ ///
+ /// \see setPointCount
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual std::size_t getPointCount() const;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Set the position of a point
+ ///
+ /// Don't forget that the polygon must remain convex, and
+ /// the points need to stay ordered!
+ /// setPointCount must be called first in order to set the total
+ /// number of points. The result is undefined if \a index is out
+ /// of the valid range.
+ ///
+ /// \param index Index of the point to change, in range [0 .. getPointCount() - 1]
+ /// \param point New position of the point
+ ///
+ /// \see getPoint
+ ///
+ ////////////////////////////////////////////////////////////
+ void setPoint(std::size_t index, const Vector2f& point);
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Get the position of a point
+ ///
+ /// The returned point is in local coordinates, that is,
+ /// the shape's transforms (position, rotation, scale) are
+ /// not taken into account.
+ /// The result is undefined if \a index is out of the valid range.
+ ///
+ /// \param index Index of the point to get, in range [0 .. getPointCount() - 1]
+ ///
+ /// \return Position of the index-th point of the polygon
+ ///
+ /// \see setPoint
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual Vector2f getPoint(std::size_t index) const;
+
+private:
+
+ ////////////////////////////////////////////////////////////
+ // Member data
+ ////////////////////////////////////////////////////////////
+ std::vector m_points; ///< Points composing the convex polygon
+};
+
+} // namespace sf
+
+
+#endif // SFML_CONVEXSHAPE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::ConvexShape
+/// \ingroup graphics
+///
+/// This class inherits all the functions of sf::Transformable
+/// (position, rotation, scale, bounds, ...) as well as the
+/// functions of sf::Shape (outline, color, texture, ...).
+///
+/// It is important to keep in mind that a convex shape must
+/// always be... convex, otherwise it may not be drawn correctly.
+/// Moreover, the points must be defined in order; using a random
+/// order would result in an incorrect shape.
+///
+/// Usage example:
+/// \code
+/// sf::ConvexShape polygon;
+/// polygon.setPointCount(3);
+/// polygon.setPoint(0, sf::Vector2f(0, 0));
+/// polygon.setPoint(1, sf::Vector2f(0, 10));
+/// polygon.setPoint(2, sf::Vector2f(25, 5));
+/// polygon.setOutlineColor(sf::Color::Red);
+/// polygon.setOutlineThickness(5);
+/// polygon.setPosition(10, 20);
+/// ...
+/// window.draw(polygon);
+/// \endcode
+///
+/// \see sf::Shape, sf::RectangleShape, sf::CircleShape
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Drawable.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Drawable.hpp
new file mode 100644
index 0000000..852b22d
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Drawable.hpp
@@ -0,0 +1,126 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_DRAWABLE_HPP
+#define SFML_DRAWABLE_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+#include
+
+
+namespace sf
+{
+class RenderTarget;
+
+////////////////////////////////////////////////////////////
+/// \brief Abstract base class for objects that can be drawn
+/// to a render target
+///
+////////////////////////////////////////////////////////////
+class SFML_GRAPHICS_API Drawable
+{
+public:
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Virtual destructor
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual ~Drawable() {}
+
+protected:
+
+ friend class RenderTarget;
+
+ ////////////////////////////////////////////////////////////
+ /// \brief Draw the object to a render target
+ ///
+ /// This is a pure virtual function that has to be implemented
+ /// by the derived class to define how the drawable should be
+ /// drawn.
+ ///
+ /// \param target Render target to draw to
+ /// \param states Current render states
+ ///
+ ////////////////////////////////////////////////////////////
+ virtual void draw(RenderTarget& target, RenderStates states) const = 0;
+};
+
+} // namespace sf
+
+
+#endif // SFML_DRAWABLE_HPP
+
+
+////////////////////////////////////////////////////////////
+/// \class sf::Drawable
+/// \ingroup graphics
+///
+/// sf::Drawable is a very simple base class that allows objects
+/// of derived classes to be drawn to a sf::RenderTarget.
+///
+/// All you have to do in your derived class is to override the
+/// draw virtual function.
+///
+/// Note that inheriting from sf::Drawable is not mandatory,
+/// but it allows this nice syntax "window.draw(object)" rather
+/// than "object.draw(window)", which is more consistent with other
+/// SFML classes.
+///
+/// Example:
+/// \code
+/// class MyDrawable : public sf::Drawable
+/// {
+/// public:
+///
+/// ...
+///
+/// private:
+///
+/// virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const
+/// {
+/// // You can draw other high-level objects
+/// target.draw(m_sprite, states);
+///
+/// // ... or use the low-level API
+/// states.texture = &m_texture;
+/// target.draw(m_vertices, states);
+///
+/// // ... or draw with OpenGL directly
+/// glBegin(GL_QUADS);
+/// ...
+/// glEnd();
+/// }
+///
+/// sf::Sprite m_sprite;
+/// sf::Texture m_texture;
+/// sf::VertexArray m_vertices;
+/// };
+/// \endcode
+///
+/// \see sf::RenderTarget
+///
+////////////////////////////////////////////////////////////
diff --git a/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Export.hpp b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Export.hpp
new file mode 100644
index 0000000..0b47b39
--- /dev/null
+++ b/SQCSim2021/external/sfml251-32/include/SFML/Graphics/Export.hpp
@@ -0,0 +1,48 @@
+////////////////////////////////////////////////////////////
+//
+// SFML - Simple and Fast Multimedia Library
+// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
+//
+// This software is provided 'as-is', without any express or implied warranty.
+// In no event will the authors be held liable for any damages arising from the use of this software.
+//
+// Permission is granted to anyone to use this software for any purpose,
+// including commercial applications, and to alter it and redistribute it freely,
+// subject to the following restrictions:
+//
+// 1. The origin of this software must not be misrepresented;
+// you must not claim that you wrote the original software.
+// If you use this software in a product, an acknowledgment
+// in the product documentation would be appreciated but is not required.
+//
+// 2. Altered source versions must be plainly marked as such,
+// and must not be misrepresented as being the original software.
+//
+// 3. This notice may not be removed or altered from any source distribution.
+//
+////////////////////////////////////////////////////////////
+
+#ifndef SFML_GRAPHICS_EXPORT_HPP
+#define SFML_GRAPHICS_EXPORT_HPP
+
+////////////////////////////////////////////////////////////
+// Headers
+////////////////////////////////////////////////////////////
+#include
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+