ImageMaskConfiguration Class Reference

Configuration parameters for image masking operations, including mask type, and color. More...

#include <ImageMask.h>

Collaboration diagram for ImageMaskConfiguration:

Public Member Functions
	ImageMaskConfiguration ()
	Constructs a default image mask configuration.
	ImageMaskConfiguration (ImageMaskType maskType, RGBA maskColor)
	Constructs a configuration with detailed mask settings including mask type and color.
ImageMaskType	GetMaskType () const
	Retrieves the mask type.
RGBA	GetMaskColor () const
	Retrieves the mask color.

Detailed Description

Configuration parameters for image masking operations, including mask type, and color.

Constructor & Destructor Documentation

ImageMaskConfiguration() [1/2]

ImageMaskConfiguration ( )

inline

Constructs a default image mask configuration.

This default constructor initializes the mask configuration with default values. The default values are:

• Mask Type: OUTSIDE (applies the mask outside the specified area)
• Mask Color: White

ImageMaskConfiguration() [2/2]

ImageMaskConfiguration ( ImageMaskType maskType, RGBA maskColor )

inline

Constructs a configuration with detailed mask settings including mask type and color.

Allows for comprehensive customization of the mask's appearance and behavior.

Parameters

maskType	The masking approach defined by ImageMaskType.
maskColor	The color used for the mask, represented as RGBA.

Member Function Documentation

GetMaskColor()

RGBA GetMaskColor ( ) const

inlinenodiscard

Retrieves the mask color.

Returns

An RGBA object representing the color of the mask.

GetMaskType()

ImageMaskType GetMaskType ( ) const

inlinenodiscard

Retrieves the mask type.

Returns

An ImageMaskType value representing the type of mask applied.

---

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

• Image/ImageMask.h