SkColor.h

Go to the documentation of this file.

/*
 * Copyright 2006 The Android Open Source Project
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef SkColor_DEFINED
#define SkColor_DEFINED

#include "SkScalar.h"
#include "SkPoint3.h"
#include "SkTypes.h"

typedef uint8_t SkAlpha;
typedef uint32_t SkColor;

static inline SkColor SkColorSetARGBInline(U8CPU a, U8CPU r, U8CPU g, U8CPU b)
{
    SkASSERT(a <= 255 && r <= 255 && g <= 255 && b <= 255);

    return (a << 24) | (r << 16) | (g << 8) | (b << 0);
}

#define SkColorSetARGBMacro(a, r, g, b) \
    static_cast<SkColor>( \
        (static_cast<U8CPU>(a) << 24) | \
        (static_cast<U8CPU>(r) << 16) | \
        (static_cast<U8CPU>(g) << 8) | \
        (static_cast<U8CPU>(b) << 0))

#if defined(NDEBUG)
#define SkColorSetARGB(a, r, g, b) SkColorSetARGBMacro(a, r, g, b)
#else
#define SkColorSetARGB(a, r, g, b) SkColorSetARGBInline(a, r, g, b)
#endif

#define SkColorSetRGB(r, g, b)  SkColorSetARGB(0xFF, r, g, b)

#define SkColorGetA(color)      (((color) >> 24) & 0xFF)

#define SkColorGetR(color)      (((color) >> 16) & 0xFF)

#define SkColorGetG(color)      (((color) >>  8) & 0xFF)

#define SkColorGetB(color)      (((color) >>  0) & 0xFF)

static inline SkColor SkColorSetA(SkColor c, U8CPU a) {
    return (c & 0x00FFFFFF) | (a << 24);
}

// common colors

#define SK_AlphaTRANSPARENT 0x00        
#define SK_AlphaOPAQUE      0xFF        

#define SK_ColorTRANSPARENT 0x00000000  

#define SK_ColorBLACK       0xFF000000  
#define SK_ColorDKGRAY      0xFF444444  
#define SK_ColorGRAY        0xFF888888  
#define SK_ColorLTGRAY      0xFFCCCCCC  
#define SK_ColorWHITE       0xFFFFFFFF  

#define SK_ColorRED         0xFFFF0000  
#define SK_ColorGREEN       0xFF00FF00  
#define SK_ColorBLUE        0xFF0000FF  
#define SK_ColorYELLOW      0xFFFFFF00  
#define SK_ColorCYAN        0xFF00FFFF  
#define SK_ColorMAGENTA     0xFFFF00FF  


SK_API void SkRGBToHSV(U8CPU red, U8CPU green, U8CPU blue, SkScalar hsv[3]);

static inline void SkColorToHSV(SkColor color, SkScalar hsv[3]) {
    SkRGBToHSV(SkColorGetR(color), SkColorGetG(color), SkColorGetB(color), hsv);
}

SK_API SkColor SkHSVToColor(U8CPU alpha, const SkScalar hsv[3]);

static inline SkColor SkHSVToColor(const SkScalar hsv[3]) {
    return SkHSVToColor(0xFF, hsv);
}


typedef uint32_t SkPMColor;

SK_API SkPMColor SkPreMultiplyARGB(U8CPU a, U8CPU r, U8CPU g, U8CPU b);
SK_API SkPMColor SkPreMultiplyColor(SkColor c);

typedef SkPMColor (*SkXfermodeProc)(SkPMColor src, SkPMColor dst);


struct SkPM4f;

/*
 *  The float values are 0...1 unpremultiplied
 */
struct SkColor4f {
    float fR;
    float fG;
    float fB;
    float fA;

    bool operator==(const SkColor4f& other) const {
        return fA == other.fA && fR == other.fR && fG == other.fG && fB == other.fB;
    }
    bool operator!=(const SkColor4f& other) const {
        return !(*this == other);
    }

    const float* vec() const { return &fR; }
    float* vec() { return &fR; }

    static SkColor4f Pin(float r, float g, float b, float a);
    static SkColor4f FromColor(SkColor);
    static SkColor4f FromColor3f(SkColor3f, float a);

    SkColor toSkColor() const;

    SkColor4f pin() const {
        return Pin(fR, fG, fB, fA);
    }

    SkPM4f premul() const;
};

#endif