fsSColour.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           fsCColour.h
*
*       Purpose:        RGBA rendering colour.
*
*********************************************************************/
 
#ifndef fsCColourhdr
#define fsCColourhdr
 
#include <fsCore/fsBaseTypes.h>
 
class fsStr;
struct fsSColour4B;
 
// More complex colour class to use in graphs and the like.
// Allows basic arithmetic operations
class fsSColour final
{
public:
 
        fsBool operator==(const fsSColour& pRhs) const;
        fsBool operator!=(const fsSColour& pRhs) const;
 
        const fsSColour operator+(const fsSColour& pRhs) const; // Note: Clamped.
        const fsSColour operator-(const fsSColour& pRhs) const; // Note: Not clamped.
        const fsSColour operator*(fsS32 pRhs) const; // Note: Not clamped.
        const fsSColour operator/(fsS32 pRhs) const;
 
        fsU8 redByteGet() const;
        fsU8 greenByteGet() const;
        fsU8 blueByteGet() const;
        fsU8 alphaByteGet() const;
 
        fsSColour();
        fsSColour(const fsSColour4B& pByteColour);
        fsSColour(fsF32 pR, fsF32 pG, fsF32 pB, fsF32 pA);
        fsSColour(const fsStr& pRGBAStr);
        ~fsSColour();
 
        fsF32 mR;
        fsF32 mG;
        fsF32 mB;
        fsF32 mA;
 
private:
};
 
 
// Base level colour class. No arithmetic operations due to overflow on byte type
// DON'T add any - use fssColour instead and convert
struct fsSColour4B final
{
public:
 
        fsBool operator<(const fsSColour4B& pRhs) const;
        fsBool operator!=(const fsSColour4B& pRhs) const;
        fsBool operator==(const fsSColour4B& pRhs) const;
 
        static fsSColour4B fsNONE();
        static fsSColour4B fsBLACK();
        static fsSColour4B fsWHITE();
        static fsSColour4B fsRED();
 
        fsSColour4B(const fsSColour& pCol);
        fsSColour4B(const fsStr& pRGBAStr);
 
        fsSColour4B()
        {
        }
 
        fsSColour4B(fsU8 pR, fsU8 pG, fsU8 pB, fsU8 pA) :
                mR(pR),
                mG(pG),
                mB(pB),
                mA(pA)
        {
        }
 
        fsU8 mR = 0;
        fsU8 mG = 0;
        fsU8 mB = 0;
        fsU8 mA = 0;
};
 
 
#endif