ScummVM API documentation
AtariGraphicsManager Class Referencefinal
Inheritance diagram for AtariGraphicsManager:
GraphicsManager Common::EventObserver PaletteManager Common::NonCopyable

Public Member Functions

bool hasFeature (OSystem::Feature f) const override
 
void setFeatureState (OSystem::Feature f, bool enable) override
 
bool getFeatureState (OSystem::Feature f) const override
 
const OSystem::GraphicsMode * getSupportedGraphicsModes () const override
 
int getDefaultGraphicsMode () const override
 
bool setGraphicsMode (int mode, uint flags=OSystem::kGfxModeNoFlags) override
 
int getGraphicsMode () const override
 
void initSize (uint width, uint height, const Graphics::PixelFormat *format=NULL) override
 
int getScreenChangeID () const override
 
void beginGFXTransaction () override
 
OSystem::TransactionError endGFXTransaction () override
 
int16 getHeight () const override
 
int16 getWidth () const override
 
void setPalette (const byte *colors, uint start, uint num) override
 
void grabPalette (byte *colors, uint start, uint num) const override
 
void copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h) override
 
Graphics::Surface * lockScreen () override
 
void unlockScreen () override
 
void fillScreen (uint32 col) override
 
void fillScreen (const Common::Rect &r, uint32 col) override
 
void updateScreen () override
 
void setShakePos (int shakeXOffset, int shakeYOffset) override
 
void setFocusRectangle (const Common::Rect &rect) override
 
void clearFocusRectangle () override
 
void showOverlay (bool inGUI) override
 
void hideOverlay () override
 
bool isOverlayVisible () const override
 
Graphics::PixelFormat getOverlayFormat () const override
 
void clearOverlay () override
 
void grabOverlay (Graphics::Surface &surface) const override
 
void copyRectToOverlay (const void *buf, int pitch, int x, int y, int w, int h) override
 
int16 getOverlayHeight () const override
 
int16 getOverlayWidth () const override
 
bool showMouse (bool visible) override
 
void warpMouse (int x, int y) override
 
void setMouseCursor (const void *buf, uint w, uint h, int hotspotX, int hotspotY, uint32 keycolor, const Graphics::PixelFormat *format, const byte *mask, frac_t scaleX, frac_t scaleY) override
 
void setCursorPalette (const byte *colors, uint start, uint num) override
 
Common::Point getMousePosition () const
 
void updateMousePosition (int deltaX, int deltaY)
 
bool notifyEvent (const Common::Event &event) override
 
Common::Keymap * getKeymap () const
 
- Public Member Functions inherited from 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
 
virtual int getDefaultGraphicsMode () const
 
virtual bool setGraphicsMode (int mode, uint flags=OSystem::kGfxModeNoFlags)
 
virtual int getGraphicsMode () const
 
virtual bool setShader (const Common::Path &fileName)
 
virtual const OSystem::GraphicsMode * getSupportedStretchModes () const
 
virtual int getDefaultStretchMode () const
 
virtual bool setStretchMode (int mode)
 
virtual int getStretchMode () const
 
virtual bool setRotationMode (Common::RotationMode rotation)
 
virtual uint getDefaultScaler () const
 
virtual uint getDefaultScaleFactor () const
 
virtual bool setScaler (uint mode, int factor)
 
virtual uint getScaler () const
 
virtual uint getScaleFactor () const
 
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 int16 getHeight () const =0
 
virtual int16 getWidth () const =0
 
void setPalette (const byte *colors, uint start, uint num) override=0
 
void grabPalette (byte *colors, uint start, uint num) const override=0
 
virtual void copyRectToScreen (const void *buf, int pitch, int x, int y, int w, int h)=0
 
virtual Graphics::Surface * lockScreen ()=0
 
virtual void unlockScreen ()=0
 
virtual void fillScreen (uint32 col)=0
 
virtual void fillScreen (const Common::Rect &r, uint32 col)=0
 
virtual void updateScreen ()=0
 
virtual void presentBuffer ()
 
virtual void setShakePos (int shakeXOffset, int shakeYOffset)=0
 
virtual void setFocusRectangle (const Common::Rect &rect)=0
 
virtual void clearFocusRectangle ()=0
 
virtual void showOverlay (bool inGUI)=0
 
virtual void hideOverlay ()=0
 
virtual bool isOverlayVisible () const =0
 
virtual Graphics::PixelFormat getOverlayFormat () const =0
 
virtual void clearOverlay ()=0
 
virtual void grabOverlay (Graphics::Surface &surface) 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 Common::Rect getSafeOverlayArea (int16 *width, int16 *height) const
 
virtual float getHiDPIScreenFactor () const
 
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, const Graphics::PixelFormat *format, const byte *mask, frac_t scaleX, frac_t scaleY)=0
 
virtual void setCursorPalette (const byte *colors, uint start, uint num)=0
 
virtual void displayMessageOnOSD (const Common::U32String &msg)
 
virtual void displayActivityIconOnOSD (const Graphics::Surface *icon)
 
virtual void saveScreenshot ()
 
virtual bool lockMouse (bool lock)
 
- Public Member Functions inherited from PaletteManager
virtual void setPalette (const byte *colors, uint start, uint num)=0
 
void setPalette (const Graphics::Palette &pal, uint start=0)
 
virtual void grabPalette (byte *colors, uint start, uint num) const =0
 
Graphics::Palette grabPalette (uint start, uint num)
 

Member Function Documentation

◆ hasFeature()

bool AtariGraphicsManager::hasFeature ( OSystem::Feature  f) const
overridevirtual

Implements GraphicsManager.

◆ setFeatureState()

void AtariGraphicsManager::setFeatureState ( OSystem::Feature  f,
bool  enable 
)
overridevirtual

Implements GraphicsManager.

◆ getFeatureState()

bool AtariGraphicsManager::getFeatureState ( OSystem::Feature  f) const
overridevirtual

Implements GraphicsManager.

◆ getSupportedGraphicsModes()

const OSystem::GraphicsMode * AtariGraphicsManager::getSupportedGraphicsModes ( void  ) const
inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ getDefaultGraphicsMode()

int AtariGraphicsManager::getDefaultGraphicsMode ( ) const
inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ setGraphicsMode()

bool AtariGraphicsManager::setGraphicsMode ( int  mode,
uint  flags = OSystem::kGfxModeNoFlags 
)
overridevirtual

Reimplemented from GraphicsManager.

◆ getGraphicsMode()

int AtariGraphicsManager::getGraphicsMode ( ) const
inlineoverridevirtual

Reimplemented from GraphicsManager.

◆ initSize()

void AtariGraphicsManager::initSize ( uint  width,
uint  height,
const Graphics::PixelFormat *  format = NULL 
)
overridevirtual

Implements GraphicsManager.

◆ getScreenChangeID()

int AtariGraphicsManager::getScreenChangeID ( ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ beginGFXTransaction()

void AtariGraphicsManager::beginGFXTransaction ( )
overridevirtual

Implements GraphicsManager.

◆ endGFXTransaction()

OSystem::TransactionError AtariGraphicsManager::endGFXTransaction ( )
overridevirtual

Implements GraphicsManager.

◆ getHeight()

int16 AtariGraphicsManager::getHeight ( void  ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ getWidth()

int16 AtariGraphicsManager::getWidth ( void  ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ setPalette()

void AtariGraphicsManager::setPalette ( const byte *  colors,
uint  start,
uint  num 
)
overridevirtual

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
colorsthe new palette data, in interleaved RGB format
startthe first palette entry to be updated
numthe 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 GraphicsManager.

◆ grabPalette()

void AtariGraphicsManager::grabPalette ( byte *  colors,
uint  start,
uint  num 
) const
overridevirtual

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
colorsthe palette data, in interleaved RGB format
startthe first platte entry to be read
numthe 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 GraphicsManager.

◆ copyRectToScreen()

void AtariGraphicsManager::copyRectToScreen ( const void *  buf,
int  pitch,
int  x,
int  y,
int  w,
int  h 
)
overridevirtual

Implements GraphicsManager.

◆ lockScreen()

Graphics::Surface * AtariGraphicsManager::lockScreen ( )
overridevirtual

Implements GraphicsManager.

◆ unlockScreen()

void AtariGraphicsManager::unlockScreen ( )
overridevirtual

Implements GraphicsManager.

◆ fillScreen() [1/2]

void AtariGraphicsManager::fillScreen ( uint32  col)
overridevirtual

Implements GraphicsManager.

◆ fillScreen() [2/2]

void AtariGraphicsManager::fillScreen ( const Common::Rect &  r,
uint32  col 
)
overridevirtual

Implements GraphicsManager.

◆ updateScreen()

void AtariGraphicsManager::updateScreen ( )
overridevirtual

Implements GraphicsManager.

◆ setShakePos()

void AtariGraphicsManager::setShakePos ( int  shakeXOffset,
int  shakeYOffset 
)
overridevirtual

Implements GraphicsManager.

◆ setFocusRectangle()

void AtariGraphicsManager::setFocusRectangle ( const Common::Rect &  rect)
inlineoverridevirtual

Implements GraphicsManager.

◆ clearFocusRectangle()

void AtariGraphicsManager::clearFocusRectangle ( )
inlineoverridevirtual

Implements GraphicsManager.

◆ showOverlay()

void AtariGraphicsManager::showOverlay ( bool  inGUI)
overridevirtual

Implements GraphicsManager.

◆ hideOverlay()

void AtariGraphicsManager::hideOverlay ( )
overridevirtual

Implements GraphicsManager.

◆ isOverlayVisible()

bool AtariGraphicsManager::isOverlayVisible ( ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ getOverlayFormat()

Graphics::PixelFormat AtariGraphicsManager::getOverlayFormat ( ) const
overridevirtual

Implements GraphicsManager.

◆ clearOverlay()

void AtariGraphicsManager::clearOverlay ( )
overridevirtual

Implements GraphicsManager.

◆ grabOverlay()

void AtariGraphicsManager::grabOverlay ( Graphics::Surface &  surface) const
overridevirtual

Implements GraphicsManager.

◆ copyRectToOverlay()

void AtariGraphicsManager::copyRectToOverlay ( const void *  buf,
int  pitch,
int  x,
int  y,
int  w,
int  h 
)
overridevirtual

Implements GraphicsManager.

◆ getOverlayHeight()

int16 AtariGraphicsManager::getOverlayHeight ( void  ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ getOverlayWidth()

int16 AtariGraphicsManager::getOverlayWidth ( void  ) const
inlineoverridevirtual

Implements GraphicsManager.

◆ showMouse()

bool AtariGraphicsManager::showMouse ( bool  visible)
overridevirtual

Implements GraphicsManager.

◆ warpMouse()

void AtariGraphicsManager::warpMouse ( int  x,
int  y 
)
overridevirtual

Implements GraphicsManager.

◆ setMouseCursor()

void AtariGraphicsManager::setMouseCursor ( const void *  buf,
uint  w,
uint  h,
int  hotspotX,
int  hotspotY,
uint32  keycolor,
const Graphics::PixelFormat *  format,
const byte *  mask,
frac_t  scaleX,
frac_t  scaleY 
)
overridevirtual

Implements GraphicsManager.

◆ setCursorPalette()

void AtariGraphicsManager::setCursorPalette ( const byte *  colors,
uint  start,
uint  num 
)
overridevirtual

Implements GraphicsManager.

◆ notifyEvent()

bool AtariGraphicsManager::notifyEvent ( const Common::Event &  event)
overridevirtual

Notify the observer of an incoming event.

An observer is supposed to 'eat' the event, with returning true, when it wants to prevent other observers from receiving the event. A usage example here is the keymapper: If it processes an Event, it should 'eat' it and create a new event, which the EventDispatcher will then catch.

Parameters
eventThe event that is incoming.
Return values
trueIf the event should not be passed to other observers, false otherwise.

Implements Common::EventObserver.


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