SFML

Welcome

Welcome to the official SFML documentation. Here you will find a detailed view of all the SFML classes, as well as source files.
If you are looking for tutorials, you can visit the official website at www.sfml-dev.org.

Short example

Here is a short example, to show you how simple it is to use SFML :

#include <SFML/Audio.hpp>
#include <SFML/Graphics.hpp>
int main()
{
// Create the main window
sf::RenderWindow App(sf::VideoMode(800, 600), "SFML window");
// Load a sprite to display
sf::Image Image;
if (!Image.LoadFromFile("cute_image.jpg"))
return EXIT_FAILURE;
sf::Sprite Sprite(Image);
// Create a graphical string to display
sf::Font Arial;
if (!Arial.LoadFromFile("arial.ttf"))
return EXIT_FAILURE;
sf::String Text("Hello SFML", Arial, 50);
// Load a music to play
sf::Music Music;
if (!Music.OpenFromFile("nice_music.ogg"))
return EXIT_FAILURE;
// Play the music
Music.Play();
// Start the game loop
while (App.IsOpened())
{
// Process events
sf::Event Event;
while (App.GetEvent(Event))
{
// Close window : exit
if (Event.Type == sf::Event::Closed)
App.Close();
}
// Clear screen
App.Clear();
// Draw the sprite
App.Draw(Sprite);
// Draw the string
App.Draw(Text);
// Update the window
App.Display();
}
return EXIT_SUCCESS;
}
Event defines a system event and its parameters.
Definition Event.hpp:198
EventType Type
Type of the event.
Definition Event.hpp:303
Font is the low-level class for loading and manipulating character fonts.
Definition Font.hpp:55
bool LoadFromFile(const std::string &Filename, unsigned int CharSize=30, const Unicode::Text &Charset=ourDefaultCharset)
Load the font from a file.
Definition Font.cpp:74
Image is the low-level class for loading and manipulating images.
Definition Image.hpp:47
bool LoadFromFile(const std::string &Filename)
Load the image from a file.
Definition Image.cpp:123
Music defines a big sound played using streaming, so usually what we call a music :).
Definition Music.hpp:48
bool OpenFromFile(const std::string &Filename)
Open a music file (doesn't play it – call Play() for that).
Definition Music.cpp:64
Simple wrapper for sf::Window that allows easy 2D rendering.
void Play()
Start playing the audio stream.
Sprite defines a sprite : texture, transformations, color, and draw on screen.
Definition Sprite.hpp:45
String defines a graphical 2D text, that can be drawn on screen.
Definition String.hpp:45
VideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for gett...
Definition VideoMode.hpp:43