ScummVM API documentation
Xeen::Screen Class Reference
Inheritance diagram for Xeen::Screen:
Graphics::Screen Graphics::ManagedSurface

Public Member Functions

 Screen (XeenEngine *vm)
 
void addDirtyRect (const Common::Rect &r) override
 
void loadPalette (const Common::String &name)
 
void loadBackground (const Common::String &name)
 
void loadPage (int pageNum)
 
void freePages ()
 
void horizMerge (int xp=0)
 
void vertMerge (int yp)
 
void fadeIn (int step=4)
 
void fadeOut (int step=4)
 
void saveBackground (int slot=1)
 
void restoreBackground (int slot=1)
 
bool doScroll (bool rollUp, bool fadeInFlag)
 
- Public Member Functions inherited from Graphics::Screen
 Screen (int width, int height)
 
 Screen (int width, int height, PixelFormat pixelFormat)
 
bool isDirty () const
 
void makeAllDirty ()
 
virtual void clearDirtyRects ()
 
virtual void update ()
 
virtual void updateScreen ()
 
void getPalette (byte palette[(256 *3)])
 
void getPalette (byte *palette, uint start, uint num)
 
void setPalette (const byte palette[(256 *3)])
 
void setPalette (const byte *palette, uint start, uint num)
 
void clearPalette ()
 
- Public Member Functions inherited from Graphics::ManagedSurface
bool clip (Common::Rect &srcBounds, Common::Rect &destBounds) const
 
 ManagedSurface ()
 
 ManagedSurface (const 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 SurfacerawSurface () const
 
SurfacesurfacePtr ()
 
ManagedSurfaceoperator= (const 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 blitFrom (const Surface &src)
 
void blitFrom (const Surface &src, const Common::Point &destPos)
 
void blitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos)
 
void blitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect)
 
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, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff)
 
void transBlitFrom (const Surface &src, const Common::Point &destPos, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff)
 
void transBlitFrom (const Surface &src, const Common::Point &destPos, const ManagedSurface &mask)
 
void transBlitFrom (const Surface &src, const Common::Point &destPos, const Surface &mask)
 
void transBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff)
 
void transBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff, const Surface *mask=nullptr, bool maskOnly=false)
 
void transBlitFrom (const ManagedSurface &src, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff)
 
void transBlitFrom (const ManagedSurface &src, const Common::Point &destPos, uint transColor=0, bool flipped=false, uint overrideColor=0, uint 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, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff)
 
void transBlitFrom (const ManagedSurface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint transColor=0, bool flipped=false, uint overrideColor=0, uint srcAlpha=0xff, const Surface *mask=nullptr, bool maskOnly=false)
 
void rawBlitFrom (const Surface &src, const Common::Rect &srcRect, const Common::Point &destPos, const uint32 *palette)
 
void clear (uint 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 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)
 
Surface getSubArea (const Common::Rect &area)
 
void convertToInPlace (const PixelFormat &dstFormat, const byte *palette=nullptr)
 
uint getTransparentColor () const
 
void setTransparentColor (uint color)
 
void clearTransparentColor ()
 
bool hasTransparentColor () const
 
void clearPalette ()
 
const uint32 * getPalette () const
 
void setPalette (const byte *colors, uint start, uint num)
 
void setPalette (const uint32 *colors, uint start, uint num)
 

Additional Inherited Members

- Public Attributes inherited from Graphics::ManagedSurface
int16 & w
 
int16 & h
 
int16 & pitch
 
PixelFormatformat
 
- Protected Member Functions inherited from Graphics::Screen
void mergeDirtyRects ()
 
bool unionRectangle (Common::Rect &destRect, const Common::Rect &src1, const Common::Rect &src2)
 
- Protected Member Functions inherited from Graphics::ManagedSurface
void blitFromInner (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, const uint32 *srcPalette)
 
void transBlitFromInner (const Surface &src, const Common::Rect &srcRect, const Common::Rect &destRect, uint transColor, bool flipped, uint overrideColor, uint srcAlpha, const uint32 *srcPalette, const uint32 *dstPalette, const Surface *mask, bool maskOnly)
 
- Protected Attributes inherited from Graphics::Screen
Common::List< Common::Rect_dirtyRects
 

Member Function Documentation

◆ addDirtyRect()

void Xeen::Screen::addDirtyRect ( const Common::Rect r)
inlineoverridevirtual

Base method that descendent classes can override for recording affected dirty areas of the surface

Reimplemented from Graphics::Screen.

◆ loadPalette()

void Xeen::Screen::loadPalette ( const Common::String name)

Load a palette resource into the temporary palette

◆ loadBackground()

void Xeen::Screen::loadBackground ( const Common::String name)

Load a background resource into memory

◆ loadPage()

void Xeen::Screen::loadPage ( int  pageNum)

Copy a loaded background into a display page

◆ horizMerge()

void Xeen::Screen::horizMerge ( int  xp = 0)

Merge the two pages along a horizontal split point

◆ vertMerge()

void Xeen::Screen::vertMerge ( int  yp)

Merge the two pages along a vertical split point

◆ fadeIn()

void Xeen::Screen::fadeIn ( int  step = 4)

Fades in the screen

◆ fadeOut()

void Xeen::Screen::fadeOut ( int  step = 4)

Fades out the screen

◆ saveBackground()

void Xeen::Screen::saveBackground ( int  slot = 1)

Saves a copy of the current screen into a specified slot

◆ restoreBackground()

void Xeen::Screen::restoreBackground ( int  slot = 1)

Restores a previously saved screen

◆ doScroll()

bool Xeen::Screen::doScroll ( bool  rollUp,
bool  fadeInFlag 
)

Draws the scroll in the background

Parameters
rollUpIf true, rolls up the scroll. If false, unrolls.
fadeInFlagIf true, does an initial fade in
Returns
True if key or mouse pressed

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