CircleImageMask Class Reference

Represents an image mask in the shape of a circle. More...

#include <ImageMask.h>

Collaboration diagram for CircleImageMask:

Public Member Functions
	CircleImageMask (Circle circle, ImageMaskConfiguration config)
	Constructs a CircleImageMask with a specified circle and configuration.
	CircleImageMask (Circle circle, ImageMaskConfiguration config, ImageBlurType blur)
	Constructs a CircleImageMask with a specified circle and configuration and blurring.
void	MaskWith (ImageMasker &masker) const override
	Applies the circular mask to an image using the provided ImageMasker.

Detailed Description

Represents an image mask in the shape of a circle.

It is convenient class for masking and blurring circle.

Constructor & Destructor Documentation

CircleImageMask() [1/2]

CircleImageMask ( Circle circle, ImageMaskConfiguration config )

inline

Constructs a CircleImageMask with a specified circle and configuration.

Parameters

circle	The Circle object that defines the shape and bounds of the mask.
config	The ImageMaskConfiguration object that contains masking parameters.

CircleImageMask() [2/2]

CircleImageMask ( Circle circle, ImageMaskConfiguration config, ImageBlurType blur )

inline

Constructs a CircleImageMask with a specified circle and configuration and blurring.

Parameters

circle	The Circle object that defines the shape and bounds of the mask.
blur	Type of blurring to by applied on mask-to-image transition.
config	The ImageMaskConfiguration object that contains masking parameters.

Member Function Documentation

MaskWith()

void MaskWith ( ImageMasker & masker ) const

inlineoverridevirtual

Applies the circular mask to an image using the provided ImageMasker.

Parameters

masker

The ImageMasker instance used to apply the mask to an image.

Implements ImageMask.

References ImageMasker::BlurCircle(), ImageMasker::MaskCircle(), and NO_BORDER_BLURRING.

Here is the call graph for this function:

---

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

• Image/ImageMask.h