ScummVM API documentation
SdlWindow Class Reference
Inheritance diagram for SdlWindow:
SdlIconlessWindow

Public Member Functions

virtual void setupIcon ()
 
void setWindowCaption (const Common::String &caption)
 
void grabMouse (bool grab)
 
void setMouseRect (const Common::Rect &rect)
 
bool lockMouse (bool lock)
 
bool hasMouseFocus () const
 
bool warpMouseInWindow (int x, int y)
 
void iconifyWindow ()
 
bool getSDLWMInformation (SDL_SysWMinfo *info) const
 
Common::Rect getDesktopResolution ()
 
float getSdlDpiScalingFactor () const
 
virtual float getDpiScalingFactor () const
 
bool mouseIsGrabbed () const
 
bool mouseIsLocked () const
 

Protected Member Functions

void getDisplayDpi (float *dpi, float *defaultDpi) const
 

Member Function Documentation

◆ setupIcon()

virtual void SdlWindow::setupIcon ( )
virtual

Setup the window icon.

Reimplemented in SdlIconlessWindow.

◆ setWindowCaption()

void SdlWindow::setWindowCaption ( const Common::String caption)

Change the caption of the window.

Parameters
captionNew window caption in UTF-8 encoding.

◆ grabMouse()

void SdlWindow::grabMouse ( bool  grab)

Grab or ungrab the mouse cursor. This decides whether the cursor can leave the window or not.

◆ setMouseRect()

void SdlWindow::setMouseRect ( const Common::Rect rect)

Specify the area of the window to confine the mouse cursor.

◆ lockMouse()

bool SdlWindow::lockMouse ( bool  lock)

Lock or unlock the mouse cursor within the window.

◆ hasMouseFocus()

bool SdlWindow::hasMouseFocus ( ) const

Check whether the application has mouse focus.

◆ warpMouseInWindow()

bool SdlWindow::warpMouseInWindow ( int  x,
int  y 
)

Warp the mouse to the specified position in window coordinates. The mouse will only be warped if the window is focused in the window manager.

Returns
true if the system cursor was warped.

◆ iconifyWindow()

void SdlWindow::iconifyWindow ( )

Iconifies the window.

◆ getSDLWMInformation()

bool SdlWindow::getSDLWMInformation ( SDL_SysWMinfo *  info) const

Query platform specific SDL window manager information.

Since this is an SDL internal structure clients are responsible for accessing it in a version safe manner.

◆ getDpiScalingFactor()

virtual float SdlWindow::getDpiScalingFactor ( ) const
virtual

Returns the scaling mode based on the display DPI


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