Zivid C++ API 2.9.0+4dbba385-1
Defining the Future of 3D Machine Vision
Color.h
Go to the documentation of this file.
1
2
3/*******************************************************************************
4
5 * This file is part of the Zivid 3D Camera API
6
7 *
8
9 * Copyright 2015-2023 (C) Zivid AS
10
11 * All rights reserved.
12
13 *
14
15 * Zivid Software License, v1.0
16
17 *
18
19 * Redistribution and use in source and binary forms, with or without
20
21 * modification, are permitted provided that the following conditions are met:
22
23 *
24
25 * 1. Redistributions of source code must retain the above copyright notice,
26
27 * this list of conditions and the following disclaimer.
28
29 *
30
31 * 2. Redistributions in binary form must reproduce the above copyright notice,
32
33 * this list of conditions and the following disclaimer in the documentation
34
35 * and/or other materials provided with the distribution.
36
37 *
38
39 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
40
41 * to endorse or promote products derived from this software without specific
42
43 * prior written permission.
44
45 *
46
47 * 4. This software, with or without modification, must not be used with any
48
49 * other 3D camera than from Zivid AS.
50
51 *
52
53 * 5. Any software provided in binary form under this license must not be
54
55 * reverse engineered, decompiled, modified and/or disassembled.
56
57 *
58
59 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
60
61 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
62
63 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
64
65 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
66
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68
69 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
70
71 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
72
73 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
74
75 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
76
77 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
78
79 *
80
81 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
82
83 * Info: http://www.zivid.com
84
85 ******************************************************************************/
86
87
88
89#pragma once
90
93
94#include <cstdint>
95#include <iosfwd>
96#include <string>
97#include <type_traits>
98
99namespace Zivid
100{
101#ifndef NO_DOC
103 namespace Detail
104 {
105 ZIVID_CORE_EXPORT std::string rgbaIntsToString(int r, int g, int b, int a);
106 ZIVID_CORE_EXPORT std::string bgraIntsToString(int b, int g, int r, int a);
107
108 template<typename T>
109 std::string rgbaToString(T r, T g, T b, T a)
110 {
111 return rgbaIntsToString(static_cast<int>(r), static_cast<int>(g), static_cast<int>(b), static_cast<int>(a));
112 }
113
114 template<typename T>
115 std::string bgraToString(T b, T g, T r, T a)
116 {
117 return bgraIntsToString(static_cast<int>(b), static_cast<int>(g), static_cast<int>(r), static_cast<int>(a));
118 }
119 } // namespace Detail
120#endif
121
122 struct ColorBGRA;
123
124 template<typename T>
126 {
128 using ValueType = T;
129
131 ColorRGBABase() = default;
132
134 ColorRGBABase(T red, T green, T blue, T alpha)
135 : r{ red }
136 , g{ green }
137 , b{ blue }
138 , a{ alpha }
139 {}
140
142 T r;
143
145 T g;
146
148 T b;
149
151 T a;
152
155
158
160 std::string toString() const
161 {
162 return Detail::rgbaToString(r, g, b, a);
163 }
164 };
165
167 template<typename T>
168 std::ostream &operator<<(std::ostream &stream, const ColorRGBABase<T> &color)
169 {
170 return stream << color.toString();
171 }
172
179 struct ColorRGBA : public ColorRGBABase<uint8_t>
180 {
182 };
183
185
186 template<typename T>
188 {
190 using ValueType = T;
191
193 ColorBGRABase() = default;
194
196 ColorBGRABase(T blue, T green, T red, T alpha)
197 : b{ blue }
198 , g{ green }
199 , r{ red }
200 , a{ alpha }
201 {}
202
204 T b;
205
207 T g;
208
210 T r;
211
213 T a;
214
217
220
222 std::string toString() const
223 {
224 return Detail::bgraToString(b, g, r, a);
225 }
226 };
227
229 template<typename T>
230 std::ostream &operator<<(std::ostream &stream, const ColorBGRABase<T> &color)
231 {
232 return stream << color.toString();
233 }
234
241 struct ColorBGRA : public ColorBGRABase<uint8_t>
242 {
244 };
245
247} // namespace Zivid
#define ZIVID_CORE_EXPORT
Definition: CoreExport.h:101
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:99
std::ostream & operator<<(std::ostream &stream, const Array2D< T > &array)
Serialize array information to a stream
Definition: Array2D.h:243
ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE(ColorRGBA, 4)
Definition: Color.h:188
ColorBGRABase(T blue, T green, T red, T alpha)
Constructor
Definition: Color.h:196
T g
Green channel
Definition: Color.h:207
ColorBGRABase()=default
Constructor
T a
Alpha channel
Definition: Color.h:213
T ValueType
The type of the channel values
Definition: Color.h:190
T r
Red channel
Definition: Color.h:210
ZIVID_CORE_EXPORT bool operator!=(const ColorBGRABase &rhs) const
Check for inequality
ZIVID_CORE_EXPORT bool operator==(const ColorBGRABase &rhs) const
Check for equality
T b
Blue channel
Definition: Color.h:204
std::string toString() const
Get string representation
Definition: Color.h:222
Color with 8-bit blue, green, red and alpha channels
Definition: Color.h:242
Definition: Color.h:126
T ValueType
The type of the channel values
Definition: Color.h:128
std::string toString() const
Get string representation
Definition: Color.h:160
T g
Green channel
Definition: Color.h:145
ColorRGBABase()=default
Constructor
T a
Alpha channel
Definition: Color.h:151
T r
Red channel
Definition: Color.h:142
ZIVID_CORE_EXPORT bool operator==(const ColorRGBABase &rhs) const
Check for equality
ZIVID_CORE_EXPORT bool operator!=(const ColorRGBABase &rhs) const
Check for inequality
T b
Blue channel
Definition: Color.h:148
ColorRGBABase(T red, T green, T blue, T alpha)
Constructor
Definition: Color.h:134
Color with 8-bit red, green, blue and alpha channels
Definition: Color.h:180