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:

[legend]

Collaboration diagram for openmsx::VisibleSurface:

[legend]

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

	~VisibleSurface () override

CliComm &	getCliComm () const

Display &	getDisplay () const

void	updateWindowTitle ()

bool	setFullScreen (bool fullscreen)

void	resize ()

void	finish ()
	When a complete frame is finished, call this method.

std::unique_ptr< Layer >	createSnowLayer ()

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

std::unique_ptr< Layer >	createImGUILayer (ImGuiManager &manager)

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

void	fullScreenUpdated (bool fullScreen)

std::optional< gl::ivec2 >	getWindowPosition () const
	Returns x,y coordinates of top-left window corner, or returns a nullopt when in fullscreen mode.

void	setWindowPosition (gl::ivec2 pos)

void	saveScreenshot (const std::string &filename) override
	Save the content of this OutputSurface to a PNG file.

void	update (const Setting &setting) noexcept override

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

void	executeRT () override

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

OutputSurface &	operator= (const OutputSurface &)=delete

virtual	~OutputSurface ()=default

int	getLogicalWidth () const

int	getLogicalHeight () const

gl::ivec2	getLogicalSize () const

gl::ivec2	getPhysicalSize () const

gl::ivec2	getViewOffset () const

gl::ivec2	getViewSize () const

gl::vec2	getViewScale () const

uint32_t	mapRGB (gl::vec3 rgb) const
	Returns the pixel value for the given RGB color.

uint32_t	mapRGB255 (gl::ivec3 rgb) const
	Same as mapRGB, but RGB components are in range [0..255].

Pixel	getKeyColor () const
	Returns the color key for this output surface.

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

EventListener &	operator= (const EventListener &)=delete

Static Public Member Functions
static void	saveScreenshotGL (const OutputSurface &output, const std::string &filename)

Public Attributes
bool	guiActive = false

Additional Inherited Members
Public Types inherited from openmsx::OutputSurface
using	Pixel = uint32_t

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

void	calculateViewPort (gl::ivec2 logSize, gl::ivec2 physSize)

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 28 of file VisibleSurface.hh.

Constructor & Destructor Documentation

◆ VisibleSurface()

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

Definition at line 41 of file VisibleSurface.cc.

References openmsx::Subject< T >::attach(), gl::context, openmsx::InputEventGenerator::getGrabInput(), openmsx::Display::getRenderSettings(), openmsx::IMGUI_ACTIVE, ImGui_ImplOpenGL3_Init(), ImGui_ImplSDL2_InitForOpenGL(), openmsx::MOUSE_BUTTON_DOWN, openmsx::MOUSE_BUTTON_UP, openmsx::MOUSE_MOTION, openmsx::EventDistributor::registerEventListener(), openmsx::WindowEvent::setMainWindowId(), and VERSION_STRING.

◆ ~VisibleSurface()

openmsx::VisibleSurface::~VisibleSurface ( )

override

Definition at line 155 of file VisibleSurface.cc.

References gl::context, openmsx::Subject< T >::detach(), openmsx::InputEventGenerator::getGrabInput(), openmsx::Display::getRenderSettings(), openmsx::RenderSettings::getVSyncSetting(), getWindowPosition(), openmsx::IMGUI_ACTIVE, ImGui_ImplOpenGL3_Shutdown(), ImGui_ImplSDL2_Shutdown(), openmsx::MOUSE_BUTTON_DOWN, openmsx::MOUSE_BUTTON_UP, openmsx::MOUSE_MOTION, openmsx::Display::storeWindowPosition(), and openmsx::EventDistributor::unregisterEventListener().

Member Function Documentation

◆ createImGUILayer()

std::unique_ptr< Layer > openmsx::VisibleSurface::createImGUILayer ( ImGuiManager & manager )

Definition at line 385 of file VisibleSurface.cc.

◆ createOffScreenSurface()

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

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.

Definition at line 390 of file VisibleSurface.cc.

◆ createOSDGUILayer()

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

Definition at line 380 of file VisibleSurface.cc.

◆ createSnowLayer()

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

Definition at line 375 of file VisibleSurface.cc.

References getDisplay().

◆ executeRT()

void openmsx::VisibleSurface::executeRT ( )

overridevirtual

Implements openmsx::RTSchedulable.

Definition at line 265 of file VisibleSurface.cc.

References openmsx::VideoSystem::showCursor(), and openmsx::InputEventGenerator::updateGrab().

◆ finish()

void openmsx::VisibleSurface::finish ( )

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.

Definition at line 370 of file VisibleSurface.cc.

◆ fullScreenUpdated()

void openmsx::VisibleSurface::fullScreenUpdated ( bool fullScreen )

Definition at line 443 of file VisibleSurface.cc.

References openmsx::OutputSurface::getLogicalSize().

Referenced by setFullScreen().

◆ getCliComm()

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

inline

Definition at line 40 of file VisibleSurface.hh.

◆ getDisplay()

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

inline

Definition at line 41 of file VisibleSurface.hh.

Referenced by createSnowLayer(), and updateWindowTitle().

◆ getWindowPosition()

std::optional< gl::ivec2 > openmsx::VisibleSurface::getWindowPosition ( ) const

Returns x,y coordinates of top-left window corner, or returns a nullopt when in fullscreen mode.

Definition at line 185 of file VisibleSurface.cc.

Referenced by ~VisibleSurface().

◆ resize()

void openmsx::VisibleSurface::resize ( )

Definition at line 332 of file VisibleSurface.cc.

References openmsx::RenderSettings::getFullScreen(), and openmsx::Display::getRenderSettings().

◆ saveScreenshot()

void openmsx::VisibleSurface::saveScreenshot ( const std::string & filename )

overridevirtual

Save the content of this OutputSurface to a PNG file.

Exceptions

MSXException If creating the PNG file fails.

Implements openmsx::OutputSurface.

Definition at line 347 of file VisibleSurface.cc.

References saveScreenshotGL().

◆ saveScreenshotGL()

void openmsx::VisibleSurface::saveScreenshotGL	(	const OutputSurface &	output,
		const std::string &	filename
	)

static

Definition at line 352 of file VisibleSurface.cc.

References openmsx::MemBuffer< T, ALIGNMENT >::data(), openmsx::OutputSurface::getViewOffset(), openmsx::OutputSurface::getViewSize(), openmsx::PNG::saveRGBA(), VLA, and xrange().

Referenced by saveScreenshot().

◆ setFullScreen()

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

Definition at line 306 of file VisibleSurface.cc.

References fullScreenUpdated().

◆ setWindowPosition()

void openmsx::VisibleSurface::setWindowPosition ( gl::ivec2 pos )

Definition at line 193 of file VisibleSurface.cc.

◆ signalEvent()

int openmsx::VisibleSurface::signalEvent ( const Event & event )

overridevirtual

This method gets called when an event you are subscribed to occurs.

Returns: Must return a bitmask of EventListener priorities. When a bit is set, this event won't be delivered to listeners with that priority. It's only allowed/possible to block an event for listeners with a strictly lower priority than this listener. Returning 0 means don't block the event for any listeners.

Implements openmsx::EventListener.

Definition at line 272 of file VisibleSurface.cc.

References openmsx::getType(), guiActive, and openmsx::IMGUI_ACTIVE.

◆ update()

void openmsx::VisibleSurface::update ( const Setting & setting )

overridevirtualnoexcept

Implements openmsx::Observer< Setting >.

Definition at line 260 of file VisibleSurface.cc.

◆ updateWindowTitle()

void openmsx::VisibleSurface::updateWindowTitle ( )

Definition at line 341 of file VisibleSurface.cc.

References getDisplay().

Member Data Documentation

◆ guiActive

bool openmsx::VisibleSurface::guiActive = false

Definition at line 85 of file VisibleSurface.hh.

Referenced by signalEvent().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VisibleSurface()

◆ ~VisibleSurface()

Member Function Documentation

◆ createImGUILayer()

◆ createOffScreenSurface()

◆ createOSDGUILayer()

◆ createSnowLayer()

◆ executeRT()

◆ finish()

◆ fullScreenUpdated()

◆ getCliComm()

◆ getDisplay()

◆ getWindowPosition()

◆ resize()

◆ saveScreenshot()

◆ saveScreenshotGL()

◆ setFullScreen()

◆ setWindowPosition()

◆ signalEvent()

◆ update()

◆ updateWindowTitle()

Member Data Documentation

◆ guiActive