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

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::GraphicsModegetSupportedGraphicsModes () 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::SurfacelockScreen () 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, bool dontScale=false, const Graphics::PixelFormat *format=NULL, const byte *mask=NULL) 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::KeymapgetKeymap () const
 
- Public Member Functions inherited from GraphicsManager
virtual bool setShader (const Common::Path &fileName)
 
virtual const OSystem::GraphicsModegetSupportedStretchModes () const
 
virtual int getDefaultStretchMode () const
 
virtual bool setStretchMode (int mode)
 
virtual int getStretchMode () const
 
virtual Common::RotationMode getRotationMode () const
 
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 initSizeHint (const Graphics::ModeList &modes)
 
virtual float getHiDPIScreenFactor () const
 
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
void setPalette (const Graphics::Palette &pal, uint start=0)
 
Graphics::Palette grabPalette (uint start, uint num)
 

Protected Types

typedef void *(* AtariMemAlloc) (size_t bytes)
 
typedef void(* AtariMemFree) (void *ptr)
 

Protected Member Functions

void allocateSurfaces ()
 
void freeSurfaces ()
 

Member Function Documentation

◆ 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.

◆ 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: