openMSX: openmsx::VisibleSurface Class Reference

openMSX

An OutputSurface which is visible to the user, such as a window or a full screen display. More...

#include <VisibleSurface.hh>

Inheritance diagram for openmsx::VisibleSurface:

Inheritance graph

[legend]

Collaboration diagram for openmsx::VisibleSurface:

Collaboration graph

[legend]

Public Member Functions
virtual	~VisibleSurface ()

virtual void	updateWindowTitle ()=0

virtual bool	setFullScreen (bool fullscreen)=0

virtual void	finish ()=0
	When a complete frame is finished, call this method. More...

virtual std::unique_ptr< Layer >	createSnowLayer ()=0

virtual std::unique_ptr< Layer >	createConsoleLayer (Reactor &reactor, CommandConsole &console)=0

virtual std::unique_ptr< Layer >	createOSDGUILayer (OSDGUI &gui)=0

virtual std::unique_ptr< OutputSurface >	createOffScreenSurface ()=0
	Create an off-screen OutputSurface which has similar properties as this VisibleSurface. More...

CliComm &	getCliComm () const

Display &	getDisplay () const

Public Member Functions inherited from openmsx::EventListener
	EventListener (const EventListener &)=delete

EventListener &	operator= (const EventListener &)=delete

virtual int	signalEvent (const Event &event)=0
	This method gets called when an event you are subscribed to occurs. More...

Protected Member Functions
	VisibleSurface (Display &display, RTScheduler &rtScheduler, EventDistributor &eventDistributor, InputEventGenerator &inputEventGenerator, CliComm &cliComm, VideoSystem &videoSystem)

Protected Member Functions inherited from openmsx::EventListener
	EventListener ()=default

	~EventListener ()=default

Detailed Description

An OutputSurface which is visible to the user, such as a window or a full screen display.

Definition at line 26 of file VisibleSurface.hh.

Constructor & Destructor Documentation

◆ ~VisibleSurface()

openmsx::VisibleSurface::~VisibleSurface ( )

virtual

Definition at line 44 of file VisibleSurface.cc.

References openmsx::Subject< T >::detach(), openmsx::InputEventGenerator::getGrabInput(), openmsx::RenderSettings::getPointerHideDelaySetting(), openmsx::Display::getRenderSettings(), openmsx::MOUSE_BUTTON_DOWN, openmsx::MOUSE_BUTTON_UP, openmsx::MOUSE_MOTION, and openmsx::EventDistributor::unregisterEventListener().

◆ VisibleSurface()

openmsx::VisibleSurface::VisibleSurface	(	Display &	display,
		RTScheduler &	rtScheduler,
		EventDistributor &	eventDistributor,
		InputEventGenerator &	inputEventGenerator,
		CliComm &	cliComm,
		VideoSystem &	videoSystem
	)

protected

Definition at line 15 of file VisibleSurface.cc.

References openmsx::Subject< T >::attach(), openmsx::InputEventGenerator::getGrabInput(), openmsx::Display::getRenderSettings(), openmsx::MOUSE_BUTTON_DOWN, openmsx::MOUSE_BUTTON_UP, openmsx::MOUSE_MOTION, and openmsx::EventDistributor::registerEventListener().

Member Function Documentation

◆ createConsoleLayer()

virtual std::unique_ptr< Layer > openmsx::VisibleSurface::createConsoleLayer	(	Reactor &	reactor,
		CommandConsole &	console
	)

pure virtual

Implemented in openmsx::SDLGLVisibleSurface, and openmsx::SDLVisibleSurface.

◆ createOffScreenSurface()

virtual std::unique_ptr< OutputSurface > openmsx::VisibleSurface::createOffScreenSurface ( )

pure virtual

Create an off-screen OutputSurface which has similar properties as this VisibleSurface.

E.g. used to re-render the current frame without OSD elements to take a screenshot.

Implemented in openmsx::SDLGLVisibleSurface, and openmsx::SDLVisibleSurface.

◆ createOSDGUILayer()

virtual std::unique_ptr< Layer > openmsx::VisibleSurface::createOSDGUILayer ( OSDGUI & gui )

pure virtual

Implemented in openmsx::SDLGLVisibleSurface, and openmsx::SDLVisibleSurface.

◆ createSnowLayer()

virtual std::unique_ptr< Layer > openmsx::VisibleSurface::createSnowLayer ( )

pure virtual

Implemented in openmsx::SDLGLVisibleSurface, and openmsx::SDLVisibleSurface.

◆ finish()

virtual void openmsx::VisibleSurface::finish ( )

pure virtual

When a complete frame is finished, call this method.

It will 'actually' display it. E.g. when using double buffering it will swap the front and back buffer.

Implemented in openmsx::SDLGLVisibleSurface, and openmsx::SDLVisibleSurface.

◆ getCliComm()

CliComm & openmsx::VisibleSurface::getCliComm ( ) const

inline

Definition at line 51 of file VisibleSurface.hh.

Referenced by openmsx::SDLVisibleSurfaceBase::createSurface().

◆ getDisplay()

Display & openmsx::VisibleSurface::getDisplay ( ) const

inline

Definition at line 52 of file VisibleSurface.hh.

Referenced by openmsx::SDLGLVisibleSurface::createSnowLayer(), openmsx::SDLVisibleSurface::createSnowLayer(), openmsx::SDLVisibleSurfaceBase::createSurface(), openmsx::SDLGLVisibleSurface::SDLGLVisibleSurface(), openmsx::SDLVisibleSurfaceBase::updateWindowTitle(), and openmsx::SDLGLVisibleSurface::~SDLGLVisibleSurface().

◆ setFullScreen()

virtual bool openmsx::VisibleSurface::setFullScreen ( bool fullscreen )

pure virtual

Implemented in openmsx::SDLVisibleSurfaceBase.

◆ updateWindowTitle()

virtual void openmsx::VisibleSurface::updateWindowTitle ( )

pure virtual

Implemented in openmsx::SDLVisibleSurfaceBase.

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