public

Inheritance Graph

graph BT
	WindowSDL
	WindowSDL --> Window
	click WindowSDL "classUtil_1_1UI_1_1WindowSDL"
	click Window "classUtil_1_1UI_1_1Window"

Description

Class to create a window with an embedded OpenGL rendering context by using SDL.

Author: Benjamin Eikel

Date: 2010-07-20

Public Functions

   
   
  ~WindowSDL()
Destroy the window and free the allocated resources.
   
void swapBuffers()
Swap front and back buffer of the window.
   
int32_t getSwapInterval() const
   
void warpCursor(int x, int y)
Set the cursor to the given location inside the window.
   
void grabInput()
Grap control of mouse and keyboard input.
   
void ungrabInput()
Release control of mouse and keyboard input.
   
std::deque< Event > fetchEvents()
Return any pending events for this window.
   
void setIcon(const Bitmap & icon)
Set an image that is shown as the window’s icon.
   
std::string getClipboardText() const
Read text from the clipboard.
   
void setClipboardText(const std::string & text)
Write text to the clipboard.
   
void makeCurrent()
Enables rendering to this window.

Documentation

function
Util::UI::WindowSDL::~WindowSDL

public virtual
   
   
~WindowSDL( )

Destroy the window and free the allocated resources.

Defined in Util/UI/WindowSDL.h:35


function
Util::UI::WindowSDL::swapBuffers

public virtual
   
   
void swapBuffers( )

Swap front and back buffer of the window.

Defined in Util/UI/WindowSDL.h:38


function
Util::UI::WindowSDL::getSwapInterval

public const virtual
   
   
int32_t getSwapInterval( ) const

See also: SDL_GL_GetAttribute

Defined in Util/UI/WindowSDL.h:41


function
Util::UI::WindowSDL::warpCursor

public virtual
     
     
void warpCursor( int x,
  int y
)    

Set the cursor to the given location inside the window.

Defined in Util/UI/WindowSDL.h:44


function
Util::UI::WindowSDL::grabInput

public virtual
   
   
void grabInput( )

Grap control of mouse and keyboard input.

Defined in Util/UI/WindowSDL.h:47


function
Util::UI::WindowSDL::ungrabInput

public virtual
   
   
void ungrabInput( )

Release control of mouse and keyboard input.

Defined in Util/UI/WindowSDL.h:50


function
Util::UI::WindowSDL::fetchEvents

public virtual
   
   
std::deque< Event > fetchEvents( )

Return any pending events for this window.

Defined in Util/UI/WindowSDL.h:53


function
Util::UI::WindowSDL::setIcon

public virtual
     
     
void setIcon( const Bitmap & icon )

Set an image that is shown as the window’s icon.

Defined in Util/UI/WindowSDL.h:56


function
Util::UI::WindowSDL::getClipboardText

public const virtual
   
   
std::string getClipboardText( ) const

Read text from the clipboard.

Defined in Util/UI/WindowSDL.h:59


function
Util::UI::WindowSDL::setClipboardText

public virtual
     
     
void setClipboardText( const std::string & text )

Write text to the clipboard.

Defined in Util/UI/WindowSDL.h:62


function
Util::UI::WindowSDL::makeCurrent

public virtual
   
   
void makeCurrent( )

Enables rendering to this window.

Defined in Util/UI/WindowSDL.h:65