Inheritance diagram for LibretroGraphics:

Public Member Functions
Common::List< Graphics::PixelFormat >	getSupportedFormats () const override

const OSystem::GraphicsMode *	getSupportedGraphicsModes (void) const override

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

int16	getHeight (void) const override

int16	getWidth (void) const override

Graphics::PixelFormat	getScreenFormat (void) const override

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

void	updateScreen (void) override

void	clearOverlay (void) override

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

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

int16	getOverlayHeight (void) const override

int16	getOverlayWidth (void) const override

Graphics::PixelFormat	getOverlayFormat () const override

const Graphics::ManagedSurface *	getScreen (void)

void	warpMouse (int x, int y) 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

bool	isOverlayInGUI (void)

bool	hasFeature (OSystem::Feature f) const override

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

bool	getFeatureState (OSystem::Feature f) const override

int	getDefaultGraphicsMode () const override

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

int	getGraphicsMode () const override

Graphics::Surface *	lockScreen () override

void	unlockScreen () override

int	getScreenChangeID () const override

void	beginGFXTransaction () override

OSystem::TransactionError	endGFXTransaction () override

void	fillScreen (uint32 col) override

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

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

void	clearFocusRectangle () override

void	realUpdateScreen (void)

bool	gameNeedsAspectRatioCorrection () const override

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

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

void	setMousePosition (int x, int y)

void	displayMessageOnOSD (const Common::U32String &msg) 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 Attributes
Graphics::ManagedSurface	_screen

Graphics::Surface	_gameScreen

Graphics::Surface	_overlay

Graphics::Surface	_cursor

Graphics::Palette	_cursorPalette

Graphics::Palette	_gamePalette

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

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

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)

Additional Inherited Members
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

Member Function Documentation

◆ getSupportedGraphicsModes()

const OSystem::GraphicsMode * LibretroGraphics::getSupportedGraphicsModes ( void ) const

overridevirtual

Reimplemented from GraphicsManager.

◆ initSize()

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

overridevirtual

Implements GraphicsManager.

◆ getHeight()

int16 LibretroGraphics::getHeight ( void ) const

overridevirtual

Implements GraphicsManager.

◆ getWidth()

int16 LibretroGraphics::getWidth ( void ) const

overridevirtual

Implements GraphicsManager.

◆ copyRectToScreen()

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

overridevirtual

Implements GraphicsManager.

◆ updateScreen()

void LibretroGraphics::updateScreen ( void )

overridevirtual

Implements GraphicsManager.

◆ clearOverlay()

void LibretroGraphics::clearOverlay ( void )

overridevirtual

Implements GraphicsManager.

◆ grabOverlay()

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

overridevirtual

Implements GraphicsManager.

◆ copyRectToOverlay()

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

overridevirtual

Implements GraphicsManager.

◆ getOverlayHeight()

int16 LibretroGraphics::getOverlayHeight ( void ) const

overridevirtual

Implements GraphicsManager.

◆ getOverlayWidth()

int16 LibretroGraphics::getOverlayWidth ( void ) const

overridevirtual

Implements GraphicsManager.

◆ getOverlayFormat()

Graphics::PixelFormat LibretroGraphics::getOverlayFormat ( ) const

overridevirtual

Implements GraphicsManager.

◆ warpMouse()

void LibretroGraphics::warpMouse	(	int	x,
		int	y
	)

overridevirtual

Move ("warp") the mouse cursor to the specified position.

Parameters

x	The new X position of the mouse in virtual screen coordinates.
y	The new Y position of the mouse in virtual screen coordinates.

Reimplemented from WindowedGraphicsManager.

◆ setMouseCursor()

void LibretroGraphics::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
	)

overridevirtual

Implements GraphicsManager.

◆ setCursorPalette()

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

overridevirtual

Implements GraphicsManager.

◆ hasFeature()

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

overridevirtual

Implements GraphicsManager.

◆ setFeatureState()

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

overridevirtual

Implements GraphicsManager.

◆ getFeatureState()

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

overridevirtual

Implements GraphicsManager.

◆ getDefaultGraphicsMode()

int LibretroGraphics::getDefaultGraphicsMode ( ) const

inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ setGraphicsMode()

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

inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ getGraphicsMode()

int LibretroGraphics::getGraphicsMode ( ) const

inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ lockScreen()

Graphics::Surface * LibretroGraphics::lockScreen ( )

inlineoverridevirtual

Implements GraphicsManager.

◆ unlockScreen()

void LibretroGraphics::unlockScreen ( )

inlineoverridevirtual

Implements GraphicsManager.

◆ getScreenChangeID()

int LibretroGraphics::getScreenChangeID ( ) const

overridevirtual

Implements GraphicsManager.

◆ beginGFXTransaction()

void LibretroGraphics::beginGFXTransaction ( )

inlineoverridevirtual

Implements GraphicsManager.

◆ endGFXTransaction()

OSystem::TransactionError LibretroGraphics::endGFXTransaction ( )

overridevirtual

Implements GraphicsManager.

◆ fillScreen() [1/2]

void LibretroGraphics::fillScreen ( uint32 col )

inlineoverridevirtual

Implements GraphicsManager.

◆ fillScreen() [2/2]

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

inlineoverridevirtual

Implements GraphicsManager.

◆ setFocusRectangle()

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

inlineoverridevirtual

Implements GraphicsManager.

◆ clearFocusRectangle()

void LibretroGraphics::clearFocusRectangle ( )

inlineoverridevirtual

Implements GraphicsManager.

◆ gameNeedsAspectRatioCorrection()

bool LibretroGraphics::gameNeedsAspectRatioCorrection ( ) const

inlineoverridevirtual

Returns: whether or not the game screen must have aspect ratio correction applied for correct rendering.

Implements WindowedGraphicsManager.

◆ handleResizeImpl()

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

overridevirtual

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

Implements WindowedGraphicsManager.

◆ setSystemMousePosition()

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

inlineoverridevirtual

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.

◆ displayMessageOnOSD()

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

overridevirtual

Reimplemented from GraphicsManager.

◆ setPalette()

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

overrideprotectedvirtual

Replace the specified range of the palette with new colors. The palette entries from 'start' till (start+num-1) will be replaced - so a full palette update is accomplished via start=0, num=256.

The palette data is specified in interleaved RGB format. That is, the first byte of the memory block 'colors' points at is the red component of the first new color; the second byte the green component of the first new color; the third byte the blue component, the last byte to the alpha (transparency) value. Then the second color starts, and so on. So memory looks like this: R1-G1-B1-R2-G2-B2-R3-...

Parameters

colors	the new palette data, in interleaved RGB format
start	the first palette entry to be updated
num	the number of palette entries to be updated

Note: It is an error if start+num exceeds 256, behavior is undefined in that case (the backend may ignore it silently or assert).; It is an error if this function gets called when the pixel format in use (the return value of getScreenFormat) has more than one byte per pixel.

See also: getScreenFormat

Implements GraphicsManager.

◆ grabPalette()

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

overrideprotectedvirtual

Grabs a specified part of the currently active palette. The format is the same as for setPalette.

This should return exactly the same RGB data as was setup via previous setPalette calls.

For example, for every valid value of start and num of the following code:

byte origPal[num*3]; // Setup origPal's data however you like g_system->setPalette(origPal, start, num); byte obtainedPal[num*3]; g_system->grabPalette(obtainedPal, start, num);

the following should be true:

memcmp(origPal, obtainedPal, num*3) == 0

See also: setPalette

Parameters

colors	the palette data, in interleaved RGB format
start	the first platte entry to be read
num	the number of palette entries to be read

Note: It is an error if this function gets called when the pixel format in use (the return value of getScreenFormat) has more than one byte per pixel.

See also: getScreenFormat

Implements GraphicsManager.

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

backends/platform/libretro/include/libretro-graphics-surface.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ getSupportedGraphicsModes()

◆ initSize()

◆ getHeight()

◆ getWidth()

◆ copyRectToScreen()

◆ updateScreen()

◆ clearOverlay()

◆ grabOverlay()

◆ copyRectToOverlay()

◆ getOverlayHeight()

◆ getOverlayWidth()

◆ getOverlayFormat()

◆ warpMouse()

◆ setMouseCursor()

◆ setCursorPalette()

◆ hasFeature()

◆ setFeatureState()

◆ getFeatureState()

◆ getDefaultGraphicsMode()

◆ setGraphicsMode()

◆ getGraphicsMode()

◆ lockScreen()

◆ unlockScreen()

◆ getScreenChangeID()

◆ beginGFXTransaction()

◆ endGFXTransaction()

◆ fillScreen() [1/2]

◆ fillScreen() [2/2]

◆ setFocusRectangle()

◆ clearFocusRectangle()

◆ gameNeedsAspectRatioCorrection()

◆ handleResizeImpl()

◆ setSystemMousePosition()

◆ displayMessageOnOSD()

◆ setPalette()

◆ grabPalette()