openMSX
Public Member Functions | Protected Member Functions | List of all members
openmsx::VideoSystem Class Referenceabstract

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< RasterizercreateRasterizer (VDP &vdp)=0
 Create the rasterizer selected by the current renderer setting. More...
 
virtual std::unique_ptr< V9990RasterizercreateV9990Rasterizer (V9990 &vdp)=0
 Create the V9990 rasterizer selected by the current renderer setting. More...
 
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 OutputSurfacegetOutputSurface ()=0
 TODO. More...
 

Protected Member Functions

 VideoSystem ()=default
 

Detailed Description

Video back-end system.

Definition at line 20 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 succesfully 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.

◆ 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
vdpThe VDP whose display will be rendered.
Returns
The rasterizer created.

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

◆ 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
vdpThe V9990 whose display will be rendered.
Returns
The rasterizer created.

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

◆ flush()

virtual void openmsx::VideoSystem::flush ( )
pure virtual

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

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

◆ getOutputSurface()

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

◆ takeScreenShot()

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

Take a screenshot.

The default implementation throws an exception.

Parameters
filenameName of the file to save the screenshot to.
withOsdShould OSD elements be included in the screenshot.
Exceptions
MSXExceptionIf 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: