Graphics::Screen Class Reference

#include <screen.h>

Inheritance diagram for Graphics::Screen:

Public Member Functions
	Screen (int width, int height)
	Screen (int width, int height, PixelFormat pixelFormat)
bool	isDirty () const
void	makeAllDirty ()
virtual void	clearDirtyRects ()
virtual void	addDirtyRect (const Common::Rect &r)
virtual void	update ()
virtual void	updateScreen ()
void	getPalette (byte palette[PALETTE_SIZE])
void	getPalette (byte *palette, uint start, uint num)
Graphics::Palette	getPalette (uint start=0, uint num=PALETTE_COUNT)
void	setPalette (const byte palette[PALETTE_SIZE])
void	setPalette (const byte *palette, uint start, uint num)
void	setPalette (const Graphics::Palette &pal, uint start=0)
void	clearPalette ()
Public Member Functions inherited from Graphics::ManagedSurface
bool	clip (Common::Rect &srcBounds, Common::Rect &destBounds) const
	ManagedSurface ()
	ManagedSurface (const ManagedSurface &surf)
	ManagedSurface (ManagedSurface &&surf)
	ManagedSurface (int width, int height)
	ManagedSurface (int width, int height, const Graphics::PixelFormat &pixelFormat)
	ManagedSurface (ManagedSurface &surf, const Common::Rect &bounds)
	ManagedSurface (Surface *surf, DisposeAfterUse::Flag disposeAfterUse=DisposeAfterUse::YES)
	ManagedSurface (const Surface *surf)
virtual	~ManagedSurface ()
	operator const Surface & () const
const Surface &	rawSurface () const
Surface *	surfacePtr ()
ManagedSurface &	operator= (const ManagedSurface &surf)
ManagedSurface &	operator= (ManagedSurface &&surf)
bool	empty () const
DisposeAfterUse::Flag	disposeAfterUse () const
uint32	getPixel (int x, int y) const
void	setPixel (int x, int y, uint32 pixel)
const void *	getBasePtr (int x, int y) const
void *	getBasePtr (int x, int y)
void *	getPixels ()
const void *	getPixels () const
virtual void	setPixels (void *newPixels)
virtual void	create (int16 width, int16 height)
virtual void	create (int16 width, int16 height, const PixelFormat &pixelFormat)
virtual void	create (ManagedSurface &surf, const Common::Rect &bounds)
virtual void	free ()
const Common::Point	getOffsetFromOwner () const
const Common::Rect	getBounds () const
void	simpleBlitFrom (const Surface &src, const Palette *srcPalette=nullptr)
void	simpleBlitFrom (const Surface &src, const Common::Point &destPos, const Palette *srcPalette=nullptr)
void	simpleBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, const Palette *srcPalette=nullptr)
void	simpleBlitFrom (const ManagedSurface &src)
void	simpleBlitFrom (const ManagedSurface &src, const Common::Point &destPos)
void	simpleBlitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Point &destPos)
void	blitFrom (const Surface &src, const Palette *srcPalette=nullptr)
void	blitFrom (const Surface &src, const Common::Point &destPos, const Palette *srcPalette=nullptr)
void	blitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, const Palette *srcPalette=nullptr)
void	blitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, const Palette *srcPalette=nullptr)
void	blitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Rect &destRect)
void	blitFrom (const ManagedSurface &src)
void	blitFrom (const ManagedSurface &src, const Common::Point &destPos)
void	blitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Point &destPos)
void	transBlitFrom (const Surface &src, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff, const Palette *srcPalette=nullptr)
void	transBlitFrom (const Surface &src, const Common::Point &destPos, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff, const Palette *srcPalette=nullptr)
void	transBlitFrom (const Surface &src, const Common::Point &destPos, const ManagedSurface &mask, const Palette *srcPalette=nullptr)
void	transBlitFrom (const Surface &src, const Common::Point &destPos, const Surface &mask, const Palette *srcPalette=nullptr)
void	transBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff, const Palette *srcPalette=nullptr)
void	transBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, const Palette *srcPalette)
void	transBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff, const Surface *mask=nullptr, bool maskOnly=false, const Palette *srcPalette=nullptr)
void	transBlitFrom (const ManagedSurface &src, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff)
void	transBlitFrom (const ManagedSurface &src, const Common::Point &destPos, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff)
void	transBlitFrom (const ManagedSurface &src, const Common::Point &destPos, const ManagedSurface &mask)
void	transBlitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Point &destPos, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff)
void	transBlitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint32 transColor=0, bool flipped=false, uint32 overrideColor=0, uint32 srcAlpha=0xff, const Surface *mask=nullptr, bool maskOnly=false)
void	rawBlitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Point &destPos)
Common::Rect	blendBlitTo (ManagedSurface &target, const int posX=0, const int posY=0, const int flipping=FLIP_NONE, const Common::Rect *srcRect=nullptr, const uint colorMod=(uint32)(((255)<< 24)|((255)<< 16)|((255)<< 8)|(255)), const int width=-1, const int height=-1, const TSpriteBlendMode blend=BLEND_NORMAL, const AlphaType alphaType=ALPHA_FULL)
	Renders this surface onto target. More...
Common::Rect	blendBlitTo (Surface &target, const int posX=0, const int posY=0, const int flipping=FLIP_NONE, const Common::Rect *srcRect=nullptr, const uint colorMod=(uint32)(((255)<< 24)|((255)<< 16)|((255)<< 8)|(255)), const int width=-1, const int height=-1, const TSpriteBlendMode blend=BLEND_NORMAL, const AlphaType alphaType=ALPHA_FULL)
void	clear (uint32 color=0)
void	markAllDirty ()
void	copyRectToSurface (const void *buffer, int srcPitch, int destX, int destY, int width, int height)
void	copyRectToSurface (const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect)
void	copyRectToSurfaceWithKey (const void *buffer, int srcPitch, int destX, int destY, int width, int height, uint32 key)
void	copyRectToSurfaceWithKey (const Graphics::Surface &srcSurface, int destX, int destY, const Common::Rect subRect, uint32 key)
void	copyFrom (const ManagedSurface &surf)
void	copyFrom (const Surface &surf)
void	convertFrom (const ManagedSurface &surf, const PixelFormat &fmt)
void	convertFrom (const Surface &surf, const PixelFormat &fmt)
ManagedSurface *	scale (int16 newWidth, int16 newHeight, bool filtering=false) const
ManagedSurface *	rotoscale (const TransformStruct &transform, bool filtering=false) const
	Rotoscale function; this returns a transformed version of this surface after rotation and scaling. Please do not use this if angle == 0, use plain old scaling function. More...
void	drawLine (int x0, int y0, int x1, int y1, uint32 color)
void	drawThickLine (int x0, int y0, int x1, int y1, int penX, int penY, uint32 color)
void	hLine (int x, int y, int x2, uint32 color)
void	vLine (int x, int y, int y2, uint32 color)
void	fillRect (Common::Rect r, uint32 color)
void	frameRect (const Common::Rect &r, uint32 color)
AlphaType	detectAlpha () const
Surface	getSubArea (const Common::Rect &area)
void	convertToInPlace (const PixelFormat &dstFormat)
void	convertToInPlace (const PixelFormat &dstFormat, const byte *palette, uint16 paletteCount)
uint	getTransparentColor () const
void	setTransparentColor (uint32 color)
void	clearTransparentColor ()
bool	hasTransparentColor () const
void	clearPalette ()
bool	hasPalette () const
void	grabPalette (byte *colors, uint start, uint num) const
void	setPalette (const byte *colors, uint start, uint num)

Protected Member Functions
void	mergeDirtyRects ()
bool	unionRectangle (Common::Rect &destRect, const Common::Rect &src1, const Common::Rect &src2)
Protected Member Functions inherited from Graphics::ManagedSurface
void	simpleBlitFromInner (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, const Palette *srcPalette, bool transparentColorSet, uint transparentColor)
void	blitFromInner (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, const Palette *srcPalette)
void	transBlitFromInner (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint32 transColor, bool flipped, uint32 overrideColor, uint32 srcAlpha, const Palette *srcPalette, const Palette *dstPalette, const Surface *mask, bool maskOnly)

Protected Attributes
Common::List< Common::Rect >	_dirtyRects

Additional Inherited Members
Static Public Member Functions inherited from Graphics::ManagedSurface
static bool	isBlendBlitPixelFormatSupported (const PixelFormat &src, const PixelFormat &dst)
Public Attributes inherited from Graphics::ManagedSurface
int16 &	w
int16 &	h
int32 &	pitch
PixelFormat &	format

Detailed Description

Implements a specialised surface that represents the screen. It keeps track of any areas of itself that are updated by drawing calls, and provides an update that method that blits the affected areas to the physical screen

Member Function Documentation

mergeDirtyRects()

void Graphics::Screen::mergeDirtyRects ( )

protected

Merges together overlapping dirty areas of the screen

unionRectangle()

bool Graphics::Screen::unionRectangle ( Common::Rect &  destRect, const Common::Rect &  src1, const Common::Rect &  src2  )

protected

Returns the union of two dirty area rectangles

isDirty()

bool Graphics::Screen::isDirty ( ) const

inline

Returns true if there are any pending screen updates (dirty areas)

makeAllDirty()

void Graphics::Screen::makeAllDirty

(

)

Marks the whole screen as dirty. This forces the next call to update to copy the entire screen contents

clearDirtyRects()

virtual void Graphics::Screen::clearDirtyRects ( )

inlinevirtual

Clear the current dirty rects list

Reimplemented from Graphics::ManagedSurface.

addDirtyRect()

virtual void Graphics::Screen::addDirtyRect ( const Common::Rect &  r )

virtual

Adds a rectangle to the list of modified areas of the screen during the current frame

Reimplemented from Graphics::ManagedSurface.

Reimplemented in MADS::MSurface, Access::ASurface, Sherlock::Surface, TsAGE::GfxSurface, MM::Xeen::Screen, and Petka::VideoSystem.

update()

virtual void Graphics::Screen::update ( )

virtual

Updates the screen by copying any affected areas to the system

Reimplemented in MADS::Screen, TwinE::TwineScreen, Access::Screen, Ultima::Shared::Gfx::Screen, TsAGE::Screen, and Petka::VideoSystem.

updateScreen()

virtual void Graphics::Screen::updateScreen ( )

virtual

Updates the screen at the end of an update call

Reimplemented in Ultima::Shared::Gfx::Screen.

getPalette() [1/3]

void Graphics::Screen::getPalette

(

byte

palette[PALETTE_SIZE]

)

Return the currently active palette

getPalette() [2/3]

void Graphics::Screen::getPalette	(	byte *	palette,
		uint	start,
		uint	num
	)

Return a portion of the currently active palette

getPalette() [3/3]

Graphics::Palette Graphics::Screen::getPalette ( uint  start = 0, uint  num = PALETTE_COUNT  )

inline

Return a portion of the currently active palette as a palette object

setPalette() [1/3]

void Graphics::Screen::setPalette

(

const byte

palette[PALETTE_SIZE]

)

Set the palette

setPalette() [2/3]

void Graphics::Screen::setPalette	(	const byte *	palette,
		uint	start,
		uint	num
	)

Set a subsection of the palette

setPalette() [3/3]

void Graphics::Screen::setPalette ( const Graphics::Palette &  pal, uint  start = 0  )

inline

Set a palette based on a passed palette object

clearPalette()

void Graphics::Screen::clearPalette

(

)

Clears the current palette, setting all entries to black

Member Data Documentation

_dirtyRects

Common::List<Common::Rect> Graphics::Screen::_dirtyRects

protected

List of affected areas of the screen

---

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

• graphics/screen.h