mirror of
https://github.com/SFML/CSFML.git
synced 2026-10-24 21:53:37 +02:00
94 lines
2.8 KiB
C++
94 lines
2.8 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>.<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 <SFML/Audio.h>
|
|
/// #include <SFML/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, sfTrue);
|
|
///
|
|
/// /* 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
|
|
////////////////////////////////////////////////////////////
|