mirrors/SFML
1
0
Fork 0
mirror of https://github.com/SFML/SFML.git synced 2024-11-24 20:31:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation of creating Music and Cursor

Browse Source
This commit is contained in:
copyrat90 2024-06-11 16:23:05 +09:00 committed by Lukas Dürrenberger
parent 571eee359f
commit 37ac80dbe5
3 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/mainpage.hpp
View File

@ -29,9 +29,7 @@
/// sf::Text text(font, "Hello SFML", 50);
///
/// // Load a music to play
/// sf::Music music;
/// if (!music.openFromFile("nice_music.ogg"))
/// return EXIT_FAILURE;
/// auto music = sf::Music::openFromFile("nice_music.ogg").value();
///
/// // Play the music
/// music.play();

10
include/SFML/Audio/Music.hpp
View File

@ -299,14 +299,8 @@ private:
///
/// Usage example:
/// \code
/// // Declare a new music
/// sf::Music music;
///
/// // Open it from an audio file
/// if (!music.openFromFile("music.ogg"))
/// {
/// // error...
/// }
/// // Open a music from an audio file
/// auto music = sf::Music::openFromFile("music.ogg").value();
///
/// // Change some parameters
/// music.setPosition(0, 1, 10); // change its 3D position

5
include/SFML/Window/Cursor.hpp
View File

@ -245,9 +245,8 @@ private:
///
/// // ... create window as usual ...
///
/// sf::Cursor cursor;
/// if (cursor.loadFromSystem(sf::Cursor::Type::Hand))
/// window.setMouseCursor(cursor);
/// const auto cursor = sf::Cursor::loadFromSystem(sf::Cursor::Type::Hand).value();
/// window.setMouseCursor(cursor);
/// \endcode
///
/// \see sf::WindowBase::setMouseCursor