mirror of
https://github.com/SFML/SFML.git
synced 2024-11-28 22:31:09 +08:00
9c959777d3
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1171 4e206d99-4929-0410-ac5d-dfc041789085
96 lines
3.0 KiB
C++
96 lines
3.0 KiB
C++
////////////////////////////////////////////////////////////
|
|
/// \mainpage
|
|
///
|
|
/// \section welcome Welcome
|
|
/// Welcome to the official SFML documentation for C. Here you will find a detailed
|
|
/// view of all the SFML <a href="./globals_func.htm">functions</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 in C :
|
|
///
|
|
/// \code
|
|
///
|
|
/// #include <SFML/Audio.h>
|
|
/// #include <SFML/Graphics.h>
|
|
///
|
|
/// int main()
|
|
/// {
|
|
/// sfWindowSettings settings = {24, 8, 0};
|
|
/// sfVideoMode mode = {800, 600, 32};
|
|
/// sfRenderWindow* window;
|
|
/// sfImage* image;
|
|
/// sfSprite* sprite;
|
|
/// sfFont* font;
|
|
/// sfString* text;
|
|
/// sfMusic* music;
|
|
/// sfEvent event;
|
|
///
|
|
/// /* Create the main window */
|
|
/// window = sfRenderWindow_Create(mode, "SFML window", sfResize | sfClose, settings);
|
|
/// if (!window)
|
|
/// return EXIT_FAILURE;
|
|
///
|
|
/// /* Load a sprite to display */
|
|
/// image = sfImage_CreateFromFile("cute_image.jpg");
|
|
/// if (!image)
|
|
/// return EXIT_FAILURE;
|
|
/// sprite = sfSprite_Create();
|
|
/// sfSprite_SetImage(sprite, image);
|
|
///
|
|
/// /* Create a graphical string to display */
|
|
/// font = sfFont_CreateFromFile("arial.ttf", 50, NULL);
|
|
/// if (!font)
|
|
/// return EXIT_FAILURE;
|
|
/// text = sfString_Create();
|
|
/// sfString_SetText(text, "Hello SFML");
|
|
/// sfString_SetFont(text, font);
|
|
/// sfString_SetSize(text, 50);
|
|
///
|
|
/// /* Load a music to play */
|
|
/// music = sfMusic_CreateFromFile("nice_music.ogg");
|
|
/// if (!music)
|
|
/// return EXIT_FAILURE;
|
|
///
|
|
/// /* Play the music */
|
|
/// sfMusic_Play(music);
|
|
///
|
|
/// /* Start the game loop */
|
|
/// while (sfRenderWindow_IsOpened(window))
|
|
/// {
|
|
/// /* Process events */
|
|
/// while (sfRenderWindow_GetEvent(window, &event))
|
|
/// {
|
|
/// /* Close window : exit */
|
|
/// if (event.Type == sfEvtClosed)
|
|
/// sfRenderWindow_Close(window);
|
|
/// }
|
|
///
|
|
/// /* Clear the screen */
|
|
/// sfRenderWindow_Clear(window, sfBlack);
|
|
///
|
|
/// /* Draw the sprite */
|
|
/// sfRenderWindow_DrawSprite(window, sprite);
|
|
///
|
|
/// /* Draw the string */
|
|
/// sfRenderWindow_DrawString(window, text);
|
|
///
|
|
/// /* Update the window */
|
|
/// sfRenderWindow_Display(window);
|
|
/// }
|
|
///
|
|
/// /* Cleanup resources */
|
|
/// sfMusic_Destroy(music);
|
|
/// sfString_Destroy(text);
|
|
/// sfFont_Destroy(font);
|
|
/// sfSprite_Destroy(sprite);
|
|
/// sfImage_Destroy(image);
|
|
/// sfRenderWindow_Destroy(window);
|
|
///
|
|
/// return EXIT_SUCCESS;
|
|
/// }
|
|
/// \endcode
|
|
////////////////////////////////////////////////////////////
|