ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

GraphicsManager Class Reference

Abstract class for graphics manager. More...

#include <graphics.h>

Inheritance diagram for GraphicsManager:
Collaboration diagram for GraphicsManager:

List of all members.

Public Member Functions

virtual ~GraphicsManager ()
virtual bool hasFeature (OSystem::Feature f) const =0
virtual void setFeatureState (OSystem::Feature f, bool enable)=0
virtual bool getFeatureState (OSystem::Feature f) const =0
virtual const
OSystem::GraphicsMode
getSupportedGraphicsModes () const =0
virtual int getDefaultGraphicsMode () const =0
virtual bool setGraphicsMode (int mode)=0
virtual void resetGraphicsScale ()=0
virtual int getGraphicsMode () const =0
virtual const
OSystem::GraphicsMode
getSupportedShaders () const
virtual bool setShader (int id)
virtual int getShader () const
virtual const
OSystem::GraphicsMode
getSupportedStretchModes () const
virtual int getDefaultStretchMode () const
virtual bool setStretchMode (int mode)
virtual int getStretchMode () const
virtual Graphics::PixelFormat getScreenFormat () const =0
virtual Common::List
< Graphics::PixelFormat
getSupportedFormats () const =0
virtual void initSize (uint width, uint height, const Graphics::PixelFormat *format=NULL)=0
virtual void initSizeHint (const Graphics::ModeList &modes)
virtual int getScreenChangeID () const =0
virtual void beginGFXTransaction ()=0
virtual OSystem::TransactionError endGFXTransaction ()=0
virtual void setupScreen (uint screenW, uint screenH, bool fullscreen, bool accel3d)=0
virtual Graphics::PixelBuffer getScreenPixelBuffer ()=0
virtual void suggestSideTextures (Graphics::Surface *left, Graphics::Surface *right)=0
virtual int16 getHeight () const =0
virtual int16 getWidth () const =0
virtual void setPalette (const byte *colors, uint start, uint num)=0
 Replace the specified range of the palette with new colors.
virtual void grabPalette (byte *colors, uint start, uint num) const =0
 Grabs a specified part of the currently active palette.
virtual void copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h)=0
virtual Graphics::SurfacelockScreen ()=0
virtual void unlockScreen ()=0
virtual void fillScreen (uint32 col)=0
virtual void updateScreen ()=0
virtual void setShakePos (int shakeOffset)=0
virtual void setFocusRectangle (const Common::Rect &rect)=0
virtual void clearFocusRectangle ()=0
virtual void showOverlay ()=0
virtual void hideOverlay ()=0
virtual Graphics::PixelFormat getOverlayFormat () const =0
virtual void clearOverlay ()=0
virtual void grabOverlay (void *buf, int pitch) const =0
virtual void copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h)=0
virtual int16 getOverlayHeight () const =0
virtual int16 getOverlayWidth () const =0
virtual bool showMouse (bool visible)=0
virtual void warpMouse (int x, int y)=0
virtual void setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, bool dontScale=false, const Graphics::PixelFormat *format=NULL)=0
virtual void setCursorPalette (const byte *colors, uint start, uint num)=0
virtual bool lockMouse (bool lock)=0
virtual void displayMessageOnOSD (const char *msg)
virtual void displayActivityIconOnOSD (const Graphics::Surface *icon)

Detailed Description

Abstract class for graphics manager.

Subclasses implement the real functionality.

Definition at line 37 of file graphics.h.


Constructor & Destructor Documentation

virtual GraphicsManager::~GraphicsManager (  )  [inline, virtual]

Definition at line 39 of file graphics.h.


Member Function Documentation

virtual void GraphicsManager::beginGFXTransaction (  )  [pure virtual]
virtual void GraphicsManager::clearFocusRectangle (  )  [pure virtual]
virtual void GraphicsManager::clearOverlay (  )  [pure virtual]
virtual void GraphicsManager::copyRectToOverlay ( const void *  buf,
int  pitch,
int  x,
int  y,
int  w,
int  h 
) [pure virtual]
virtual void GraphicsManager::copyRectToScreen ( const void *  buf,
int  pitch,
int  x,
int  y,
int  w,
int  h 
) [pure virtual]
virtual void GraphicsManager::displayActivityIconOnOSD ( const Graphics::Surface icon  )  [inline, virtual]

Definition at line 113 of file graphics.h.

virtual void GraphicsManager::displayMessageOnOSD ( const char *  msg  )  [inline, virtual]

Definition at line 112 of file graphics.h.

virtual OSystem::TransactionError GraphicsManager::endGFXTransaction (  )  [pure virtual]
virtual void GraphicsManager::fillScreen ( uint32  col  )  [pure virtual]
virtual int GraphicsManager::getDefaultGraphicsMode (  )  const [pure virtual]
virtual int GraphicsManager::getDefaultStretchMode (  )  const [inline, virtual]

Definition at line 60 of file graphics.h.

virtual bool GraphicsManager::getFeatureState ( OSystem::Feature  f  )  const [pure virtual]
virtual int GraphicsManager::getGraphicsMode (  )  const [pure virtual]
virtual int16 GraphicsManager::getHeight (  )  const [pure virtual]
virtual Graphics::PixelFormat GraphicsManager::getOverlayFormat (  )  const [pure virtual]
virtual int16 GraphicsManager::getOverlayHeight (  )  const [pure virtual]
virtual int16 GraphicsManager::getOverlayWidth (  )  const [pure virtual]
virtual int GraphicsManager::getScreenChangeID (  )  const [pure virtual]
virtual Graphics::PixelFormat GraphicsManager::getScreenFormat (  )  const [pure virtual]
virtual Graphics::PixelBuffer GraphicsManager::getScreenPixelBuffer (  )  [pure virtual]
virtual int GraphicsManager::getShader (  )  const [inline, virtual]

Definition at line 55 of file graphics.h.

virtual int GraphicsManager::getStretchMode (  )  const [inline, virtual]

Definition at line 62 of file graphics.h.

virtual Common::List<Graphics::PixelFormat> GraphicsManager::getSupportedFormats (  )  const [pure virtual]
virtual const OSystem::GraphicsMode* GraphicsManager::getSupportedGraphicsModes (  )  const [pure virtual]
virtual const OSystem::GraphicsMode* GraphicsManager::getSupportedShaders (  )  const [inline, virtual]

Definition at line 50 of file graphics.h.

virtual const OSystem::GraphicsMode* GraphicsManager::getSupportedStretchModes (  )  const [inline, virtual]

Definition at line 56 of file graphics.h.

virtual int16 GraphicsManager::getWidth (  )  const [pure virtual]
virtual void GraphicsManager::grabOverlay ( void *  buf,
int  pitch 
) const [pure virtual]
virtual void GraphicsManager::grabPalette ( byte colors,
uint  start,
uint  num 
) const [pure virtual]

Grabs a specified part of the currently active palette.

The format is the same as for setPalette.

This should return exactly the same RGB data as was setup via previous setPalette calls.

For example, for every valid value of start and num of the following code:

byte origPal[num*3]; // Setup origPal's data however you like g_system->setPalette(origPal, start, num); byte obtainedPal[num*3]; g_system->grabPalette(obtainedPal, start, num);

the following should be true:

memcmp(origPal, obtainedPal, num*3) == 0

See also:
setPalette
Parameters:
colors the palette data, in interleaved RGB format
start the first platte entry to be read
num the number of palette entries to be read
Note:
It is an error if this function gets called when the pixel format in use (the return value of getScreenFormat) has more than one byte per pixel.
See also:
getScreenFormat

Implements PaletteManager.

virtual bool GraphicsManager::hasFeature ( OSystem::Feature  f  )  const [pure virtual]
virtual void GraphicsManager::hideOverlay (  )  [pure virtual]
virtual void GraphicsManager::initSize ( uint  width,
uint  height,
const Graphics::PixelFormat format = NULL 
) [pure virtual]
virtual void GraphicsManager::initSizeHint ( const Graphics::ModeList modes  )  [inline, virtual]

Definition at line 69 of file graphics.h.

virtual bool GraphicsManager::lockMouse ( bool  lock  )  [pure virtual]
virtual Graphics::Surface* GraphicsManager::lockScreen (  )  [pure virtual]
virtual void GraphicsManager::resetGraphicsScale (  )  [pure virtual]
virtual void GraphicsManager::setCursorPalette ( const byte colors,
uint  start,
uint  num 
) [pure virtual]
virtual void GraphicsManager::setFeatureState ( OSystem::Feature  f,
bool  enable 
) [pure virtual]
virtual void GraphicsManager::setFocusRectangle ( const Common::Rect rect  )  [pure virtual]
virtual bool GraphicsManager::setGraphicsMode ( int  mode  )  [pure virtual]
virtual void GraphicsManager::setMouseCursor ( const void *  buf,
uint  w,
uint  h,
int  hotspotX,
int  hotspotY,
uint32  keycolor,
bool  dontScale = false,
const Graphics::PixelFormat format = NULL 
) [pure virtual]
virtual void GraphicsManager::setPalette ( const byte colors,
uint  start,
uint  num 
) [pure virtual]

Replace the specified range of the palette with new colors.

The palette entries from 'start' till (start+num-1) will be replaced - so a full palette update is accomplished via start=0, num=256.

The palette data is specified in interleaved RGB format. That is, the first byte of the memory block 'colors' points at is the red component of the first new color; the second byte the green component of the first new color; the third byte the blue component, the last byte to the alpha (transparency) value. Then the second color starts, and so on. So memory looks like this: R1-G1-B1-R2-G2-B2-R3-...

Parameters:
colors the new palette data, in interleaved RGB format
start the first palette entry to be updated
num the number of palette entries to be updated
Note:
It is an error if start+num exceeds 256, behavior is undefined in that case (the backend may ignore it silently or assert).
It is an error if this function gets called when the pixel format in use (the return value of getScreenFormat) has more than one byte per pixel.
See also:
getScreenFormat

Implements PaletteManager.

virtual bool GraphicsManager::setShader ( int  id  )  [inline, virtual]

Definition at line 54 of file graphics.h.

virtual void GraphicsManager::setShakePos ( int  shakeOffset  )  [pure virtual]
virtual bool GraphicsManager::setStretchMode ( int  mode  )  [inline, virtual]

Definition at line 61 of file graphics.h.

virtual void GraphicsManager::setupScreen ( uint  screenW,
uint  screenH,
bool  fullscreen,
bool  accel3d 
) [pure virtual]
virtual bool GraphicsManager::showMouse ( bool  visible  )  [pure virtual]
virtual void GraphicsManager::showOverlay (  )  [pure virtual]
virtual void GraphicsManager::suggestSideTextures ( Graphics::Surface left,
Graphics::Surface right 
) [pure virtual]
virtual void GraphicsManager::unlockScreen (  )  [pure virtual]
virtual void GraphicsManager::updateScreen (  )  [pure virtual]
virtual void GraphicsManager::warpMouse ( int  x,
int  y 
) [pure virtual]

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


Generated on Sat Jan 19 2019 05:04:09 for ResidualVM by doxygen 1.7.1
curved edge   curved edge