Color balance settings. More...

#include <Zivid/Settings2D.h>

Classes
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...

Public Types
using	Descendants

Public Member Functions
	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.

Static Public Attributes
static constexpr DataModel::NodeType	nodeType = DataModel::NodeType::group
	The type of this node.

static constexpr const char *	path { "Processing/Color/Balance" }
	The full path for this value.

static constexpr const char *	name { "Balance" }
	The name of this value.

static constexpr const char *	description { R"description(Color balance settings.)description" }
	The description for this value.

Friends
struct	DataModel::Detail::Befriend< Balance >

std::ostream &	operator<< (std::ostream &stream, const Balance &value)
	Operator to send the value as string to a stream.

Detailed Description

Color balance settings.

Member Typedef Documentation

◆ Descendants

using Zivid::Settings2D::Processing::Color::Balance::Descendants

Initial value:

 std::tuple<
                        Settings2D::Processing::Color::Balance::Blue,
                        Settings2D::Processing::Color::Balance::Green,
                        Settings2D::Processing::Color::Balance::Red>

Constructor & Destructor Documentation

◆ Balance() [1/2]

Zivid::Settings2D::Processing::Color::Balance::Balance ( )

Default constructor.

◆ 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:

Member Function Documentation

◆ blue() [1/2]

Blue & Zivid::Settings2D::Processing::Color::Balance::blue ( )

inline

Get Blue.

◆ blue() [2/2]

const Blue & Zivid::Settings2D::Processing::Color::Balance::blue ( ) const

inline

Get Blue.

◆ 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]

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 & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ get() [2/6]

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 & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ get() [3/6]

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 & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ get() [4/6]

template<size_t i, typename std::enable_if< i==0, int >::type = 0>

const Settings2D::Processing::Color::Balance::Blue & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ get() [5/6]

template<size_t i, typename std::enable_if< i==1, int >::type = 0>

const Settings2D::Processing::Color::Balance::Green & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ get() [6/6]

template<size_t i, typename std::enable_if< i==2, int >::type = 0>

const Settings2D::Processing::Color::Balance::Red & Zivid::Settings2D::Processing::Color::Balance::get ( ) const

inline

◆ green() [1/2]

Green & Zivid::Settings2D::Processing::Color::Balance::green ( )

inline

Get Green.

◆ green() [2/2]

const Green & Zivid::Settings2D::Processing::Color::Balance::green ( ) const

inline

Get Green.

◆ operator!=()

bool Zivid::Settings2D::Processing::Color::Balance::operator!= ( const Balance & other ) const

Inequality operator.

◆ operator==()

bool Zivid::Settings2D::Processing::Color::Balance::operator== ( const Balance & other ) const

Equality operator.

◆ red() [1/2]

Red & Zivid::Settings2D::Processing::Color::Balance::red ( )

inline

Get Red.

◆ red() [2/2]

const Red & Zivid::Settings2D::Processing::Color::Balance::red ( ) const

inline

Get Red.

◆ 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 Blue.

◆ set() [3/4]

Balance & Zivid::Settings2D::Processing::Color::Balance::set ( const Green & value )

inline

Set Green.

◆ set() [4/4]

Balance & Zivid::Settings2D::Processing::Color::Balance::set ( const Red & value )

inline

Set Red.

◆ toString()

std::string Zivid::Settings2D::Processing::Color::Balance::toString ( ) const

Get the value as string.

Friends And Related Symbol Documentation

◆ 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.

Member Data Documentation

◆ description

constexpr const char* Zivid::Settings2D::Processing::Color::Balance::description { R"description(Color balance settings.)description" }

staticconstexpr

The description for this value.

◆ name

constexpr const char* Zivid::Settings2D::Processing::Color::Balance::name { "Balance" }

staticconstexpr

The name of this value.

◆ nodeType

constexpr DataModel::NodeType Zivid::Settings2D::Processing::Color::Balance::nodeType = DataModel::NodeType::group

staticconstexpr

The type of this node.

◆ path

constexpr 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:

Zivid/Settings2D.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Descendants

Constructor & Destructor Documentation

◆ Balance() [1/2]

◆ Balance() [2/2]

Member Function Documentation

◆ blue() [1/2]

◆ blue() [2/2]

◆ copyWith()

◆ forEach() [1/2]

◆ forEach() [2/2]

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ green() [1/2]

◆ green() [2/2]

◆ operator!=()

◆ operator==()

◆ red() [1/2]

◆ red() [2/2]

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ toString()

Friends And Related Symbol Documentation

◆ DataModel::Detail::Befriend< Balance >

◆ operator<<

Member Data Documentation

◆ description

◆ name

◆ nodeType

◆ path