Color balance settings.
More...
#include <Zivid/Settings2D.h>
|
class | Blue |
| Digital gain applied to blue channel. More...
|
|
class | Green |
| Digital gain applied to green channel. More...
|
|
class | Red |
| Digital gain applied to red channel. More...
|
|
|
| Balance () |
| Default constructor.
|
|
template<typename... Args> |
| Balance (Args &&...args) |
| Constructor taking variadic number of arguments.
|
|
template<typename... Args> |
void | set (Args &&...args) |
| Set multiple arguments.
|
|
template<typename... Args> |
Balance | copyWith (Args &&...args) const |
| Returns a copy of this object with the given argument(s) set to the new value(s)
|
|
const Blue & | blue () const |
| Get Blue.
|
|
Blue & | blue () |
| Get Blue.
|
|
Balance & | set (const Blue &value) |
| Set Blue.
|
|
const Green & | green () const |
| Get Green.
|
|
Green & | green () |
| Get Green.
|
|
Balance & | set (const Green &value) |
| Set Green.
|
|
const Red & | red () const |
| Get Red.
|
|
Red & | red () |
| Get Red.
|
|
Balance & | set (const Red &value) |
| Set Red.
|
|
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Blue >::value, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Blue & | get () const |
|
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Green >::value, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Green & | get () const |
|
template<typename T , typename std::enable_if< std::is_same< T, Settings2D::Processing::Color::Balance::Red >::value, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Red & | get () const |
|
template<size_t i, typename std::enable_if< i==0, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Blue & | get () const |
|
template<size_t i, typename std::enable_if< i==1, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Green & | get () const |
|
template<size_t i, typename std::enable_if< i==2, int >::type = 0> |
const Settings2D::Processing::Color::Balance::Red & | 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 Balance &other) const |
| Equality operator.
|
|
bool | operator!= (const Balance &other) const |
| Inequality operator.
|
|
std::string | toString () const |
| Get the value as string.
|
|
◆ Descendants
Initial value: std::tuple<
Settings2D::Processing::Color::Balance::Blue,
Settings2D::Processing::Color::Balance::Green,
Settings2D::Processing::Color::Balance::Red>
◆ Balance() [1/2]
Zivid::Settings2D::Processing::Color::Balance::Balance |
( |
| ) |
|
◆ Balance() [2/2]
template<typename... Args>
Zivid::Settings2D::Processing::Color::Balance::Balance |
( |
Args &&... | args | ) |
|
|
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 Balance
then invoking set(args)
.
The provided arguments must be descendants of Balance
. These types can be provided:
◆ blue() [1/2]
Blue & Zivid::Settings2D::Processing::Color::Balance::blue |
( |
| ) |
|
|
inline |
◆ blue() [2/2]
const Blue & Zivid::Settings2D::Processing::Color::Balance::blue |
( |
| ) |
const |
|
inline |
◆ copyWith()
template<typename... Args>
Balance Zivid::Settings2D::Processing::Color::Balance::copyWith |
( |
Args &&... | args | ) |
const |
|
inline |
Returns a copy of this object with the given argument(s) set to the new value(s)
Creates a copy of this Balance 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 Balance
. These types can be provided:
◆ forEach() [1/2]
template<typename F >
void Zivid::Settings2D::Processing::Color::Balance::forEach |
( |
const F & | f | ) |
|
|
inline |
Run the given function on each direct member with the value of the member as parameter.
◆ forEach() [2/2]
template<typename F >
void Zivid::Settings2D::Processing::Color::Balance::forEach |
( |
const F & | f | ) |
const |
|
inline |
Run the given function on each direct member with the value of the member as parameter.
◆ get() [1/6]
◆ get() [2/6]
◆ get() [3/6]
◆ get() [4/6]
template<size_t i, typename std::enable_if< i==0, int >::type = 0>
◆ get() [5/6]
template<size_t i, typename std::enable_if< i==1, int >::type = 0>
◆ get() [6/6]
template<size_t i, typename std::enable_if< i==2, int >::type = 0>
◆ green() [1/2]
Green & Zivid::Settings2D::Processing::Color::Balance::green |
( |
| ) |
|
|
inline |
◆ green() [2/2]
const Green & Zivid::Settings2D::Processing::Color::Balance::green |
( |
| ) |
const |
|
inline |
◆ operator!=()
bool Zivid::Settings2D::Processing::Color::Balance::operator!= |
( |
const Balance & | other | ) |
const |
◆ operator==()
bool Zivid::Settings2D::Processing::Color::Balance::operator== |
( |
const Balance & | other | ) |
const |
◆ red() [1/2]
Red & Zivid::Settings2D::Processing::Color::Balance::red |
( |
| ) |
|
|
inline |
◆ red() [2/2]
const Red & Zivid::Settings2D::Processing::Color::Balance::red |
( |
| ) |
const |
|
inline |
◆ set() [1/4]
template<typename... Args>
void Zivid::Settings2D::Processing::Color::Balance::set |
( |
Args &&... | args | ) |
|
|
inline |
Set multiple arguments.
The method invokes set(arg)
with each of the provided arguments.
The provided arguments must be descendants of Balance
. These types can be provided:
◆ set() [2/4]
Balance & Zivid::Settings2D::Processing::Color::Balance::set |
( |
const Blue & | value | ) |
|
|
inline |
◆ set() [3/4]
Balance & Zivid::Settings2D::Processing::Color::Balance::set |
( |
const Green & | value | ) |
|
|
inline |
◆ set() [4/4]
Balance & Zivid::Settings2D::Processing::Color::Balance::set |
( |
const Red & | value | ) |
|
|
inline |
◆ toString()
std::string Zivid::Settings2D::Processing::Color::Balance::toString |
( |
| ) |
const |
◆ DataModel::Detail::Befriend< Balance >
friend struct DataModel::Detail::Befriend< Balance > |
|
friend |
◆ operator<<
std::ostream & operator<< |
( |
std::ostream & | stream, |
|
|
const Balance & | value ) |
|
friend |
Operator to send the value as string to a stream.
◆ description
const char* Zivid::Settings2D::Processing::Color::Balance::description { R"description(Color balance settings.)description" } |
|
staticconstexpr |
The description for this value.
◆ name
const char* Zivid::Settings2D::Processing::Color::Balance::name { "Balance" } |
|
staticconstexpr |
◆ nodeType
◆ path
const char* Zivid::Settings2D::Processing::Color::Balance::path { "Processing/Color/Balance" } |
|
staticconstexpr |
The full path for this value.
The documentation for this class was generated from the following file: