Choose how to sample colors for the 2D image. The rgb
option gives an image with full colors. The grayscale
option gives a grayscale (r=g=b) image, which can be acquired faster than full colors.
More...
#include <Zivid/Settings2D.h>
Choose how to sample colors for the 2D image. The rgb
option gives an image with full colors. The grayscale
option gives a grayscale (r=g=b) image, which can be acquired faster than full colors.
The grayscale
option is not available on all camera models.
◆ ValueType
The type of the underlying value.
◆ Color() [1/2]
Zivid::Settings2D::Sampling::Color::Color |
( |
| ) |
|
|
default |
◆ Color() [2/2]
Zivid::Settings2D::Sampling::Color::Color |
( |
ValueType | value | ) |
|
|
inlineexplicitconstexpr |
◆ hasValue()
bool Zivid::Settings2D::Sampling::Color::hasValue |
( |
| ) |
const |
Check if the value is set.
◆ operator!=()
bool Zivid::Settings2D::Sampling::Color::operator!= |
( |
const Color & | other | ) |
const |
|
inline |
◆ operator==()
bool Zivid::Settings2D::Sampling::Color::operator== |
( |
const Color & | other | ) |
const |
|
inline |
◆ reset()
void Zivid::Settings2D::Sampling::Color::reset |
( |
| ) |
|
Reset the node to unset state.
◆ toString()
std::string Zivid::Settings2D::Sampling::Color::toString |
( |
| ) |
const |
◆ validValues()
static std::set< ValueType > Zivid::Settings2D::Sampling::Color::validValues |
( |
| ) |
|
|
inlinestatic |
All valid values of Color.
◆ value()
ValueType Zivid::Settings2D::Sampling::Color::value |
( |
| ) |
const |
Get the value.
If this object does not contain a value (see hasValue) then this method throws an exception.
◆ DataModel::Detail::Befriend< Color >
friend struct DataModel::Detail::Befriend< Color > |
|
friend |
◆ operator<< [1/2]
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const Color & | value ) |
|
friend |
Operator to serialize the value to a stream.
◆ operator<< [2/2]
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const Color::ValueType & | value ) |
|
friend |
Operator to serialize ValueType to a stream.
◆ description
const char* Zivid::Settings2D::Sampling::Color::description |
|
staticconstexpr |
Initial value:{
R"description(Choose how to sample colors for the 2D image. The `rgb` option gives an image
with full colors. The `grayscale` option gives a grayscale (r=g=b) image, which
can be acquired faster than full colors.
The `grayscale` option is not available on all camera models.
)description"
}
The description for this value.
◆ grayscale
const Color Zivid::Settings2D::Sampling::Color::grayscale |
|
static |
◆ name
const char* Zivid::Settings2D::Sampling::Color::name { "Color" } |
|
staticconstexpr |
◆ nodeType
◆ path
const char* Zivid::Settings2D::Sampling::Color::path { "Sampling/Color" } |
|
staticconstexpr |
The full path for this value.
◆ rgb
const Color Zivid::Settings2D::Sampling::Color::rgb |
|
static |
The documentation for this class was generated from the following file: