Inheritance diagram for OpenGLSdlGraphicsManager:

Public Member Functions
	OpenGLSdlGraphicsManager (SdlEventSource eventSource, SdlWindow window)

bool	hasFeature (OSystem::Feature f) const override

void	setFeatureState (OSystem::Feature f, bool enable) override

bool	getFeatureState (OSystem::Feature f) const override

void	initSize (uint w, uint h, const Graphics::PixelFormat *format) override

void	updateScreen () override

float	getHiDPIScreenFactor () const override

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

void	notifyVideoExpose () override

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

Public Member Functions inherited from OpenGL::OpenGLGraphicsManager
bool	hasFeature (OSystem::Feature f) const override

void	setFeatureState (OSystem::Feature f, bool enable) override

bool	getFeatureState (OSystem::Feature f) const override

const OSystem::GraphicsMode *	getSupportedGraphicsModes () const override

int	getDefaultGraphicsMode () const override

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

int	getGraphicsMode () const override

const OSystem::GraphicsMode *	getSupportedStretchModes () const override

int	getDefaultStretchMode () const override

bool	setStretchMode (int mode) override

int	getStretchMode () const override

bool	setShader (const Common::Path &fileNode) override

void	beginGFXTransaction () override

OSystem::TransactionError	endGFXTransaction () override

int	getScreenChangeID () const override

void	initSize (uint width, uint height, const Graphics::PixelFormat *format) override

int16	getWidth () const override

int16	getHeight () const override

void	copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h) override

void	fillScreen (uint32 col) override

void	fillScreen (const Common::Rect &r, uint32 col) override

void	updateScreen () override

void	presentBuffer () override

Graphics::Surface *	lockScreen () override

void	unlockScreen () override

void	setFocusRectangle (const Common::Rect &rect) override

void	clearFocusRectangle () override

int16	getOverlayWidth () const override

int16	getOverlayHeight () const override

void	showOverlay (bool inGUI) override

void	hideOverlay () override

Graphics::PixelFormat	getOverlayFormat () const override

void	copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h) override

void	clearOverlay () override

void	grabOverlay (Graphics::Surface &surface) const override

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) override

void	setCursorPalette (const byte *colors, uint start, uint num) override

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

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

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

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

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 SdlGraphicsManager
	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 Common::EventObserver
virtual bool	notifyEvent (const Event &event)=0

virtual void	notifyPoll ()

Protected Member Functions
bool	loadVideoMode (uint requestedWidth, uint requestedHeight, bool resizable, int antialiasing) override

void	refreshScreen () override

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

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

bool	canSwitchFullscreen () const override

Protected Member Functions inherited from OpenGL::OpenGLGraphicsManager
void	renderCursor ()

bool	isGLESContext () const

void	notifyContextCreate (ContextType type, Framebuffer *target, const Graphics::PixelFormat &defaultFormat, const Graphics::PixelFormat &defaultFormatAlpha)

void	notifyContextDestroy ()

Surface *	createSurface (const Graphics::PixelFormat &format, bool wantAlpha=false, bool wantScaler=false, bool wantMask=false)

TransactionMode	getTransactionMode () const

virtual bool	loadVideoMode (uint requestedWidth, uint requestedHeight, bool resizable, int antialiasing)=0

bool	loadShader (const Common::Path &fileName)

virtual void	refreshScreen ()=0

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

bool	getGLPixelFormat (const Graphics::PixelFormat &pixelFormat, GLenum &glIntFormat, GLenum &glFormat, GLenum &glType) const

bool	gameNeedsAspectRatioCorrection () const override

int	getGameRenderScale () const override

void	recalculateDisplayAreas () override

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

void	updateTextureSettings ()

Pipeline *	getPipeline () const

void	updateCursorPalette ()

void	recalculateCursorScaling ()

virtual const Graphics::Font *	getFontOSD () 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 Member Functions inherited from SdlGraphicsManager
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

Additional Inherited Members
Protected Types inherited from OpenGL::OpenGLGraphicsManager
enum	TransactionMode { kTransactionNone = 0 , kTransactionActive = 1 , kTransactionRollback = 2 }

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

Protected Attributes inherited from OpenGL::OpenGLGraphicsManager
VideoState	_currentState

VideoState	_oldState

Graphics::PixelFormat	_defaultFormat

Graphics::PixelFormat	_defaultFormatAlpha

Framebuffer *	_targetBuffer

Surface *	_gameScreen

byte	_gamePalette [3 *256]

Surface *	_overlay

Surface *	_cursor

Surface *	_cursorMask

int	_cursorHotspotX

int	_cursorHotspotY

int	_cursorHotspotXScaled

int	_cursorHotspotYScaled

float	_cursorWidthScaled

float	_cursorHeightScaled

uint32	_cursorKeyColor

bool	_cursorUseKey

float	_cursorScaleX

float	_cursorScaleY

bool	_cursorPaletteEnabled

byte	_cursorPalette [3 *256]

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

Protected Attributes inherited from SdlGraphicsManager
SDL_Surface *	_hwScreen

SdlEventSource *	_eventSource

SdlWindow *	_window

Member Function Documentation

◆ hasFeature()

bool OpenGLSdlGraphicsManager::hasFeature ( OSystem::Feature f ) const

overridevirtual

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ setFeatureState()

void OpenGLSdlGraphicsManager::setFeatureState	(	OSystem::Feature	f,
		bool	enable
	)

overridevirtual

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ getFeatureState()

bool OpenGLSdlGraphicsManager::getFeatureState ( OSystem::Feature f ) const

overridevirtual

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ initSize()

void OpenGLSdlGraphicsManager::initSize	(	uint	w,
		uint	h,
		const Graphics::PixelFormat *	format
	)

overridevirtual

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ updateScreen()

void OpenGLSdlGraphicsManager::updateScreen ( )

overridevirtual

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ getHiDPIScreenFactor()

float OpenGLSdlGraphicsManager::getHiDPIScreenFactor ( ) const

overridevirtual

Reimplemented from GraphicsManager.

◆ notifyEvent()

bool OpenGLSdlGraphicsManager::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.

◆ notifyVideoExpose()

void OpenGLSdlGraphicsManager::notifyVideoExpose ( )

overridevirtual

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.

Implements SdlGraphicsManager.

◆ notifyResize()

void OpenGLSdlGraphicsManager::notifyResize	(	const int	width,
		const int	height
	)

overridevirtual

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 from SdlGraphicsManager.

◆ loadVideoMode()

bool OpenGLSdlGraphicsManager::loadVideoMode	(	uint	requestedWidth,
		uint	requestedHeight,
		bool	resizable,
		int	antialiasing
	)

overrideprotectedvirtual

Set up the requested video mode. This takes parameters which describe what resolution the game screen requests (this is possibly aspect ratio corrected!).

A sub-class should take these parameters as hints. It might very well set up a mode which it thinks suites the situation best.

@parma requestedWidth This is the requested actual game screen width.

Parameters

requestedHeight	This is the requested actual game screen height.
resizable	This indicates that the window should not be resized because we can't handle it.
antialiasing	This is the requested antialiasing level.

Returns: true on success, false otherwise

Implements OpenGL::OpenGLGraphicsManager.

◆ refreshScreen()

void OpenGLSdlGraphicsManager::refreshScreen ( )

overrideprotectedvirtual

Refresh the screen contents.

Implements OpenGL::OpenGLGraphicsManager.

◆ handleResizeImpl()

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

overrideprotectedvirtual

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

Reimplemented from OpenGL::OpenGLGraphicsManager.

◆ saveScreenshot()

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

overrideprotectedvirtual

Reimplemented from SdlGraphicsManager.

◆ canSwitchFullscreen()

bool OpenGLSdlGraphicsManager::canSwitchFullscreen ( ) const

overrideprotectedvirtual

Returns: whether switching the fullscreen state is currently safe

Reimplemented from SdlGraphicsManager.

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

backends/graphics/openglsdl/openglsdl-graphics.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ hasFeature()

◆ setFeatureState()

◆ getFeatureState()

◆ initSize()

◆ updateScreen()

◆ getHiDPIScreenFactor()

◆ notifyEvent()

◆ notifyVideoExpose()

◆ notifyResize()

◆ loadVideoMode()

◆ refreshScreen()

◆ handleResizeImpl()

◆ saveScreenshot()

◆ canSwitchFullscreen()