GUI window object. More...

#include <SDL2pp/Window.hh>

Public Member Functions
	Window (SDL_Window *window)
	Construct from existing SDL_Window structure.

	Window (const std::string &title, int x, int y, int w, int h, Uint32 flags)
	Create window with specified title and dimensions.

virtual	~Window ()
	Destructor.

	Window (Window &&other) noexcept
	Move constructor.

Window &	operator= (Window &&other) noexcept
	Move assignment operator.

	Window (const Window &other)=delete
	Deleted copy constructor.

Window &	operator= (const Window &other)=delete
	Deleted assignment operator.

SDL_Window *	Get () const
	Get pointer to managed SDL_Window structure.

Point	GetSize () const
	Get dimensions of the window.

int	GetWidth () const
	Get width of the window.

int	GetHeight () const
	Get height of the window.

Point	GetDrawableSize () const
	Get drawable dimensions of the window.

int	GetDrawableWidth () const
	Get drawable width of the window.

int	GetDrawableHeight () const
	Get drawable height of the window.

Window &	SetTitle (const std::string &title)
	Set window title.

std::string	GetTitle () const
	Get window title.

Window &	Maximize ()
	Make a window as large as possible.

Window &	Minimize ()
	Minimize a window to an iconic representation.

Window &	Hide ()
	Hide a window.

Window &	Restore ()
	Restore the size and position of a minimized or maximized window.

Window &	Raise ()
	Raise a window above other windows and set the input focus.

Window &	Show ()
	Show a window.

Window &	SetFullscreen (Uint32 flags)
	Set a window's fullscreen state.

Window &	SetSize (int w, int h)
	Set the size of a window's client area.

Window &	SetSize (const Point &size)
	Set the size of a window's client area.

float	GetBrightness () const
	Get the brightness (gamma multiplier) for the display that owns a given window.

Window &	SetBrightness (float brightness)
	Set the brightness (gamma multiplier) for the display that owns a given window.

Point	GetPosition () const
	Get the position of a window.

Window &	SetPosition (int x, int y)
	Set the position of a window.

Window &	SetPosition (const Point &pos)
	Set the position of a window.

Point	GetMinimumSize () const
	Get the minimum size of a window's client area.

Window &	SetMinimumSize (int w, int h)
	Set the minimum size of a window's client area.

Window &	SetMinimumSize (const Point &size)
	Set the minimum size of a window's client area.

Point	GetMaximumSize () const
	Get the maximum size of a window's client area.

Window &	SetMaximumSize (int w, int h)
	Set the maximum size of a window's client area.

Window &	SetMaximumSize (const Point &size)
	Set the maximum size of a window's client area.

bool	GetGrab () const
	Get a window's input grab mode.

Window &	SetGrab (bool grabbed)
	Set a window's input grab mode.

int	GetDisplayIndex () const
	Get the index of the display associated with a window.

void	GetDisplayMode (SDL_DisplayMode &mode) const
	Get information about the display mode to use when a window is visible at fullscreen.

Uint32	GetFlags () const
	Get the window flags.

Window &	SetIcon (const Surface &icon)
	Set the icon for a window.

Window &	SetBordered (bool bordered=true)
	Set the border state of a window.

Window &	SetOpacity (float opacity=1.0f)
	Set the opacity for a window.

float	GetOpacity () const
	Get the opacity of a window.

Window &	SetResizable (bool resizable=true)
	Set user-resizable state of a window.

Detailed Description

GUI window object.

SDL2pp::Window is a wrapper around SDL_Window structure and related functions which take care of GUI window management.

Usage example:

{
    SDL2pp::SDL sdl(SDL_INIT_VIDEO);
    SDL2pp::Window window("Test Window",
                          SDL_WINDOWPOS_UNDEFINED,
                          SDL_WINDOWPOS_UNDEFINED,
                          640,
                          480,
                          SDL_WINDOW_OPENGL);
 
    SDL_Delay(3000); // show window for 3 seconds
}

Constructor & Destructor Documentation

◆ Window() [1/4]

SDL2pp::Window::Window ( SDL_Window * window )

explicit

Construct from existing SDL_Window structure.

Parameters

[in] window Existing SDL_Window to manage

◆ Window() [2/4]

SDL2pp::Window::Window	(	const std::string &	title,
		int	x,
		int	y,
		int	w,
		int	h,
		Uint32	flags
	)

Create window with specified title and dimensions.

Parameters

[in]	title	Title of the windows, in UTF-8 encoding
[in]	x	X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
[in]	y	X position of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
[in]	w	Width of the window
[in]	h	Height of the window
[in]	flags	0 or more SDL_WindowFlags OR'd together

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_CreateWindow

◆ ~Window()

SDL2pp::Window::~Window ( )

virtual

Destructor.

See also: http://wiki.libsdl.org/SDL_DestroyWindow

◆ Window() [3/4]

SDL2pp::Window::Window ( Window && other )

noexcept

Move constructor.

Parameters

[in] other SDL2pp::Window object to move data from

◆ Window() [4/4]

SDL2pp::Window::Window ( const Window & other )

delete

Deleted copy constructor.

This class is not copyable

Member Function Documentation

◆ Get()

SDL_Window * SDL2pp::Window::Get ( ) const

Get pointer to managed SDL_Window structure.

Returns: Pointer to managed SDL_Window structure

◆ GetBrightness()

float SDL2pp::Window::GetBrightness ( ) const

Get the brightness (gamma multiplier) for the display that owns a given window.

Returns: Brightness for the display where 0.0 is completely dark and 1.0 is normal brightness

See also: http://wiki.libsdl.org/SDL_GetWindowBrightness

◆ GetDisplayIndex()

int SDL2pp::Window::GetDisplayIndex ( ) const

Get the index of the display associated with a window.

Returns: Index of the display containing the center of the window

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetWindowDisplayIndex

◆ GetDisplayMode()

void SDL2pp::Window::GetDisplayMode ( SDL_DisplayMode & mode ) const

Get information about the display mode to use when a window is visible at fullscreen.

Parameters

[out] mode SDL_DisplayMode structure filled in with the fullscreen display mode

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_GetWindowDisplayMode

◆ GetDrawableHeight()

int SDL2pp::Window::GetDrawableHeight ( ) const

Get drawable height of the window.

Returns: Height of the window drawable area in pixels

See also: http://wiki.libsdl.org/SDL_GL_GetDrawableSize

◆ GetDrawableSize()

Point SDL2pp::Window::GetDrawableSize ( ) const

Get drawable dimensions of the window.

Returns: SDL2pp::Point representing dimensions (width and height) of the window drawable area in pixels

See also: http://wiki.libsdl.org/SDL_GL_GetDrawableSize

◆ GetDrawableWidth()

int SDL2pp::Window::GetDrawableWidth ( ) const

Get drawable width of the window.

Returns: Width of the window drawable area in pixels

See also: http://wiki.libsdl.org/SDL_GL_GetDrawableSize

◆ GetFlags()

Uint32 SDL2pp::Window::GetFlags ( ) const

Get the window flags.

Returns: Mask of the SDL_WindowFlags associated with window

See also: http://wiki.libsdl.org/SDL_GetWindowFlags

◆ GetGrab()

bool SDL2pp::Window::GetGrab ( ) const

Get a window's input grab mode.

Returns: True if input is grabbed, flase otherwise

See also: http://wiki.libsdl.org/SDL_GetWindowGrab

◆ GetHeight()

int SDL2pp::Window::GetHeight ( ) const

Get height of the window.

Returns: Height of the window in pixels

See also: http://wiki.libsdl.org/SDL_GetWindowSize

◆ GetMaximumSize()

Point SDL2pp::Window::GetMaximumSize ( ) const

Get the maximum size of a window's client area.

Returns: Point representing maximum area of window's client area

See also: http://wiki.libsdl.org/SDL_GetWindowMaximumSize

◆ GetMinimumSize()

Point SDL2pp::Window::GetMinimumSize ( ) const

Get the minimum size of a window's client area.

Returns: Point representing minimum area of window's client area

See also: http://wiki.libsdl.org/SDL_GetWindowMinimumSize

◆ GetOpacity()

float SDL2pp::Window::GetOpacity ( ) const

Get the opacity of a window.

Returns: Opacity value (0.0f - transparent, 1.0f - opaque)

Exceptions

SDL2pp:Exception

See also: http://wiki.libsdl.org/SDL_GetWindowOpacity

◆ GetPosition()

Point SDL2pp::Window::GetPosition ( ) const

Get the position of a window.

Returns: Point representing window position

See also: http://wiki.libsdl.org/SDL_GetWindowPosition

◆ GetSize()

Point SDL2pp::Window::GetSize ( ) const

Get dimensions of the window.

Returns: SDL2pp::Point representing dimensions (width and height) of the window in pixels

See also: http://wiki.libsdl.org/SDL_GetWindowSize

◆ GetTitle()

std::string SDL2pp::Window::GetTitle ( ) const

Get window title.

Returns: Title of the window in UTF-8 format or "" if there is no title

See also: http://wiki.libsdl.org/SDL_GetWindowTitle

◆ GetWidth()

int SDL2pp::Window::GetWidth ( ) const

Get width of the window.

Returns: Width of the window in pixels

See also: http://wiki.libsdl.org/SDL_GetWindowSize

◆ Hide()

Window & SDL2pp::Window::Hide ( )

Hide a window.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_HideWindow

◆ Maximize()

Window & SDL2pp::Window::Maximize ( )

Make a window as large as possible.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_MaximizeWindow

◆ Minimize()

Window & SDL2pp::Window::Minimize ( )

Minimize a window to an iconic representation.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_MinimizeWindow

◆ operator=() [1/2]

Window & SDL2pp::Window::operator= ( const Window & other )

delete

Deleted assignment operator.

This class is not copyable

◆ operator=() [2/2]

Window & SDL2pp::Window::operator= ( Window && other )

noexcept

Move assignment operator.

Parameters

[in] other SDL2pp::Window object to move data from

Returns: Reference to self

◆ Raise()

Window & SDL2pp::Window::Raise ( )

Raise a window above other windows and set the input focus.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_RaiseWindow

◆ Restore()

Window & SDL2pp::Window::Restore ( )

Restore the size and position of a minimized or maximized window.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_RestoreWindow

◆ SetBordered()

Window & SDL2pp::Window::SetBordered ( bool bordered = true )

Set the border state of a window.

Parameters

[in] bordered False to remove border, true to add border

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowBordered

◆ SetBrightness()

Window & SDL2pp::Window::SetBrightness ( float brightness )

Set the brightness (gamma multiplier) for the display that owns a given window.

Parameters

[in] brightness Brightness value to set where 0.0 is completely dark and 1.0 is normal brightness

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetWindowBrightness

◆ SetFullscreen()

Window & SDL2pp::Window::SetFullscreen ( Uint32 flags )

Set a window's fullscreen state.

Parameters

[in] flags SDL_WINDOW_FULLSCREEN, SDL_WINDOW_FULLSCREEN_DESKTOP or 0

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetWindowFullscreen

◆ SetGrab()

Window & SDL2pp::Window::SetGrab ( bool grabbed )

Set a window's input grab mode.

Parameters

[in] grabbed True to grab input, false to release input

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowGrab

◆ SetIcon()

Window & SDL2pp::Window::SetIcon ( const Surface & icon )

Set the icon for a window.

Parameters

[in] icon Surface containing the icon for the window

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowIcon

Icon surface may be destroyed after calling this function

◆ SetMaximumSize() [1/2]

Window & SDL2pp::Window::SetMaximumSize ( const Point & size )

Set the maximum size of a window's client area.

Parameters

[in] size Maximum area of the window in pixels

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowMaximumSize

◆ SetMaximumSize() [2/2]

Window & SDL2pp::Window::SetMaximumSize	(	int	w,
		int	h
	)

Set the maximum size of a window's client area.

Parameters

[in]	w	Maximum width of the window in pixels
[in]	h	Maximum height of the window in pixels

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowMaximumSize

◆ SetMinimumSize() [1/2]

Window & SDL2pp::Window::SetMinimumSize ( const Point & size )

Set the minimum size of a window's client area.

Parameters

[in] size Minimum area of the window in pixels

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowMinimumSize

◆ SetMinimumSize() [2/2]

Window & SDL2pp::Window::SetMinimumSize	(	int	w,
		int	h
	)

Set the minimum size of a window's client area.

Parameters

[in]	w	Minimum width of the window in pixels
[in]	h	Minimum height of the window in pixels

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowMinimumSize

◆ SetOpacity()

Window & SDL2pp::Window::SetOpacity ( float opacity = 1.0f )

Set the opacity for a window.

Parameters

[in] opacity The opacity value (0.0f - transparent, 1.0f - opaque)

Returns: Reference to self

Exceptions

SDL2pp::Exception

See also: http://wiki.libsdl.org/SDL_SetWindowOpacity

◆ SetPosition() [1/2]

Window & SDL2pp::Window::SetPosition ( const Point & pos )

Set the position of a window.

Parameters

[in] pos Point representin position of the a window

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowPosition

◆ SetPosition() [2/2]

Window & SDL2pp::Window::SetPosition	(	int	x,
		int	y
	)

Set the position of a window.

Parameters

[in]	x	X coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED
[in]	y	Y coordinate of the window, SDL_WINDOWPOS_CENTERED, or SDL_WINDOWPOS_UNDEFINED

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowPosition

◆ SetResizable()

Window & SDL2pp::Window::SetResizable ( bool resizable = true )

Set user-resizable state of a window.

Parameters

[in] resizable True to allow resizing, false to disallow

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowResizable

◆ SetSize() [1/2]

Window & SDL2pp::Window::SetSize ( const Point & size )

Set the size of a window's client area.

Parameters

[in] size Point representing window dimensions

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowSize

◆ SetSize() [2/2]

Window & SDL2pp::Window::SetSize	(	int	w,
		int	h
	)

Set the size of a window's client area.

Parameters

[in]	w	Width of the window in pixels
[in]	h	Height of the window in pixels

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowSize

◆ SetTitle()

Window & SDL2pp::Window::SetTitle ( const std::string & title )

Set window title.

Parameters

[in] title New window title in UTF-8 encoding

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_SetWindowTitle

◆ Show()

Window & SDL2pp::Window::Show ( )

Show a window.

Returns: Reference to self

See also: http://wiki.libsdl.org/SDL_ShowWindow

The documentation for this class was generated from the following files:

SDL2pp/Window.hh
SDL2pp/Window.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Window() [1/4]

◆ Window() [2/4]

◆ ~Window()

◆ Window() [3/4]

◆ Window() [4/4]

Member Function Documentation

◆ Get()

◆ GetBrightness()

◆ GetDisplayIndex()

◆ GetDisplayMode()

◆ GetDrawableHeight()

◆ GetDrawableSize()

◆ GetDrawableWidth()

◆ GetFlags()

◆ GetGrab()

◆ GetHeight()

◆ GetMaximumSize()

◆ GetMinimumSize()

◆ GetOpacity()

◆ GetPosition()

◆ GetSize()

◆ GetTitle()

◆ GetWidth()

◆ Hide()

◆ Maximize()

◆ Minimize()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Raise()

◆ Restore()

◆ SetBordered()

◆ SetBrightness()

◆ SetFullscreen()

◆ SetGrab()

◆ SetIcon()

◆ SetMaximumSize() [1/2]

◆ SetMaximumSize() [2/2]

◆ SetMinimumSize() [1/2]

◆ SetMinimumSize() [2/2]

◆ SetOpacity()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ SetResizable()

◆ SetSize() [1/2]

◆ SetSize() [2/2]

◆ SetTitle()

◆ Show()