openMSX: openmsx::VideoSystem Class Reference

openMSX

Video back-end system. More...

#include <VideoSystem.hh>

Inheritance diagram for openmsx::VideoSystem:

Inheritance graph

[legend]

Public Member Functions
virtual	~VideoSystem ()=default

virtual std::unique_ptr< Rasterizer >	createRasterizer (VDP &vdp)=0
	Create the rasterizer selected by the current renderer setting. More...

virtual std::unique_ptr< V9990Rasterizer >	createV9990Rasterizer (V9990 &vdp)=0
	Create the V9990 rasterizer selected by the current renderer setting. More...

virtual std::unique_ptr< LDRasterizer >	createLDRasterizer (LaserdiscPlayer &ld)=0

virtual bool	checkSettings ()
	Requests that this renderer checks its settings against the current RenderSettings. More...

virtual void	flush ()=0
	Finish pending drawing operations and make them visible to the user. More...

virtual void	takeScreenShot (const std::string &filename, bool withOsd)
	Take a screenshot. More...

virtual void	updateWindowTitle ()
	Called when the window title string has changed. More...

virtual gl::ivec2	getMouseCoord ()=0
	Returns the current mouse pointer coordinates. More...

virtual OutputSurface *	getOutputSurface ()=0
	TODO. More...

virtual void	showCursor (bool show)=0

virtual bool	getCursorEnabled ()=0

virtual std::string	getClipboardText ()=0

virtual void	setClipboardText (zstring_view text)=0

virtual void	repaint ()=0
	Requests a repaint of the output surface. More...

Protected Member Functions
	VideoSystem ()=default

Detailed Description

Video back-end system.

Definition at line 22 of file VideoSystem.hh.

Constructor & Destructor Documentation

◆ ~VideoSystem()

virtual openmsx::VideoSystem::~VideoSystem ( )

virtualdefault

◆ VideoSystem()

openmsx::VideoSystem::VideoSystem ( )

protecteddefault

Member Function Documentation

◆ checkSettings()

bool openmsx::VideoSystem::checkSettings ( )

virtual

Requests that this renderer checks its settings against the current RenderSettings.

If possible, update the settings of this renderer. The implementation in the Renderer base class checks whether the right renderer is selected. Subclasses are encouraged to check more settings.

Returns: True if the settings were still in sync or were successfully synced; false if the renderer is unable to bring the settings in sync. TODO: Text copied from Renderer interface, if this stays here then rewrite text accordingly.

Reimplemented in openmsx::SDLVideoSystem.

Definition at line 6 of file VideoSystem.cc.

◆ createLDRasterizer()

virtual std::unique_ptr< LDRasterizer > openmsx::VideoSystem::createLDRasterizer ( LaserdiscPlayer & ld )

pure virtual

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ createRasterizer()

virtual std::unique_ptr< Rasterizer > openmsx::VideoSystem::createRasterizer ( VDP & vdp )

pure virtual

Create the rasterizer selected by the current renderer setting.

Video systems that use a rasterizer must override this method.

Parameters

vdp	The VDP whose display will be rendered.

Returns: The rasterizer created.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ createV9990Rasterizer()

virtual std::unique_ptr< V9990Rasterizer > openmsx::VideoSystem::createV9990Rasterizer ( V9990 & vdp )

pure virtual

Create the V9990 rasterizer selected by the current renderer setting.

Video systems that use a rasterizer must override this method.

Parameters

vdp	The V9990 whose display will be rendered.

Returns: The rasterizer created.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ flush()

virtual void openmsx::VideoSystem::flush ( )

pure virtual

Finish pending drawing operations and make them visible to the user.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ getClipboardText()

virtual std::string openmsx::VideoSystem::getClipboardText ( )

pure virtual

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

Referenced by openmsx::GetClipboardCommand::execute().

◆ getCursorEnabled()

virtual bool openmsx::VideoSystem::getCursorEnabled ( )

pure virtual

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ getMouseCoord()

virtual gl::ivec2 openmsx::VideoSystem::getMouseCoord ( )

pure virtual

Returns the current mouse pointer coordinates.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ getOutputSurface()

virtual OutputSurface * openmsx::VideoSystem::getOutputSurface ( )

pure virtual

TODO.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ repaint()

virtual void openmsx::VideoSystem::repaint ( )

pure virtual

Requests a repaint of the output surface.

An implementation might start a repaint directly, or trigger a queued rendering.

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ setClipboardText()

virtual void openmsx::VideoSystem::setClipboardText ( zstring_view text )

pure virtual

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

Referenced by openmsx::SetClipboardCommand::execute().

◆ showCursor()

virtual void openmsx::VideoSystem::showCursor ( bool show )

pure virtual

Implemented in openmsx::DummyVideoSystem, and openmsx::SDLVideoSystem.

◆ takeScreenShot()

void openmsx::VideoSystem::takeScreenShot	(	const std::string &	filename,
		bool	withOsd
	)

virtual

Take a screenshot.

The default implementation throws an exception.

Parameters

filename	Name of the file to save the screenshot to.
withOsd	Should OSD elements be included in the screenshot.

Exceptions

MSXException If taking the screen shot fails.

Reimplemented in openmsx::SDLVideoSystem.

Definition at line 11 of file VideoSystem.cc.

◆ updateWindowTitle()

void openmsx::VideoSystem::updateWindowTitle ( )

virtual

Called when the window title string has changed.

Reimplemented in openmsx::SDLVideoSystem.

Definition at line 18 of file VideoSystem.cc.

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