mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 22:31:09 +08:00
71 lines
2.0 KiB
C++
71 lines
2.0 KiB
C++
////////////////////////////////////////////////////////////
|
|
/// \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. <br/>
|
|
/// If you are looking for tutorials, you can visit the official website
|
|
/// at <a href="https://www.sfml-dev.org/">www.sfml-dev.org</a>.
|
|
///
|
|
/// \section example Short example
|
|
/// Here is a short example, to show you how simple it is to use SFML:
|
|
///
|
|
/// \code
|
|
///
|
|
/// #include <SFML/Audio.hpp>
|
|
/// #include <SFML/Graphics.hpp>
|
|
///
|
|
/// int main()
|
|
/// {
|
|
/// // Create the main window
|
|
/// sf::RenderWindow window(sf::VideoMode({800, 600}), "SFML window");
|
|
///
|
|
/// // Load a sprite to display
|
|
/// sf::Texture texture;
|
|
/// if (!texture.loadFromFile("cute_image.jpg"))
|
|
/// return EXIT_FAILURE;
|
|
/// sf::Sprite sprite(texture);
|
|
///
|
|
/// // Create a graphical text to display
|
|
/// sf::Font font;
|
|
/// if (!font.loadFromFile("arial.ttf"))
|
|
/// return EXIT_FAILURE;
|
|
/// sf::Text text(font, "Hello SFML", 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 (window.isOpen())
|
|
/// {
|
|
/// // Process events
|
|
/// while (const auto maybeEvent = window.pollEvent())
|
|
/// {
|
|
/// const auto& event = *maybeEvent;
|
|
///
|
|
/// // Close window: exit
|
|
/// if (event.is<sf::Event::Closed>())
|
|
/// window.close();
|
|
/// }
|
|
///
|
|
/// // Clear screen
|
|
/// window.clear();
|
|
///
|
|
/// // Draw the sprite
|
|
/// window.draw(sprite);
|
|
///
|
|
/// // Draw the string
|
|
/// window.draw(text);
|
|
///
|
|
/// // Update the window
|
|
/// window.display();
|
|
/// }
|
|
/// }
|
|
/// \endcode
|
|
////////////////////////////////////////////////////////////
|