1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
////////////////////////////////////////////////////////////
/// \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.html">functions</a>.<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 in C :
///
/// \code
///
/// #include <CSFML/Audio.h>
/// #include <CSFML/Graphics.h>
///
/// int main()
/// {
/// sfVideoMode mode = {{800, 600}, 32};
/// sfRenderWindow* window;
/// sfTexture* texture;
/// sfSprite* sprite;
/// sfFont* font;
/// sfText* text;
/// sfMusic* music;
/// sfEvent event;
///
/// /* Create the main window */
/// window = sfRenderWindow_create(mode, "SFML window", sfResize | sfClose, NULL);
/// if (!window)
/// return EXIT_FAILURE;
///
/// /* Load a sprite to display */
/// texture = sfTexture_createFromFile("cute_image.jpg", NULL);
/// if (!texture)
/// return EXIT_FAILURE;
/// sprite = sfSprite_create();
/// sfSprite_setTexture(sprite, texture, true);
///
/// /* Create a graphical text to display */
/// font = sfFont_createFromFile("arial.ttf");
/// if (!font)
/// return EXIT_FAILURE;
/// text = sfText_create();
/// sfText_setString(text, "Hello SFML");
/// sfText_setFont(text, font);
/// sfText_setCharacterSize(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_isOpen(window))
/// {
/// /* Process events */
/// while (sfRenderWindow_pollEvent(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, NULL);
///
/// /* Draw the text */
/// sfRenderWindow_drawText(window, text, NULL);
///
/// /* Update the window */
/// sfRenderWindow_display(window);
/// }
///
/// /* Cleanup resources */
/// sfMusic_destroy(music);
/// sfText_destroy(text);
/// sfFont_destroy(font);
/// sfSprite_destroy(sprite);
/// sfTexture_destroy(texture);
/// sfRenderWindow_destroy(window);
///
/// return EXIT_SUCCESS;
/// }
/// \endcode
////////////////////////////////////////////////////////////
|