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

Document new Window methods

Browse Source
This commit is contained in:
Dmitry Marakasov 2014-12-26 21:51:16 +03:00
parent e67394628c
commit 28a08d9071
1 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
SDL2pp/Window.hh
View File

@ -146,15 +146,85 @@ public:
////////////////////////////////////////////////////////////
SDL_Window* Get() const;
////////////////////////////////////////////////////////////
/// \brief Make a window as large as possible
///
/// \see http://wiki.libsdl.org/SDL_MaximizeWindow
///
////////////////////////////////////////////////////////////
void Maximize();
////////////////////////////////////////////////////////////
/// \brief Minimize a window to an iconic representation
///
/// \see http://wiki.libsdl.org/SDL_MinimizeWindow
///
////////////////////////////////////////////////////////////
void Minimize();
////////////////////////////////////////////////////////////
/// \brief Hide a window
///
/// \see http://wiki.libsdl.org/SDL_HideWindow
///
////////////////////////////////////////////////////////////
void Hide();
////////////////////////////////////////////////////////////
/// \brief Restore the size and position of a minimized or maximized window
///
/// \see http://wiki.libsdl.org/SDL_RestoreWindow
///
////////////////////////////////////////////////////////////
void Restore();
////////////////////////////////////////////////////////////
/// \brief Raise a window above other windows and set the input focus
///
/// \see http://wiki.libsdl.org/SDL_RaiseWindow
///
////////////////////////////////////////////////////////////
void Raise();
////////////////////////////////////////////////////////////
/// \brief Show a window
///
/// \see http://wiki.libsdl.org/SDL_ShowWindow
///
////////////////////////////////////////////////////////////
void Show();
////////////////////////////////////////////////////////////
/// \brief Set a window's fullscreen state
///
/// \param flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0
///
/// \throws SDL2pp::Exception
///
/// \see http://wiki.libsdl.org/SDL_SetWindowFullscreen
///
////////////////////////////////////////////////////////////
void SetFullscreen(int flags);
////////////////////////////////////////////////////////////
/// \brief Set the size of a window's client area
///
/// \param w Width of the window in pixles
/// \param h Height of the window in pixles
///
/// \see http://wiki.libsdl.org/SDL_SetWindowSize
///
////////////////////////////////////////////////////////////
void SetSize(int w, int h);
////////////////////////////////////////////////////////////
/// \brief Set the size of a window's client area
///
/// \param size Point representin window dimensions
///
/// \see http://wiki.libsdl.org/SDL_SetWindowSize
///
////////////////////////////////////////////////////////////
void SetSize(const Point& size);
};