//////////////////////////////////////////////////////////// /// \mainpage SFML Documentation /// /// \section welcome Welcome /// Welcome to the official SFML documentation. Here you will find a detailed /// view of all the SFML classes and functions.
/// If you are looking for tutorials, you can visit the official website /// at www.sfml-dev.org. /// /// \section example Short example /// Here is a short example, to show you how simple it is to use SFML: /// /// \code /// /// #include /// #include /// /// int main() /// { /// // Create the main window /// sf::RenderWindow window(sf::VideoMode({800, 600}), "SFML window"); /// /// // Load a sprite to display /// const auto texture = sf::Texture::loadFromFile("cute_image.jpg").value(); /// sf::Sprite sprite(texture); /// /// // Create a graphical text to display /// const auto font = sf::Font::loadFromFile("arial.ttf").value(); /// sf::Text text(font, "Hello SFML", 50); /// /// // Load a music to play /// auto music = sf::Music::openFromFile("nice_music.ogg").value(); /// /// // Play the music /// music.play(); /// /// // Start the game loop /// while (window.isOpen()) /// { /// // Process events /// while (const std::optional event = window.pollEvent()) /// { /// // Close window: exit /// if (event->is()) /// window.close(); /// } /// /// // Clear screen /// window.clear(); /// /// // Draw the sprite /// window.draw(sprite); /// /// // Draw the string /// window.draw(text); /// /// // Update the window /// window.display(); /// } /// } /// \endcode ////////////////////////////////////////////////////////////