Color.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <Zivid/Detail/DataFormatUtils.h>
#include <Zivid/Detail/UtilsExport.h>
 
#include <cstdint>
#include <iosfwd>
#include <string>
#include <type_traits>
 
namespace Zivid
{
#ifndef NO_DOC
    namespace Detail
    {
        ZIVID_UTILS_EXPORT std::string rgbaIntsToString(int r, int g, int b, int a);
        ZIVID_UTILS_EXPORT std::string bgraIntsToString(int b, int g, int r, int a);
        ZIVID_UTILS_EXPORT std::string rgbIntsToString(int r, int g, int b);
        ZIVID_UTILS_EXPORT std::string bgrIntsToString(int b, int g, int r);
 
        template<typename T>
        std::string rgbaToString(T r, T g, T b, T a)
        {
            return rgbaIntsToString(static_cast<int>(r), static_cast<int>(g), static_cast<int>(b), static_cast<int>(a));
        }
 
        template<typename T>
        std::string bgraToString(T b, T g, T r, T a)
        {
            return bgraIntsToString(static_cast<int>(b), static_cast<int>(g), static_cast<int>(r), static_cast<int>(a));
        }
 
        template<typename T>
        std::string rgbToString(T r, T g, T b)
        {
            return rgbIntsToString(static_cast<int>(r), static_cast<int>(g), static_cast<int>(b));
        }
 
        template<typename T>
        std::string bgrToString(T b, T g, T r)
        {
            return bgrIntsToString(static_cast<int>(b), static_cast<int>(g), static_cast<int>(r));
        }
    } // namespace Detail
#endif
 
    struct ColorBGRA;
    struct ColorSRGB;
    using ColorRGBA_SRGB = ColorSRGB;
    struct ColorRGB_SRGB;
    struct ColorBGR_SRGB;
 
    template<typename T>
    struct ColorRGBABase
    {
        using ValueType = T;

        ColorRGBABase() = default;

        ColorRGBABase(T red, T green, T blue, T alpha)
            : r{ red }
            , g{ green }
            , b{ blue }
            , a{ alpha }
        {}

        T r;

        T g;

        T b;

        T a;

        ZIVID_UTILS_EXPORT bool operator==(const ColorRGBABase &rhs) const;

        ZIVID_UTILS_EXPORT bool operator!=(const ColorRGBABase &rhs) const;

        std::string toString() const
        {
            return Detail::rgbaToString(r, g, b, a);
        }
    };

    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const ColorRGBABase<T> &color)
    {
        return stream << color.toString();
    }

    struct ColorSRGB : public ColorRGBABase<uint8_t>
    {
        using ColorRGBABase::ColorRGBABase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorSRGB, 4);

    using ColorRGBA_SRGB = ColorSRGB;

    struct ColorRGBA : public ColorRGBABase<uint8_t>
    {
        using ColorRGBABase::ColorRGBABase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGBA, 4);
 
    template<typename T>
    struct ColorBGRABase
    {
        using ValueType = T;

        ColorBGRABase() = default;

        ColorBGRABase(T blue, T green, T red, T alpha)
            : b{ blue }
            , g{ green }
            , r{ red }
            , a{ alpha }
        {}

        T b;

        T g;

        T r;

        T a;

        ZIVID_UTILS_EXPORT bool operator==(const ColorBGRABase &rhs) const;

        ZIVID_UTILS_EXPORT bool operator!=(const ColorBGRABase &rhs) const;

        std::string toString() const
        {
            return Detail::bgraToString(b, g, r, a);
        }
    };

    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const ColorBGRABase<T> &color)
    {
        return stream << color.toString();
    }

    struct ColorBGRA : public ColorBGRABase<uint8_t>
    {
        using ColorBGRABase::ColorBGRABase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorBGRA, 4);

    struct ColorBGRA_SRGB : public ColorBGRABase<uint8_t>
    {
        using ColorBGRABase::ColorBGRABase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorBGRA_SRGB, 4);

    struct ColorRGBAf : public ColorRGBABase<float>
    {
        using ColorRGBABase::ColorRGBABase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGBAf, 16);
 
    template<typename T>
    struct ColorRGBBase
    {
        using ValueType = T;

        ColorRGBBase() = default;

        ColorRGBBase(T red, T green, T blue)
            : r{ red }
            , g{ green }
            , b{ blue }
        {}

        T r;

        T g;

        T b;

        ZIVID_UTILS_EXPORT bool operator==(const ColorRGBBase &rhs) const;

        ZIVID_UTILS_EXPORT bool operator!=(const ColorRGBBase &rhs) const;

        std::string toString() const
        {
            return Detail::rgbToString(r, g, b);
        }
    };

    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const ColorRGBBase<T> &color)
    {
        return stream << color.toString();
    }

    struct ColorRGB : public ColorRGBBase<uint8_t>
    {
        using ColorRGBBase::ColorRGBBase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGB, 3);

    struct ColorRGB_SRGB : public ColorRGBBase<uint8_t>
    {
        using ColorRGBBase::ColorRGBBase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGB_SRGB, 3);
 
    template<typename T>
    struct ColorBGRBase
    {
        using ValueType = T;

        ColorBGRBase() = default;

        ColorBGRBase(T blue, T green, T red)
            : b{ blue }
            , g{ green }
            , r{ red }
        {}

        T b;

        T g;

        T r;

        ZIVID_UTILS_EXPORT bool operator==(const ColorBGRBase &rhs) const;

        ZIVID_UTILS_EXPORT bool operator!=(const ColorBGRBase &rhs) const;

        std::string toString() const
        {
            return Detail::bgrToString(b, g, r);
        }
    };

    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const ColorBGRBase<T> &color)
    {
        return stream << color.toString();
    }

    struct ColorBGR : public ColorBGRBase<uint8_t>
    {
        using ColorBGRBase::ColorBGRBase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorBGR, 3);

    struct ColorBGR_SRGB : public ColorBGRBase<uint8_t>
    {
        using ColorBGRBase::ColorBGRBase;
    };
 
    ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorBGR_SRGB, 3);
} // namespace Zivid