Zivid C++ API 2.13.1+18e79e79-1
|
#include <Zivid/Settings.h>
Classes | |
class | Balance |
Color balance settings. More... | |
class | Experimental |
Experimental color settings. These may be renamed, moved or deleted in the future. More... | |
class | Gamma |
Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker. More... | |
Public Types | |
using | Descendants |
Public Member Functions | |
Color () | |
Default constructor. | |
template<typename... Args> | |
Color (Args &&...args) | |
Constructor taking variadic number of arguments. | |
template<typename... Args> | |
void | set (Args &&...args) |
Set multiple arguments. | |
template<typename... Args> | |
Color | copyWith (Args &&...args) const |
Returns a copy of this object with the given argument(s) set to the new value(s) | |
const Balance & | balance () const |
Get Balance. | |
Balance & | balance () |
Get Balance. | |
Color & | set (const Balance &value) |
Set Balance. | |
Color & | set (const Balance::Blue &value) |
Set Balance::Blue. | |
Color & | set (const Balance::Green &value) |
Set Balance::Green. | |
Color & | set (const Balance::Red &value) |
Set Balance::Red. | |
const Experimental & | experimental () const |
Get Experimental. | |
Experimental & | experimental () |
Get Experimental. | |
Color & | set (const Experimental &value) |
Set Experimental. | |
Color & | set (const Experimental::Mode &value) |
Set Experimental::Mode. | |
const Gamma & | gamma () const |
Get Gamma. | |
Gamma & | gamma () |
Get Gamma. | |
Color & | set (const Gamma &value) |
Set Gamma. | |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance >::value, int >::type = 0> | |
const Settings::Processing::Color::Balance & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Blue >::value, int >::type = 0> | |
const Settings::Processing::Color::Balance::Blue & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Green >::value, int >::type = 0> | |
const Settings::Processing::Color::Balance::Green & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Balance::Red >::value, int >::type = 0> | |
const Settings::Processing::Color::Balance::Red & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental >::value, int >::type = 0> | |
const Settings::Processing::Color::Experimental & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Experimental::Mode >::value, int >::type = 0> | |
const Settings::Processing::Color::Experimental::Mode & | get () const |
template<typename T , typename std::enable_if< std::is_same< T, Settings::Processing::Color::Gamma >::value, int >::type = 0> | |
const Settings::Processing::Color::Gamma & | get () const |
template<size_t i, typename std::enable_if< i==0, int >::type = 0> | |
const Settings::Processing::Color::Balance & | get () const |
template<size_t i, typename std::enable_if< i==1, int >::type = 0> | |
const Settings::Processing::Color::Experimental & | get () const |
template<size_t i, typename std::enable_if< i==2, int >::type = 0> | |
const Settings::Processing::Color::Gamma & | get () const |
template<typename F > | |
void | forEach (const F &f) const |
Run the given function on each direct member with the value of the member as parameter. | |
template<typename F > | |
void | forEach (const F &f) |
Run the given function on each direct member with the value of the member as parameter. | |
bool | operator== (const Color &other) const |
Equality operator. | |
bool | operator!= (const Color &other) const |
Inequality operator. | |
std::string | toString () const |
Get the value as string. | |
Static Public Attributes | |
static constexpr DataModel::NodeType | nodeType = DataModel::NodeType::group |
The type of this node. | |
static constexpr const char * | path { "Processing/Color" } |
The full path for this value. | |
static constexpr const char * | name { "Color" } |
The name of this value. | |
static constexpr const char * | description { R"description(Color settings.)description" } |
The description for this value. | |
Friends | |
struct | DataModel::Detail::Befriend< Color > |
std::ostream & | operator<< (std::ostream &stream, const Color &value) |
Operator to send the value as string to a stream. | |
Color settings.
Zivid::Settings::Processing::Color::Color | ( | ) |
Default constructor.
|
inlineexplicit |
Constructor taking variadic number of arguments.
One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Color
then invoking set(args)
.
The provided arguments must be descendants of Color
. These types can be provided:
|
inline |
Returns a copy of this object with the given argument(s) set to the new value(s)
Creates a copy of this Color object, then invokes set(args)
on the copy, and finally returns the copy. This method does not modify the original object.
The provided arguments must be descendants of Color
. These types can be provided:
|
inline |
Get Experimental.
|
inline |
Get Experimental.
|
inline |
Run the given function on each direct member with the value of the member as parameter.
|
inline |
Run the given function on each direct member with the value of the member as parameter.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool Zivid::Settings::Processing::Color::operator!= | ( | const Color & | other | ) | const |
Inequality operator.
bool Zivid::Settings::Processing::Color::operator== | ( | const Color & | other | ) | const |
Equality operator.
|
inline |
Set multiple arguments.
The method invokes set(arg)
with each of the provided arguments.
The provided arguments must be descendants of Color
. These types can be provided:
|
inline |
Set Balance::Blue.
|
inline |
Set Balance::Green.
|
inline |
Set Balance::Red.
|
inline |
Set Experimental.
|
inline |
Set Experimental::Mode.
std::string Zivid::Settings::Processing::Color::toString | ( | ) | const |
Get the value as string.
|
friend |
|
friend |
Operator to send the value as string to a stream.
|
staticconstexpr |
The description for this value.
|
staticconstexpr |
The name of this value.
|
staticconstexpr |
The type of this node.
|
staticconstexpr |
The full path for this value.