StdColors.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	CStdPalette

Macros
#define	C4RGB(r, g, b)   (((DWORD)(0xff)<<24)|(((DWORD)(r)&0xff)<<16)|(((DWORD)(g)&0xff)<<8)|((b)&0xff))
#define	GetBlueValue(rgb)   ((unsigned char)(rgb))
#define	GetGreenValue(rgb)   ((unsigned char)(((unsigned short)(rgb)) >> 8))
#define	GetRedValue(rgb)   ((unsigned char)((rgb)>>16))

Functions
uint32_t	RGBA (uint32_t r, uint32_t g, uint32_t b, uint32_t a)
void	BltAlpha (DWORD &dwDst, DWORD dwSrc)
void	BltAlphaAdd (DWORD &dwDst, DWORD dwSrc)
void	ModulateClr (DWORD &dwDst, DWORD dwMod)
void	ModulateClrA (DWORD &dwDst, DWORD dwMod)
void	ModulateClrMOD2 (DWORD &dwDst, DWORD dwMod)
DWORD	LightenClrBy (DWORD &dwDst, int iBy)
DWORD	DarkenClrBy (DWORD &dwDst, int iBy)
DWORD	PlrClr2TxtClr (DWORD dwClr)
DWORD	GetClrModulation (DWORD dwSrcClr, DWORD dwDstClr, DWORD &dwBack)
bool	rgb2xyY (double r, double g, double b, double *px, double *py, double *pY)
bool	xy2upvp (double x, double y, double *pu, double *pv)
bool	RGB2rgb (int R, int G, int B, double *pr, double *pg, double *pb, double gamma=2.2)

Macro Definition Documentation

C4RGB

#define C4RGB	(		r,
			g,
			b
	)		(((DWORD)(0xff)<<24)|(((DWORD)(r)&0xff)<<16)|(((DWORD)(g)&0xff)<<8)|((b)&0xff))

Definition at line 26 of file StdColors.h.

Referenced by C4Draw::ApplyGammaTo(), C4ConsoleGUIPreviewWindow::Close(), C4TransferZone::Draw(), C4PathFinderRay::Draw(), C4Def::Draw(), C4Object::Draw(), C4ScriptGuiWindow::Draw(), C4MenuItem::DrawElement(), C4Chart::DrawElement(), C4Menu::DrawFrame(), C4Command::Fail(), GameMsgObject(), GameMsgObjectError(), GameMsgObjectPlayer(), GenerateRandomPlayerColor(), CPNGFile::GetPix(), C4StartupPlrColorPickerDlg::OnClosed(), CSurface8::Read(), C4Surface::ReadBMP(), C4Sky::SetFadePalette(), C4TextureMap::StoreMapPalette(), and C4Network2ClientDlg::UpdateText().

GetBlueValue

#define GetBlueValue

(

rgb

)

((unsigned char)(rgb))

Definition at line 27 of file StdColors.h.

Referenced by C4Draw::ApplyGammaTo(), C4PlayerList::CheckColorDw(), ClrByOwner(), CStdGL::FillBG(), C4Draw::Grayscale(), C4StartupPlrColorPickerDlg::OnClosed(), PlrClr2TxtClr(), C4BMP256Info::Set(), C4FoWLight::SetColor(), CPNGFile::SetPix(), and C4TextureMap::StoreMapPalette().

GetGreenValue

#define GetGreenValue

(

rgb

)

((unsigned char)(((unsigned short)(rgb)) >> 8))

Definition at line 28 of file StdColors.h.

Referenced by C4Draw::ApplyGammaTo(), C4PlayerList::CheckColorDw(), ClrByOwner(), CStdGL::FillBG(), C4Draw::Grayscale(), C4StartupPlrColorPickerDlg::OnClosed(), PlrClr2TxtClr(), C4BMP256Info::Set(), C4FoWLight::SetColor(), CPNGFile::SetPix(), and C4TextureMap::StoreMapPalette().

GetRedValue

#define GetRedValue

(

rgb

)

((unsigned char)((rgb)>>16))

Definition at line 29 of file StdColors.h.

Referenced by C4Draw::ApplyGammaTo(), C4PlayerList::CheckColorDw(), ClrByOwner(), CStdGL::FillBG(), C4Draw::Grayscale(), C4StartupPlrColorPickerDlg::OnClosed(), PlrClr2TxtClr(), C4BMP256Info::Set(), C4FoWLight::SetColor(), CPNGFile::SetPix(), and C4TextureMap::StoreMapPalette().

Function Documentation

BltAlpha()

void BltAlpha ( DWORD &  dwDst, DWORD  dwSrc  )

inline

Definition at line 31 of file StdColors.h.

Referenced by CStdFont::AddRenderedChar(), C4Surface::BltPix(), and C4Surface::GetPixDw().

{
    // blit one color value w/alpha on another
    if (dwDst>>24 == 0x00) { dwDst=dwSrc; return; }
    BYTE byAlphaSrc=BYTE(dwSrc>>24); BYTE byAlphaDst=255-byAlphaSrc;
    dwDst = std::min<uint32_t>(((dwDst    & 0xff ) * byAlphaDst + (dwSrc & 0xff    ) * byAlphaSrc) >>8,            0xff)      | // blue
            std::min<uint32_t>(((dwDst   & 0xff00) * byAlphaDst + (dwSrc & 0xff00  ) * byAlphaSrc) >>8 & 0xff00,   0xff00)    | // green
            std::min<uint32_t>(((dwDst & 0xff0000) * byAlphaDst + (dwSrc & 0xff0000) * byAlphaSrc) >>8 & 0xff0000, 0xff0000)  | // red
            std::min<uint32_t>( (dwDst >> 24) + byAlphaSrc, 255) << 24; // alpha
}

Here is the caller graph for this function:

BltAlphaAdd()

void BltAlphaAdd ( DWORD &  dwDst, DWORD  dwSrc  )

inline

Definition at line 42 of file StdColors.h.

Referenced by C4Surface::BltPix().

{
    // blit one color value w/alpha on another in additive mode
    if (dwDst>>24 == 0x00) { dwDst=dwSrc; return; }
    BYTE byAlphaSrc=BYTE(dwSrc>>24);
    dwDst = std::min<uint32_t>((dwDst    & 0xff ) + ((int(dwSrc    & 0xff  ) * byAlphaSrc) >>8)       , 0xff)      | // blue
            std::min<uint32_t>(((dwDst   & 0xff00) + (int(dwSrc>>8 & 0xff  ) * byAlphaSrc)) & 0x00ffff00, 0xff00)    | // green
            std::min<uint32_t>(((dwDst & 0xff0000) + (int(dwSrc>>8 & 0xff00) * byAlphaSrc)) & 0xffff0000, 0xff0000)  | // red
            std::min<uint32_t>( (dwDst >> 24) + byAlphaSrc, 255) << 24; // alpha
}

Here is the caller graph for this function:

DarkenClrBy()

DWORD DarkenClrBy ( DWORD &  dwDst, int  iBy  )

inline

Definition at line 93 of file StdColors.h.

{
    // darken a color
    // quite a desaturating method...
    dwDst = std::max<int>(int(dwDst     & 0xff) - iBy, 0)       | // blue
            std::max<int>(int(dwDst>> 8 & 0xff) - iBy, 0) <<  8 | // green
            std::max<int>(int(dwDst>>16 & 0xff) - iBy, 0) << 16 | // red
            (dwDst & 0xff000000);                     // alpha
    return dwDst;
}

GetClrModulation()

DWORD GetClrModulation ( DWORD  dwSrcClr, DWORD  dwDstClr, DWORD &  dwBack  )

inline

Definition at line 112 of file StdColors.h.

References RGBA().

{
    // get modulation that is necessary to transform dwSrcClr to dwDstClr
    // does not support alpha values in dwSrcClr and dwDstClr
    // get source color
    BYTE sB=BYTE(dwSrcClr); dwSrcClr=dwSrcClr>>8;
    BYTE sG=BYTE(dwSrcClr); dwSrcClr=dwSrcClr>>8;
    BYTE sR=BYTE(dwSrcClr); dwSrcClr=dwSrcClr>>8;
    // get dest color
    BYTE dB=BYTE(dwDstClr); dwDstClr=dwDstClr>>8;
    BYTE dG=BYTE(dwDstClr); dwDstClr=dwDstClr>>8;
    BYTE dR=BYTE(dwDstClr); dwDstClr=dwDstClr>>8;
    // get difference
    int cR=(int) dR-sR;
    int cG=(int) dG-sG;
    int cB=(int) dB-sB;
    // get max enlightment
    int diffN=0;
    if (cR>0) diffN=cR;
    if (cG>0) diffN=std::max(diffN, cG);
    if (cB>0) diffN=std::max(diffN, cB);
    // is dest > src?
    if (diffN)
    {
        // so a back mask must be used
        int bR=sR+(cR*255)/diffN;
        int bG=sG+(cG*255)/diffN;
        int bB=sB+(cB*255)/diffN;
        dwBack=RGBA(bR, bG, bB, 255);
    }
    if (!sR) sR=1; if (!sG) sG=1; if (!sB) sB=1;
    return RGBA(std::min((int)dR*256/sR, 255), std::min((int)dG*256/sG, 255), std::min((int)dB*256/sB, 255), 255-diffN);
}

Here is the call graph for this function:

LightenClrBy()

DWORD LightenClrBy ( DWORD &  dwDst, int  iBy  )

inline

Definition at line 82 of file StdColors.h.

Referenced by PlrClr2TxtClr().

{
    // enlight a color
    // quite a desaturating method...
    dwDst = std::min<int>((dwDst     & 0xff) + iBy, 255)       | // blue
            std::min<int>((dwDst>> 8 & 0xff) + iBy, 255) <<  8 | // green
            std::min<int>((dwDst>>16 & 0xff) + iBy, 255) << 16 | // red
            (dwDst & 0xff000000);                     // alpha
    return dwDst;
}

Here is the caller graph for this function:

ModulateClr()

void ModulateClr ( DWORD &  dwDst, DWORD  dwMod  )

inline

Definition at line 53 of file StdColors.h.

Referenced by CStdFont::DrawText(), and C4Surface::GetPixDw().

{
    // modulate two color values
    // get alpha
    int iA1=dwDst>>24, iA2=dwMod>>24;
    // modulate color values; mod alpha upwards
    dwDst = ((dwDst     & 0xff) * (dwMod     & 0xff) / 0xff)      | // blue
            ((dwDst>> 8 & 0xff) * (dwMod>> 8 & 0xff) / 0xff) << 8 | // green
            ((dwDst>>16 & 0xff) * (dwMod>>16 & 0xff) / 0xff) << 16| // red
            std::min(iA1*iA2/0xff, 255)                           << 24; // alpha (TODO: We don't need std::min() here, do we?)
}

Here is the caller graph for this function:

ModulateClrA()

void ModulateClrA ( DWORD &  dwDst, DWORD  dwMod  )

inline

Definition at line 65 of file StdColors.h.

Referenced by CStdFont::DrawText().

{
    // modulate two color values and add alpha value
    dwDst = ((dwDst     & 0xff) * (dwMod     & 0xff) / 0xff)      | // B
            ((dwDst>> 8 & 0xff) * (dwMod>> 8 & 0xff) / 0xff) << 8 | // G
            ((dwDst>>16 & 0xff) * (dwMod>>16 & 0xff) / 0xff) << 16| // R
            (std::max<uint32_t>((dwDst>>24)+(dwMod>>24), 0xff) - 0xff)<<24;
}

Here is the caller graph for this function:

ModulateClrMOD2()

void ModulateClrMOD2 ( DWORD &  dwDst, DWORD  dwMod  )

inline

Definition at line 73 of file StdColors.h.

Referenced by C4Surface::GetPixDw().

{
    // signed color addition
    dwDst = (Clamp<int>(((int)(dwDst&0xff)+(dwMod&0xff)-0x7f)<<1,0,0xff)&0xff) |  // B
            (Clamp<int>(((int)(dwDst&0xff00)+(dwMod&0xff00)-0x7f00)<<1,0,0xff00)&0xff00) | // G
            (Clamp<int>(((int)(dwDst&0xff0000)+(dwMod&0xff0000)-0x7f0000)<<1,0,0xff0000)&0xff0000) | // R
            (std::max<uint32_t>((dwDst>>24)+(dwMod>>24), 0xff) - 0xff)<<24;
}

Here is the caller graph for this function:

PlrClr2TxtClr()

DWORD PlrClr2TxtClr ( DWORD  dwClr )

inline

Definition at line 104 of file StdColors.h.

References GetBlueValue, GetGreenValue, GetRedValue, and LightenClrBy().

Referenced by C4MessageBoard::Draw().

{
    // convert player color to text color, lightening up when necessary
    int lgt=std::max(std::max(GetRedValue(dwClr), GetGreenValue(dwClr)), GetBlueValue(dwClr));
    if (lgt<0x8f) LightenClrBy(dwClr, 0x8f-lgt);
    return dwClr|0xff000000;
}

Here is the call graph for this function:

Here is the caller graph for this function:

RGB2rgb()

bool RGB2rgb ( int  R, int  G, int  B, double *  pr, double *  pg, double *  pb, double  gamma = 2.2  )

inline

Definition at line 173 of file StdColors.h.

Referenced by IsColorConflict().

{
    *pr = pow((double) R / 255.0, 1.0/gamma);
    *pg = pow((double) G / 255.0, 1.0/gamma);
    *pb = pow((double) B / 255.0, 1.0/gamma);
    return true;
}

Here is the caller graph for this function:

rgb2xyY()

bool rgb2xyY ( double  r, double  g, double  b, double *  px, double *  py, double *  pY  )

inline

Definition at line 146 of file StdColors.h.

References b, and X.

Referenced by IsColorConflict().

{
    double X = 0.412453*r + 0.357580*g + 0.180423*b;
    double Y = 0.212671*r + 0.715160*g + 0.072169*b;
    double Z = 0.019334*r + 0.119193*g + 0.950227*b;
    double XYZ=X+Y+Z;
    if (!XYZ)
    {
        *px=*py=0.3; // assume grey cromaticity for black
    }
    else
    {
        *px = X/XYZ; *py = Y/XYZ;
    }
    *pY = Y;
    return true;
}

Here is the caller graph for this function:

RGBA()

uint32_t RGBA ( uint32_t  r, uint32_t  g, uint32_t  b, uint32_t  a  )

inline

Definition at line 22 of file StdColors.h.

Referenced by CStdFont::AddRenderedChar(), C4LandscapeRenderGL::Clear(), ClrByOwner(), GetClrModulation(), CPNGFile::GetPix(), C4Draw::Grayscale(), and C4LandscapeRenderGL::Update().

{
    return ((a & 255) << 24) | ((r & 255) << 16) | ((g & 255) << 8) | (b & 255);
}

Here is the caller graph for this function:

xy2upvp()

bool xy2upvp ( double  x, double  y, double *  pu, double *  pv  )

inline

Definition at line 164 of file StdColors.h.

Referenced by IsColorConflict().

{
    double n = -2.0*x+12.0*y+3.0;
    if (!n) return false;
    *pu = 4.0*x / n;
    *pv = 9.0*y / n;
    return true;
}

Here is the caller graph for this function: