peak::pipeline::modules::IGain Class Reference

Interface for modules that provide gain control functionality. More...

#include <peak_common/pipeline/modules/peak_common_igain_module.hpp>

Inheritance diagram for peak::pipeline::modules::IGain:

Public Member Functions
virtual void	SetMaster (float value)=0
	Sets the master gain value.
virtual PEAK_COMMON_NO_DISCARD float	GetMaster () const =0
	Retrieves the current master gain value.
virtual void	SetRed (float value)=0
	Sets the gain value for the red channel.
virtual PEAK_COMMON_NO_DISCARD float	GetRed () const =0
	Retrieves the gain value for the red channel.
virtual void	SetGreen (float value)=0
	Sets the gain value for the green channel.
virtual PEAK_COMMON_NO_DISCARD float	GetGreen () const =0
	Retrieves the gain value for the green channel.
virtual void	SetBlue (float value)=0
	Sets the gain value for the blue channel.
virtual PEAK_COMMON_NO_DISCARD float	GetBlue () const =0
	Retrieves the gain value for the blue channel.
Public Member Functions inherited from peak::pipeline::modules::IModule
	~IModule () override=default
virtual void	SetEnabled (bool enabled)=0
	Sets the enabled state of the module.
virtual PEAK_COMMON_NO_DISCARD bool	IsEnabled () const =0
	Checks whether the module is currently enabled.
virtual PEAK_COMMON_NO_DISCARD const char *	GetType () const =0
	Returns the type identifier of the module.
virtual PEAK_COMMON_NO_DISCARD peak::common::Any	Process (const peak::common::Any &input) const =0
	Processes input data and returns the result.
virtual void	ResetToDefault ()=0
	Resets the module to its default state. The enabled state is not reset.
Public Member Functions inherited from peak::common::serialization::ISerializable
virtual	~ISerializable ()=default
virtual void	Serialize (IArchive &archive) const =0
	Serializes the current object into the provided archive.
virtual void	Deserialize (const IArchive &archive)=0
	Deserializes the object's state from the provided archive.

Detailed Description

Interface for modules that provide gain control functionality.

A gain module consists of a master gain value applied to all channels, along with individual gain values for the red, green, and blue channels.

Member Function Documentation

GetBlue()

virtual PEAK_COMMON_NO_DISCARD float peak::pipeline::modules::IGain::GetBlue ( ) const

pure virtual

Retrieves the gain value for the blue channel.

Returns

The blue channel gain value.

Since

ids_peak_common 1.0

GetGreen()

virtual PEAK_COMMON_NO_DISCARD float peak::pipeline::modules::IGain::GetGreen ( ) const

pure virtual

Retrieves the gain value for the green channel.

Returns

The green channel gain value.

Since

ids_peak_common 1.0

GetMaster()

virtual PEAK_COMMON_NO_DISCARD float peak::pipeline::modules::IGain::GetMaster ( ) const

pure virtual

Retrieves the current master gain value.

Returns

The master gain value.

Since

ids_peak_common 1.0

GetRed()

virtual PEAK_COMMON_NO_DISCARD float peak::pipeline::modules::IGain::GetRed ( ) const

pure virtual

Retrieves the gain value for the red channel.

Returns

The red channel gain value.

Since

ids_peak_common 1.0

SetBlue()

virtual void peak::pipeline::modules::IGain::SetBlue ( float value )

pure virtual

Sets the gain value for the blue channel.

Parameters

value

The gain value for the blue channel.

Since

ids_peak_common 1.0

SetGreen()

virtual void peak::pipeline::modules::IGain::SetGreen ( float value )

pure virtual

Sets the gain value for the green channel.

Parameters

value

The gain value for the green channel.

Since

ids_peak_common 1.0

SetMaster()

virtual void peak::pipeline::modules::IGain::SetMaster ( float value )

pure virtual

Sets the master gain value.

This value is applied uniformly to all color channels.

Parameters

value

The master gain value to apply.

Since

ids_peak_common 1.0

SetRed()

virtual void peak::pipeline::modules::IGain::SetRed ( float value )

pure virtual

Sets the gain value for the red channel.

Parameters

value

The gain value for the red channel.

Since

ids_peak_common 1.0

---

The documentation for this class was generated from the following file:

• peak_common/pipeline/modules/peak_common_igain_module.hpp