mirror of
https://github.com/SFML/SFML.git
synced 2024-11-25 04:41:05 +08:00
73 lines
2.1 KiB
C++
73 lines
2.1 KiB
C++
|
////////////////////////////////////////////////////////////
|
||
|
|
/// \mainpage
|
||
|
|
///
|
||
|
|
/// \section welcome Welcome
|
||
|
|
/// Welcome to the official SFML documentation. Here you will find a detailed
|
||
|
|
/// view of all the SFML <a href="./annotated.htm">classes</a>, as well as source
|
||
|
|
/// <a href="./files.htm">files</a>. <br/>
|
||
|
|
/// If you are looking for tutorials, you can visit the official website
|
||
|
|
/// at <a href="http://www.sfml-dev.org/tutorials/">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 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;
|
||
|
|
/// }
|
||
|
|
/// \endcode
|
||
|
|
////////////////////////////////////////////////////////////
|