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

PaletteManager Class Reference

The PaletteManager is part of the OSystem backend API and responsible for handling the (possibly emulated) "hardware" palette needed for many old games (e.g. More...

#include <palette.h>

Inheritance diagram for PaletteManager:
Collaboration diagram for PaletteManager:

List of all members.

Public Member Functions

virtual ~PaletteManager ()
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.

Detailed Description

The PaletteManager is part of the OSystem backend API and responsible for handling the (possibly emulated) "hardware" palette needed for many old games (e.g.

in EGA and VGA mode).

By itself it is a pure abstract class, i.e. an "interface"; you can use the OSystem::getPaletteManager() method to obtain an instance that you can use to perform actual palette modifications.

Definition at line 38 of file palette.h.


Constructor & Destructor Documentation

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

Definition at line 40 of file palette.h.


Member Function Documentation

virtual void PaletteManager::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

Implemented in DefaultPaletteManager, and GraphicsManager.

virtual void PaletteManager::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

Implemented in DefaultPaletteManager, and GraphicsManager.


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


Generated on Sat Sep 14 2019 05:03:15 for ResidualVM by doxygen 1.7.1
curved edge   curved edge