#include <sdl-graphics.h>

Inheritance diagram for SdlGraphicsManager:

Classes
struct	State

Public Member Functions
	SdlGraphicsManager (SdlEventSource source, SdlWindow window)

virtual void	activateManager ()

virtual void	deactivateManager ()

virtual void	notifyVideoExpose ()=0

virtual void	notifyResize (const int width, const int height)

virtual bool	notifyMousePosition (Common::Point &mouse)

bool	showMouse (bool visible) override

bool	lockMouse (bool lock) override

virtual bool	saveScreenshot (const Common::Path &filename) const

void	saveScreenshot () override

bool	setRotationMode (Common::RotationMode rotation) override

bool	notifyEvent (const Common::Event &event) override

State	getState () const

bool	setState (const State &state)

SdlWindow *	getWindow () const

void	initSizeHint (const Graphics::ModeList &modes) override

Common::Keymap *	getKeymap ()

Public Member Functions inherited from WindowedGraphicsManager
void	showOverlay (bool inGUI) override

void	hideOverlay () override

bool	isOverlayVisible () const override

Common::Rect	getSafeOverlayArea (int16 width, int16 height) const override

void	setShakePos (int shakeXOffset, int shakeYOffset) override

int	getWindowWidth () const

int	getWindowHeight () const

void	setIgnoreGameSafeArea (bool ignoreGameSafeArea)

Public Member Functions inherited from GraphicsManager
virtual bool	hasFeature (OSystem::Feature f) const =0

virtual void	setFeatureState (OSystem::Feature f, bool enable)=0

virtual bool	getFeatureState (OSystem::Feature f) const =0

virtual const OSystem::GraphicsMode *	getSupportedGraphicsModes () const

virtual int	getDefaultGraphicsMode () const

virtual bool	setGraphicsMode (int mode, uint flags=OSystem::kGfxModeNoFlags)

virtual int	getGraphicsMode () const

virtual bool	setShader (const Common::Path &fileName)

virtual const OSystem::GraphicsMode *	getSupportedStretchModes () const

virtual int	getDefaultStretchMode () const

virtual bool	setStretchMode (int mode)

virtual int	getStretchMode () const

virtual bool	setRotationMode (Common::RotationMode rotation)

virtual uint	getDefaultScaler () const

virtual uint	getDefaultScaleFactor () const

virtual bool	setScaler (uint mode, int factor)

virtual uint	getScaler () const

virtual uint	getScaleFactor () const

virtual void	initSize (uint width, uint height, const Graphics::PixelFormat *format=NULL)=0

virtual void	initSizeHint (const Graphics::ModeList &modes)

virtual int	getScreenChangeID () const =0

virtual void	beginGFXTransaction ()=0

virtual OSystem::TransactionError	endGFXTransaction ()=0

virtual int16	getHeight () const =0

virtual int16	getWidth () const =0

void	setPalette (const byte *colors, uint start, uint num) override=0

void	grabPalette (byte *colors, uint start, uint num) const override=0

virtual void	copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h)=0

virtual Graphics::Surface *	lockScreen ()=0

virtual void	unlockScreen ()=0

virtual void	fillScreen (uint32 col)=0

virtual void	fillScreen (const Common::Rect &r, uint32 col)=0

virtual void	updateScreen ()=0

virtual void	presentBuffer ()

virtual void	setShakePos (int shakeXOffset, int shakeYOffset)=0

virtual void	setFocusRectangle (const Common::Rect &rect)=0

virtual void	clearFocusRectangle ()=0

virtual void	showOverlay (bool inGUI)=0

virtual void	hideOverlay ()=0

virtual bool	isOverlayVisible () const =0

virtual Graphics::PixelFormat	getOverlayFormat () const =0

virtual void	clearOverlay ()=0

virtual void	grabOverlay (Graphics::Surface &surface) const =0

virtual void	copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h)=0

virtual int16	getOverlayHeight () const =0

virtual int16	getOverlayWidth () const =0

virtual Common::Rect	getSafeOverlayArea (int16 width, int16 height) const

virtual float	getHiDPIScreenFactor () const

virtual bool	showMouse (bool visible)=0

virtual void	warpMouse (int x, int y)=0

virtual void	setMouseCursor (const void buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat format, const byte *mask, frac_t scaleX, frac_t scaleY)=0

virtual void	setCursorPalette (const byte *colors, uint start, uint num)=0

virtual void	displayMessageOnOSD (const Common::U32String &msg)

virtual void	displayActivityIconOnOSD (const Graphics::Surface *icon)

virtual void	saveScreenshot ()

virtual bool	lockMouse (bool lock)

Public Member Functions inherited from PaletteManager
virtual void	setPalette (const byte *colors, uint start, uint num)=0

void	setPalette (const Graphics::Palette &pal, uint start=0)

virtual void	grabPalette (byte *colors, uint start, uint num) const =0

Graphics::Palette	grabPalette (uint start, uint num)

Public Member Functions inherited from Common::EventObserver
virtual bool	notifyEvent (const Event &event)=0

virtual void	notifyPoll ()

Protected Types
enum	CustomEventAction { kActionToggleFullscreen = 100 , kActionToggleMouseCapture , kActionToggleResizableWindow , kActionSaveScreenshot , kActionToggleAspectRatioCorrection , kActionToggleFilteredScaling , kActionCycleStretchMode , kActionIncreaseScaleFactor , kActionDecreaseScaleFactor , kActionNextScaleFilter , kActionPreviousScaleFilter }

Protected Member Functions
Common::Rect	getPreferredFullscreenResolution ()

bool	defaultGraphicsModeConfig () const

void	getWindowSizeFromSdl (int width, int height) const

virtual void	showSystemMouseCursor (bool visible)

void	setSystemMousePosition (const int x, const int y) override

void	notifyActiveAreaChanged () override

void	handleResizeImpl (const int width, const int height) override

virtual bool	canSwitchFullscreen () const

Protected Member Functions inherited from WindowedGraphicsManager
virtual bool	gameNeedsAspectRatioCorrection () const =0

virtual void	handleResizeImpl (const int width, const int height)=0

Common::Point	convertVirtualToWindow (const int x, const int y) const

Common::Point	convertWindowToVirtual (int x, int y) const

frac_t	getDesiredGameAspectRatio () const

virtual int	getGameRenderScale () const

virtual Insets	getSafeAreaInsets () const

void	handleResize (const int width, const int height)

virtual void	recalculateDisplayAreas ()

virtual void	setSystemMousePosition (const int x, const int y)=0

virtual void	notifyActiveAreaChanged ()

bool	showMouse (bool visible) override

void	warpMouse (int x, int y) override

void	setMousePosition (int x, int y)

Protected Attributes
SDL_Surface *	_hwScreen

SdlEventSource *	_eventSource

SdlWindow *	_window

Protected Attributes inherited from WindowedGraphicsManager
int	_windowWidth

int	_windowHeight

int	_screenAlign

Common::RotationMode	_rotationMode

bool	_ignoreGameSafeArea

bool	_overlayVisible

bool	_overlayInGUI

int	_gameScreenShakeXOffset

int	_gameScreenShakeYOffset

Common::Rect	_gameDrawRect

Common::Rect	_overlayDrawRect

DisplayArea	_activeArea

bool	_forceRedraw

bool	_cursorVisible

bool	_cursorNeedsRedraw

bool	_cursorLastInActiveArea

int	_cursorX

int	_cursorY

Detailed Description

Base class for a SDL based graphics manager.

Member Function Documentation

◆ activateManager()

virtual void SdlGraphicsManager::activateManager ( )

virtual

Makes this graphics manager active. That means it should be ready to process inputs now. However, even without being active it should be able to query the supported modes and other bits.

◆ deactivateManager()

virtual void SdlGraphicsManager::deactivateManager ( )

virtual

Makes this graphics manager inactive. This should allow another graphics manager to become active again.

◆ notifyVideoExpose()

virtual void SdlGraphicsManager::notifyVideoExpose ( )

pure virtual

Notify the graphics manager that the graphics needs to be redrawn, since the application window was modified.

This is basically called when SDL_VIDEOEXPOSE was received.

Implemented in OpenGLSdlGraphicsManager, and SurfaceSdlGraphicsManager.

◆ notifyResize()

virtual void SdlGraphicsManager::notifyResize	(	const int	width,
		const int	height
	)

inlinevirtual

Notify the graphics manager about a resize event.

It is noteworthy that the requested width/height should actually be set up as is and not changed by the graphics manager, since otherwise it may lead to odd behavior for certain window managers.

It is only required to overwrite this method in case you want a resizable window. The default implementation just does nothing.

Parameters

width	Requested window width.
height	Requested window height.

Reimplemented in OpenGLSdlGraphicsManager, and SurfaceSdlGraphicsManager.

◆ notifyMousePosition()

virtual bool SdlGraphicsManager::notifyMousePosition ( Common::Point & mouse )

virtual

Notifies the graphics manager about a mouse position change.

The passed point must be converted from window coordinates to virtual coordinates in order for the event to be processed correctly by the game engine. Just use convertWindowToVirtual for this unless you need to do something special.

Parameters

mouse The mouse position in window coordinates, which must be converted synchronously to virtual coordinates.

Returns: true if the mouse was in a valid position for the game and should cause the event to be sent to the game.

◆ showMouse()

bool SdlGraphicsManager::showMouse ( bool visible )

overridevirtual

Implements GraphicsManager.

◆ lockMouse()

bool SdlGraphicsManager::lockMouse ( bool lock )

overridevirtual

Reimplemented from GraphicsManager.

◆ saveScreenshot()

void SdlGraphicsManager::saveScreenshot ( )

overridevirtual

Reimplemented from GraphicsManager.

◆ setRotationMode()

bool SdlGraphicsManager::setRotationMode ( Common::RotationMode rotation )

inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ notifyEvent()

bool SdlGraphicsManager::notifyEvent ( const Common::Event & event )

overridevirtual

Notify the observer of an incoming event.

An observer is supposed to 'eat' the event, with returning true, when it wants to prevent other observers from receiving the event. A usage example here is the keymapper: If it processes an Event, it should 'eat' it and create a new event, which the EventDispatcher will then catch.

Parameters

event The event that is incoming.

Return values

true	If the event should not be passed to other observers, false otherwise.

Implements Common::EventObserver.

Reimplemented in SurfaceSdlGraphicsManager.

◆ getState()

State SdlGraphicsManager::getState ( ) const

Gets the current state of the graphics manager.

◆ setState()

bool SdlGraphicsManager::setState ( const State & state )

Sets up a basic state of the graphics manager.

◆ getWindow()

SdlWindow * SdlGraphicsManager::getWindow ( ) const

inline

Returns: the SDL window.

◆ initSizeHint()

void SdlGraphicsManager::initSizeHint ( const Graphics::ModeList & modes )

overridevirtual

Reimplemented from GraphicsManager.

◆ getPreferredFullscreenResolution()

Common::Rect SdlGraphicsManager::getPreferredFullscreenResolution ( )

protected

Obtain the user configured fullscreen resolution, or default to the desktop resolution

◆ getWindowSizeFromSdl()

void SdlGraphicsManager::getWindowSizeFromSdl	(	int *	width,
		int *	height
	)		const

inlineprotected

Gets the dimensions of the window directly from SDL instead of from the values stored by the graphics manager.

◆ setSystemMousePosition()

void SdlGraphicsManager::setSystemMousePosition	(	const int	x,
		const int	y
	)

overrideprotectedvirtual

Sets the position of the hardware mouse cursor in the host system, relative to the window.

Parameters

x	X coordinate in window coordinates.
y	Y coordinate in window coordinates.

Implements WindowedGraphicsManager.

◆ notifyActiveAreaChanged()

void SdlGraphicsManager::notifyActiveAreaChanged ( )

overrideprotectedvirtual

Called whenever the active area has changed.

Reimplemented from WindowedGraphicsManager.

◆ handleResizeImpl()

void SdlGraphicsManager::handleResizeImpl	(	const int	width,
		const int	height
	)

overrideprotectedvirtual

Backend-specific implementation for updating internal surfaces that need to reflect the new window size.

Implements WindowedGraphicsManager.

Reimplemented in SurfaceSdlGraphicsManager.

◆ canSwitchFullscreen()

virtual bool SdlGraphicsManager::canSwitchFullscreen ( ) const

inlineprotectedvirtual

Returns: whether switching the fullscreen state is currently safe

Reimplemented in OpenGLSdlGraphicsManager, and SurfaceSdlGraphicsManager.

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

backends/graphics/sdl/sdl-graphics.h

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ activateManager()

◆ deactivateManager()

◆ notifyVideoExpose()

◆ notifyResize()

◆ notifyMousePosition()

◆ showMouse()

◆ lockMouse()

◆ saveScreenshot()

◆ setRotationMode()

◆ notifyEvent()

◆ getState()

◆ setState()

◆ getWindow()

◆ initSizeHint()

◆ getPreferredFullscreenResolution()

◆ getWindowSizeFromSdl()

◆ setSystemMousePosition()

◆ notifyActiveAreaChanged()

◆ handleResizeImpl()

◆ canSwitchFullscreen()