Set the pixel sampling to use for the 2D capture. This setting defines how the camera sensor is sampled. When doing 2D+3D capture, picking the same value that is used for 3D is generally recommended.
More...
#include <Zivid/Settings2D.h>
Set the pixel sampling to use for the 2D capture. This setting defines how the camera sensor is sampled. When doing 2D+3D capture, picking the same value that is used for 3D is generally recommended.
◆ ValueType
The type of the underlying value.
Enumerator |
---|
all | |
blueSubsample2x2 | |
redSubsample2x2 | |
blueSubsample4x4 | |
redSubsample4x4 | |
by2x2 | |
by4x4 | |
◆ Pixel() [1/2]
Zivid::Settings2D::Sampling::Pixel::Pixel |
( |
| ) |
|
|
default |
◆ Pixel() [2/2]
Zivid::Settings2D::Sampling::Pixel::Pixel |
( |
ValueType | value | ) |
|
|
inlineexplicitconstexpr |
◆ hasValue()
bool Zivid::Settings2D::Sampling::Pixel::hasValue |
( |
| ) |
const |
Check if the value is set.
◆ operator!=()
bool Zivid::Settings2D::Sampling::Pixel::operator!= |
( |
const Pixel & | other | ) |
const |
|
inline |
◆ operator==()
bool Zivid::Settings2D::Sampling::Pixel::operator== |
( |
const Pixel & | other | ) |
const |
|
inline |
◆ reset()
void Zivid::Settings2D::Sampling::Pixel::reset |
( |
| ) |
|
Reset the node to unset state.
◆ toString()
std::string Zivid::Settings2D::Sampling::Pixel::toString |
( |
| ) |
const |
◆ validValues()
static std::set< ValueType > Zivid::Settings2D::Sampling::Pixel::validValues |
( |
| ) |
|
|
inlinestatic |
All valid values of Pixel.
◆ value()
ValueType Zivid::Settings2D::Sampling::Pixel::value |
( |
| ) |
const |
Get the value.
If this object does not contain a value (see hasValue) then this method throws an exception.
◆ DataModel::Detail::Befriend< Pixel >
friend struct DataModel::Detail::Befriend< Pixel > |
|
friend |
◆ operator<< [1/2]
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const Pixel & | value ) |
|
friend |
Operator to serialize the value to a stream.
◆ operator<< [2/2]
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const Pixel::ValueType & | value ) |
|
friend |
Operator to serialize ValueType to a stream.
◆ all
const Pixel Zivid::Settings2D::Sampling::Pixel::all |
|
static |
◆ blueSubsample2x2
const Pixel Zivid::Settings2D::Sampling::Pixel::blueSubsample2x2 |
|
static |
◆ blueSubsample4x4
const Pixel Zivid::Settings2D::Sampling::Pixel::blueSubsample4x4 |
|
static |
◆ by2x2
const Pixel Zivid::Settings2D::Sampling::Pixel::by2x2 |
|
static |
◆ by4x4
const Pixel Zivid::Settings2D::Sampling::Pixel::by4x4 |
|
static |
◆ description
const char* Zivid::Settings2D::Sampling::Pixel::description |
|
staticconstexpr |
Initial value:{
R"description(Set the pixel sampling to use for the 2D capture. This setting defines how the camera sensor is sampled.
When doing 2D+3D capture, picking the same value that is used for 3D is generally recommended.
)description"
}
The description for this value.
◆ name
const char* Zivid::Settings2D::Sampling::Pixel::name { "Pixel" } |
|
staticconstexpr |
◆ nodeType
◆ path
const char* Zivid::Settings2D::Sampling::Pixel::path { "Sampling/Pixel" } |
|
staticconstexpr |
The full path for this value.
◆ redSubsample2x2
const Pixel Zivid::Settings2D::Sampling::Pixel::redSubsample2x2 |
|
static |
◆ redSubsample4x4
const Pixel Zivid::Settings2D::Sampling::Pixel::redSubsample4x4 |
|
static |
The documentation for this class was generated from the following file: