TheCloud/libSDL2pp
1
0
Fork 0
mirror of https://github.com/libSDL2pp/libSDL2pp.git synced 2025-08-03 19:05:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added EventWait documentation

Browse Source
This commit is contained in:
Vraiment 2017-07-23 01:19:59 -07:00
parent 10c653b815
commit 7d3e54a29f
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
SDL2pp/EventWait.hh
View File

@ -28,8 +28,47 @@
namespace SDL2pp {
namespace Event {
////////////////////////////////////////////////////////////
/// \brief Waits indefinitely for an event
///
/// This function waits for the next available event. This
/// function WILL STOP the program execution until an event
/// is available.
///
/// \ingroup events
///
/// \headerfile SDL2pp/EventWait.hh
///
/// \returns The event that was available
///
/// \throws SDL2pp::Exception
///
/// \see https://wiki.libsdl.org/SDL_WaitEvent
///
////////////////////////////////////////////////////////////
SDL_Event WaitEvent();
////////////////////////////////////////////////////////////
/// \brief Waits a given amount of time for an event
///
/// This function waits for the next available event for
/// specified amount of time. This function WILL STOP the
/// program execution until the given amount of time runs out
/// or an event is available.
///
/// \ingroup events
///
/// \headerfile SDL2pp/EventWait.hh
///
/// \param[in] timeout The amount of time to wait for an event
///
/// \returns The last event that was available
///
/// \throws SDL2pp::Exception
///
/// \see https://wiki.libsdl.org/SDL_WaitEvent
///
////////////////////////////////////////////////////////////
Optional<SDL_Event> WaitEvent(int timeout);
}
}