IDS peak ICV v1.4.0
Loading...
Searching...
No Matches
Opacity Class Reference

#include <peak_icv/painting/peak_icv_opacity.hpp>

Inheritance diagram for Opacity:

Public Member Functions

constexpr Opacity ()
 Constructs an Opacity object with full opacity (100).
 
constexpr Opacity (uint32_t value)
 Constructs an Opacity object with the specified value.
 
constexpr uint32_t GetValue () const
 
template<typename Opacity >
auto operator== (const Opacity &value) const
 

Static Public Member Functions

static constexpr uint32_t GetMinimum ()
 
static constexpr uint32_t GetMaximum ()
 

Detailed Description

Holds an opacity value representing the transparency level of an object or pixel.

Opacity ranges from 0 to 100, where 0 indicates complete transparency and 100 indicates complete opacity. Intermediate values represent varying levels of transparency.

Since
ids_peak_icv 1.1

Constructor & Destructor Documentation

◆ Opacity() [1/2]

Opacity ( )
inlineexplicitconstexpr

Constructs an Opacity object with full opacity (100).

Since
ids_peak_icv 1.1

◆ Opacity() [2/2]

Opacity ( uint32_t value)
inlineexplicitconstexpr

Constructs an Opacity object with the specified value.

Parameters
valueOpacity value in the range [0, 100]
Exceptions
OutOfRangeExceptionif value is greater than 100
Since
ids_peak_icv 1.1

Member Function Documentation

◆ GetMaximum()

static constexpr uint32_t GetMaximum ( )
inlinestaticconstexpr
Returns
The maximum allowed opacity value.
Since
ids_peak_icv 1.1

◆ GetMinimum()

static constexpr uint32_t GetMinimum ( )
inlinestaticconstexpr
Returns
The minimum allowed opacity value.
Since
ids_peak_icv 1.1

◆ GetValue()

uint32_t GetValue ( ) const
inlineconstexpr
Returns
The opacity value.
Since
ids_peak_icv 1.1

◆ operator==()

template<typename Opacity >
auto operator== ( const Opacity & value) const
inline
Since
ids_peak_icv 1.1