colorSpace.h

//
// Copyright 2024 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_COLORSPACE_H
#define PXR_BASE_GF_COLORSPACE_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/vec2f.h"
#include "pxr/base/gf/matrix3f.h"
#include "pxr/base/gf/api.h"
#include "pxr/base/tf/span.h"
#include "pxr/base/tf/staticTokens.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
#define GF_COLORSPACE_NAME_TOKENS                \
    ((LinearAP1, "lin_ap1_scene"))               \
    ((LinearAP0, "lin_ap0_scene"))               \
    ((LinearRec709, "lin_rec709_scene"))         \
    ((LinearP3D65, "lin_p3d65_scene"))           \
    ((LinearRec2020, "lin_rec2020_scene"))       \
    ((LinearAdobeRGB, "lin_adobergb_scene"))     \
    ((LinearCIEXYZD65, "lin_ciexyzd65_scene"))   \
    ((SRGBRec709, "srgb_rec709_scene"))          \
    ((G24Rec709, "g24_rec709_scene"))            \
    ((G22Rec709, "g22_rec709_scene"))            \
    ((G18Rec709, "g18_rec709_scene"))            \
    ((SRGBAP1, "srgb_ap1_scene"))                \
    ((G22AP1, "g22_ap1_scene"))                  \
    ((SRGBP3D65, "srgb_p3d65_scene"))            \
    ((G22AdobeRGB, "g22_adobergb_scene"))        \
    ((Identity, "identity"))                     \
    ((Data, "data"))                             \
    ((Raw, "raw"))                               \
    ((Unknown, "unknown"))                       \
    ((CIEXYZ, "lin_ciexyzd65_scene"))            \
    ((LinearDisplayP3, "lin_p3d65_scene")) 
 
TF_DECLARE_PUBLIC_TOKENS(GfColorSpaceNames, GF_API, 
                         GF_COLORSPACE_NAME_TOKENS);
 
class GfColor;
 
 
class GfColorSpace {
    friend class GfColor;
public:    
    GF_API 
    explicit GfColorSpace(const TfToken& name);
 
    GF_API
    static bool IsValid(const TfToken& name);
 
    GF_API
    explicit GfColorSpace(const TfToken& name,
                          const GfVec2f &redChroma,
                          const GfVec2f &greenChroma,
                          const GfVec2f &blueChroma,
                          const GfVec2f &whitePoint,
                          float gamma,
                          float linearBias);
 
    GF_API 
    explicit GfColorSpace(const TfToken& name,
                          const GfMatrix3f &rgbToXYZ,
                          float gamma,
                          float linearBias);
    
    GF_API 
    TfToken GetName() const;
 
    GF_API 
    bool operator ==(const GfColorSpace &rh) const;
 
    bool operator !=(const GfColorSpace &rh) const { return !(*this == rh); }
 
    GF_API 
    void ConvertRGBSpan(const GfColorSpace& srcColorSpace, TfSpan<float> rgb) const;
 
    GF_API 
    void ConvertRGBASpan(const GfColorSpace& srcColorSpace, TfSpan<float> rgba) const;
 
    GF_API
    GfColor Convert(const GfColorSpace& srcColorSpace, const GfVec3f& rgb) const;
 
    GF_API 
    GfMatrix3f GetRGBToXYZ() const;
 
    GF_API 
    GfMatrix3f GetRGBToRGB(const GfColorSpace& srcColorSpace) const;
 
    GF_API 
    float GetGamma() const;
 
    GF_API 
    float GetLinearBias() const;
 
    GF_API 
    std::pair<float, float> GetTransferFunctionParams() const;
 
    GF_API 
    std::tuple<GfVec2f, GfVec2f, GfVec2f, GfVec2f>
        GetPrimariesAndWhitePoint() const;
 
private:
    struct _Data;
    std::shared_ptr<_Data> _data;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_COLORSPACE_H