Back to index

libsfml  1.6+dfsg2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends
sf::SFML_API Protocol Reference

Abstract base class for every class that owns a device-dependant resource -- allow them to initialize / shutdown even when the audio context is not created /////////////////////////////////////////////////////////. More...

#include <AudioResource.hpp>

Inheritance diagram for sf::SFML_API:
Inheritance graph
[legend]
Collaboration diagram for sf::SFML_API:
Collaboration graph
[legend]

List of all members.

Classes

struct  Chunk
 Structure defining a chunk of audio data to stream /////////////////////////////////////////////////////////. More...
struct  Point
 Defines a simple 2D point /////////////////////////////////////////////////////////. More...
protocol  SFML_API
 This class wraps a FTP response, which is basically : More...

Public Types

enum  Status { Stopped, Paused, Playing }
 Enumeration of the sound states /////////////////////////////////////////////////////////. More...
enum  Style { Regular = 0, Bold = 1 << 0, Italic = 1 << 1, Underlined = 1 << 2 }
 Enumerate the string drawing styles /////////////////////////////////////////////////////////. More...
enum  TransferMode { Binary, Ascii, Ebcdic }
 Enumeration of transfer modes /////////////////////////////////////////////////////////. More...
typedef int SocketType
typedef socklen_t LengthType
typedef SOCKET SocketType
typedef int LengthType
typedef std::basic_string< Uint8 > UTF8String
 Define a string type for each encoding Warning : in UTF8 and UTF16 strings, one element doesn't necessarily maps to one character ; only an UTF32 element is wide enough to hold all possible unicode values /////////////////////////////////////////////////////////.
typedef std::basic_string< Uint16 > UTF16String
typedef std::basic_string< Uint32 > UTF32String
typedef void(* FuncType )(void *)
typedef void(* FuncType )(void *)

Public Member Functions

 Music (std::size_t BufferSize=44100)
 Construct the music with a buffer size.
 ~Music ()
 Destructor.
bool OpenFromFile (const std::string &Filename)
 Open a music file (doesn't play it -- call Play() for that)
bool OpenFromMemory (const char *Data, std::size_t SizeInBytes)
 Open a music file from memory (doesn't play it -- call Play() for that)
float GetDuration () const
 Get the music duration.
 Sound ()
 Default constructor.
 Sound (const SoundBuffer &Buffer, bool Loop=false, float Pitch=1.f, float Volume=100.f, const Vector3f &Position=Vector3f(0, 0, 0))
 Construct the sound from its parameters.
 Sound (const Sound &Copy)
 Copy constructor.
 ~Sound ()
 Destructor.
void Play ()
 Play the sound.
void Pause ()
 Pause the sound.
void Stop ()
 Stop the sound.
void SetBuffer (const SoundBuffer &Buffer)
 Set the source buffer.
void SetLoop (bool Loop)
 Set the sound loop state. This parameter is disabled by default.
void SetPitch (float Pitch)
 Set the sound pitch. The default pitch is 1.
void SetVolume (float Volume)
 Set the sound volume. The default volume is 100.
void SetPosition (float X, float Y, float Z)
 Set the sound position (take 3 values). The default position is (0, 0, 0)
void SetPosition (const Vector3f &Position)
 Set the sound position (take a 3D vector). The default position is (0, 0, 0)
void SetRelativeToListener (bool Relative)
 Make the sound's position relative to the listener's position, or absolute. The default value is false (absolute)
void SetMinDistance (float MinDistance)
 Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume. The default minimum distance is 1.0.
void SetAttenuation (float Attenuation)
 Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener. The default attenuation factor 1.0.
void SetPlayingOffset (float TimeOffset)
 Set the current playing position of the sound.
const SoundBufferGetBuffer () const
 Get the source buffer.
bool GetLoop () const
 Tell whether or not the sound is looping.
float GetPitch () const
 Get the pitch.
float GetVolume () const
 Get the volume.
Vector3f GetPosition () const
 Get the sound position.
bool IsRelativeToListener () const
 Tell if the sound's position is relative to the listener's position, or if it's absolute.
float GetMinDistance () const
 Get the minimum distance.
float GetAttenuation () const
 Get the attenuation factor.
Status GetStatus () const
 Get the status of the sound (stopped, paused, playing)
float GetPlayingOffset () const
 Get the current playing position of the sound.
Soundoperator= (const Sound &Other)
 Assignment operator.
void ResetBuffer ()
 Reset the internal buffer.
 SoundBuffer ()
 Default constructor.
 SoundBuffer (const SoundBuffer &Copy)
 Copy constructor.
 ~SoundBuffer ()
 Destructor.
bool LoadFromFile (const std::string &Filename)
 Load the sound buffer from a file.
bool LoadFromMemory (const char *Data, std::size_t SizeInBytes)
 Load the sound buffer from a file in memory.
bool LoadFromSamples (const Int16 *Samples, std::size_t SamplesCount, unsigned int ChannelsCount, unsigned int SampleRate)
 Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.
bool SaveToFile (const std::string &Filename) const
 Save the sound buffer to a file.
const Int16 * GetSamples () const
 Return the sound samples.
std::size_t GetSamplesCount () const
 Return the samples count.
unsigned int GetSampleRate () const
 Get the sample rate.
unsigned int GetChannelsCount () const
 Return the number of channels (1 = mono, 2 = stereo, ...)
float GetDuration () const
 Get the sound duration.
SoundBufferoperator= (const SoundBuffer &Other)
 Assignment operator.
const SoundBufferGetBuffer () const
 Get the sound buffer containing the captured audio data.
virtual ~SoundRecorder ()
 Virtual destructor.
void Start (unsigned int SampleRate=44100)
 Start the capture. Warning : only one capture can happen at the same time.
void Stop ()
 Stop the capture.
unsigned int GetSampleRate () const
 Get the sample rate.
virtual ~SoundStream ()
 Virtual destructor.
void Play ()
 Start playing the audio stream.
void Stop ()
 Stop playing the audio stream.
unsigned int GetChannelsCount () const
 Return the number of channels (1 = mono, 2 = stereo)
unsigned int GetSampleRate () const
 Get the stream sample rate.
Status GetStatus () const
 Get the status of the stream (stopped, paused, playing)
float GetPlayingOffset () const
 Get the current playing position of the stream.
void SetLoop (bool Loop)
 Set the stream loop state. This parameter is disabled by default.
bool GetLoop () const
 Tell whether or not the stream is looping.
 Color ()
 Default constructor.
 Color (Uint8 R, Uint8 G, Uint8 B, Uint8 A=255)
 Construct the color from its 4 RGBA components.
Coloroperator+= (const Color &Other)
 Operator += overload to add a color.
Coloroperator*= (const Color &Other)
 Operator *= overload to modulate a color.
bool operator== (const Color &Other) const
 Compare two colors (for equality)
bool operator!= (const Color &Other) const
 Compare two colors (for difference)
 Drawable (const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))
 Default constructor.
virtual ~Drawable ()
 Virtual destructor.
void SetPosition (float X, float Y)
 Set the position of the object (take 2 values)
void SetPosition (const Vector2f &Position)
 Set the position of the object (take a 2D vector)
void SetX (float X)
 Set the X position of the object.
void SetY (float Y)
 Set the Y position of the object.
void SetScale (float ScaleX, float ScaleY)
 Set the scale of the object (take 2 values)
void SetScale (const Vector2f &Scale)
 Set the scale of the object (take a 2D vector)
void SetScaleX (float FactorX)
 Set the X scale factor of the object.
void SetScaleY (float FactorY)
 Set the Y scale factor of the object.
void SetCenter (float CenterX, float CenterY)
 Set the center of the object, in coordinates relative to the top-left of the object (take 2 values). The default center is (0, 0)
void SetCenter (const Vector2f &Center)
 Set the center of the object, in coordinates relative to the top-left of the object (take a 2D vector). The default center is (0, 0)
void SetRotation (float Rotation)
 Set the orientation of the object.
void SetColor (const Color &Col)
 Set the color of the object. The default color is white.
void SetBlendMode (Blend::Mode Mode)
 Set the blending mode for the object. The default blend mode is Blend::Alpha.
const Vector2fGetPosition () const
 Get the position of the object.
const Vector2fGetScale () const
 Get the current scale of the object.
const Vector2fGetCenter () const
 Get the center of the object.
float GetRotation () const
 Get the orientation of the object. Rotation is always in the range [0, 360].
const ColorGetColor () const
 Get the color of the object.
Blend::Mode GetBlendMode () const
 Get the current blending mode.
void Move (float OffsetX, float OffsetY)
 Move the object of a given offset (take 2 values)
void Move (const Vector2f &Offset)
 Move the object of a given offset (take a 2D vector)
void Scale (float FactorX, float FactorY)
 Scale the object (take 2 values)
void Scale (const Vector2f &Factor)
 Scale the object (take a 2D vector)
void Rotate (float Angle)
 Rotate the object.
sf::Vector2f TransformToLocal (const sf::Vector2f &Point) const
 Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's center, translation, rotation and scale to the point)
sf::Vector2f TransformToGlobal (const sf::Vector2f &Point) const
 Transform a point from local coordinates into global coordinates (ie it applies the object's center, translation, rotation and scale to the point)
 Font ()
 Default constructor.
bool LoadFromFile (const std::string &Filename, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
 Load the font from a file.
bool LoadFromMemory (const char *Data, std::size_t SizeInBytes, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
 Load the font from a file in memory.
unsigned int GetCharacterSize () const
 Get the base size of characters in the font; All glyphs dimensions are based on this value.
const GlyphGetGlyph (Uint32 CodePoint) const
 Get the description of a glyph (character) given by its unicode value.
const ImageGetImage () const
 Get the image containing the rendered characters (glyphs)
 Glyph ()
 Default constructor.
 Image ()
 Default constructor.
 Image (const Image &Copy)
 Copy constructor.
 Image (unsigned int Width, unsigned int Height, const Color &Col=Color(0, 0, 0, 255))
 Construct an empty image.
 Image (unsigned int Width, unsigned int Height, const Uint8 *Data)
 Construct the image from pixels in memory.
 ~Image ()
 Destructor.
bool LoadFromFile (const std::string &Filename)
 Load the image from a file.
bool LoadFromMemory (const char *Data, std::size_t SizeInBytes)
 Load the image from a file in memory.
bool LoadFromPixels (unsigned int Width, unsigned int Height, const Uint8 *Data)
 Load the image directly from an array of pixels.
bool SaveToFile (const std::string &Filename) const
 Save the content of the image to a file.
bool Create (unsigned int Width, unsigned int Height, Color Col=Color(0, 0, 0, 255))
 Create an empty image.
void CreateMaskFromColor (Color ColorKey, Uint8 Alpha=0)
 Create transparency mask from a specified colorkey.
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. This function does a slow pixel copy and should only be used at initialization time.
bool CopyScreen (RenderWindow &Window, const IntRect &SourceRect=IntRect(0, 0, 0, 0))
 Create the image from the current contents of the given window.
void SetPixel (unsigned int X, unsigned int Y, const Color &Col)
 Change the color of a pixel.
const ColorGetPixel (unsigned int X, unsigned int Y) const
 Get a pixel from the image.
const Uint8 * GetPixelsPtr () const
 Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.
void Bind () const
 Bind the image for rendering.
void SetSmooth (bool Smooth)
 Enable or disable image smooth filter. This parameter is enabled by default.
unsigned int GetWidth () const
 Return the width of the image.
unsigned int GetHeight () const
 Return the height of the image.
bool IsSmooth () const
 Tells whether the smooth filtering is enabled or not.
FloatRect GetTexCoords (const IntRect &Rect) const
 Convert a subrect expressed in pixels, into float texture coordinates.
Imageoperator= (const Image &Other)
 Assignment operator.
 Matrix3 ()
 Default constructor (builds an identity matrix)
 Matrix3 (float a00, float a01, float a02, float a10, float a11, float a12, float a20, float a21, float a22)
 Construct a matrix from its 9 elements.
void SetFromTransformations (const Vector2f &Center, const Vector2f &Translation, float Rotation, const Vector2f &Scale)
 Build a matrix from a set of transformations.
Vector2f Transform (const Vector2f &Point) const
 Transform a point by the matrix.
Matrix3 GetInverse () const
 Return the inverse of the matrix.
const float * Get4x4Elements () const
 Return the elements of the matrix as a 4x4, in an array of 16 floats.
float operator() (unsigned int Row, unsigned int Col) const
 Operator () overloads to access the matrix elements.
float & operator() (unsigned int Row, unsigned int Col)
Matrix3 operator* (const Matrix3 &Mat) const
 Operator * overload to multiply two matrices.
Matrix3operator*= (const Matrix3 &Mat)
 Operator *= overload to multiply-assign two matrices.
 PostFX ()
 Default constructor.
 PostFX (const PostFX &Copy)
 Copy constructor.
 ~PostFX ()
 Destructor.
bool LoadFromFile (const std::string &Filename)
 Load the effect from a file.
bool LoadFromMemory (const std::string &Effect)
 Load the effect from a text in memory.
void SetParameter (const std::string &Name, float X)
 Change a parameter of the effect (1 float)
void SetParameter (const std::string &Name, float X, float Y)
 Change a parameter of the effect (2 floats)
void SetParameter (const std::string &Name, float X, float Y, float Z)
 Change a parameter of the effect (3 floats)
void SetParameter (const std::string &Name, float X, float Y, float Z, float W)
 Change a parameter of the effect (4 floats)
void SetTexture (const std::string &Name, Image *Texture)
 Set a texture parameter.
PostFXoperator= (const PostFX &Other)
 Assignment operator.
virtual ~RenderTarget ()
 Destructor.
void Clear (const Color &FillColor=Color(0, 0, 0))
 Clear the entire target with a single color.
virtual void Draw (const Drawable &Object)
 Draw something into the target.
virtual unsigned int GetWidth () const =0
 Get the width of the rendering region of the target.
virtual unsigned int GetHeight () const =0
 Get the height of the rendering region of the target.
void SetView (const View &NewView)
 Change the current active view.
const ViewGetView () const
 Get the current view.
ViewGetDefaultView ()
 Get the default view of the window for read / write.
void PreserveOpenGLStates (bool Preserve)
 Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default.
 RenderWindow ()
 Default constructor.
 RenderWindow (VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())
 Construct the window.
 RenderWindow (WindowHandle Handle, const WindowSettings &Params=WindowSettings())
 Construct the window from an existing control.
virtual ~RenderWindow ()
 Destructor.
virtual unsigned int GetWidth () const
 Get the width of the rendering region of the window.
virtual unsigned int GetHeight () const
 Get the height of the rendering region of the window.
Image Capture () const
 Save the content of the window to an image.
sf::Vector2f ConvertCoords (unsigned int WindowX, unsigned int WindowY, const View *TargetView=NULL) const
 Convert a point in window coordinates into view coordinates.
 Shape ()
 Default constructor.
void AddPoint (float X, float Y, const Color &Col=Color(255, 255, 255), const Color &OutlineCol=Color(0, 0, 0))
 Add a point to the shape.
void AddPoint (const Vector2f &Position, const Color &Col=Color(255, 255, 255), const Color &OutlineCol=Color(0, 0, 0))
 Add a point to the shape.
unsigned int GetNbPoints () const
 Get the number of points composing the shape.
void EnableFill (bool Enable)
 Enable or disable filling the shape. Fill is enabled by default.
void EnableOutline (bool Enable)
 Enable or disable drawing the shape outline. Outline is enabled by default.
void SetPointPosition (unsigned int Index, const Vector2f &Position)
 Set the position of a point.
void SetPointPosition (unsigned int Index, float X, float Y)
 Set the position of a point.
void SetPointColor (unsigned int Index, const Color &Col)
 Set the color of a point.
void SetPointOutlineColor (unsigned int Index, const Color &OutlineCol)
 Set the outline color of a point.
void SetOutlineWidth (float Width)
 Change the width of the shape outline.
const Vector2fGetPointPosition (unsigned int Index) const
 Get the position of a point.
const ColorGetPointColor (unsigned int Index) const
 Get the color of a point.
const ColorGetPointOutlineColor (unsigned int Index) const
 Get the outline color of a point.
float GetOutlineWidth () const
 Get the width of the shape outline.
 Sprite ()
 Default constructor.
 Sprite (const Image &Img, const Vector2f &Position=Vector2f(0, 0), const Vector2f &Scale=Vector2f(1, 1), float Rotation=0.f, const Color &Col=Color(255, 255, 255, 255))
 Construct the sprite from a source image.
void SetImage (const Image &Img)
 Change the image of the sprite.
void SetSubRect (const IntRect &SubRect)
 Set the sub-rectangle of the sprite inside the source image. By default, the subrect covers the entire source image.
void Resize (float Width, float Height)
 Resize the sprite (by changing its scale factors) (take 2 values). The default size is defined by the subrect.
void Resize (const Vector2f &Size)
 Resize the sprite (by changing its scale factors) (take a 2D vector). The default size is defined by the subrect.
void FlipX (bool Flipped)
 Flip the sprite horizontally.
void FlipY (bool Flipped)
 Flip the sprite vertically.
const ImageGetImage () const
 Get the source image of the sprite.
const IntRectGetSubRect () const
 Get the sub-rectangle of the sprite inside the source image.
Vector2f GetSize () const
 Get the sprite size.
Color GetPixel (unsigned int X, unsigned int Y) const
 Get the color of a given pixel in the sprite (point is in local coordinates)
 String ()
 Default constructor.
 String (const Unicode::Text &Text, const Font &CharFont=Font::GetDefaultFont(), float Size=30.f)
 Construct the string from any kind of text.
void SetText (const Unicode::Text &Text)
 Set the text (from any kind of string)
void SetFont (const Font &CharFont)
 Set the font of the string.
void SetSize (float Size)
 Set the size of the string The default size is 30.
void SetStyle (unsigned long TextStyle)
 Set the style of the text The default style is Regular.
const Unicode::Text & GetText () const
 Get the text (the returned text can be converted implicitely to any kind of string)
const FontGetFont () const
 Get the font used by the string.
float GetSize () const
 Get the size of the characters.
unsigned long GetStyle () const
 Get the style of the text.
sf::Vector2f GetCharacterPos (std::size_t Index) const
 Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied)
FloatRect GetRect () const
 Get the string rectangle on screen.
 View (const FloatRect &ViewRect=FloatRect(0, 0, 1000, 1000))
 Construct the view from a rectangle.
 View (const sf::Vector2f &Center, const sf::Vector2f &HalfSize)
 Construct the view from its center and half-size.
void SetCenter (float X, float Y)
 Change the center of the view (take 2 values)
void SetCenter (const sf::Vector2f &Center)
 Change the center of the view (take a vector)
void SetHalfSize (float HalfWidth, float HalfHeight)
 Change the half-size of the view (take 2 values)
void SetHalfSize (const sf::Vector2f &HalfSize)
 Change the half-size of the view (take a vector)
void SetFromRect (const FloatRect &ViewRect)
 Rebuild the view from a rectangle.
const sf::Vector2fGetCenter () const
 Get the center of the view.
const sf::Vector2fGetHalfSize () const
 Get the half-size of the view.
const sf::FloatRectGetRect () const
 Get the bounding rectangle of the view.
void Move (float OffsetX, float OffsetY)
 Move the view (take 2 values)
void Move (const sf::Vector2f &Offset)
 Move the view (take a vector)
void Zoom (float Factor)
 Resize the view rectangle to simulate a zoom / unzoom effect.
 ~Ftp ()
 Destructor -- close the connection with the server.
Response Connect (const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)
 Connect to the specified FTP server.
Response Login ()
 Log in using anonymous account.
Response Login (const std::string &UserName, const std::string &Password)
 Log in using a username and a password.
Response Disconnect ()
 Close the connection with FTP server.
Response KeepAlive ()
 Send a null command just to prevent from being disconnected.
DirectoryResponse GetWorkingDirectory ()
 Get the current working directory.
ListingResponse GetDirectoryListing (const std::string &Directory="")
 Get the contents of the given directory (subdirectories and files)
Response ChangeDirectory (const std::string &Directory)
 Change the current working directory.
Response ParentDirectory ()
 Go to the parent directory of the current one.
Response MakeDirectory (const std::string &Name)
 Create a new directory.
Response DeleteDirectory (const std::string &Name)
 Remove an existing directory.
Response RenameFile (const std::string &File, const std::string &NewName)
 Rename a file.
Response DeleteFile (const std::string &Name)
 Remove an existing file.
Response Download (const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)
 Download a file from the server.
Response Upload (const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)
 Upload a file to the server.
 Http ()
 Default constructor.
 Http (const std::string &Host, unsigned short Port=0)
 Construct the Http instance with the target host.
void SetHost (const std::string &Host, unsigned short Port=0)
 Set the target host.
Response SendRequest (const Request &Req, float Timeout=0.f)
 Send a HTTP request and return the server's response. You must be connected to a host before sending requests. Any missing mandatory header field 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.
 IPAddress ()
 Default constructor -- constructs an invalid address.
 IPAddress (const std::string &Address)
 Construct the address from a string.
 IPAddress (const char *Address)
 Construct the address from a C-style string ; Needed for implicit conversions from literal strings to IPAddress to work.
 IPAddress (Uint8 Byte0, Uint8 Byte1, Uint8 Byte2, Uint8 Byte3)
 Construct the address from 4 bytes.
 IPAddress (Uint32 Address)
 Construct the address from a 32-bits integer.
bool IsValid () const
 Tell if the address is a valid one.
std::string ToString () const
 Get a string representation of the address.
Uint32 ToInteger () const
 Get an integer representation of the address.
bool operator== (const IPAddress &Other) const
 Comparison operator ==.
bool operator!= (const IPAddress &Other) const
 Comparison operator !=.
bool operator< (const IPAddress &Other) const
 Comparison operator <.
bool operator> (const IPAddress &Other) const
 Comparison operator >
bool operator<= (const IPAddress &Other) const
 Comparison operator <=.
bool operator>= (const IPAddress &Other) const
 Comparison operator >=.
 Packet ()
 Default constructor.
virtual ~Packet ()
 Virtual destructor.
void Append (const void *Data, std::size_t SizeInBytes)
 Append data to the end of the packet.
void Clear ()
 Clear the packet data.
const char * GetData () const
 Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.
std::size_t GetDataSize () const
 Get the size of the data contained in the packet.
bool EndOfPacket () const
 Tell if the reading position has reached the end of the packet.
 operator bool () const
 Return the validity of packet.
Packetoperator>> (bool &Data)
 Operator >> overloads to extract data from the packet.
Packetoperator>> (Int8 &Data)
Packetoperator>> (Uint8 &Data)
Packetoperator>> (Int16 &Data)
Packetoperator>> (Uint16 &Data)
Packetoperator>> (Int32 &Data)
Packetoperator>> (Uint32 &Data)
Packetoperator>> (float &Data)
Packetoperator>> (double &Data)
Packetoperator>> (char *Data)
Packetoperator>> (std::string &Data)
Packetoperator>> (wchar_t *Data)
Packetoperator>> (std::wstring &Data)
Packetoperator<< (bool Data)
 Operator << overloads to put data into the packet.
Packetoperator<< (Int8 Data)
Packetoperator<< (Uint8 Data)
Packetoperator<< (Int16 Data)
Packetoperator<< (Uint16 Data)
Packetoperator<< (Int32 Data)
Packetoperator<< (Uint32 Data)
Packetoperator<< (float Data)
Packetoperator<< (double Data)
Packetoperator<< (const char *Data)
Packetoperator<< (const std::string &Data)
Packetoperator<< (const wchar_t *Data)
Packetoperator<< (const std::wstring &Data)
 SelectorBase ()
 Default constructor.
void Add (SocketHelper::SocketType Socket)
 Add a socket to watch.
void Remove (SocketHelper::SocketType Socket)
 Remove a socket.
void Clear ()
 Remove all sockets.
unsigned int Wait (float Timeout=0.f)
 Wait and collect sockets which are ready for reading. This functions will return either when at least one socket is ready, or when the given time is out.
SocketHelper::SocketType GetSocketReady (unsigned int Index)
 After a call to Wait(), get the Index-th socket which is ready for reading. The total number of sockets ready is the integer returned by the previous call to Wait()
 SocketTCP ()
 Default constructor.
void SetBlocking (bool Blocking)
 Change the blocking state of the socket. The default behaviour of a socket is blocking.
Socket::Status Connect (unsigned short Port, const IPAddress &HostAddress, float Timeout=0.f)
 Connect to another computer on a specified port.
bool Listen (unsigned short Port)
 Listen to a specified port for incoming data or connections.
Socket::Status Accept (SocketTCP &Connected, IPAddress *Address=NULL)
 Wait for a connection (must be listening to a port). This function will block if the socket is blocking.
Socket::Status Send (const char *Data, std::size_t Size)
 Send an array of bytes to the host (must be connected first)
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived)
 Receive an array of bytes from the host (must be connected first). This function will block if the socket is blocking.
Socket::Status Send (Packet &PacketToSend)
 Send a packet of data to the host (must be connected first)
Socket::Status Receive (Packet &PacketToReceive)
 Receive a packet from the host (must be connected first). This function will block if the socket is blocking.
bool Close ()
 Close the socket.
bool IsValid () const
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
bool operator== (const SocketTCP &Other) const
 Comparison operator ==.
bool operator!= (const SocketTCP &Other) const
 Comparison operator !=.
bool operator< (const SocketTCP &Other) const
 Comparison operator <. Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...
 SocketUDP ()
 Default constructor.
void SetBlocking (bool Blocking)
 Change the blocking state of the socket. The default behaviour of a socket is blocking.
bool Bind (unsigned short Port)
 Bind the socket to a specific port.
bool Unbind ()
 Unbind the socket from its previous port, if any.
Socket::Status Send (const char *Data, std::size_t Size, const IPAddress &Address, unsigned short Port)
 Send an array of bytes.
Socket::Status Receive (char *Data, std::size_t MaxSize, std::size_t &SizeReceived, IPAddress &Address, unsigned short &Port)
 Receive an array of bytes. This function will block if the socket is blocking.
Socket::Status Send (Packet &PacketToSend, const IPAddress &Address, unsigned short Port)
 Send a packet of data.
Socket::Status Receive (Packet &PacketToReceive, IPAddress &Address, unsigned short &Port)
 Receive a packet. This function will block if the socket is blocking.
bool Close ()
 Close the socket.
bool IsValid () const
 Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.
unsigned short GetPort () const
 Get the port the socket is currently bound to.
bool operator== (const SocketUDP &Other) const
 Comparison operator ==.
bool operator!= (const SocketUDP &Other) const
 Comparison operator !=.
bool operator< (const SocketUDP &Other) const
 Comparison operator <. Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...
 Clock ()
 Default constructor.
float GetElapsedTime () const
 Get the time elapsed since last reset.
void Reset ()
 Restart the timer.
 Lock (Mutex &Mutex)
 Construct the lock with a target mutex (lock it)
 ~Lock ()
 Destructor (unlocks the mutex)
 Mutex ()
 Default constructor.
 ~Mutex ()
 Destructor.
void Lock ()
 Lock the mutex.
void Unlock ()
 Unlock the mutex.
 Thread (FuncType Function, void *UserData=NULL)
 Construct the thread from a function pointer.
virtual ~Thread ()
 Virtual destructor.
void Launch ()
 Create and run the thread.
void Wait ()
 Wait until the thread finishes.
void Terminate ()
 Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.
 Mutex ()
 Default constructor.
 ~Mutex ()
 Destructor.
void Lock ()
 Lock the mutex.
void Unlock ()
 Unlock the mutex.
 Thread (FuncType Function, void *UserData=NULL)
 Construct the thread from a function pointer.
virtual ~Thread ()
 Virtual destructor.
void Launch ()
 Create and run the thread.
void Wait ()
 Wait until the thread finishes.
void Terminate ()
 Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.
 Context ()
 Default constructor, create the context.
 ~Context ()
 Destructor, destroy the context.
void SetActive (bool Active)
 Activate or deactivate the context.
 Input ()
 Default constructor.
bool IsKeyDown (Key::Code KeyCode) const
 Get the state of a key.
bool IsMouseButtonDown (Mouse::Button Button) const
 Get the state of a mouse button.
bool IsJoystickButtonDown (unsigned int JoyId, unsigned int Button) const
 Get the state of a joystick button.
int GetMouseX () const
 Get the mouse X position.
int GetMouseY () const
 Get the mouse Y position.
float GetJoystickAxis (unsigned int JoyId, Joy::Axis Axis) const
 Get a joystick axis position.
 VideoMode ()
 Default constructor.
 VideoMode (unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp=32)
 Construct the video mode with its attributes.
bool IsValid () const
 Tell whether or not the video mode is supported.
bool operator== (const VideoMode &Other) const
 Comparison operator overload -- tell if two video modes are equal.
bool operator!= (const VideoMode &Other) const
 Comparison operator overload -- tell if two video modes are different.
 Window ()
 Default constructor.
 Window (VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())
 Construct a new window.
 Window (WindowHandle Handle, const WindowSettings &Params=WindowSettings())
 Construct the window from an existing control.
virtual ~Window ()
 Destructor.
void Create (VideoMode Mode, const std::string &Title, unsigned long WindowStyle=Style::Resize|Style::Close, const WindowSettings &Params=WindowSettings())
 Create (or recreate) the window.
void Create (WindowHandle Handle, const WindowSettings &Params=WindowSettings())
 Create (or recreate) the window from an existing control.
void Close ()
 Close (destroy) the window. The sf::Window instance remains valid and you can call Create to recreate the window.
bool IsOpened () const
 Tell whether or not the window is opened (ie. has been created). Note that a hidden window (Show(false)) will still return true.
unsigned int GetWidth () const
 Get the width of the rendering region of the window.
unsigned int GetHeight () const
 Get the height of the rendering region of the window.
const WindowSettingsGetSettings () const
 Get the creation settings of the window.
bool GetEvent (Event &EventReceived)
 Get the event on top of events stack, if any, and pop it.
void UseVerticalSync (bool Enabled)
 Enable / disable vertical synchronization.
void ShowMouseCursor (bool Show)
 Show or hide the mouse cursor.
void SetCursorPosition (unsigned int Left, unsigned int Top)
 Change the position of the mouse cursor.
void SetPosition (int Left, int Top)
 Change the position of the window on screen. Only works for top-level windows.
void SetSize (unsigned int Width, unsigned int Height)
 Change the size of the rendering region of the window.
void Show (bool State)
 Show or hide the window.
void EnableKeyRepeat (bool Enabled)
 Enable or disable automatic key-repeat. Automatic key-repeat is enabled by default.
void SetIcon (unsigned int Width, unsigned int Height, const Uint8 *Pixels)
 Change the window's icon.
bool SetActive (bool Active=true) const
 Activate of deactivate the window as the current target for rendering.
void Display ()
 Display the window on screen.
const InputGetInput () const
 Get the input manager of the window.
void SetFramerateLimit (unsigned int Limit)
 Limit the framerate to a maximum fixed frequency.
float GetFrameTime () const
 Get time elapsed since last frame.
void SetJoystickThreshold (float Threshold)
 Change the joystick threshold, ie. the value below which no move event will be generated.
virtual void OnEvent (const Event &EventReceived)=0
 Called each time an event is received from attached window.

Static Public Member Functions

static void SetGlobalVolume (float Volume)
 Change the global volume of all the sounds. The default volume is 100.
static float GetGlobalVolume ()
 Get the current value of the global volume of all the sounds.
static void SetPosition (float X, float Y, float Z)
 Change the position of the listener (take 3 values). The default position is (0, 0, 0)
static void SetPosition (const Vector3f &Position)
 Change the position of the listener (take a 3D vector). The default position is (0, 0, 0)
static Vector3f GetPosition ()
 Get the current position of the listener.
static void SetTarget (float X, float Y, float Z)
 Change the orientation of the listener (the point he must look at) (take 3 values). The default target is (0, 0, -1)
static void SetTarget (const Vector3f &Target)
 Change the orientation of the listener (the point he must look at) (take a 3D vector). The default target is (0, 0, -1)
static Vector3f GetTarget ()
 Get the current orientation of the listener (the point he's looking at)
static bool CanCapture ()
 Tell if the system supports sound capture. If not, this class won't be usable.
static const FontGetDefaultFont ()
 Get the SFML default built-in font (Arial)
static unsigned int GetValidTextureSize (unsigned int Size)
 Get a valid texture size according to hardware support.
static bool CanUsePostFX ()
 Tell whether or not the system supports post-effects.
static Shape Line (float P1X, float P1Y, float P2X, float P2Y, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use floats)
static Shape Line (const Vector2f &P1, const Vector2f &P2, float Thickness, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single line (use vectors)
static Shape Rectangle (float P1X, float P1Y, float P2X, float P2Y, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use floats)
static Shape Rectangle (const Vector2f &P1, const Vector2f &P2, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single rectangle (use vectors)
static Shape Circle (float X, float Y, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single circle (use floats)
static Shape Circle (const Vector2f &Center, float Radius, const Color &Col, float Outline=0.f, const Color &OutlineCol=sf::Color(0, 0, 0))
 Create a shape made of a single circle (use vectors)
static IPAddress GetLocalAddress ()
 Get the computer's local IP address (from the LAN point of view)
static IPAddress GetPublicAddress (float Timeout=0.f)
 Get the computer's public IP address (from the web point of view). The only way to get a public address is to ask it to a distant website ; as a consequence, this function may be very slow -- use it as few as possible !
static SocketType InvalidSocket ()
 Return the value of the invalid socket.
static bool Close (SocketType Socket)
 Close / destroy a socket.
static void SetBlocking (SocketType Socket, bool Block)
 Set a socket as blocking or non-blocking.
static Socket::Status GetErrorStatus ()
 Get the last socket error status.
static SocketType InvalidSocket ()
 Return the value of the invalid socket.
static bool Close (SocketType Socket)
 Close / destroy a socket.
static void SetBlocking (SocketType Socket, bool Block)
 Set a socket as blocking or non-blocking.
static Socket::Status GetErrorStatus ()
 Get the last socket error status.
static void SetSeed (unsigned int Seed)
 Set the seed for the generator. Using a known seed allows you to reproduce the same sequence of random number.
static unsigned int GetSeed ()
 Get the seed used to generate random numbers the generator.
static float Random (float Begin, float End)
 Get a random float number in a given range.
static int Random (int Begin, int End)
 Get a random integer number in a given range.
template<typename In , typename Out >
static Out UTF32ToANSI (In Begin, In End, Out Output, char Replacement= '?', const std::locale &Locale=GetDefaultLocale())
 Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.
template<typename In , typename Out >
static Out ANSIToUTF32 (In Begin, In End, Out Output, const std::locale &Locale=GetDefaultLocale())
 Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF8ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement= '?')
 Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF8ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement= '?')
 Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF16ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement= '?')
 Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF16ToUTF32 (In Begin, In End, Out Output, Uint32 Replacement= '?')
 Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF32ToUTF8 (In Begin, In End, Out Output, Uint8 Replacement= '?')
 Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.
template<typename In , typename Out >
static Out UTF32ToUTF16 (In Begin, In End, Out Output, Uint16 Replacement= '?')
 Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.
template<typename In >
static std::size_t GetUTF8Length (In Begin, In End)
 Get the number of characters composing an UTF-8 string.
template<typename In >
static std::size_t GetUTF16Length (In Begin, In End)
 Get the number of characters composing an UTF-16 string.
template<typename In >
static std::size_t GetUTF32Length (In Begin, In End)
 Get the number of characters composing an UTF-32 string.
static bool IsContextActive ()
 Check if there's a context bound to the current thread.
static ContextGetGlobal ()
 Get the global context.
static VideoMode GetDesktopMode ()
 Get the current desktop video mode.
static VideoMode GetMode (std::size_t Index)
 Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.
static std::size_t GetModesCount ()
 Get valid video modes count.

Public Attributes

Uint8 r
 Red component.
Uint8 g
 Green component.
Uint8 b
 Blue component.
Uint8 a
 Alpha (transparency) component.
int Advance
 Offset to move horizontically to the next character.
IntRect Rectangle
 Bounding rectangle of the glyph, in relative coordinates.
FloatRect TexCoords
 Texture coordinates of the glyph inside the bitmap font.
unsigned int Width
 Video mode width, in pixels.
unsigned int Height
 Video mode height, in pixels.
unsigned int BitsPerPixel
 Video mode pixel depth, in bits per pixels.

Static Public Attributes

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 Matrix3 Identity
 Identity matrix.
static const IPAddress LocalHost
 Local host address (to connect to the same computer)

Protected Member Functions

 AudioResource ()
 Default constructor.
 AudioResource (const AudioResource &)
 Copy constructor.
virtual ~AudioResource ()
 Destructor.
 SoundRecorder ()
 Default constructor.
 SoundStream ()
 Default constructor.
void Initialize (unsigned int ChannelsCount, unsigned int SampleRate)
 Set the audio stream parameters, you must call it before Play()
const Matrix3GetMatrix () const
 Get the transform matrix of the drawable.
const Matrix3GetInverseMatrix () const
 Get the inverse transform matrix of the drawable.
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
 RenderTarget ()
 Default constructor.
void Initialize ()
 Called by the derived class when it's ready to be initialized.
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
virtual void Render (RenderTarget &Target) const
 /see Drawable::Render
 NonCopyable ()
 The default constructor won't be generated, so provide it.
 Thread ()
 Default constructor.
 Thread ()
 Default constructor.
virtual ~WindowListener ()
 Destructor.

Private Types

enum  { BuffersCount = 3 }
typedef std::set< Sound * > SoundList
 Set of unique sound instances.
typedef std::map< std::string,
const Image * > 
TextureTable

Private Member Functions

virtual bool OnStart ()
 /see SoundStream::OnStart
virtual bool OnGetData (Chunk &Data)
 /see SoundStream::OnGetData
bool Update (unsigned int ChannelsCount, unsigned int SampleRate)
 Update the internal buffer with the audio samples.
void AttachSound (Sound *Instance) const
 Add a sound to the list of sounds that use this buffer.
void DetachSound (Sound *Instance) const
 Remove a sound from the list of sounds that use this buffer.
virtual bool OnStart ()
 /see SoundBuffer::OnStart
virtual bool OnProcessSamples (const Int16 *Samples, std::size_t SamplesCount)
 /see SoundBuffer::OnProcessSamples
virtual void OnStop ()
 /see SoundBuffer::OnStop
virtual bool OnStart ()
 Start recording audio data.
virtual bool OnProcessSamples (const Int16 *Samples, std::size_t SamplesCount)=0
 Process a new chunk of recorded samples.
virtual void OnStop ()
 Stop recording audio data.
virtual void Run ()
 /see Thread::Run
void ProcessCapturedSamples ()
 Get the available captured samples and process them.
void CleanUp ()
 Clean up the recorder internal resources.
virtual void Run ()
 /see Thread::Run
virtual bool OnStart ()
 Called when the sound restarts.
virtual bool OnGetData (Chunk &Data)=0
 Called each time new audio data is needed to feed the stream.
bool FillAndPushBuffer (unsigned int BufferNum)
 Fill a new buffer with audio data, and push it to the playing queue.
bool FillQueue ()
 Fill the buffers queue with all available buffers.
void ClearQueue ()
 Clear the queue of any remaining buffers.
void Draw (RenderTarget &Target) const
 Draw the object into the specified window.
virtual void Render (RenderTarget &Target) const =0
 Render the specific geometry of the object.
bool CreateTexture ()
 Create the OpenGL texture.
void EnsureTextureUpdate () const
 Make sure the texture in video memory is updated with the array of pixels /////////////////////////////////////////////////////////.
void EnsureArrayUpdate () const
 Make sure the array of pixels is updated with the texture in video memory /////////////////////////////////////////////////////////.
void Reset ()
 Reset the image attributes.
void DestroyTexture ()
 Destroy the OpenGL texture.
void CreateProgram ()
 Create the program and attach the shaders.
virtual bool Activate (bool Active)=0
 Activate the target for rendering.
void SetRenderStates ()
 Set the OpenGL render states needed for the SFML rendering.
virtual void OnCreate ()
 /see Window::OnCreate
virtual bool Activate (bool Active)
 /see RenderTarget::Activate
void Compile ()
 Compile the shape : compute its center and its outline.
void RecomputeRect ()
 Recompute the bounding rectangle of the text.
const Matrix3GetMatrix () const
 Get the projection matrix of the view.
void RecomputeMatrix ()
 Recompute the view rectangle and the projection matrix.
Response SendCommand (const std::string &Command, const std::string &Parameter="")
 Send a command to the FTP server.
Response GetResponse ()
 Receive a response from the server (usually after a command has been sent)
bool CheckSize (std::size_t Size)
 Check if the packet can extract a given size of bytes.
virtual const char * OnSend (std::size_t &DataSize)
 Called before the packet is sent to the network.
virtual void OnReceive (const char *Data, std::size_t DataSize)
 Called after the packet has been received from the network.
 SocketTCP (SocketHelper::SocketType Descriptor)
 Construct the socket from a socket descriptor (for internal use only)
void Create (SocketHelper::SocketType Descriptor=0)
 Create the socket.
 SocketUDP (SocketHelper::SocketType Descriptor)
 Construct the socket from a socket descriptor (for internal use only)
void Create (SocketHelper::SocketType Descriptor=0)
 Create the socket.
 NonCopyable (const NonCopyable &)
 Copy constructor : declare it private and don't implement it to prevent from calling it.
NonCopyableoperator= (const NonCopyable &)
 Assignment operator : declare it private and don't implement it to prevent from calling it.
virtual void Run ()
 Function called as the thread entry point.
virtual void Run ()
 Function called as the thread entry point.
virtual void OnEvent (const Event &EventReceived)
 /see WindowListener::OnEvent
void ResetStates ()
 Reset all the states.
virtual void OnCreate ()
 Called after the window has been created.
virtual void OnEvent (const Event &EventReceived)
 /see WindowListener::OnEvent
void Initialize (priv::WindowImpl *Impl)
 Initialize internal window.

Static Private Member Functions

static std::string PreprocessEffect (std::istream &File)
 Preprocess a SFML effect file to convert it to a valid GLSL fragment shader.
static bool ComputeNormal (const Vector2f &P1, const Vector2f &P2, Vector2f &Normal)
 Compute the normal of a given 2D segment.
static const std::locale & GetDefaultLocale ()
 Get the default system locale.
static void * ThreadFunc (void *UserData)
 Actual thread entry point, dispatches to instances.
static unsigned int __stdcall ThreadFunc (void *UserData)
 Actual thread entry point, dispatches to instances.
static void InitializeModes ()
 Get and sort valid video modes /////////////////////////////////////////////////////////.

Private Attributes

priv::SoundFilemyFile
 Sound file.
float myDuration
 Music duration, in seconds.
std::vector< Int16 > mySamples
 Temporary buffer of samples.
unsigned int mySource
 OpenAL source identifier.
ResourcePtr< SoundBuffermyBuffer
 Sound buffer bound to the source.
unsigned int myBuffer
 OpenAL buffer identifier.
SoundList mySounds
 List of sounds that are using this buffer.
SoundBuffer myBuffer
 Sound buffer that will contain the recorded data.
unsigned int mySampleRate
 Sample rate.
bool myIsCapturing
 Capturing state.
bool myIsStreaming
 Streaming state (true = playing, false = stopped)
unsigned int myBuffers [BuffersCount]
 Sound buffers used to store temporary audio data.
unsigned int myChannelsCount
 Number of channels (1 = mono, 2 = stereo, ...)
unsigned long myFormat
 Format of the internal sound buffers.
bool myLoop
 Loop flag (true to loop, false to play once)
unsigned int mySamplesProcessed
 Number of buffers processed since beginning of the stream.
bool myEndBuffers [BuffersCount]
 Each buffer is marked as "end buffer" or not, for proper duration calculation.
Vector2f myPosition
 Position of the object on screen.
Vector2f myScale
 Scale of the object.
Vector2f myCenter
 Origin of translation / rotation / scaling of the object.
float myRotation
 Orientation of the object, in degrees.
Color myColor
 Overlay color of the object.
Blend::Mode myBlendMode
 Blending mode.
bool myNeedUpdate
 Do we need to recompute the transform matrix ?
bool myInvNeedUpdate
 Do we need to recompute the inverse transform matrix ?
Matrix3 myMatrix
 Precomputed transform matrix gathering the translation / rotation / scale / center.
Matrix3 myInvMatrix
 Precomputed inverse transform matrix gathering the translation / rotation / scale / center.
Image myTexture
 Texture holding the bitmap font.
unsigned int myCharSize
 Size of characters in the bitmap font.
std::map< Uint32, GlyphmyGlyphs
 Rendering settings of each character (glyph)
unsigned int myWidth
 Image width.
unsigned int myHeight
 Image Height.
unsigned int myTextureWidth
 Actual texture width (can be greater than image width because of padding)
unsigned int myTextureHeight
 Actual texture height (can be greater than image height because of padding)
unsigned int myTexture
 Internal texture identifier.
bool myIsSmooth
 Status of the smooth filter.
std::vector< ColormyPixels
 Pixels of the image.
bool myNeedTextureUpdate
 Status of synchronization between pixels in central memory and the internal texture un video memory.
bool myNeedArrayUpdate
 Status of synchronization between pixels in central memory and the internal texture un video memory.
float myData [16]
unsigned int myShaderProgram
 OpenGL identifier for the program.
TextureTable myTextures
 Texture variables in the effect.
std::string myFragmentShader
 Fragment shader source code.
Image myFrameBuffer
 Texture containing the current frame buffer.
View myDefaultView
 Default view.
const ViewmyCurrentView
 Current active view.
bool myPreserveStates
 Should we preserve external OpenGL states ?
bool myIsDrawing
 True when Draw is called from inside, to allow some renderstates optimizations.
std::vector< PointmyPoints
 Points composing the shape.
float myOutline
 Outline width.
bool myIsFillEnabled
 Should we draw the inside if the shape ?
bool myIsOutlineEnabled
 Should we draw the outline if the shape ?
bool myIsCompiled
 Compiled state of the shape.
ResourcePtr< ImagemyImage
 Image used to draw the sprite.
IntRect mySubRect
 Sub-rectangle of source image to assign to the sprite.
bool myIsFlippedX
 Is the sprite flipped on the X axis ?
bool myIsFlippedY
 Is the sprite flipped on the Y axis ?
Unicode::Text myText
 Text to display.
ResourcePtr< FontmyFont
 Font used to display the string.
float mySize
 Size of the characters.
unsigned long myStyle
 Text style (see Style enum)
FloatRect myBaseRect
 Bounding rectangle of the text in object coordinates.
bool myNeedRectUpdate
 Does the bounding rect need an update ?
sf::Vector2f myCenter
 Center of the view.
sf::Vector2f myHalfSize
 Half-size of the view.
FloatRect myRect
 Rectangle defining the bounds of the view.
SocketTCP myCommandSocket
 Socket holding the control connection with the server.
SocketTCP myConnection
 Connection to the host.
IPAddress myHost
 Web host address.
std::string myHostName
 Web host name.
unsigned short myPort
 Port used for connection with host.
Uint32 myAddress
 Address stored as an unsigned 32 bits integer.
std::vector< char > myData
 Data stored in the packet.
std::size_t myReadPos
 Current reading position in the packet.
bool myIsValid
 Reading state of the packet.
fd_set mySet
 Set of socket to watch.
fd_set mySetReady
 Set of socket which are ready for reading.
int myMaxSocket
 Maximum socket index.
SocketHelper::SocketType mySocket
 Socket descriptor.
Uint32 myPendingHeader
 Data of the current pending packet header, if any.
Uint32 myPendingHeaderSize
 Size of the current pending packet header, if any.
std::vector< char > myPendingPacket
 Data of the current pending packet, if any.
Int32 myPendingPacketSize
 Size of the current pending packet, if any.
bool myIsBlocking
 Is the socket blocking or non-blocking ?
double myStartTime
 Time of last reset.
MutexmyMutex
 Mutex to lock / unlock.
pthread_mutex_t myMutex
 pthread instance of the mutex
pthread_t myThread
 Unix thread instance.
bool myIsActive
 Thread state (active or inactive)
FuncType myFunction
 Function to call as the thread entry point.
void * myUserData
 Data to pass to the thread function.
CRITICAL_SECTION myHandle
 Win32 handle of the mutex.
HANDLE myHandle
 Win32 thread handle.
priv::WindowImplmyDummyWindow
 Dummy window holding the context.
bool myKeys [Key::Count]
 Array containing the state of all keyboard keys.
bool myMouseButtons [Mouse::ButtonCount]
 Array containing the state of all mouse buttons.
int myMouseX
 Mouse position on X.
int myMouseY
 Mouse position on Y.
bool myJoystickButtons [Joy::Count][Joy::ButtonCount]
 Array containing the state of all joysticks buttons.
float myJoystickAxis [Joy::Count][Joy::AxisCount]
 Joysticks position on each axis.
priv::WindowImplmyWindow
 Platform-specific implementation of window.
std::queue< EventmyEvents
 Queue of received events.
Input myInput
 Input manager connected to window.
Clock myClock
 Clock for measuring the elapsed time between frames.
WindowSettings mySettings
 Creation settings of the window.
float myLastFrameTime
 Time elapsed since last frame.
bool myIsExternal
 Tell whether the window is internal or external (created by SFML or not)
unsigned int myFramerateLimit
 Current framerate limit.
int mySetCursorPosX
 X coordinate passed to the last call to SetCursorPosition.
int mySetCursorPosY
 Y coordinate passed to the last call to SetCursorPosition.

Static Private Attributes

static Uint32 ourDefaultCharset []
 The default charset (all printable ISO-8859-1 characters)
static unsigned int ourSeed
static const int UTF8TrailingBytes [256]
 Lookup table to find the length of an UTF-8 sequence.
static const Uint32 UTF8Offsets [6]
 Magic values to subtract during UTF-8 conversions.
static const Uint8 UTF8FirstBytes [7]
 First bytes for UTF-8 sequences.

Friends

class SoundStream
class Sound
class RenderTarget
class priv::FontLoader
class DataChannel
class SocketTCP
class SocketUDP
class Selector< SocketTCP >
class Selector< SocketUDP >

Detailed Description

Abstract base class for every class that owns a device-dependant resource -- allow them to initialize / shutdown even when the audio context is not created /////////////////////////////////////////////////////////.

Base class for classes that want to receive events from a window (for internal use only) /////////////////////////////////////////////////////////.

Window is a rendering window ; it can create a new window or connect to an existing one /////////////////////////////////////////////////////////.

VideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device /////////////////////////////////////////////////////////.

Input handles real-time input from keyboard and mouse. Use it instead of events to handle continuous moves and more game-friendly inputs /////////////////////////////////////////////////////////.

Class wrapping an OpenGL context. All SFML windows already have their own context, so this class is more a helper for specific issues involving OpenGL and multi-threading. It's meant to be used internally. /////////////////////////////////////////////////////////.

Thread defines an easy way to manipulate a thread. There are two ways to use Thread :

Mutex defines a mutex (MUTual EXclusion) object, that allows a thread to lock critical instructions to avoid simultaneous access with other threads. The Win32 version uses critical sections, as it is faster than mutexes.
See Lock for an efficient way of using it. /////////////////////////////////////////////////////////.

Thread defines a thread. There is two ways to use Thread :

Mutex defines a mutex (MUTual EXclusion) object, that allows a thread to lock critical instructions to avoid simultaneous access with other threads. See Lock for an efficient way of using it. /////////////////////////////////////////////////////////.

Provides utility functions to convert from and to any unicode and ASCII encoding /////////////////////////////////////////////////////////.

Randomizer is an utility class for generating pseudo-random numbers /////////////////////////////////////////////////////////.

Utility base class to easily declare non-copyable classes. Just inherit from NonCopyable to get a non-copyable class /////////////////////////////////////////////////////////.

Lock is an exception-safe automatic wrapper for locking and unlocking mutexes /////////////////////////////////////////////////////////.

Clock is an utility class for manipulating time /////////////////////////////////////////////////////////.

This class defines helper functions to do all the non-portable socket stuff. This class is meant for internal use only /////////////////////////////////////////////////////////.

SocketUDP wraps a socket using UDP protocol to send data fastly (but with less safety) /////////////////////////////////////////////////////////.

SocketTCP wraps a socket using TCP protocol to send data safely (but a bit slower) /////////////////////////////////////////////////////////.

Private base class for selectors. As Selector is a template class, this base is needed so that every system call get compiled in SFML (not inlined) /////////////////////////////////////////////////////////.

Packet wraps data to send / to receive through the network /////////////////////////////////////////////////////////.

IPAddress provides easy manipulation of IP v4 addresses /////////////////////////////////////////////////////////.

This class provides methods for manipulating the HTTP protocol (described in RFC 1945). It can connect to a website, get its files, send requests, etc. /////////////////////////////////////////////////////////.

This class provides methods for manipulating the FTP protocol (described in RFC 959). It provides easy access and transfers to remote directories and files on a FTP server /////////////////////////////////////////////////////////.

This class defines a view (position, size, etc.) ; you can consider it as a 2D camera /////////////////////////////////////////////////////////.

String defines a graphical 2D text, that can be drawn on screen /////////////////////////////////////////////////////////.

Sprite defines a sprite : texture, transformations, color, and draw on screen /////////////////////////////////////////////////////////.

Shape defines a drawable convex shape ; it also defines helper functions to draw simple shapes like lines, rectangles, circles, etc. /////////////////////////////////////////////////////////.

Simple wrapper for sf::Window that allows easy 2D rendering /////////////////////////////////////////////////////////.

Base class for all render targets (window, image, ...) /////////////////////////////////////////////////////////.

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

Utility class to manipulate 3x3 matrices representing 2D transformations /////////////////////////////////////////////////////////.

Image is the low-level class for loading and manipulating images /////////////////////////////////////////////////////////.

Structure describing a glyph (a visual character) /////////////////////////////////////////////////////////.

Font is the low-level class for loading and manipulating character fonts. This class is meant to be used by sf::String /////////////////////////////////////////////////////////.

Abstract base class for every object that can be drawn into a render window /////////////////////////////////////////////////////////.

Color is an utility class for manipulating 32-bits RGBA colors /////////////////////////////////////////////////////////.

SoundStream is a streamed sound, ie samples are acquired while the sound is playing. Use it for big sounds that would require hundreds of MB in memory (see Music), or for streaming sound from the network /////////////////////////////////////////////////////////.

SoundRecorder is an interface for capturing sound data, it is meant to be used as a base class /////////////////////////////////////////////////////////.

Specialized SoundRecorder which saves the captured audio data into a sound buffer /////////////////////////////////////////////////////////.

SoundBuffer is the low-level for loading and manipulating sound buffers /////////////////////////////////////////////////////////.

Sound defines the properties of a sound such as position, volume, pitch, etc. /////////////////////////////////////////////////////////.

Music defines a big sound played using streaming, so usually what we call a music :) /////////////////////////////////////////////////////////.

Listener is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard /////////////////////////////////////////////////////////.

Definition at line 41 of file AudioResource.hpp.


Class Documentation

struct sf::SFML_API::Chunk

Structure defining a chunk of audio data to stream /////////////////////////////////////////////////////////.

Definition at line 69 of file SoundStream.hpp.

Class Members
size_t NbSamples Number of samples pointed by Samples.
const Int16 * Samples Pointer to the audio samples.

Member Typedef Documentation

typedef void(* sf::SFML_API::FuncType)(void *)

Definition at line 48 of file Thread.hpp.

typedef void(* sf::SFML_API::FuncType)(void *)

Definition at line 48 of file Thread.hpp.

Definition at line 49 of file SocketHelper.hpp.

typedef socklen_t sf::SFML_API::LengthType

Definition at line 55 of file SocketHelper.hpp.

typedef SOCKET sf::SFML_API::SocketType

Definition at line 48 of file SocketHelper.hpp.

Definition at line 54 of file SocketHelper.hpp.

typedef std::set<Sound*> sf::SFML_API::SoundList [private]

Set of unique sound instances.

Definition at line 199 of file SoundBuffer.hpp.

typedef std::map<std::string, const Image*> sf::SFML_API::TextureTable [private]

Definition at line 180 of file PostFX.hpp.

typedef std::basic_string<Uint16> sf::SFML_API::UTF16String

Definition at line 55 of file Unicode.hpp.

typedef std::basic_string<Uint32> sf::SFML_API::UTF32String

Definition at line 56 of file Unicode.hpp.

typedef std::basic_string<Uint8> sf::SFML_API::UTF8String

Define a string type for each encoding Warning : in UTF8 and UTF16 strings, one element doesn't necessarily maps to one character ; only an UTF32 element is wide enough to hold all possible unicode values /////////////////////////////////////////////////////////.

Definition at line 54 of file Unicode.hpp.


Member Enumeration Documentation

anonymous enum [private]
Enumerator:
BuffersCount 

Definition at line 210 of file SoundStream.hpp.

{BuffersCount = 3};

Enumeration of the sound states /////////////////////////////////////////////////////////.

Enumerator:
Stopped 

Sound is not playing.

Paused 

Sound is paused.

Playing 

Sound is playing.

Definition at line 52 of file Sound.hpp.

Enumerate the string drawing styles /////////////////////////////////////////////////////////.

Enumerator:
Regular 

Regular characters, no style.

Bold 

Characters are bold.

Italic 

Characters are in italic.

Underlined 

Characters are underlined.

Definition at line 51 of file String.hpp.

    {
        Regular    = 0,      
        Bold       = 1 << 0, 
        Italic     = 1 << 1, 
        Underlined = 1 << 2  
    };

Enumeration of transfer modes /////////////////////////////////////////////////////////.

Enumerator:
Binary 

Binary mode (file is transfered as a sequence of bytes)

Ascii 

Text mode using ASCII encoding.

Ebcdic 

Text mode using EBCDIC encoding.

Definition at line 54 of file Ftp.hpp.


Constructor & Destructor Documentation

virtual sf::SFML_API::~AudioResource ( ) [protected, virtual]

Destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~SoundRecorder ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~SoundStream ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~Drawable ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~RenderTarget ( ) [virtual]

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~RenderWindow ( ) [virtual]

Destructor.

/////////////////////////////////////////////////////////

Destructor -- close the connection with the server.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~Packet ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

Destructor (unlocks the mutex)

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~Thread ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~Thread ( ) [virtual]

Virtual destructor.

/////////////////////////////////////////////////////////

Destructor, destroy the context.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~Window ( ) [virtual]

Destructor.

/////////////////////////////////////////////////////////

virtual sf::SFML_API::~WindowListener ( ) [inline, protected, virtual]

Destructor.

/////////////////////////////////////////////////////////

Definition at line 60 of file WindowListener.hpp.

{}

Member Function Documentation

Socket::Status sf::SFML_API::Accept ( SocketTCP Connected,
IPAddress Address = NULL 
)

Wait for a connection (must be listening to a port). This function will block if the socket is blocking.

Parameters:
Connected: Socket containing the connection with the connected client
Address: Pointer to an address to fill with client infos (NULL by default)
Returns:
Status code

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::Activate ( bool  Active) [private, virtual]

/see RenderTarget::Activate

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::Activate ( bool  Active) [private, pure virtual]

Activate the target for rendering.

Parameters:
Active: True to activate rendering, false to deactivate
Returns:
True if activation succeeded

/////////////////////////////////////////////////////////

void sf::SFML_API::Add ( SocketHelper::SocketType  Socket)

Add a socket to watch.

Parameters:
Socket: Socket to add

/////////////////////////////////////////////////////////

void sf::SFML_API::AddPoint ( float  X,
float  Y,
const Color Col = Color(255, 255, 255),
const Color OutlineCol = Color(0, 0, 0) 
)

Add a point to the shape.

Parameters:
X,Y: Position of the point
Col: Color of the point (white by default)
OutlineCol: Outline color of the point (black by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::AddPoint ( const Vector2f Position,
const Color Col = Color(255, 255, 255),
const Color OutlineCol = Color(0, 0, 0) 
)

Add a point to the shape.

Parameters:
Position: Position of the point
Col: Color of the point (white by default)
OutlineCol: Outline color of the point (black by default)

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::ANSIToUTF32 ( In  Begin,
In  End,
Out  Output,
const std::locale &  Locale = GetDefaultLocale() 
) [static]

Generic function to convert an ANSI characters range to an UTF-32 characters range, using the given locale.

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 (uses the current one by default)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

void sf::SFML_API::Append ( const void *  Data,
std::size_t  SizeInBytes 
)

Append data to the end of the packet.

Parameters:
Data: Pointer to the bytes to append
SizeInBytes: Number of bytes to append

/////////////////////////////////////////////////////////

void sf::SFML_API::AttachSound ( Sound Instance) const [private]

Add a sound to the list of sounds that use this buffer.

Parameters:
Instance: Sound object to attach

/////////////////////////////////////////////////////////

sf::SFML_API::AudioResource ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::AudioResource ( const AudioResource ) [protected]

Copy constructor.

/////////////////////////////////////////////////////////

bool sf::SFML_API::Bind ( unsigned short  Port)

Bind the socket to a specific port.

Parameters:
Port: Port to bind the socket to
Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

void sf::SFML_API::Bind ( ) const

Bind the image for rendering.

/////////////////////////////////////////////////////////

static bool sf::SFML_API::CanCapture ( ) [static]

Tell if the system supports sound capture. If not, this class won't be usable.

Returns:
True if audio capture is supported

/////////////////////////////////////////////////////////

static bool sf::SFML_API::CanUsePostFX ( ) [static]

Tell whether or not the system supports post-effects.

Returns:
True if the system can use post-effects

/////////////////////////////////////////////////////////

Save the content of the window to an image.

Returns:
Image instance containing the contents of the screen

/////////////////////////////////////////////////////////

Response sf::SFML_API::ChangeDirectory ( const std::string &  Directory)

Change the current working directory.

Parameters:
Directory: New directory, relative to the current one
Returns:
Server response to the request

/////////////////////////////////////////////////////////

bool sf::SFML_API::CheckSize ( std::size_t  Size) [private]

Check if the packet can extract a given size of bytes.

Parameters:
Size: Size to check
Returns:
True if Size bytes can be read from the packet's data

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Circle ( float  X,
float  Y,
float  Radius,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single circle (use floats)

Parameters:
X,Y: Position of the center
Radius: Radius
Col: Color used to fill the circle
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Circle ( const Vector2f Center,
float  Radius,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single circle (use vectors)

Parameters:
Center: Position of the center
Radius: Radius
Col: Color used to fill the circle
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::CleanUp ( ) [private]

Clean up the recorder internal resources.

/////////////////////////////////////////////////////////

void sf::SFML_API::Clear ( const Color FillColor = Color(0, 0, 0))

Clear the entire target with a single color.

Parameters:
FillColor: Color to use to clear the render target

/////////////////////////////////////////////////////////

Clear the packet data.

/////////////////////////////////////////////////////////

Remove all sockets.

/////////////////////////////////////////////////////////

void sf::SFML_API::ClearQueue ( ) [private]

Clear the queue of any remaining buffers.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

static bool sf::SFML_API::Close ( SocketType  Socket) [static]

Close / destroy a socket.

Parameters:
Socket: Socket to close
Returns:
True on success

/////////////////////////////////////////////////////////

static bool sf::SFML_API::Close ( SocketType  Socket) [static]

Close / destroy a socket.

Parameters:
Socket: Socket to close
Returns:
True on success

/////////////////////////////////////////////////////////

Close (destroy) the window. The sf::Window instance remains valid and you can call Create to recreate the window.

/////////////////////////////////////////////////////////

Close the socket.

Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

Close the socket.

Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Color ( Uint8  R,
Uint8  G,
Uint8  B,
Uint8  A = 255 
)

Construct the color from its 4 RGBA components.

Parameters:
R: Red component (0 .. 255)
G: Green component (0 .. 255)
B: Blue component (0 .. 255)
A: Alpha component (0 .. 255) (255 by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::Compile ( ) [private]

Compile the shape : compute its center and its outline.

/////////////////////////////////////////////////////////

static bool sf::SFML_API::ComputeNormal ( const Vector2f P1,
const Vector2f P2,
Vector2f Normal 
) [static, private]

Compute the normal of a given 2D segment.

Parameters:
P1: First point of the segment
P2: Second point of the segment
Normal: Calculated normal
Returns:
False if the normal couldn't be calculated (segment is null)

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Connect ( unsigned short  Port,
const IPAddress HostAddress,
float  Timeout = 0.f 
)

Connect to another computer on a specified port.

Parameters:
Port: Port to use for transfers (warning : ports < 1024 are reserved)
HostAddress: IP Address of the host to connect to
Timeout: Maximum time to wait, in seconds (0 by default : no timeout) (this parameter is ignored for non-blocking sockets)
Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

Response sf::SFML_API::Connect ( const IPAddress Server,
unsigned short  Port = 21,
float  Timeout = 0.f 
)

Connect to the specified FTP server.

Parameters:
Server: FTP server to connect to
Port: Port used for connection (21 by default, standard FTP port)
Timeout: Maximum time to wait, in seconds (0 by default, means no timeout)
Returns:
Server response to the request

/////////////////////////////////////////////////////////

Default constructor, create the context.

/////////////////////////////////////////////////////////

sf::Vector2f sf::SFML_API::ConvertCoords ( unsigned int  WindowX,
unsigned int  WindowY,
const View TargetView = NULL 
) const

Convert a point in window coordinates into view coordinates.

Parameters:
WindowX: X coordinate of the point to convert, relative to the window
WindowY: Y coordinate of the point to convert, relative to the window
TargetView: Target view to convert the point to (NULL by default -- uses the current view)
Returns:
Converted point

/////////////////////////////////////////////////////////

void sf::SFML_API::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 only be used at initialization time.

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 (empty by default - entire image)
ApplyAlpha: Should the copy take in account the source transparency? (false by default)

/////////////////////////////////////////////////////////

bool sf::SFML_API::CopyScreen ( RenderWindow Window,
const IntRect SourceRect = IntRect(0, 0, 0, 0) 
)

Create the image from the current contents of the given window.

Parameters:
Window: Window to capture
SourceRect: Sub-rectangle of the screen to copy (empty by default - entire image)
Returns:
True if copy was successful

/////////////////////////////////////////////////////////

void sf::SFML_API::Create ( VideoMode  Mode,
const std::string &  Title,
unsigned long  WindowStyle = Style::Resize|Style::Close,
const WindowSettings Params = WindowSettings() 
)

Create (or recreate) the window.

Parameters:
Mode: Video mode to use
Title: Title of the window
WindowStyle: Window style, see sf::Style (Resize | Close by default)
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

void sf::SFML_API::Create ( WindowHandle  Handle,
const WindowSettings Params = WindowSettings() 
)

Create (or recreate) the window from an existing control.

Parameters:
Handle: Platform-specific handle of the control
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

bool sf::SFML_API::Create ( unsigned int  Width,
unsigned int  Height,
Color  Col = Color(0, 0, 0, 255) 
)

Create an empty image.

Parameters:
Width: Image width
Height: Image height
Col: Image color (black by default)
Returns:
True if creation was successful

/////////////////////////////////////////////////////////

void sf::SFML_API::Create ( SocketHelper::SocketType  Descriptor = 0) [private]

Create the socket.

Parameters:
Descriptor: System socket descriptor to use (0 by default -- create a new socket)

/////////////////////////////////////////////////////////

void sf::SFML_API::Create ( SocketHelper::SocketType  Descriptor = 0) [private]

Create the socket.

Parameters:
Descriptor: System socket descriptor to use (0 by default -- create a new socket)

/////////////////////////////////////////////////////////

void sf::SFML_API::CreateMaskFromColor ( Color  ColorKey,
Uint8  Alpha = 0 
)

Create transparency mask from a specified colorkey.

Parameters:
ColorKey: Color to become transparent
Alpha: Alpha value to use for transparent pixels (0 by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::CreateProgram ( ) [private]

Create the program and attach the shaders.

/////////////////////////////////////////////////////////

bool sf::SFML_API::CreateTexture ( ) [private]

Create the OpenGL texture.

Returns:
True if texture has been successfully created

/////////////////////////////////////////////////////////

Response sf::SFML_API::DeleteDirectory ( const std::string &  Name)

Remove an existing directory.

Parameters:
Name: Name of the directory to remove
Returns:
Server response to the request

/////////////////////////////////////////////////////////

Response sf::SFML_API::DeleteFile ( const std::string &  Name)

Remove an existing file.

Parameters:
Name: File to remove
Returns:
Server response to the request

/////////////////////////////////////////////////////////

void sf::SFML_API::DestroyTexture ( ) [private]

Destroy the OpenGL texture.

/////////////////////////////////////////////////////////

void sf::SFML_API::DetachSound ( Sound Instance) const [private]

Remove a sound from the list of sounds that use this buffer.

Parameters:
Instance: Sound object to detach

/////////////////////////////////////////////////////////

Close the connection with FTP server.

Returns:
Server response to the request

/////////////////////////////////////////////////////////

Display the window on screen.

/////////////////////////////////////////////////////////

Response sf::SFML_API::Download ( const std::string &  DistantFile,
const std::string &  DestPath,
TransferMode  Mode = Binary 
)

Download a file from the server.

Parameters:
DistantFile: Path of the distant file to download
DestPath: Where to put to file on the local computer
Mode: Transfer mode (binary by default)
Returns:
Server response to the request

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Draw ( const Drawable Object) [virtual]

Draw something into the target.

Parameters:
Object: Object to draw

/////////////////////////////////////////////////////////

void sf::SFML_API::Draw ( RenderTarget Target) const [private]

Draw the object into the specified window.

Parameters:
Target: Target into which render the object

/////////////////////////////////////////////////////////

sf::SFML_API::Drawable ( const Vector2f Position = Vector2f(0, 0),
const Vector2f Scale = Vector2f(1, 1),
float  Rotation = 0.f,
const Color Col = Color(255, 255, 255, 255) 
)

Default constructor.

Parameters:
Position: Position of the object (0, 0 by default)
Scale: Scale factor (1, 1 by default)
Rotation: Orientation, in degrees (0 by default)
Col: Color of the object (white by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::EnableFill ( bool  Enable)

Enable or disable filling the shape. Fill is enabled by default.

Parameters:
Enable: True to enable, false to disable

/////////////////////////////////////////////////////////

void sf::SFML_API::EnableKeyRepeat ( bool  Enabled)

Enable or disable automatic key-repeat. Automatic key-repeat is enabled by default.

Parameters:
Enabled: True to enable, false to disable

/////////////////////////////////////////////////////////

void sf::SFML_API::EnableOutline ( bool  Enable)

Enable or disable drawing the shape outline. Outline is enabled by default.

Parameters:
Enable: True to enable, false to disable

/////////////////////////////////////////////////////////

bool sf::SFML_API::EndOfPacket ( ) const

Tell if the reading position has reached the end of the packet.

Returns:
True if all data have been read into the packet

/////////////////////////////////////////////////////////

void sf::SFML_API::EnsureArrayUpdate ( ) const [private]

Make sure the array of pixels is updated with the texture in video memory /////////////////////////////////////////////////////////.

void sf::SFML_API::EnsureTextureUpdate ( ) const [private]

Make sure the texture in video memory is updated with the array of pixels /////////////////////////////////////////////////////////.

bool sf::SFML_API::FillAndPushBuffer ( unsigned int  BufferNum) [private]

Fill a new buffer with audio data, and push it to the playing queue.

Parameters:
Buffer: Number of the buffer to fill (in [0, BuffersCount])
Returns:
True if the derived class has requested to stop

/////////////////////////////////////////////////////////

bool sf::SFML_API::FillQueue ( ) [private]

Fill the buffers queue with all available buffers.

Returns:
True if the derived class has requested to stop

/////////////////////////////////////////////////////////

void sf::SFML_API::FlipX ( bool  Flipped)

Flip the sprite horizontally.

Parameters:
Flipped: True to flip the sprite

/////////////////////////////////////////////////////////

void sf::SFML_API::FlipY ( bool  Flipped)

Flip the sprite vertically.

Parameters:
Flipped: True to flip the sprite

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

const float* sf::SFML_API::Get4x4Elements ( ) const

Return the elements of the matrix as a 4x4, in an array of 16 floats.

Returns:
Pointer to the 4x4 matrix elements

/////////////////////////////////////////////////////////

Get the attenuation factor.

Returns:
Attenuation factor of the sound

/////////////////////////////////////////////////////////

Get the current blending mode.

Returns:
Current blending mode

/////////////////////////////////////////////////////////

Get the sound buffer containing the captured audio data.

Returns:
Constant reference to the sound buffer

/////////////////////////////////////////////////////////

Get the source buffer.

Returns:
Sound buffer bound to the sound (can be NULL)

/////////////////////////////////////////////////////////

Get the center of the view.

Returns:
Center of the view

/////////////////////////////////////////////////////////

Get the center of the object.

Returns:
Current position of the center

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetChannelsCount ( ) const

Return the number of channels (1 = mono, 2 = stereo)

Returns:
Number of channels

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetChannelsCount ( ) const

Return the number of channels (1 = mono, 2 = stereo, ...)

Returns:
Number of channels

/////////////////////////////////////////////////////////

sf::Vector2f sf::SFML_API::GetCharacterPos ( std::size_t  Index) const

Return the visual position of the Index-th character of the string, in coordinates relative to the string (note : translation, center, rotation and scale are not applied)

Parameters:
Index: Index of the character
Returns:
Position of the Index-th character (end of string if Index is out of range)

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetCharacterSize ( ) const

Get the base size of characters in the font; All glyphs dimensions are based on this value.

Returns:
Base size of characters

/////////////////////////////////////////////////////////

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

Get the color of the object.

Returns:
Current color

/////////////////////////////////////////////////////////

const char* sf::SFML_API::GetData ( ) const

Get a pointer to the data contained in the packet Warning : the returned pointer may be invalid after you append data to the packet.

Returns:
Pointer to the data

/////////////////////////////////////////////////////////

std::size_t sf::SFML_API::GetDataSize ( ) const

Get the size of the data contained in the packet.

Returns:
Data size, in bytes

/////////////////////////////////////////////////////////

static const Font& sf::SFML_API::GetDefaultFont ( ) [static]

Get the SFML default built-in font (Arial)

Returns:
Instance of the default font

/////////////////////////////////////////////////////////

static const std::locale& sf::SFML_API::GetDefaultLocale ( ) [static, private]

Get the default system locale.

Returns:
Reference to the default system locale

/////////////////////////////////////////////////////////

Get the default view of the window for read / write.

Returns:
Default view

/////////////////////////////////////////////////////////

Get the current desktop video mode.

Returns:
Current desktop video mode

/////////////////////////////////////////////////////////

ListingResponse sf::SFML_API::GetDirectoryListing ( const std::string &  Directory = "")

Get the contents of the given directory (subdirectories and files)

Parameters:
Directory: Directory to list ("" by default, the current one)
Returns:
Server response to the request

/////////////////////////////////////////////////////////

float sf::SFML_API::GetDuration ( ) const

Get the music duration.

Returns:
Music duration, in seconds

/////////////////////////////////////////////////////////

float sf::SFML_API::GetDuration ( ) const

Get the sound duration.

Returns:
Sound duration, in seconds

/////////////////////////////////////////////////////////

Get the time elapsed since last reset.

Returns:
Time elapsed, in seconds

/////////////////////////////////////////////////////////

Get the last socket error status.

Returns:
Status corresponding to the last socket error

/////////////////////////////////////////////////////////

Get the last socket error status.

Returns:
Status corresponding to the last socket error

/////////////////////////////////////////////////////////

bool sf::SFML_API::GetEvent ( Event EventReceived)

Get the event on top of events stack, if any, and pop it.

Parameters:
EventReceived: Event to fill, if any
Returns:
True if an event was returned, false if events stack was empty

/////////////////////////////////////////////////////////

const Font& sf::SFML_API::GetFont ( ) const

Get the font used by the string.

Returns:
Font used

/////////////////////////////////////////////////////////

float sf::SFML_API::GetFrameTime ( ) const

Get time elapsed since last frame.

Returns:
Time elapsed, in seconds

/////////////////////////////////////////////////////////

static Context& sf::SFML_API::GetGlobal ( ) [static]

Get the global context.

Returns:
Reference to the global context

/////////////////////////////////////////////////////////

static float sf::SFML_API::GetGlobalVolume ( ) [static]

Get the current value of the global volume of all the sounds.

Returns:
Current global volume, in the range [0, 100]

/////////////////////////////////////////////////////////

const Glyph& sf::SFML_API::GetGlyph ( Uint32  CodePoint) const

Get the description of a glyph (character) given by its unicode value.

Parameters:
CodePoint: Unicode value of the character to get
Returns:
Glyph's visual settings, or an invalid glyph if character not found

/////////////////////////////////////////////////////////

Get the half-size of the view.

Returns:
Half-size of the view

/////////////////////////////////////////////////////////

virtual unsigned int sf::SFML_API::GetHeight ( ) const [pure virtual]

Get the height of the rendering region of the target.

Returns:
Height in pixels

/////////////////////////////////////////////////////////

virtual unsigned int sf::SFML_API::GetHeight ( ) const [virtual]

Get the height of the rendering region of the window.

Returns:
Height in pixels

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetHeight ( ) const

Get the height of the rendering region of the window.

Returns:
Height in pixels

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetHeight ( ) const

Return the height of the image.

Returns:
Height in pixels

/////////////////////////////////////////////////////////

const Image& sf::SFML_API::GetImage ( ) const

Get the image containing the rendered characters (glyphs)

Returns:
Image containing glyphs

/////////////////////////////////////////////////////////

const Image* sf::SFML_API::GetImage ( ) const

Get the source image of the sprite.

Returns:
Pointer to the image (can be NULL)

/////////////////////////////////////////////////////////

const Input& sf::SFML_API::GetInput ( ) const

Get the input manager of the window.

Returns:
Reference to the input

/////////////////////////////////////////////////////////

Return the inverse of the matrix.

Returns:
A new matrix which is the inverse of this

/////////////////////////////////////////////////////////

const Matrix3& sf::SFML_API::GetInverseMatrix ( ) const [protected]

Get the inverse transform matrix of the drawable.

Returns:
Inverse transform matrix

/////////////////////////////////////////////////////////

float sf::SFML_API::GetJoystickAxis ( unsigned int  JoyId,
Joy::Axis  Axis 
) const

Get a joystick axis position.

Parameters:
JoyId: Identifier of the joystick to check (0 or 1)
Axis: Axis to get
Returns:
Current axis position, in the range [-100, 100] (except for POV, which is [0, 360])

/////////////////////////////////////////////////////////

Get the computer's local IP address (from the LAN point of view)

Returns:
Local IP address

/////////////////////////////////////////////////////////

bool sf::SFML_API::GetLoop ( ) const

Tell whether or not the stream is looping.

Returns:
True if the music is looping, false otherwise

/////////////////////////////////////////////////////////

bool sf::SFML_API::GetLoop ( ) const

Tell whether or not the sound is looping.

Returns:
True if the sound is looping, false otherwise

/////////////////////////////////////////////////////////

const Matrix3& sf::SFML_API::GetMatrix ( ) const [private]

Get the projection matrix of the view.

Returns:
Projection matrix containing the view settings

/////////////////////////////////////////////////////////

const Matrix3& sf::SFML_API::GetMatrix ( ) const [protected]

Get the transform matrix of the drawable.

Returns:
Transform matrix

/////////////////////////////////////////////////////////

Get the minimum distance.

Returns:
Minimum distance for the sound

/////////////////////////////////////////////////////////

static VideoMode sf::SFML_API::GetMode ( std::size_t  Index) [static]

Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst.

Parameters:
Index: Index of video mode to get
Returns:
Corresponding video mode (invalid mode if index is out of range)

/////////////////////////////////////////////////////////

static std::size_t sf::SFML_API::GetModesCount ( ) [static]

Get valid video modes count.

Returns:
Number of valid video modes available

/////////////////////////////////////////////////////////

int sf::SFML_API::GetMouseX ( ) const

Get the mouse X position.

Returns:
Current mouse left position, relative to owner window

/////////////////////////////////////////////////////////

int sf::SFML_API::GetMouseY ( ) const

Get the mouse Y position.

Returns:
Current mouse top position, relative to owner window

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetNbPoints ( ) const

Get the number of points composing the shape.

Parameters:
Totalnumber of points

/////////////////////////////////////////////////////////

Get the width of the shape outline.

Returns:
Current outline width

/////////////////////////////////////////////////////////

float sf::SFML_API::GetPitch ( ) const

Get the pitch.

Returns:
Pitch value

/////////////////////////////////////////////////////////

Color sf::SFML_API::GetPixel ( unsigned int  X,
unsigned int  Y 
) const

Get the color of a given pixel in the sprite (point is in local coordinates)

Parameters:
X: X coordinate of the pixel to get
Y: Y coordinate of the pixel to get
Returns:
Color of pixel (X, Y)

/////////////////////////////////////////////////////////

const Color& sf::SFML_API::GetPixel ( unsigned int  X,
unsigned int  Y 
) const

Get a pixel from the image.

Parameters:
X: X coordinate of pixel in the image
Y: Y coordinate of pixel in the image
Returns:
Color of pixel (X, Y)

/////////////////////////////////////////////////////////

const Uint8* sf::SFML_API::GetPixelsPtr ( ) const

Get a read-only pointer to the array of pixels (RGBA 8 bits integers components) Array size is GetWidth() x GetHeight() x 4 This pointer becomes invalid if you reload or resize the image.

Returns:
Const pointer to the array of pixels

/////////////////////////////////////////////////////////

Get the current playing position of the stream.

Returns:
Current playing position, expressed in seconds

/////////////////////////////////////////////////////////

Get the current playing position of the sound.

Returns:
Current playing position, expressed in seconds

/////////////////////////////////////////////////////////

const Color& sf::SFML_API::GetPointColor ( unsigned int  Index) const

Get the color of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
Returns:
Color of the Index-th point

/////////////////////////////////////////////////////////

const Color& sf::SFML_API::GetPointOutlineColor ( unsigned int  Index) const

Get the outline color of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
Returns:
Outline color of the Index-th point

/////////////////////////////////////////////////////////

const Vector2f& sf::SFML_API::GetPointPosition ( unsigned int  Index) const

Get the position of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
Returns:
Position of the Index-th point

/////////////////////////////////////////////////////////

unsigned short sf::SFML_API::GetPort ( ) const

Get the port the socket is currently bound to.

Returns:
Current port (0 means the socket is not bound)

/////////////////////////////////////////////////////////

static Vector3f sf::SFML_API::GetPosition ( ) [static]

Get the current position of the listener.

Returns:
Position of the listener in the world

/////////////////////////////////////////////////////////

Get the position of the object.

Returns:
Current position

/////////////////////////////////////////////////////////

Get the sound position.

Returns:
Position of the sound in the world

/////////////////////////////////////////////////////////

static IPAddress sf::SFML_API::GetPublicAddress ( float  Timeout = 0.f) [static]

Get the computer's public IP address (from the web point of view). The only way to get a public address is to ask it to a distant website ; as a consequence, this function may be very slow -- use it as few as possible !

Parameters:
Timeout: Maximum time to wait, in seconds (0 by default : no timeout)
Returns:
Public IP address

/////////////////////////////////////////////////////////

Get the bounding rectangle of the view.

Returns:
Bounding rectangle of the view

/////////////////////////////////////////////////////////

Get the string rectangle on screen.

Returns:
Rectangle contaning the string in screen coordinates

/////////////////////////////////////////////////////////

Response sf::SFML_API::GetResponse ( ) [private]

Receive a response from the server (usually after a command has been sent)

Returns:
Server response to the request

/////////////////////////////////////////////////////////

float sf::SFML_API::GetRotation ( ) const

Get the orientation of the object. Rotation is always in the range [0, 360].

Returns:
Current rotation, in degrees

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetSampleRate ( ) const

Get the sample rate.

Returns:
Frequency, in samples per second

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetSampleRate ( ) const

Get the stream sample rate.

Returns:
Stream frequency (number of samples per second)

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetSampleRate ( ) const

Get the sample rate.

Returns:
Sound frequency (number of samples per second)

/////////////////////////////////////////////////////////

const Int16* sf::SFML_API::GetSamples ( ) const

Return the sound samples.

Returns:
Pointer to the array of sound samples, in 16 bits signed integer format

/////////////////////////////////////////////////////////

std::size_t sf::SFML_API::GetSamplesCount ( ) const

Return the samples count.

Returns:
Number of samples

/////////////////////////////////////////////////////////

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

Get the current scale of the object.

Returns:
Current scale factor (always positive)

/////////////////////////////////////////////////////////

static unsigned int sf::SFML_API::GetSeed ( ) [static]

Get the seed used to generate random numbers the generator.

Returns:
Current seed

/////////////////////////////////////////////////////////

Get the creation settings of the window.

Returns:
Structure containing the creation settings

/////////////////////////////////////////////////////////

float sf::SFML_API::GetSize ( ) const

Get the size of the characters.

Returns:
Size of the characters

/////////////////////////////////////////////////////////

Get the sprite size.

Returns:
Size of the sprite

/////////////////////////////////////////////////////////

SocketHelper::SocketType sf::SFML_API::GetSocketReady ( unsigned int  Index)

After a call to Wait(), get the Index-th socket which is ready for reading. The total number of sockets ready is the integer returned by the previous call to Wait()

Parameters:
Index: Index of the socket to get
Returns:
The Index-th socket

/////////////////////////////////////////////////////////

Get the status of the stream (stopped, paused, playing)

Returns:
Current status of the sound

/////////////////////////////////////////////////////////

Get the status of the sound (stopped, paused, playing)

Returns:
Current status of the sound

/////////////////////////////////////////////////////////

unsigned long sf::SFML_API::GetStyle ( ) const

Get the style of the text.

Returns:
Current string style (combination of Style enum values)

/////////////////////////////////////////////////////////

Get the sub-rectangle of the sprite inside the source image.

Returns:
Sub-rectangle

/////////////////////////////////////////////////////////

static Vector3f sf::SFML_API::GetTarget ( ) [static]

Get the current orientation of the listener (the point he's looking at)

Returns:
: Position of the point the listener is looking at

/////////////////////////////////////////////////////////

FloatRect sf::SFML_API::GetTexCoords ( const IntRect Rect) const

Convert a subrect expressed in pixels, into float texture coordinates.

Parameters:
Rect: Sub-rectangle of image to convert
Returns:
Texture coordinates corresponding to the sub-rectangle

/////////////////////////////////////////////////////////

const Unicode::Text& sf::SFML_API::GetText ( ) const

Get the text (the returned text can be converted implicitely to any kind of string)

Returns:
String's text

/////////////////////////////////////////////////////////

template<typename In >
static std::size_t sf::SFML_API::GetUTF16Length ( In  Begin,
In  End 
) [static]

Get the number of characters composing an UTF-16 string.

Parameters:
Begin: Iterator pointing to the beginning of the input sequence
End: Iterator pointing to the end of the input sequence
Returns:
Count of the characters in the string

/////////////////////////////////////////////////////////

template<typename In >
static std::size_t sf::SFML_API::GetUTF32Length ( In  Begin,
In  End 
) [static]

Get the number of characters composing an UTF-32 string.

Parameters:
Begin: Iterator pointing to the beginning of the input sequence
End: Iterator pointing to the end of the input sequence
Returns:
Count of the characters in the string

/////////////////////////////////////////////////////////

template<typename In >
static std::size_t sf::SFML_API::GetUTF8Length ( In  Begin,
In  End 
) [static]

Get the number of characters composing an UTF-8 string.

Parameters:
Begin: Iterator pointing to the beginning of the input sequence
End: Iterator pointing to the end of the input sequence
Returns:
Count of the characters in the string

/////////////////////////////////////////////////////////

static unsigned int sf::SFML_API::GetValidTextureSize ( unsigned int  Size) [static]

Get a valid texture size according to hardware support.

Parameters:
Size: Size to convert
Returns:
Valid nearest size (greater than or equal to specified size)

/////////////////////////////////////////////////////////

const View& sf::SFML_API::GetView ( ) const

Get the current view.

Returns:
Current view active in the window

/////////////////////////////////////////////////////////

float sf::SFML_API::GetVolume ( ) const

Get the volume.

Returns:
Volume value (in range [1, 100])

/////////////////////////////////////////////////////////

virtual unsigned int sf::SFML_API::GetWidth ( ) const [pure virtual]

Get the width of the rendering region of the target.

Returns:
Width in pixels

/////////////////////////////////////////////////////////

virtual unsigned int sf::SFML_API::GetWidth ( ) const [virtual]

Get the width of the rendering region of the window.

Returns:
Width in pixels

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetWidth ( ) const

Get the width of the rendering region of the window.

Returns:
Width in pixels

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::GetWidth ( ) const

Return the width of the image.

Returns:
Width in pixels

/////////////////////////////////////////////////////////

DirectoryResponse sf::SFML_API::GetWorkingDirectory ( )

Get the current working directory.

Returns:
Server response to the request

/////////////////////////////////////////////////////////

sf::SFML_API::Glyph ( ) [inline]

Default constructor.

/////////////////////////////////////////////////////////

Definition at line 48 of file Glyph.hpp.

: Advance(0) {}

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Http ( const std::string &  Host,
unsigned short  Port = 0 
)

Construct the Http instance with the target host.

Parameters:
Host: Web server to connect to
Port: Port to use for connection (0 by default -- use the standard port of the protocol used)

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Image ( const Image Copy)

Copy constructor.

Parameters:
Copy: instance to copy

/////////////////////////////////////////////////////////

sf::SFML_API::Image ( unsigned int  Width,
unsigned int  Height,
const Color Col = Color(0, 0, 0, 255) 
)

Construct an empty image.

Parameters:
Width: Image width
Height: Image height
Col: Image color (black by default)

/////////////////////////////////////////////////////////

sf::SFML_API::Image ( unsigned int  Width,
unsigned int  Height,
const Uint8 *  Data 
)

Construct the image from pixels in memory.

Parameters:
Width: Image width
Height: Image height
Data: Pointer to the pixels in memory (assumed format is RGBA)

/////////////////////////////////////////////////////////

void sf::SFML_API::Initialize ( ) [protected]

Called by the derived class when it's ready to be initialized.

/////////////////////////////////////////////////////////

void sf::SFML_API::Initialize ( unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [protected]

Set the audio stream parameters, you must call it before Play()

Parameters:
ChannelsCount: Number of channels
SampleRate: Sample rate

/////////////////////////////////////////////////////////

void sf::SFML_API::Initialize ( priv::WindowImpl Impl) [private]

Initialize internal window.

Parameters:
Impl: New internal window implementation

/////////////////////////////////////////////////////////

static void sf::SFML_API::InitializeModes ( ) [static, private]

Get and sort valid video modes /////////////////////////////////////////////////////////.

Default constructor.

/////////////////////////////////////////////////////////

Return the value of the invalid socket.

Returns:
Unique value of the invalid socket

/////////////////////////////////////////////////////////

Return the value of the invalid socket.

Returns:
Unique value of the invalid socket

/////////////////////////////////////////////////////////

Default constructor -- constructs an invalid address.

/////////////////////////////////////////////////////////

sf::SFML_API::IPAddress ( const std::string &  Address)

Construct the address from a string.

Parameters:
Address: IP address ("xxx.xxx.xxx.xxx") or network name

/////////////////////////////////////////////////////////

sf::SFML_API::IPAddress ( const char *  Address)

Construct the address from a C-style string ; Needed for implicit conversions from literal strings to IPAddress to work.

Parameters:
Address: IP address ("xxx.xxx.xxx.xxx") or network name

/////////////////////////////////////////////////////////

sf::SFML_API::IPAddress ( Uint8  Byte0,
Uint8  Byte1,
Uint8  Byte2,
Uint8  Byte3 
)

Construct the address from 4 bytes.

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

/////////////////////////////////////////////////////////

sf::SFML_API::IPAddress ( Uint32  Address)

Construct the address from a 32-bits integer.

Parameters:
Address: 4 bytes of the address packed into a 32-bits integer

/////////////////////////////////////////////////////////

static bool sf::SFML_API::IsContextActive ( ) [static]

Check if there's a context bound to the current thread.

Returns:
True if there's a context bound to the current thread

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsJoystickButtonDown ( unsigned int  JoyId,
unsigned int  Button 
) const

Get the state of a joystick button.

Parameters:
JoyId: Identifier of the joystick to check (0 or 1)
Button: Button to check
Returns:
True if button is down, false if button is up

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsKeyDown ( Key::Code  KeyCode) const

Get the state of a key.

Parameters:
KeyCode: Key to check
Returns:
True if key is down, false if key is up

/////////////////////////////////////////////////////////

Get the state of a mouse button.

Parameters:
Button: Button to check
Returns:
True if button is down, false if button is up

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsOpened ( ) const

Tell whether or not the window is opened (ie. has been created). Note that a hidden window (Show(false)) will still return true.

Returns:
True if the window is opened

/////////////////////////////////////////////////////////

Tell if the sound's position is relative to the listener's position, or if it's absolute.

Returns:
True if the position is relative, false if it's absolute

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsSmooth ( ) const

Tells whether the smooth filtering is enabled or not.

Returns:
True if image smoothing is enabled

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsValid ( ) const

Tell if the address is a valid one.

Returns:
True if address has a valid syntax

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsValid ( ) const

Tell whether or not the video mode is supported.

Returns:
True if video mode is supported, false otherwise

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsValid ( ) const

Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

Returns:
True if the socket is valid

/////////////////////////////////////////////////////////

bool sf::SFML_API::IsValid ( ) const

Check if the socket is in a valid state ; this function can be called any time to check if the socket is OK.

Returns:
True if the socket is valid

/////////////////////////////////////////////////////////

Send a null command just to prevent from being disconnected.

Returns:
Server response to the request

/////////////////////////////////////////////////////////

Create and run the thread.

/////////////////////////////////////////////////////////

Create and run the thread.

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Line ( float  P1X,
float  P1Y,
float  P2X,
float  P2Y,
float  Thickness,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single line (use floats)

Parameters:
P1X,P1Y: Position of the first point
P2X,P2Y: Position second point
Thickness: Line thickness
Col: Color used to draw the line
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Line ( const Vector2f P1,
const Vector2f P2,
float  Thickness,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single line (use vectors)

Parameters:
P1X,P1Y: Position of the first point
P2X,P2Y: Position second point
Thickness: Line thickness
Col: Color used to draw the line
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

bool sf::SFML_API::Listen ( unsigned short  Port)

Listen to a specified port for incoming data or connections.

Parameters:
Port: Port to listen to
Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromFile ( const std::string &  Filename,
unsigned int  CharSize = 30,
const Unicode::Text &  Charset = ourDefaultCharset 
)

Load the font from a file.

Parameters:
Filename: Font file to load
CharSize: Size of characters in bitmap - the bigger, the higher quality (30 by default)
Charset: Characters set to generate (by default, contains the ISO-8859-1 printable characters)
Returns:
True if loading was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromFile ( const std::string &  Filename)

Load the effect from a file.

Parameters:
Filename: Path of the effect file to load
Returns:
True on success

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromFile ( const std::string &  Filename)

Load the sound buffer from a file.

Parameters:
Filename: Path of the sound file to load
Returns:
True if loading has been successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromFile ( const std::string &  Filename)

Load the image from a file.

Parameters:
Filename: Path of the image file to load
Returns:
True if loading was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromMemory ( const std::string &  Effect)

Load the effect from a text in memory.

Parameters:
Effect: String containing the effect code
Returns:
True on success

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromMemory ( const char *  Data,
std::size_t  SizeInBytes,
unsigned int  CharSize = 30,
const Unicode::Text &  Charset = ourDefaultCharset 
)

Load the font from a file in memory.

Parameters:
Data: Pointer to the data to load
SizeInBytes: Size of the data, in bytes
CharSize: Size of characters in bitmap - the bigger, the higher quality (30 by default)
Charset: Characters set to generate (by default, contains the ISO-8859-1 printable characters)
Returns:
True if loading was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromMemory ( const char *  Data,
std::size_t  SizeInBytes 
)

Load the sound buffer from a file in memory.

Parameters:
Data: Pointer to the file data in memory
SizeInBytes: Size of the data to load, in bytes
Returns:
True if loading has been successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromMemory ( const char *  Data,
std::size_t  SizeInBytes 
)

Load the image from a file in memory.

Parameters:
Data: Pointer to the file data in memory
SizeInBytes: Size of the data to load, in bytes
Returns:
True if loading was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromPixels ( unsigned int  Width,
unsigned int  Height,
const Uint8 *  Data 
)

Load the image directly from an array of pixels.

Parameters:
Width: Image width
Height: Image height
Data: Pointer to the pixels in memory (assumed format is RGBA)
Returns:
True if loading was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::LoadFromSamples ( const Int16 *  Samples,
std::size_t  SamplesCount,
unsigned int  ChannelsCount,
unsigned int  SampleRate 
)

Load the sound buffer from an array of samples - assumed format for samples is 16 bits signed integer.

Parameters:
Samples: Pointer to the samples in memory
SamplesCount: Number of samples pointed by Samples
ChannelsCount: Number of channels (1 = mono, 2 = stereo, ...)
SampleRate: Frequency (number of samples to play per second)
Returns:
True if loading has been successful

/////////////////////////////////////////////////////////

sf::SFML_API::Lock ( Mutex Mutex)

Construct the lock with a target mutex (lock it)

Parameters:
Mutex: Mutex to lock

/////////////////////////////////////////////////////////

Lock the mutex.

/////////////////////////////////////////////////////////

Lock the mutex.

/////////////////////////////////////////////////////////

Response sf::SFML_API::Login ( )

Log in using anonymous account.

Returns:
Server response to the request

/////////////////////////////////////////////////////////

Response sf::SFML_API::Login ( const std::string &  UserName,
const std::string &  Password 
)

Log in using a username and a password.

Parameters:
UserName: User name
Password: Password
Returns:
Server response to the request

/////////////////////////////////////////////////////////

Response sf::SFML_API::MakeDirectory ( const std::string &  Name)

Create a new directory.

Parameters:
Name: Name of the directory to create
Returns:
Server response to the request

/////////////////////////////////////////////////////////

Default constructor (builds an identity matrix)

/////////////////////////////////////////////////////////

sf::SFML_API::Matrix3 ( float  a00,
float  a01,
float  a02,
float  a10,
float  a11,
float  a12,
float  a20,
float  a21,
float  a22 
)

Construct a matrix from its 9 elements.

/////////////////////////////////////////////////////////

void sf::SFML_API::Move ( float  OffsetX,
float  OffsetY 
)

Move the view (take 2 values)

Parameters:
OffsetX: Offset to move the view, on X axis
OffsetY: Offset to move the view, on Y axis

/////////////////////////////////////////////////////////

void sf::SFML_API::Move ( const sf::Vector2f Offset)

Move the view (take a vector)

Parameters:
Offset: Offset to move the view

/////////////////////////////////////////////////////////

void sf::SFML_API::Move ( float  OffsetX,
float  OffsetY 
)

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

Parameters:
OffsetX: X offset
OffsetY: Y offset

/////////////////////////////////////////////////////////

void sf::SFML_API::Move ( const Vector2f Offset)

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

Parameters:
Offset: Amount of units to move the object of

/////////////////////////////////////////////////////////

sf::SFML_API::Music ( std::size_t  BufferSize = 44100) [explicit]

Construct the music with a buffer size.

Parameters:
BufferSize: Size of the internal buffer, expressed in number of samples (ie. size taken by the music in memory) (44100 by default)

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::NonCopyable ( ) [inline, protected]

The default constructor won't be generated, so provide it.

/////////////////////////////////////////////////////////

Definition at line 48 of file NonCopyable.hpp.

{}
sf::SFML_API::NonCopyable ( const NonCopyable ) [private]

Copy constructor : declare it private and don't implement it to prevent from calling it.

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnCreate ( ) [private, virtual]

/see Window::OnCreate

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnCreate ( ) [private, virtual]

Called after the window has been created.

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnEvent ( const Event EventReceived) [pure virtual]

Called each time an event is received from attached window.

Parameters:
EventReceived: Event received

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnEvent ( const Event EventReceived) [private, virtual]

/see WindowListener::OnEvent

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnEvent ( const Event EventReceived) [private, virtual]

/see WindowListener::OnEvent

Parameters:
EventReceived: Event received

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnGetData ( Chunk Data) [private, virtual]

/see SoundStream::OnGetData

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnGetData ( Chunk Data) [private, pure virtual]

Called each time new audio data is needed to feed the stream.

Parameters:
Data: New chunk of data to stream
Returns:
True to continue playback, false to stop

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnProcessSamples ( const Int16 *  Samples,
std::size_t  SamplesCount 
) [private, virtual]

/see SoundBuffer::OnProcessSamples

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnProcessSamples ( const Int16 *  Samples,
std::size_t  SamplesCount 
) [private, pure virtual]

Process a new chunk of recorded samples.

Parameters:
Samples: Pointer to the new chunk of recorded samples
SamplesCount: Number of samples pointed by Samples
Returns:
False to stop recording audio data, true to continue

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnReceive ( const char *  Data,
std::size_t  DataSize 
) [private, virtual]

Called after the packet has been received from the network.

Parameters:
Data: Pointer to the array of received bytes
DataSize: Size of the array of bytes

/////////////////////////////////////////////////////////

virtual const char* sf::SFML_API::OnSend ( std::size_t &  DataSize) [private, virtual]

Called before the packet is sent to the network.

Parameters:
DataSize: Variable to fill with the size of data to send
Returns:
Pointer to the array of bytes to send

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnStart ( ) [private, virtual]

/see SoundBuffer::OnStart

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnStart ( ) [private, virtual]

Start recording audio data.

Returns:
False to abort recording audio data, true to start

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnStart ( ) [private, virtual]

/see SoundStream::OnStart

/////////////////////////////////////////////////////////

virtual bool sf::SFML_API::OnStart ( ) [private, virtual]

Called when the sound restarts.

Returns:
If false is returned, the playback is aborted

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnStop ( ) [private, virtual]

/see SoundBuffer::OnStop

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::OnStop ( ) [private, virtual]

Stop recording audio data.

/////////////////////////////////////////////////////////

bool sf::SFML_API::OpenFromFile ( const std::string &  Filename)

Open a music file (doesn't play it -- call Play() for that)

Parameters:
Filename: Path of the music file to open
Returns:
True if loading has been successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::OpenFromMemory ( const char *  Data,
std::size_t  SizeInBytes 
)

Open a music file from memory (doesn't play it -- call Play() for that)

Parameters:
Data: Pointer to the file data in memory
SizeInBytes: Size of the data to load, in bytes
Returns:
True if loading has been successful

/////////////////////////////////////////////////////////

sf::SFML_API::operator bool ( ) const

Return the validity of packet.

Returns:
True if last data extraction from packet was successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator!= ( const Color Other) const

Compare two colors (for difference)

Parameters:
Other: Color to compare
Returns:
True if colors are different

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator!= ( const VideoMode Other) const

Comparison operator overload -- tell if two video modes are different.

Parameters:
Other: Video mode to compare
Returns:
True if modes are different

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator!= ( const IPAddress Other) const

Comparison operator !=.

Parameters:
Other: Address to compare
Returns:
True if *this != Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator!= ( const SocketTCP Other) const

Comparison operator !=.

Parameters:
Other: Socket to compare
Returns:
True if *this != Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator!= ( const SocketUDP Other) const

Comparison operator !=.

Parameters:
Other: Socket to compare
Returns:
True if *this != Other

/////////////////////////////////////////////////////////

float sf::SFML_API::operator() ( unsigned int  Row,
unsigned int  Col 
) const

Operator () overloads to access the matrix elements.

Parameters:
Row: Element row (0 based)
Col: Element column (0 based)
Returns:
Matrix element (Row, Col)

/////////////////////////////////////////////////////////

float& sf::SFML_API::operator() ( unsigned int  Row,
unsigned int  Col 
)
Matrix3 sf::SFML_API::operator* ( const Matrix3 Mat) const

Operator * overload to multiply two matrices.

Parameters:
Mat: Matrix to multiply
Returns:
this * Mat

/////////////////////////////////////////////////////////

Color& sf::SFML_API::operator*= ( const Color Other)

Operator *= overload to modulate a color.

Parameters:
Other: Color to modulate
Returns:
Component-wise multiplication of the two colors

/////////////////////////////////////////////////////////

Matrix3& sf::SFML_API::operator*= ( const Matrix3 Mat)

Operator *= overload to multiply-assign two matrices.

Parameters:
Mat: Matrix to multiply
Returns:
this * Mat

/////////////////////////////////////////////////////////

Color& sf::SFML_API::operator+= ( const Color Other)

Operator += overload to add a color.

Parameters:
Other: Color to add
Returns:
Component-wise saturated addition of the two colors

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator< ( const IPAddress Other) const

Comparison operator <.

Parameters:
Other: Address to compare
Returns:
True if *this < Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator< ( const SocketTCP Other) const

Comparison operator <. Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Parameters:
Other: Socket to compare
Returns:
True if *this < Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator< ( const SocketUDP Other) const

Comparison operator <. Provided for compatibility with standard containers, as comparing two sockets doesn't make much sense...

Parameters:
Other: Socket to compare
Returns:
True if *this < Other

/////////////////////////////////////////////////////////

Packet& sf::SFML_API::operator<< ( bool  Data)

Operator << overloads to put data into the packet.

/////////////////////////////////////////////////////////

Packet& sf::SFML_API::operator<< ( Int8  Data)
Packet& sf::SFML_API::operator<< ( Uint8  Data)
Packet& sf::SFML_API::operator<< ( Int16  Data)
Packet& sf::SFML_API::operator<< ( Uint16  Data)
Packet& sf::SFML_API::operator<< ( Int32  Data)
Packet& sf::SFML_API::operator<< ( Uint32  Data)
Packet& sf::SFML_API::operator<< ( float  Data)
Packet& sf::SFML_API::operator<< ( double  Data)
Packet& sf::SFML_API::operator<< ( const char *  Data)
Packet& sf::SFML_API::operator<< ( const std::string &  Data)
Packet& sf::SFML_API::operator<< ( const wchar_t *  Data)
Packet& sf::SFML_API::operator<< ( const std::wstring &  Data)
bool sf::SFML_API::operator<= ( const IPAddress Other) const

Comparison operator <=.

Parameters:
Other: Address to compare
Returns:
True if *this <= Other

/////////////////////////////////////////////////////////

NonCopyable& sf::SFML_API::operator= ( const NonCopyable ) [private]

Assignment operator : declare it private and don't implement it to prevent from calling it.

/////////////////////////////////////////////////////////

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

Assignment operator.

Parameters:
Other: Instance to assign
Returns:
Reference to the post-effect

/////////////////////////////////////////////////////////

SoundBuffer& sf::SFML_API::operator= ( const SoundBuffer Other)

Assignment operator.

Parameters:
Other: Instance to assign
Returns:
Reference to the sound buffer

/////////////////////////////////////////////////////////

Image& sf::SFML_API::operator= ( const Image Other)

Assignment operator.

Parameters:
Other: instance to assign
Returns:
Reference to the image

/////////////////////////////////////////////////////////

Sound& sf::SFML_API::operator= ( const Sound Other)

Assignment operator.

Parameters:
Other: Instance to assign
Returns:
Reference to the sound

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator== ( const Color Other) const

Compare two colors (for equality)

Parameters:
Other: Color to compare
Returns:
True if colors are equal

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator== ( const VideoMode Other) const

Comparison operator overload -- tell if two video modes are equal.

Parameters:
Other: Video mode to compare
Returns:
True if modes are equal

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator== ( const IPAddress Other) const

Comparison operator ==.

Parameters:
Other: Address to compare
Returns:
True if *this == Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator== ( const SocketTCP Other) const

Comparison operator ==.

Parameters:
Other: Socket to compare
Returns:
True if *this == Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator== ( const SocketUDP Other) const

Comparison operator ==.

Parameters:
Other: Socket to compare
Returns:
True if *this == Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator> ( const IPAddress Other) const

Comparison operator >

Parameters:
Other: Address to compare
Returns:
True if *this > Other

/////////////////////////////////////////////////////////

bool sf::SFML_API::operator>= ( const IPAddress Other) const

Comparison operator >=.

Parameters:
Other: Address to compare
Returns:
True if *this >= Other

/////////////////////////////////////////////////////////

Packet& sf::SFML_API::operator>> ( bool &  Data)

Operator >> overloads to extract data from the packet.

/////////////////////////////////////////////////////////

Packet& sf::SFML_API::operator>> ( Int8 &  Data)
Packet& sf::SFML_API::operator>> ( Uint8 &  Data)
Packet& sf::SFML_API::operator>> ( Int16 &  Data)
Packet& sf::SFML_API::operator>> ( Uint16 &  Data)
Packet& sf::SFML_API::operator>> ( Int32 &  Data)
Packet& sf::SFML_API::operator>> ( Uint32 &  Data)
Packet& sf::SFML_API::operator>> ( float &  Data)
Packet& sf::SFML_API::operator>> ( double &  Data)
Packet& sf::SFML_API::operator>> ( char *  Data)
Packet& sf::SFML_API::operator>> ( std::string &  Data)
Packet& sf::SFML_API::operator>> ( wchar_t *  Data)
Packet& sf::SFML_API::operator>> ( std::wstring &  Data)

Default constructor.

/////////////////////////////////////////////////////////

Go to the parent directory of the current one.

Returns:
Server response to the request

/////////////////////////////////////////////////////////

Pause the sound.

/////////////////////////////////////////////////////////

Start playing the audio stream.

/////////////////////////////////////////////////////////

Play the sound.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::PostFX ( const PostFX Copy)

Copy constructor.

Parameters:
Copy: Instance to copy

/////////////////////////////////////////////////////////

static std::string sf::SFML_API::PreprocessEffect ( std::istream &  File) [static, private]

Preprocess a SFML effect file to convert it to a valid GLSL fragment shader.

Parameters:
File: Stream containing the code to process
Returns:
Valid fragment shader source code

/////////////////////////////////////////////////////////

void sf::SFML_API::PreserveOpenGLStates ( bool  Preserve)

Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default.

Parameters:
Preserve: True to preserve OpenGL states, false to let SFML optimize

/////////////////////////////////////////////////////////

Get the available captured samples and process them.

/////////////////////////////////////////////////////////

static float sf::SFML_API::Random ( float  Begin,
float  End 
) [static]

Get a random float number in a given range.

Returns:
Start : Start of the range
End : End of the range
Random number in [Begin, End]

/////////////////////////////////////////////////////////

static int sf::SFML_API::Random ( int  Begin,
int  End 
) [static]

Get a random integer number in a given range.

Returns:
Start : Start of the range
End : End of the range
Random number in [Begin, End]

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Receive ( char *  Data,
std::size_t  MaxSize,
std::size_t &  SizeReceived,
IPAddress Address,
unsigned short &  Port 
)

Receive an array of bytes. This function will block if the socket is blocking.

Parameters:
Data: Pointer to a byte array to fill (make sure it is big enough)
MaxSize: Maximum number of bytes to read
SizeReceived: Number of bytes received
Address: Address of the computer which sent the data
Port: Port on which the remote computer sent the data
Returns:
Status code

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Receive ( char *  Data,
std::size_t  MaxSize,
std::size_t &  SizeReceived 
)

Receive an array of bytes from the host (must be connected first). This function will block if the socket is blocking.

Parameters:
Data: Pointer to a byte array to fill (make sure it is big enough)
MaxSize: Maximum number of bytes to read
SizeReceived: Number of bytes received
Returns:
Status code

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Receive ( Packet PacketToReceive,
IPAddress Address,
unsigned short &  Port 
)

Receive a packet. This function will block if the socket is blocking.

Parameters:
PacketToReceive: Packet to fill with received data
Address: Address of the computer which sent the packet
Port: Port on which the remote computer sent the data
Returns:
Status code

/////////////////////////////////////////////////////////

Receive a packet from the host (must be connected first). This function will block if the socket is blocking.

Parameters:
PacketToReceive: Packet to fill with received data
Returns:
Status code

/////////////////////////////////////////////////////////

void sf::SFML_API::RecomputeMatrix ( ) [private]

Recompute the view rectangle and the projection matrix.

/////////////////////////////////////////////////////////

void sf::SFML_API::RecomputeRect ( ) [private]

Recompute the bounding rectangle of the text.

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Rectangle ( float  P1X,
float  P1Y,
float  P2X,
float  P2Y,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single rectangle (use floats)

Parameters:
P1X,P1Y: Position of the first point
P2X,P2Y: Position second point
Col: Color used to fill the rectangle
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

static Shape sf::SFML_API::Rectangle ( const Vector2f P1,
const Vector2f P2,
const Color Col,
float  Outline = 0.f,
const Color OutlineCol = sf::Color(0, 0, 0) 
) [static]

Create a shape made of a single rectangle (use vectors)

Parameters:
P1: Position of the first point
P2: Position second point
Col: Color used to fill the rectangle
Outline: Outline width (0 by default)
OutlineCol: Color used to draw the outline (black by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::Remove ( SocketHelper::SocketType  Socket)

Remove a socket.

Parameters:
Socket: Socket to remove

/////////////////////////////////////////////////////////

Response sf::SFML_API::RenameFile ( const std::string &  File,
const std::string &  NewName 
)

Rename a file.

Parameters:
File: File to rename
NewName: New name
Returns:
Server response to the request

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Render ( RenderTarget Target) const [protected, virtual]

/see Drawable::Render

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Render ( RenderTarget Target) const [protected, virtual]

/see Drawable::Render

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Render ( RenderTarget Target) const [protected, virtual]

/see Drawable::Render

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Render ( RenderTarget Target) const [protected, virtual]

/see Drawable::Render

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Render ( RenderTarget Target) const [private, pure virtual]

Render the specific geometry of the object.

Parameters:
Target: Target into which render the object

/////////////////////////////////////////////////////////

sf::SFML_API::RenderTarget ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::RenderWindow ( VideoMode  Mode,
const std::string &  Title,
unsigned long  WindowStyle = Style::Resize|Style::Close,
const WindowSettings Params = WindowSettings() 
)

Construct the window.

Parameters:
Mode: Video mode to use
Title: Title of the window
WindowStyle: Window style, see sf::Style (Resize | Close by default)
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

sf::SFML_API::RenderWindow ( WindowHandle  Handle,
const WindowSettings Params = WindowSettings() 
)

Construct the window from an existing control.

Parameters:
Handle: Platform-specific handle of the control
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

Restart the timer.

/////////////////////////////////////////////////////////

void sf::SFML_API::Reset ( ) [private]

Reset the image attributes.

/////////////////////////////////////////////////////////

Reset the internal buffer.

This function is for internal use only, you don't have to use it.

/////////////////////////////////////////////////////////

void sf::SFML_API::ResetStates ( ) [private]

Reset all the states.

/////////////////////////////////////////////////////////

void sf::SFML_API::Resize ( float  Width,
float  Height 
)

Resize the sprite (by changing its scale factors) (take 2 values). The default size is defined by the subrect.

Parameters:
Width: New width (must be strictly positive)
Height: New height (must be strictly positive)

/////////////////////////////////////////////////////////

void sf::SFML_API::Resize ( const Vector2f Size)

Resize the sprite (by changing its scale factors) (take a 2D vector). The default size is defined by the subrect.

Parameters:
Size: New size (both coordinates must be strictly positive)

/////////////////////////////////////////////////////////

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

Rotate the object.

Parameters:
Angle: Angle of rotation, in degrees

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Run ( ) [private, virtual]

Function called as the thread entry point.

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Run ( ) [private, virtual]

Function called as the thread entry point.

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Run ( ) [private, virtual]

/see Thread::Run

/////////////////////////////////////////////////////////

virtual void sf::SFML_API::Run ( ) [private, virtual]

/see Thread::Run

/////////////////////////////////////////////////////////

bool sf::SFML_API::SaveToFile ( const std::string &  Filename) const

Save the sound buffer to a file.

Parameters:
Filename: Path of the sound file to write
Returns:
True if saving has been successful

/////////////////////////////////////////////////////////

bool sf::SFML_API::SaveToFile ( const std::string &  Filename) const

Save the content of the image to a file.

Parameters:
Filename: Path of the file to save (overwritten if already exist)
Returns:
True if saving was successful

/////////////////////////////////////////////////////////

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

Scale the object (take 2 values)

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

/////////////////////////////////////////////////////////

void sf::SFML_API::Scale ( const Vector2f Factor)

Scale the object (take a 2D vector)

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

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Send ( const char *  Data,
std::size_t  Size,
const IPAddress Address,
unsigned short  Port 
)

Send an array of bytes.

Parameters:
Data: Pointer to the bytes to send
Size: Number of bytes to send
Address: Address of the computer to send the packet to
Port: Port to send the data to
Returns:
Status code

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Send ( const char *  Data,
std::size_t  Size 
)

Send an array of bytes to the host (must be connected first)

Parameters:
Data: Pointer to the bytes to send
Size: Number of bytes to send
Returns:
Status code

/////////////////////////////////////////////////////////

Socket::Status sf::SFML_API::Send ( Packet PacketToSend,
const IPAddress Address,
unsigned short  Port 
)

Send a packet of data.

Parameters:
PacketToSend: Packet to send
Address: Address of the computer to send the packet to
Port: Port to send the data to
Returns:
Status code

/////////////////////////////////////////////////////////

Send a packet of data to the host (must be connected first)

Parameters:
PacketToSend: Packet to send
Returns:
Status code

/////////////////////////////////////////////////////////

Response sf::SFML_API::SendCommand ( const std::string &  Command,
const std::string &  Parameter = "" 
) [private]

Send a command to the FTP server.

Parameters:
Command: Command to send
Parameter: Command parameter ("" by default)
Returns:
Server response to the request

/////////////////////////////////////////////////////////

Response sf::SFML_API::SendRequest ( const Request &  Req,
float  Timeout = 0.f 
)

Send a HTTP request and return the server's response. You must be connected to a host before sending requests. Any missing mandatory header field 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.

Parameters:
Req: Request to send
Timeout: Maximum time to wait, in seconds (0 by default, means no timeout)
Returns:
Server's response

/////////////////////////////////////////////////////////

void sf::SFML_API::SetActive ( bool  Active)

Activate or deactivate the context.

Parameters:
Active: True to activate the context, false to deactivate it

/////////////////////////////////////////////////////////

bool sf::SFML_API::SetActive ( bool  Active = true) const

Activate of deactivate the window as the current target for rendering.

Parameters:
Active: True to activate, false to deactivate (true by default)
Returns:
True if operation was successful, false otherwise

/////////////////////////////////////////////////////////

void sf::SFML_API::SetAttenuation ( float  Attenuation)

Set the attenuation factor - the higher the attenuation, the more the sound will be attenuated with distance from listener. The default attenuation factor 1.0.

Parameters:
Attenuation: New attenuation factor for the sound

/////////////////////////////////////////////////////////

Set the blending mode for the object. The default blend mode is Blend::Alpha.

Parameters:
Mode: New blending mode

/////////////////////////////////////////////////////////

void sf::SFML_API::SetBlocking ( bool  Blocking)

Change the blocking state of the socket. The default behaviour of a socket is blocking.

Parameters:
Blocking: Pass true to set the socket as blocking, or false for non-blocking

/////////////////////////////////////////////////////////

void sf::SFML_API::SetBlocking ( bool  Blocking)

Change the blocking state of the socket. The default behaviour of a socket is blocking.

Parameters:
Blocking: Pass true to set the socket as blocking, or false for non-blocking

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetBlocking ( SocketType  Socket,
bool  Block 
) [static]

Set a socket as blocking or non-blocking.

Parameters:
Socket: Socket to modify
Block: New blocking state of the socket

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetBlocking ( SocketType  Socket,
bool  Block 
) [static]

Set a socket as blocking or non-blocking.

Parameters:
Socket: Socket to modify
Block: New blocking state of the socket

/////////////////////////////////////////////////////////

void sf::SFML_API::SetBuffer ( const SoundBuffer Buffer)

Set the source buffer.

Parameters:
Buffer: New sound buffer to bind to the sound

/////////////////////////////////////////////////////////

void sf::SFML_API::SetCenter ( float  X,
float  Y 
)

Change the center of the view (take 2 values)

Parameters:
X: X coordinate of the new center
Y: Y coordinate of the new center

/////////////////////////////////////////////////////////

void sf::SFML_API::SetCenter ( const sf::Vector2f Center)

Change the center of the view (take a vector)

Parameters:
Center: New center

/////////////////////////////////////////////////////////

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

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

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

/////////////////////////////////////////////////////////

void sf::SFML_API::SetCenter ( const Vector2f Center)

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

Parameters:
Center: New center

/////////////////////////////////////////////////////////

void sf::SFML_API::SetColor ( const Color Col)

Set the color of the object. The default color is white.

Parameters:
Col: New color

/////////////////////////////////////////////////////////

void sf::SFML_API::SetCursorPosition ( unsigned int  Left,
unsigned int  Top 
)

Change the position of the mouse cursor.

Parameters:
Left: Left coordinate of the cursor, relative to the window
Top: Top coordinate of the cursor, relative to the window

/////////////////////////////////////////////////////////

void sf::SFML_API::SetFont ( const Font CharFont)

Set the font of the string.

Parameters:
Font: Font to use

/////////////////////////////////////////////////////////

void sf::SFML_API::SetFramerateLimit ( unsigned int  Limit)

Limit the framerate to a maximum fixed frequency.

Parameters:
Limit: Framerate limit, in frames per seconds (use 0 to disable limit)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetFromRect ( const FloatRect ViewRect)

Rebuild the view from a rectangle.

Parameters:
ViewRect: Rectangle defining the position and size of the view

/////////////////////////////////////////////////////////

void sf::SFML_API::SetFromTransformations ( const Vector2f Center,
const Vector2f Translation,
float  Rotation,
const Vector2f Scale 
)

Build a matrix from a set of transformations.

Parameters:
Center: Origin for the transformations
Translation: Translation offset
Rotation: Rotation angle in degrees
Scale: Scaling factors

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetGlobalVolume ( float  Volume) [static]

Change the global volume of all the sounds. The default volume is 100.

Parameters:
Volume: New global volume, in the range [0, 100]

/////////////////////////////////////////////////////////

void sf::SFML_API::SetHalfSize ( float  HalfWidth,
float  HalfHeight 
)

Change the half-size of the view (take 2 values)

Parameters:
HalfWidth: New half-width
HalfHeight: New half-height

/////////////////////////////////////////////////////////

void sf::SFML_API::SetHalfSize ( const sf::Vector2f HalfSize)

Change the half-size of the view (take a vector)

Parameters:
HalfSize: New half-size

/////////////////////////////////////////////////////////

void sf::SFML_API::SetHost ( const std::string &  Host,
unsigned short  Port = 0 
)

Set the target host.

Parameters:
Host: Web server to connect to
Port: Port to use for connection (0 by default -- use the standard port of the protocol used)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetIcon ( unsigned int  Width,
unsigned int  Height,
const Uint8 *  Pixels 
)

Change the window's icon.

Parameters:
Width: Icon's width, in pixels
Height: Icon's height, in pixels
Pixels: Pointer to the pixels in memory, format must be RGBA 32 bits

/////////////////////////////////////////////////////////

void sf::SFML_API::SetImage ( const Image Img)

Change the image of the sprite.

Parameters:
Img: New image

/////////////////////////////////////////////////////////

void sf::SFML_API::SetJoystickThreshold ( float  Threshold)

Change the joystick threshold, ie. the value below which no move event will be generated.

Parameters:
Threshold: New threshold, in range [0, 100]

/////////////////////////////////////////////////////////

void sf::SFML_API::SetLoop ( bool  Loop)

Set the sound loop state. This parameter is disabled by default.

Parameters:
Loop: True to play in loop, false to play once

/////////////////////////////////////////////////////////

void sf::SFML_API::SetLoop ( bool  Loop)

Set the stream loop state. This parameter is disabled by default.

Parameters:
Loop: True to play in loop, false to play once

/////////////////////////////////////////////////////////

void sf::SFML_API::SetMinDistance ( float  MinDistance)

Set the minimum distance - closer than this distance, the listener will hear the sound at its maximum volume. The default minimum distance is 1.0.

Parameters:
MinDistance: New minimum distance for the sound

/////////////////////////////////////////////////////////

void sf::SFML_API::SetOutlineWidth ( float  Width)

Change the width of the shape outline.

Parameters:
Width: New width

/////////////////////////////////////////////////////////

void sf::SFML_API::SetParameter ( const std::string &  Name,
float  X 
)

Change a parameter of the effect (1 float)

Parameters:
Name: Parameter name in the effect
X: Value to assign

/////////////////////////////////////////////////////////

void sf::SFML_API::SetParameter ( const std::string &  Name,
float  X,
float  Y 
)

Change a parameter of the effect (2 floats)

Parameters:
Name: Parameter name in the effect
X,Y: Values to assign

/////////////////////////////////////////////////////////

void sf::SFML_API::SetParameter ( const std::string &  Name,
float  X,
float  Y,
float  Z 
)

Change a parameter of the effect (3 floats)

Parameters:
Name: Parameter name in the effect
X,Y,Z: Values to assign

/////////////////////////////////////////////////////////

void sf::SFML_API::SetParameter ( const std::string &  Name,
float  X,
float  Y,
float  Z,
float  W 
)

Change a parameter of the effect (4 floats)

Parameters:
Name: Parameter name in the effect
X,Y,Z,W: Values to assign

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPitch ( float  Pitch)

Set the sound pitch. The default pitch is 1.

Parameters:
Pitch: New pitch

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPixel ( unsigned int  X,
unsigned int  Y,
const Color Col 
)

Change the color of a pixel.

Parameters:
X: X coordinate of pixel in the image
Y: Y coordinate of pixel in the image
Col: New color for pixel (X, Y)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPlayingOffset ( float  TimeOffset)

Set the current playing position of the sound.

Parameters:
TimeOffset: New playing position, expressed in seconds

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPointColor ( unsigned int  Index,
const Color Col 
)

Set the color of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
Col: New color of the Index-th point

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPointOutlineColor ( unsigned int  Index,
const Color OutlineCol 
)

Set the outline color of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
OutlineCol: New outline color of the Index-th point

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPointPosition ( unsigned int  Index,
const Vector2f Position 
)

Set the position of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
Position: New position of the Index-th point

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPointPosition ( unsigned int  Index,
float  X,
float  Y 
)

Set the position of a point.

Parameters:
Index: Index of the point, in range [0, GetNbPoints() - 1]
X: New X coordinate of the Index-th point
Y: New Y coordinate of the Index-th point

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetPosition ( float  X,
float  Y,
float  Z 
) [static]

Change the position of the listener (take 3 values). The default position is (0, 0, 0)

Parameters:
X,Y,Z: Position of the listener in the world

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetPosition ( const Vector3f Position) [static]

Change the position of the listener (take a 3D vector). The default position is (0, 0, 0)

Parameters:
Position: Position of the listener in the world

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPosition ( float  X,
float  Y 
)

Set the position of the object (take 2 values)

Parameters:
X: New X coordinate
Y: New Y coordinate

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPosition ( const Vector2f Position)

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

Parameters:
Position: New position

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPosition ( float  X,
float  Y,
float  Z 
)

Set the sound position (take 3 values). The default position is (0, 0, 0)

Parameters:
X,Y,Z: Position of the sound in the world

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPosition ( const Vector3f Position)

Set the sound position (take a 3D vector). The default position is (0, 0, 0)

Parameters:
Position: Position of the sound in the world

/////////////////////////////////////////////////////////

void sf::SFML_API::SetPosition ( int  Left,
int  Top 
)

Change the position of the window on screen. Only works for top-level windows.

Parameters:
Left: Left position
Top: Top position

/////////////////////////////////////////////////////////

void sf::SFML_API::SetRelativeToListener ( bool  Relative)

Make the sound's position relative to the listener's position, or absolute. The default value is false (absolute)

Parameters:
Relative: True to set the position relative, false to set it absolute

/////////////////////////////////////////////////////////

void sf::SFML_API::SetRenderStates ( ) [private]

Set the OpenGL render states needed for the SFML rendering.

/////////////////////////////////////////////////////////

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

Set the orientation of the object.

Parameters:
Rotation: Angle of rotation, in degrees

/////////////////////////////////////////////////////////

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

Set the scale of the object (take 2 values)

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

/////////////////////////////////////////////////////////

void sf::SFML_API::SetScale ( const Vector2f Scale)

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

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

/////////////////////////////////////////////////////////

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

Set the X scale factor of the object.

Parameters:
X: New X scale factor

/////////////////////////////////////////////////////////

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

Set the Y scale factor of the object.

Parameters:
Y: New Y scale factor

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetSeed ( unsigned int  Seed) [static]

Set the seed for the generator. Using a known seed allows you to reproduce the same sequence of random number.

Parameters:
Seed: Number to use as the seed

/////////////////////////////////////////////////////////

void sf::SFML_API::SetSize ( float  Size)

Set the size of the string The default size is 30.

Parameters:
Size: New size, in pixels

/////////////////////////////////////////////////////////

void sf::SFML_API::SetSize ( unsigned int  Width,
unsigned int  Height 
)

Change the size of the rendering region of the window.

Parameters:
Width: New width
Height: New height

/////////////////////////////////////////////////////////

void sf::SFML_API::SetSmooth ( bool  Smooth)

Enable or disable image smooth filter. This parameter is enabled by default.

Parameters:
Smooth: True to enable smoothing filter, false to disable it

/////////////////////////////////////////////////////////

void sf::SFML_API::SetStyle ( unsigned long  TextStyle)

Set the style of the text The default style is Regular.

Parameters:
TextStyle: New text style, (combination of Style enum values)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetSubRect ( const IntRect SubRect)

Set the sub-rectangle of the sprite inside the source image. By default, the subrect covers the entire source image.

Parameters:
SubRect: New sub-rectangle

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetTarget ( float  X,
float  Y,
float  Z 
) [static]

Change the orientation of the listener (the point he must look at) (take 3 values). The default target is (0, 0, -1)

Parameters:
X,Y,Z: Position of the point the listener must look at

/////////////////////////////////////////////////////////

static void sf::SFML_API::SetTarget ( const Vector3f Target) [static]

Change the orientation of the listener (the point he must look at) (take a 3D vector). The default target is (0, 0, -1)

Parameters:
Target: Position of the point the listener must look at

/////////////////////////////////////////////////////////

void sf::SFML_API::SetText ( const Unicode::Text &  Text)

Set the text (from any kind of string)

Parameters:
Text: New text

/////////////////////////////////////////////////////////

void sf::SFML_API::SetTexture ( const std::string &  Name,
Image Texture 
)

Set a texture parameter.

Parameters:
Name: Texture name in the effect
Texture: Image to set (pass NULL to use content of current framebuffer)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetView ( const View NewView)

Change the current active view.

Parameters:
NewView: New view to use (pass GetDefaultView() to set the default view)

/////////////////////////////////////////////////////////

void sf::SFML_API::SetVolume ( float  Volume)

Set the sound volume. The default volume is 100.

Parameters:
Volume: Volume (in range [0, 100])

/////////////////////////////////////////////////////////

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

Set the X position of the object.

Parameters:
X: New X coordinate

/////////////////////////////////////////////////////////

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

Set the Y position of the object.

Parameters:
Y: New Y coordinate

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

void sf::SFML_API::Show ( bool  State)

Show or hide the window.

Parameters:
State: True to show, false to hide

/////////////////////////////////////////////////////////

void sf::SFML_API::ShowMouseCursor ( bool  Show)

Show or hide the mouse cursor.

Parameters:
Show: True to show, false to hide

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::SocketTCP ( SocketHelper::SocketType  Descriptor) [private]

Construct the socket from a socket descriptor (for internal use only)

Parameters:
Descriptor: Socket descriptor

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::SocketUDP ( SocketHelper::SocketType  Descriptor) [private]

Construct the socket from a socket descriptor (for internal use only)

Parameters:
Descriptor: Socket descriptor

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Sound ( const SoundBuffer Buffer,
bool  Loop = false,
float  Pitch = 1.f,
float  Volume = 100.f,
const Vector3f Position = Vector3f(0, 0, 0) 
) [explicit]

Construct the sound from its parameters.

Parameters:
Buffer: Sound buffer to play (NULL by default)
Loop: Loop flag (false by default)
Pitch: Value of the pitch (1 by default)
Volume: Volume (100 by default)
Position: Position (0, 0, 0 by default)

/////////////////////////////////////////////////////////

sf::SFML_API::Sound ( const Sound Copy)

Copy constructor.

Parameters:
Copy: Instance to copy

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

Copy constructor.

Parameters:
Copy: Instance to copy

/////////////////////////////////////////////////////////

sf::SFML_API::SoundRecorder ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::SoundStream ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Sprite ( const Image Img,
const Vector2f Position = Vector2f(0, 0),
const Vector2f Scale = Vector2f(1, 1),
float  Rotation = 0.f,
const Color Col = Color(255, 255, 255, 255) 
) [explicit]

Construct the sprite from a source image.

Parameters:
Img: Image of the sprite
Position: Position of the sprite (0, 0 by default)
Scale: Scale factor (1, 1 by default)
Rotation: Orientation, in degrees (0 by default)
Col: Color of the sprite (white by default)

/////////////////////////////////////////////////////////

void sf::SFML_API::Start ( unsigned int  SampleRate = 44100)

Start the capture. Warning : only one capture can happen at the same time.

Parameters:
SampleRate: Sound frequency (the more samples, the higher the quality) (44100 by default = CD quality)

/////////////////////////////////////////////////////////

Stop the capture.

/////////////////////////////////////////////////////////

Stop playing the audio stream.

/////////////////////////////////////////////////////////

Stop the sound.

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::String ( const Unicode::Text &  Text,
const Font CharFont = Font::GetDefaultFont(),
float  Size = 30.f 
) [explicit]

Construct the string from any kind of text.

Parameters:
Text: Text assigned to the string
Font: Font used to draw the string (SFML built-in font by default)
Size: Characters size (30 by default)

/////////////////////////////////////////////////////////

Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.

/////////////////////////////////////////////////////////

Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself.

/////////////////////////////////////////////////////////

sf::SFML_API::Thread ( FuncType  Function,
void *  UserData = NULL 
)

Construct the thread from a function pointer.

Parameters:
Function: Entry point of the thread
UserData: Data to pass to the thread function (NULL by default)

/////////////////////////////////////////////////////////

sf::SFML_API::Thread ( FuncType  Function,
void *  UserData = NULL 
)

Construct the thread from a function pointer.

Parameters:
Function: Entry point of the thread
UserData: Data to pass to the thread function (NULL by default)

/////////////////////////////////////////////////////////

sf::SFML_API::Thread ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Thread ( ) [protected]

Default constructor.

/////////////////////////////////////////////////////////

static unsigned int __stdcall sf::SFML_API::ThreadFunc ( void *  UserData) [static, private]

Actual thread entry point, dispatches to instances.

Parameters:
UserData: Data to pass to the thread function
Returns:
Error code

/////////////////////////////////////////////////////////

static void* sf::SFML_API::ThreadFunc ( void *  UserData) [static, private]

Actual thread entry point, dispatches to instances.

Parameters:
UserData: Data to pass to the thread function
Returns:
Error code

/////////////////////////////////////////////////////////

Uint32 sf::SFML_API::ToInteger ( ) const

Get an integer representation of the address.

Returns:
32-bits integer containing the 4 bytes of the address, in system endianness

/////////////////////////////////////////////////////////

std::string sf::SFML_API::ToString ( ) const

Get a string representation of the address.

Returns:
String representation of the IP address ("xxx.xxx.xxx.xxx")

/////////////////////////////////////////////////////////

Here is the caller graph for this function:

Vector2f sf::SFML_API::Transform ( const Vector2f Point) const

Transform a point by the matrix.

Parameters:
Point: Point to transform
Returns:
Transformed point

/////////////////////////////////////////////////////////

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

Parameters:
Point: Point to transform
Returns:
Transformed point

/////////////////////////////////////////////////////////

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

Parameters:
Point: Point to transform
Returns:
Transformed point

/////////////////////////////////////////////////////////

Unbind the socket from its previous port, if any.

Returns:
True if operation has been successful

/////////////////////////////////////////////////////////

Unlock the mutex.

/////////////////////////////////////////////////////////

Unlock the mutex.

/////////////////////////////////////////////////////////

bool sf::SFML_API::Update ( unsigned int  ChannelsCount,
unsigned int  SampleRate 
) [private]

Update the internal buffer with the audio samples.

Parameters:
ChannelsCount: Number of channels
SampleRate: Sample rate
Returns:
True on success

/////////////////////////////////////////////////////////

Response sf::SFML_API::Upload ( const std::string &  LocalFile,
const std::string &  DestPath,
TransferMode  Mode = Binary 
)

Upload a file to the server.

Parameters:
LocalFile: Path of the local file to upload
DestPath: Where to put to file on the server
Mode: Transfer mode (binary by default)
Returns:
Server response to the request

/////////////////////////////////////////////////////////

void sf::SFML_API::UseVerticalSync ( bool  Enabled)

Enable / disable vertical synchronization.

Parameters:
Enabled: True to enable v-sync, false to deactivate

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF16ToUTF32 ( In  Begin,
In  End,
Out  Output,
Uint32  Replacement = '?' 
) [static]

Generic function to convert an UTF-16 characters range to an UTF-32 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF16ToUTF8 ( In  Begin,
In  End,
Out  Output,
Uint8  Replacement = '?' 
) [static]

Generic function to convert an UTF-16 characters range to an UTF-8 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF32ToANSI ( In  Begin,
In  End,
Out  Output,
char  Replacement = '?',
const std::locale &  Locale = GetDefaultLocale() 
) [static]

Generic function to convert an UTF-32 characters range to an ANSI characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Locale: Locale to use for conversion (uses the current one by default)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF32ToUTF16 ( In  Begin,
In  End,
Out  Output,
Uint16  Replacement = '?' 
) [static]

Generic function to convert an UTF-32 characters range to an UTF-16 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF32ToUTF8 ( In  Begin,
In  End,
Out  Output,
Uint8  Replacement = '?' 
) [static]

Generic function to convert an UTF-32 characters range to an UTF-8 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF8ToUTF16 ( In  Begin,
In  End,
Out  Output,
Uint16  Replacement = '?' 
) [static]

Generic function to convert an UTF-8 characters range to an UTF-16 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

template<typename In , typename Out >
static Out sf::SFML_API::UTF8ToUTF32 ( In  Begin,
In  End,
Out  Output,
Uint32  Replacement = '?' 
) [static]

Generic function to convert an UTF-8 characters range to an UTF-32 characters range, using the given locale.

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 character for characters not convertible to output encoding ('?' by default -- use 0 to use no replacement character)
Returns:
Iterator to the end of the output sequence which has been written

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::VideoMode ( unsigned int  ModeWidth,
unsigned int  ModeHeight,
unsigned int  ModeBpp = 32 
)

Construct the video mode with its attributes.

Parameters:
ModeWidth: Width in pixels
ModeHeight: Height in pixels
ModeBpp: Pixel depths in bits per pixel (32 by default)

/////////////////////////////////////////////////////////

sf::SFML_API::View ( const FloatRect ViewRect = FloatRect(0, 0, 1000, 1000)) [explicit]

Construct the view from a rectangle.

Parameters:
ViewRect: Rectangle defining the position and size of the view (1000x1000 by default)

/////////////////////////////////////////////////////////

sf::SFML_API::View ( const sf::Vector2f Center,
const sf::Vector2f HalfSize 
)

Construct the view from its center and half-size.

Parameters:
Center: Center of the view
HalfSize: Half-size of the view (from center to corner)

/////////////////////////////////////////////////////////

Wait until the thread finishes.

/////////////////////////////////////////////////////////

Wait until the thread finishes.

/////////////////////////////////////////////////////////

unsigned int sf::SFML_API::Wait ( float  Timeout = 0.f)

Wait and collect sockets which are ready for reading. This functions will return either when at least one socket is ready, or when the given time is out.

Parameters:
Timeout: Timeout, in seconds (0 by default : no timeout)
Returns:
Number of sockets ready to be read

/////////////////////////////////////////////////////////

Default constructor.

/////////////////////////////////////////////////////////

sf::SFML_API::Window ( VideoMode  Mode,
const std::string &  Title,
unsigned long  WindowStyle = Style::Resize|Style::Close,
const WindowSettings Params = WindowSettings() 
)

Construct a new window.

Parameters:
Mode: Video mode to use
Title: Title of the window
WindowStyle: Window style, see sf::Style (Resize | Close by default)
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

sf::SFML_API::Window ( WindowHandle  Handle,
const WindowSettings Params = WindowSettings() 
)

Construct the window from an existing control.

Parameters:
Handle: Platform-specific handle of the control
Params: Creation parameters (see default constructor for default values)

/////////////////////////////////////////////////////////

void sf::SFML_API::Zoom ( float  Factor)

Resize the view rectangle to simulate a zoom / unzoom effect.

Parameters:
Factor: Zoom factor to apply, relative to the current zoom

/////////////////////////////////////////////////////////


Friends And Related Function Documentation

friend class DataChannel [friend]

Definition at line 435 of file Ftp.hpp.

friend class priv::FontLoader [friend]

Definition at line 127 of file Font.hpp.

RenderTarget [friend]

Definition at line 325 of file Drawable.hpp.

friend class Selector< SocketTCP > [friend]

Definition at line 194 of file SocketTCP.hpp.

friend class Selector< SocketUDP > [friend]

Definition at line 194 of file SocketUDP.hpp.

friend class SocketTCP [friend]

Definition at line 144 of file Packet.hpp.

friend class SocketUDP [friend]

Definition at line 145 of file Packet.hpp.

friend class Sound [friend]

Definition at line 167 of file SoundBuffer.hpp.

friend class SoundStream [friend]

Definition at line 302 of file Sound.hpp.


Member Data Documentation

Alpha (transparency) component.

Definition at line 119 of file Color.hpp.

Offset to move horizontically to the next character.

Definition at line 53 of file Glyph.hpp.

Blue component.

Definition at line 118 of file Color.hpp.

Video mode pixel depth, in bits per pixels.

Definition at line 123 of file VideoMode.hpp.

const Color sf::SFML_API::Black [static]

Black predefined color.

Definition at line 104 of file Color.hpp.

const Color sf::SFML_API::Blue [static]

Blue predefined color.

Definition at line 108 of file Color.hpp.

const Color sf::SFML_API::Cyan [static]

Cyan predefined color.

Definition at line 111 of file Color.hpp.

Green component.

Definition at line 117 of file Color.hpp.

const Color sf::SFML_API::Green [static]

Green predefined color.

Definition at line 107 of file Color.hpp.

unsigned int sf::SFML_API::Height

Video mode height, in pixels.

Definition at line 122 of file VideoMode.hpp.

Identity matrix.

Definition at line 133 of file Matrix3.hpp.

Local host address (to connect to the same computer)

Definition at line 196 of file IPAddress.hpp.

const Color sf::SFML_API::Magenta [static]

Magenta predefined color.

Definition at line 110 of file Color.hpp.

Uint32 sf::SFML_API::myAddress [private]

Address stored as an unsigned 32 bits integer.

Definition at line 203 of file IPAddress.hpp.

Bounding rectangle of the text in object coordinates.

Definition at line 184 of file String.hpp.

Blending mode.

Definition at line 351 of file Drawable.hpp.

Sound buffer that will contain the recorded data.

Definition at line 78 of file SoundBufferRecorder.hpp.

unsigned int sf::SFML_API::myBuffer [private]

OpenAL buffer identifier.

Definition at line 204 of file SoundBuffer.hpp.

Sound buffer bound to the source.

Definition at line 308 of file Sound.hpp.

unsigned int sf::SFML_API::myBuffers[BuffersCount] [private]

Sound buffers used to store temporary audio data.

Definition at line 216 of file SoundStream.hpp.

Center of the view.

Definition at line 178 of file View.hpp.

Origin of translation / rotation / scaling of the object.

Definition at line 348 of file Drawable.hpp.

unsigned int sf::SFML_API::myChannelsCount [private]

Number of channels (1 = mono, 2 = stereo, ...)

Definition at line 217 of file SoundStream.hpp.

unsigned int sf::SFML_API::myCharSize [private]

Size of characters in the bitmap font.

Definition at line 138 of file Font.hpp.

Clock for measuring the elapsed time between frames.

Definition at line 314 of file Window.hpp.

Overlay color of the object.

Definition at line 350 of file Drawable.hpp.

Socket holding the control connection with the server.

Definition at line 442 of file Ftp.hpp.

Connection to the host.

Definition at line 331 of file Http.hpp.

Current active view.

Definition at line 158 of file RenderTarget.hpp.

float sf::SFML_API::myData[16] [private]

Definition at line 140 of file Matrix3.hpp.

std::vector<char> sf::SFML_API::myData [private]

Data stored in the packet.

Definition at line 179 of file Packet.hpp.

Default view.

Definition at line 157 of file RenderTarget.hpp.

Dummy window holding the context.

Definition at line 94 of file Context.hpp.

float sf::SFML_API::myDuration [private]

Music duration, in seconds.

Sound duration, in seconds.

Definition at line 113 of file Music.hpp.

Each buffer is marked as "end buffer" or not, for proper duration calculation.

Definition at line 222 of file SoundStream.hpp.

std::queue<Event> sf::SFML_API::myEvents [private]

Queue of received events.

Definition at line 312 of file Window.hpp.

Sound file.

Definition at line 112 of file Music.hpp.

Font used to display the string.

Definition at line 181 of file String.hpp.

unsigned long sf::SFML_API::myFormat [private]

Format of the internal sound buffers.

Definition at line 219 of file SoundStream.hpp.

std::string sf::SFML_API::myFragmentShader [private]

Fragment shader source code.

Definition at line 187 of file PostFX.hpp.

Image sf::SFML_API::myFrameBuffer [mutable, private]

Texture containing the current frame buffer.

Definition at line 188 of file PostFX.hpp.

unsigned int sf::SFML_API::myFramerateLimit [private]

Current framerate limit.

Definition at line 318 of file Window.hpp.

Function to call as the thread entry point.

Definition at line 117 of file Thread.hpp.

std::map<Uint32, Glyph> sf::SFML_API::myGlyphs [private]

Rendering settings of each character (glyph)

Definition at line 139 of file Font.hpp.

Half-size of the view.

Definition at line 179 of file View.hpp.

CRITICAL_SECTION sf::SFML_API::myHandle [private]

Win32 handle of the mutex.

Definition at line 78 of file Mutex.hpp.

HANDLE sf::SFML_API::myHandle [private]

Win32 thread handle.

Definition at line 115 of file Thread.hpp.

unsigned int sf::SFML_API::myHeight [private]

Image Height.

Definition at line 319 of file Image.hpp.

Web host address.

Definition at line 332 of file Http.hpp.

std::string sf::SFML_API::myHostName [private]

Web host name.

Definition at line 333 of file Http.hpp.

Image used to draw the sprite.

Definition at line 167 of file Sprite.hpp.

Input manager connected to window.

Definition at line 313 of file Window.hpp.

Matrix3 sf::SFML_API::myInvMatrix [mutable, private]

Precomputed inverse transform matrix gathering the translation / rotation / scale / center.

Definition at line 355 of file Drawable.hpp.

bool sf::SFML_API::myInvNeedUpdate [mutable, private]

Do we need to recompute the inverse transform matrix ?

Definition at line 353 of file Drawable.hpp.

bool sf::SFML_API::myIsActive [private]

Thread state (active or inactive)

Definition at line 116 of file Thread.hpp.

Is the socket blocking or non-blocking ?

Definition at line 221 of file SocketTCP.hpp.

Capturing state.

Definition at line 142 of file SoundRecorder.hpp.

Compiled state of the shape.

Definition at line 304 of file Shape.hpp.

bool sf::SFML_API::myIsDrawing [private]

True when Draw is called from inside, to allow some renderstates optimizations.

Definition at line 160 of file RenderTarget.hpp.

Tell whether the window is internal or external (created by SFML or not)

Definition at line 317 of file Window.hpp.

Should we draw the inside if the shape ?

Definition at line 302 of file Shape.hpp.

Is the sprite flipped on the X axis ?

Definition at line 169 of file Sprite.hpp.

Is the sprite flipped on the Y axis ?

Definition at line 170 of file Sprite.hpp.

Should we draw the outline if the shape ?

Definition at line 303 of file Shape.hpp.

bool sf::SFML_API::myIsSmooth [private]

Status of the smooth filter.

Definition at line 323 of file Image.hpp.

Streaming state (true = playing, false = stopped)

Definition at line 215 of file SoundStream.hpp.

bool sf::SFML_API::myIsValid [private]

Reading state of the packet.

Definition at line 181 of file Packet.hpp.

Joysticks position on each axis.

Definition at line 134 of file Input.hpp.

Array containing the state of all joysticks buttons.

Definition at line 133 of file Input.hpp.

Array containing the state of all keyboard keys.

Definition at line 129 of file Input.hpp.

Time elapsed since last frame.

Definition at line 316 of file Window.hpp.

bool sf::SFML_API::myLoop [private]

Loop flag (true to loop, false to play once)

Definition at line 220 of file SoundStream.hpp.

Matrix3 sf::SFML_API::myMatrix [mutable, private]

Precomputed transform matrix gathering the translation / rotation / scale / center.

Precomputed projection matrix corresponding to the view.

Definition at line 354 of file Drawable.hpp.

Maximum socket index.

Definition at line 106 of file SelectorBase.hpp.

Array containing the state of all mouse buttons.

Definition at line 130 of file Input.hpp.

int sf::SFML_API::myMouseX [private]

Mouse position on X.

Definition at line 131 of file Input.hpp.

int sf::SFML_API::myMouseY [private]

Mouse position on Y.

Definition at line 132 of file Input.hpp.

Mutex to lock / unlock.

Definition at line 65 of file Lock.hpp.

pthread_mutex_t sf::SFML_API::myMutex [private]

pthread instance of the mutex

Definition at line 76 of file Mutex.hpp.

bool sf::SFML_API::myNeedArrayUpdate [mutable, private]

Status of synchronization between pixels in central memory and the internal texture un video memory.

Definition at line 326 of file Image.hpp.

Does the bounding rect need an update ?

Definition at line 185 of file String.hpp.

bool sf::SFML_API::myNeedTextureUpdate [mutable, private]

Status of synchronization between pixels in central memory and the internal texture un video memory.

Definition at line 325 of file Image.hpp.

bool sf::SFML_API::myNeedUpdate [mutable, private]

Do we need to recompute the transform matrix ?

Internal state telling if the matrix needs to be updated.

Definition at line 352 of file Drawable.hpp.

float sf::SFML_API::myOutline [private]

Outline width.

Definition at line 301 of file Shape.hpp.

Data of the current pending packet header, if any.

Definition at line 217 of file SocketTCP.hpp.

Size of the current pending packet header, if any.

Definition at line 218 of file SocketTCP.hpp.

std::vector< char > sf::SFML_API::myPendingPacket [private]

Data of the current pending packet, if any.

Definition at line 219 of file SocketTCP.hpp.

Size of the current pending packet, if any.

Definition at line 220 of file SocketTCP.hpp.

std::vector<Color> sf::SFML_API::myPixels [mutable, private]

Pixels of the image.

Definition at line 324 of file Image.hpp.

std::vector<Point> sf::SFML_API::myPoints [private]

Points composing the shape.

Definition at line 300 of file Shape.hpp.

unsigned short sf::SFML_API::myPort [private]

Port used for connection with host.

Port to which the socket is bound.

Definition at line 334 of file Http.hpp.

Position of the object on screen.

Definition at line 346 of file Drawable.hpp.

Should we preserve external OpenGL states ?

Definition at line 159 of file RenderTarget.hpp.

std::size_t sf::SFML_API::myReadPos [private]

Current reading position in the packet.

Definition at line 180 of file Packet.hpp.

Rectangle defining the bounds of the view.

Definition at line 180 of file View.hpp.

float sf::SFML_API::myRotation [private]

Orientation of the object, in degrees.

Definition at line 349 of file Drawable.hpp.

unsigned int sf::SFML_API::mySampleRate [private]

Sample rate.

Frequency (samples / second)

Definition at line 141 of file SoundRecorder.hpp.

std::vector< Int16 > sf::SFML_API::mySamples [private]

Temporary buffer of samples.

Buffer to store captured samples.

Temporary sample buffer to hold the recorded data.

Samples buffer.

Definition at line 114 of file Music.hpp.

unsigned int sf::SFML_API::mySamplesProcessed [private]

Number of buffers processed since beginning of the stream.

Definition at line 221 of file SoundStream.hpp.

Scale of the object.

Definition at line 347 of file Drawable.hpp.

fd_set sf::SFML_API::mySet [private]

Set of socket to watch.

Definition at line 104 of file SelectorBase.hpp.

X coordinate passed to the last call to SetCursorPosition.

Definition at line 319 of file Window.hpp.

Y coordinate passed to the last call to SetCursorPosition.

Definition at line 320 of file Window.hpp.

fd_set sf::SFML_API::mySetReady [private]

Set of socket which are ready for reading.

Definition at line 105 of file SelectorBase.hpp.

Creation settings of the window.

Definition at line 315 of file Window.hpp.

unsigned int sf::SFML_API::myShaderProgram [private]

OpenGL identifier for the program.

Definition at line 185 of file PostFX.hpp.

float sf::SFML_API::mySize [private]

Size of the characters.

Definition at line 182 of file String.hpp.

SocketHelper::SocketType sf::SFML_API::mySocket [private]

Socket descriptor.

Socket identifier.

Definition at line 216 of file SocketTCP.hpp.

SoundList sf::SFML_API::mySounds [mutable, private]

List of sounds that are using this buffer.

Definition at line 207 of file SoundBuffer.hpp.

unsigned int sf::SFML_API::mySource [private]

OpenAL source identifier.

Definition at line 307 of file Sound.hpp.

double sf::SFML_API::myStartTime [private]

Time of last reset.

Definition at line 68 of file Clock.hpp.

unsigned long sf::SFML_API::myStyle [private]

Text style (see Style enum)

Definition at line 183 of file String.hpp.

Sub-rectangle of source image to assign to the sprite.

Definition at line 168 of file Sprite.hpp.

Unicode::Text sf::SFML_API::myText [private]

Text to display.

Definition at line 180 of file String.hpp.

Texture holding the bitmap font.

Definition at line 137 of file Font.hpp.

unsigned int sf::SFML_API::myTexture [private]

Internal texture identifier.

Definition at line 322 of file Image.hpp.

unsigned int sf::SFML_API::myTextureHeight [private]

Actual texture height (can be greater than image height because of padding)

Definition at line 321 of file Image.hpp.

Texture variables in the effect.

Definition at line 186 of file PostFX.hpp.

unsigned int sf::SFML_API::myTextureWidth [private]

Actual texture width (can be greater than image width because of padding)

Definition at line 320 of file Image.hpp.

pthread_t sf::SFML_API::myThread [private]

Unix thread instance.

Definition at line 115 of file Thread.hpp.

void * sf::SFML_API::myUserData [private]

Data to pass to the thread function.

Definition at line 118 of file Thread.hpp.

unsigned int sf::SFML_API::myWidth [private]

Image width.

Definition at line 318 of file Image.hpp.

Platform-specific implementation of window.

Definition at line 311 of file Window.hpp.

Uint32 sf::SFML_API::ourDefaultCharset[] [static, private]

The default charset (all printable ISO-8859-1 characters)

Definition at line 132 of file Font.hpp.

unsigned int sf::SFML_API::ourSeed [static, private]

Definition at line 88 of file Randomizer.hpp.

Red component.

Definition at line 116 of file Color.hpp.

Bounding rectangle of the glyph, in relative coordinates.

Definition at line 54 of file Glyph.hpp.

const Color sf::SFML_API::Red [static]

Red predefined color.

Definition at line 106 of file Color.hpp.

Texture coordinates of the glyph inside the bitmap font.

Definition at line 55 of file Glyph.hpp.

const Uint8 sf::SFML_API::UTF8FirstBytes[7] [static, private]

First bytes for UTF-8 sequences.

Definition at line 282 of file Unicode.hpp.

const Uint32 sf::SFML_API::UTF8Offsets[6] [static, private]

Magic values to subtract during UTF-8 conversions.

Definition at line 281 of file Unicode.hpp.

const int sf::SFML_API::UTF8TrailingBytes[256] [static, private]

Lookup table to find the length of an UTF-8 sequence.

Definition at line 280 of file Unicode.hpp.

const Color sf::SFML_API::White [static]

White predefined color.

Definition at line 105 of file Color.hpp.

unsigned int sf::SFML_API::Width

Video mode width, in pixels.

Definition at line 121 of file VideoMode.hpp.

const Color sf::SFML_API::Yellow [static]

Yellow predefined color.

Definition at line 109 of file Color.hpp.


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