CartoType API
Public Member Functions
CartoType::MPalette Class Reference

#include <cartotype_graphics.h>

Inheritance diagram for CartoType::MPalette:
CartoType::TSimplePalette< aColors >

List of all members.

Public Member Functions

virtual TColor Foreground (int32 aIndex) const =0
virtual TColor Background (int32 aIndex) const =0
virtual int32 Count () const =0
virtual int32 AddEntry (TResult &aError, TColor aForeground, TColor aBackground)=0

Detailed Description

A palette supplies a foreground and background colors for a given color index. The foreground is blended with the background before blending with the destination.


Member Function Documentation

virtual int32 CartoType::MPalette::AddEntry ( TResult aError,
TColor  aForeground,
TColor  aBackground 
) [pure virtual]

Add a new entry if possible, returning its index. If the combination of foreground and background colors already exists in the palette, returns its index. Return 0 and set aError if the operation fails.

Implemented in CartoType::TSimplePalette< aColors >, and CartoType::TSimplePalette< 16 >.

virtual TColor CartoType::MPalette::Background ( int32  aIndex) const [pure virtual]

Supply a background for color index aIndex. If the 'null color' KTransparentBlack is supplied no background is drawn.

Implemented in CartoType::TSimplePalette< aColors >, and CartoType::TSimplePalette< 16 >.

virtual int32 CartoType::MPalette::Count ( ) const [pure virtual]

Return the number of entries in the palette.

Implemented in CartoType::TSimplePalette< aColors >, and CartoType::TSimplePalette< 16 >.

virtual TColor CartoType::MPalette::Foreground ( int32  aIndex) const [pure virtual]

Supply a color for color index aIndex.

Implemented in CartoType::TSimplePalette< aColors >, and CartoType::TSimplePalette< 16 >.


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