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

#include <OutputSurface.hh>

Inheritance diagram for openmsx::OutputSurface:

[legend]

Collaboration diagram for openmsx::OutputSurface:

Public Member Functions
	OutputSurface (const OutputSurface &)=delete

OutputSurface &	operator= (const OutputSurface &)=delete

virtual	~OutputSurface ()=default

unsigned	getWidth () const

unsigned	getHeight () const

int	getX () const

int	getY () const

const SDL_PixelFormat &	getSDLFormat () const

SDL_Surface *	getSDLSurface () const

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

unsigned	mapRGB255 (gl::ivec3 rgb)
	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...

void	lock ()
	Lock this OutputSurface. More...

void	unlock ()
	Unlock this OutputSurface. More...

bool	isLocked () const
	Is this OutputSurface currently locked? More...

template<typename Pixel >
Pixel *	getLinePtrDirect (unsigned y)
	Returns a pointer to the requested line in the pixel buffer. More...

virtual void	flushFrameBuffer ()
	For SDLGL-FB-nn, copy frame buffer to OpenGL display. More...

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

virtual void	clearScreen ()=0
	Clear screen (paint it black). More...

Protected Member Functions
	OutputSurface ()=default

void	setPosition (int x, int y)

void	setSDLSurface (SDL_Surface *surface_)

void	setSDLFormat (const SDL_PixelFormat &format)

void	setBufferPtr (char *data, unsigned pitch)

Protected Member Functions inherited from openmsx::OutputRectangle
	~OutputRectangle ()

Friends
class	SDLGLOutputSurface

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 VisibleSurface subclass).

Definition at line 16 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

Referenced by getLinePtrDirect().

Member Function Documentation

◆ clearScreen()

virtual void openmsx::OutputSurface::clearScreen ( )

pure virtual

Clear screen (paint it black).

Referenced by getLinePtrDirect(), and openmsx::FBPostProcessor< Pixel >::paint().

◆ flushFrameBuffer()

void openmsx::OutputSurface::flushFrameBuffer ( )

virtual

For SDLGL-FB-nn, copy frame buffer to OpenGL display.

The default implementation does nothing.

Definition at line 61 of file OutputSurface.cc.

Referenced by getLinePtrDirect(), and openmsx::FBPostProcessor< Pixel >::paint().

◆ getHeight()

unsigned openmsx::OutputSurface::getHeight ( ) const

inline

Definition at line 25 of file OutputSurface.hh.

Referenced by openmsx::DirectScalerOutput< Pixel >::getHeight(), openmsx::GLPostProcessor::GLPostProcessor(), openmsx::GLScopedClip::GLScopedClip(), openmsx::SDLGLOutputSurface::init(), openmsx::SDLSnow< Pixel >::paint(), openmsx::FBPostProcessor< Pixel >::paint(), openmsx::GLPostProcessor::paint(), openmsx::FBPostProcessor< Pixel >::rotateFrames(), openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), openmsx::SDLVisibleSurface::SDLVisibleSurface(), setSDLSurface(), openmsx::GLPostProcessor::~GLPostProcessor(), and openmsx::SDLGLVisibleSurface::~SDLGLVisibleSurface().

◆ getKeyColor()

template<typename Pixel >

Pixel openmsx::OutputSurface::getKeyColor ( ) const

inline

Returns the color key for this output surface.

Definition at line 50 of file OutputSurface.hh.

Referenced by openmsx::V9990SDLRasterizer< Pixel >::setPalette(), and openmsx::SDLRasterizer< Pixel >::setTransparency().

◆ 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 61 of file OutputSurface.hh.

◆ getLinePtrDirect()

template<typename Pixel >

Pixel* openmsx::OutputSurface::getLinePtrDirect ( unsigned y )

inline

Returns a pointer to the requested line in the pixel buffer.

Not all implementations support this operation, e.g. in SDLGL (non FB version) you don't have direct access to a pixel buffer.

Definition at line 114 of file OutputSurface.hh.

References clearScreen(), flushFrameBuffer(), isLocked(), OutputSurface(), saveScreenshot(), and setPosition().

Referenced by openmsx::DirectScalerOutput< Pixel >::acquireLine(), openmsx::DirectScalerOutput< Pixel >::fillLine(), and openmsx::SDLSnow< Pixel >::paint().

◆ getSDLFormat()

const SDL_PixelFormat& openmsx::OutputSurface::getSDLFormat ( ) const

inline

Definition at line 29 of file OutputSurface.hh.

Referenced by openmsx::PostProcessor::getBpp(), openmsx::FBPostProcessor< Pixel >::paint(), openmsx::PostProcessor::PostProcessor(), openmsx::PostProcessor::rotateFrames(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), and openmsx::SDLVisibleSurface::SDLVisibleSurface().

◆ getSDLSurface()

SDL_Surface* openmsx::OutputSurface::getSDLSurface ( ) const

inline

Definition at line 30 of file OutputSurface.hh.

Referenced by openmsx::SDLImage::draw(), openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), openmsx::SDLGLVisibleSurface::SDLGLVisibleSurface(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), openmsx::SDLVisibleSurface::SDLVisibleSurface(), openmsx::VisibleSurface::setFullScreen(), and openmsx::VisibleSurface::~VisibleSurface().

◆ getWidth()

unsigned openmsx::OutputSurface::getWidth ( ) const

inline

Definition at line 24 of file OutputSurface.hh.

Referenced by openmsx::FBPostProcessor< Pixel >::FBPostProcessor(), openmsx::DirectScalerOutput< Pixel >::fillLine(), openmsx::DirectScalerOutput< Pixel >::getWidth(), openmsx::GLPostProcessor::GLPostProcessor(), openmsx::SDLGLOutputSurface::init(), openmsx::SDLSnow< Pixel >::paint(), openmsx::GLPostProcessor::paint(), openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), openmsx::SDLVisibleSurface::SDLVisibleSurface(), setSDLSurface(), and openmsx::SDLGLVisibleSurface::~SDLGLVisibleSurface().

◆ getX()

int openmsx::OutputSurface::getX ( ) const

inline

Definition at line 26 of file OutputSurface.hh.

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

◆ getY()

int openmsx::OutputSurface::getY ( ) const

inline

Definition at line 27 of file OutputSurface.hh.

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

◆ isLocked()

bool openmsx::OutputSurface::isLocked ( ) const

inline

Is this OutputSurface currently locked?

Definition at line 107 of file OutputSurface.hh.

Referenced by getLinePtrDirect(), lock(), and unlock().

◆ lock()

void openmsx::OutputSurface::lock ( )

Lock this OutputSurface.

Direct pixel access is only allowed on a locked surface. Locking an already locked surface has no effect.

Definition at line 7 of file OutputSurface.cc.

References isLocked().

Referenced by mapKeyedRGB(), openmsx::SDLSnow< Pixel >::paint(), openmsx::FBPostProcessor< Pixel >::paint(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), and openmsx::SDLVisibleSurface::SDLVisibleSurface().

◆ 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 89 of file OutputSurface.hh.

References lock(), and unlock().

Referenced by openmsx::SDLRasterizer< Pixel >::setTransparency().

◆ 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 72 of file OutputSurface.hh.

Referenced by openmsx::V9990SDLRasterizer< Pixel >::drawDisplay(), and openmsx::SDLRasterizer< Pixel >::setTransparency().

◆ mapRGB()

unsigned openmsx::OutputSurface::mapRGB ( gl::vec3 rgb )

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 36 of file OutputSurface.hh.

References mapRGB255().

Referenced by openmsx::V9990SDLRasterizer< Pixel >::drawDisplay().

◆ mapRGB255()

unsigned openmsx::OutputSurface::mapRGB255 ( gl::ivec3 rgb )

inline

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

Definition at line 43 of file OutputSurface.hh.

Referenced by 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.

Referenced by getLinePtrDirect().

◆ setBufferPtr()

void openmsx::OutputSurface::setBufferPtr	(	char *	data,
		unsigned	pitch
	)

protected

Definition at line 55 of file OutputSurface.cc.

Referenced by openmsx::SDLGLOutputSurface::init(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), openmsx::SDLVisibleSurface::SDLVisibleSurface(), and setSDLSurface().

◆ setPosition()

void openmsx::OutputSurface::setPosition	(	int	x,
		int	y
	)

protected

Definition at line 26 of file OutputSurface.cc.

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

◆ setSDLFormat()

void openmsx::OutputSurface::setSDLFormat ( const SDL_PixelFormat & format )

protected

Definition at line 32 of file OutputSurface.cc.

References UNREACHABLE.

Referenced by openmsx::SDLGLOutputSurface::init(), openmsx::SDLOffScreenSurface::SDLOffScreenSurface(), openmsx::SDLVisibleSurface::SDLVisibleSurface(), and setSDLSurface().

◆ setSDLSurface()

void openmsx::OutputSurface::setSDLSurface ( SDL_Surface * surface_ )

inlineprotected

Definition at line 137 of file OutputSurface.hh.

References getHeight(), getWidth(), setBufferPtr(), and setSDLFormat().

Referenced by openmsx::VisibleSurface::createSurface(), openmsx::SDLGLOffScreenSurface::SDLGLOffScreenSurface(), and openmsx::SDLOffScreenSurface::SDLOffScreenSurface().

◆ unlock()

void openmsx::OutputSurface::unlock ( )

Unlock this OutputSurface.

See also: lock().

Definition at line 17 of file OutputSurface.cc.

References isLocked().

Referenced by openmsx::SDLImage::draw(), mapKeyedRGB(), and openmsx::SDLVisibleSurface::SDLVisibleSurface().

Friends And Related Function Documentation

◆ SDLGLOutputSurface

friend class SDLGLOutputSurface

friend

Definition at line 153 of file OutputSurface.hh.

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

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ OutputSurface() [1/2]

◆ ~OutputSurface()

◆ OutputSurface() [2/2]

Member Function Documentation

◆ clearScreen()

◆ flushFrameBuffer()

◆ getHeight()

◆ getKeyColor()

◆ getKeyColorClash()

◆ getLinePtrDirect()

◆ getSDLFormat()

◆ getSDLSurface()

◆ getWidth()

◆ getX()

◆ getY()

◆ isLocked()

◆ lock()

◆ mapKeyedRGB()

◆ mapKeyedRGB255()

◆ mapRGB()

◆ mapRGB255()

◆ operator=()

◆ saveScreenshot()

◆ setBufferPtr()

◆ setPosition()

◆ setSDLFormat()

◆ setSDLSurface()

◆ unlock()

Friends And Related Function Documentation

◆ SDLGLOutputSurface