#include <peak_icv/painting/peak_icv_opacity.hpp>

Inheritance diagram for Opacity:

Collaboration diagram for Opacity:

Public Member Functions
constexpr	Opacity ()
	Constructs an Opacity object with a default value of 100.

constexpr	Opacity (uint32_t value)
	Constructs an Opacity object with the specified value.

constexpr uint32_t	GetValue () const
	Retrieve the current opacity value.

template<typename Opacity >
auto	operator== (const Opacity &value) const

Static Public Member Functions
static constexpr uint32_t	GetMinimum ()
	Get the smallest possible value for opacity.

static constexpr uint32_t	GetMaximum ()
	Get the largest possible value for opacity.

Detailed Description

Opacity refers to the transparency or the degree to which an object or pixel allows the background to show through. The Opacity is ranging from 0 to 100, where 0 indicates complete transparency (invisible) and 100 represents complete opacity (fully visible). Values between 0 and 100 represent varying levels of transparency.

Warning: This function is still in development and not released.

Definition at line 34 of file peak_icv_opacity.hpp.

Constructor & Destructor Documentation

◆ Opacity() [1/2]

Opacity ( )

inlineexplicitconstexpr

Constructs an Opacity object with a default value of 100.

Warning: This function is still in development and not released.

Definition at line 42 of file peak_icv_opacity.hpp.

◆ Opacity() [2/2]

Opacity ( uint32_t value )

inlineexplicitconstexpr

Constructs an Opacity object with the specified value.

Parameters

value Value of the Opacity

Exceptions

OutOfRangeException if the opacity value is greater than 100

Warning: This function is still in development and not released.

Definition at line 55 of file peak_icv_opacity.hpp.

Member Function Documentation

◆ GetMaximum()

static constexpr uint32_t GetMaximum ( )

inlinestaticconstexpr

Get the largest possible value for opacity.

Returns: The maximum opacity

Warning: This function is still in development and not released.

Definition at line 96 of file peak_icv_opacity.hpp.

◆ GetMinimum()

static constexpr uint32_t GetMinimum ( )

inlinestaticconstexpr

Get the smallest possible value for opacity.

Returns: The minimum opacity

Warning: This function is still in development and not released.

Definition at line 84 of file peak_icv_opacity.hpp.

◆ GetValue()

uint32_t GetValue ( ) const

inlineconstexpr

Retrieve the current opacity value.

Returns: The current opacity

Warning: This function is still in development and not released.

Definition at line 72 of file peak_icv_opacity.hpp.

◆ operator==()

template<typename Opacity >

auto operator== ( const Opacity & value ) const

inline

Warning: This function is still in development and not released.

Definition at line 112 of file peak_icv_opacity.hpp.

Public Member Functions

Static Public Member Functions