openmsx::OutputSurface Class Reference

A frame buffer where pixels can be written to. More...

#include <OutputSurface.hh>

Inheritance diagram for openmsx::OutputSurface:

Public Member Functions
	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
bool	isViewScaled () const
const PixelFormat &	getPixelFormat () const
uint32_t	mapRGB (gl::vec3 rgb) const
	Returns the pixel value for the given RGB color. More...
uint32_t	mapRGB255 (gl::ivec3 rgb) const
	Same as mapRGB, but RGB components are in range [0..255]. More...
template<typename Pixel >
Pixel	getKeyColor () const
	Returns the color key for this output surface. More...
template<typename Pixel >
Pixel	getKeyColorClash () const
	Returns a color that is visually very close to the key color. More...
template<typename Pixel >
Pixel	mapKeyedRGB255 (gl::ivec3 rgb)
	Returns the pixel value for the given RGB color. More...
template<typename Pixel >
Pixel	mapKeyedRGB (gl::vec3 rgb)
	Returns the pixel value for the given RGB color. More...
virtual void	saveScreenshot (const std::string &filename)=0
	Save the content of this OutputSurface to a PNG file. More...

Protected Member Functions
	OutputSurface ()=default
void	calculateViewPort (gl::ivec2 logSize, gl::ivec2 physSize)
void	setPixelFormat (const PixelFormat &format)
void	setOpenGlPixelFormat ()

Detailed Description

A frame buffer where pixels can be written to.

It could be an in-memory buffer or a video buffer visible to the user (see *OffScreenSurface and *VisibleSurface classes).

The OutputSurface class itself knows about its dimensions and pixel format. But the actual pixel storage is left for the subclasses.

Definition at line 19 of file OutputSurface.hh.

Constructor & Destructor Documentation

OutputSurface() [1/2]

openmsx::OutputSurface::OutputSurface ( const OutputSurface &  )

delete

~OutputSurface()

virtual openmsx::OutputSurface::~OutputSurface ( )

virtualdefault

OutputSurface() [2/2]

openmsx::OutputSurface::OutputSurface ( )

protecteddefault

Member Function Documentation

calculateViewPort()

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

protected

Definition at line 6 of file OutputSurface.cc.

References gl::min_component(), and gl::scale().

Referenced by openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), and openmsx::SDLVisibleSurface::SDLVisibleSurface().

getKeyColor()

template<typename Pixel >

Pixel openmsx::OutputSurface::getKeyColor ( ) const

inline

Returns the color key for this output surface.

Definition at line 58 of file OutputSurface.hh.

getKeyColorClash()

template<typename Pixel >

Pixel openmsx::OutputSurface::getKeyColorClash ( ) const

inline

Returns a color that is visually very close to the key color.

The returned color can be used as an alternative for pixels that would otherwise have the key color.

Definition at line 69 of file OutputSurface.hh.

getLogicalHeight()

int openmsx::OutputSurface::getLogicalHeight ( ) const

inline

Definition at line 28 of file OutputSurface.hh.

Referenced by openmsx::GLScopedClip::GLScopedClip().

getLogicalSize()

gl::ivec2 openmsx::OutputSurface::getLogicalSize ( ) const

inline

Definition at line 29 of file OutputSurface.hh.

Referenced by openmsx::SDLGLVisibleSurface::createConsoleLayer(), openmsx::SDLVisibleSurface::createConsoleLayer(), openmsx::SDLGLVisibleSurface::fullScreenUpdated(), openmsx::OSDTopWidget::getSize(), openmsx::GLPostProcessor::GLPostProcessor(), openmsx::GLPostProcessor::paint(), openmsx::SDLVisibleSurface::saveScreenshotSDL(), and openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface().

getLogicalWidth()

int openmsx::OutputSurface::getLogicalWidth ( ) const

inline

Definition at line 27 of file OutputSurface.hh.

Referenced by openmsx::FBPostProcessor< Pixel >::FBPostProcessor(), and openmsx::OSDWidget::getScaleFactor().

getPhysicalSize()

gl::ivec2 openmsx::OutputSurface::getPhysicalSize ( ) const

inline

Definition at line 30 of file OutputSurface.hh.

Referenced by openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface().

getPixelFormat()

const PixelFormat& openmsx::OutputSurface::getPixelFormat ( ) const

inline

Definition at line 37 of file OutputSurface.hh.

Referenced by openmsx::SDLVisibleSurface::createSnowLayer(), openmsx::PostProcessor::getBpp(), mapRGB255(), openmsx::PostProcessor::PostProcessor(), openmsx::PostProcessor::rotateFrames(), and openmsx::SDLOffScreenSurface::SDLOffScreenSurface().

getViewOffset()

gl::ivec2 openmsx::OutputSurface::getViewOffset ( ) const

inline

Definition at line 32 of file OutputSurface.hh.

Referenced by openmsx::GLScopedClip::GLScopedClip(), openmsx::GLPostProcessor::paint(), and openmsx::SDLGLVisibleSurface::saveScreenshotGL().

getViewScale()

gl::vec2 openmsx::OutputSurface::getViewScale ( ) const

inline

Definition at line 34 of file OutputSurface.hh.

Referenced by openmsx::GLScopedClip::GLScopedClip().

getViewSize()

gl::ivec2 openmsx::OutputSurface::getViewSize ( ) const

inline

Definition at line 33 of file OutputSurface.hh.

Referenced by openmsx::GLPostProcessor::paint(), and openmsx::SDLGLVisibleSurface::saveScreenshotGL().

isViewScaled()

bool openmsx::OutputSurface::isViewScaled ( ) const

inline

Definition at line 35 of file OutputSurface.hh.

Referenced by openmsx::GLPostProcessor::paint().

mapKeyedRGB()

template<typename Pixel >

Pixel openmsx::OutputSurface::mapKeyedRGB ( gl::vec3  rgb )

inline

Returns the pixel value for the given RGB color.

It is guaranteed that the returned pixel value is different from the color key for this output surface.

Definition at line 97 of file OutputSurface.hh.

mapKeyedRGB255()

template<typename Pixel >

Pixel openmsx::OutputSurface::mapKeyedRGB255 ( gl::ivec3  rgb )

inline

Returns the pixel value for the given RGB color.

It is guaranteed that the returned pixel value is different from the color key for this output surface.

Definition at line 80 of file OutputSurface.hh.

References mapRGB255().

mapRGB()

uint32_t openmsx::OutputSurface::mapRGB ( gl::vec3  rgb ) const

inline

Returns the pixel value for the given RGB color.

No effort is made to ensure that the returned pixel value is not the color key for this output surface.

Definition at line 43 of file OutputSurface.hh.

References mapRGB255().

mapRGB255()

uint32_t openmsx::OutputSurface::mapRGB255 ( gl::ivec3  rgb ) const

inline

Same as mapRGB, but RGB components are in range [0..255].

Definition at line 50 of file OutputSurface.hh.

References g, getPixelFormat(), and openmsx::PixelFormat::map().

Referenced by mapKeyedRGB255(), mapRGB(), and openmsx::SDLSnow< Pixel >::SDLSnow().

operator=()

OutputSurface& openmsx::OutputSurface::operator= ( const OutputSurface &  )

delete

saveScreenshot()

virtual void openmsx::OutputSurface::saveScreenshot ( const std::string &  filename )

pure virtual

Save the content of this OutputSurface to a PNG file.

Exceptions

MSXException

If creating the PNG file fails.

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

setOpenGlPixelFormat()

void openmsx::OutputSurface::setOpenGlPixelFormat ( )

protected

Definition at line 24 of file OutputSurface.cc.

References setPixelFormat().

Referenced by openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), and openmsx::SDLGLVisibleSurface::SDLGLVisibleSurface().

setPixelFormat()

void openmsx::OutputSurface::setPixelFormat ( const PixelFormat &  format )

inlineprotected

Definition at line 112 of file OutputSurface.hh.

References openmsx::DiskImageUtils::format().

Referenced by setOpenGlPixelFormat(), and openmsx::SDLOutputSurface::setSDLPixelFormat().

---

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

• OutputSurface.hh
• OutputSurface.cc