PDF::SoftMask Class Reference

Represents a soft mask in a PDF document. More...

#include <pdfsdk/cxx/soft_mask.h>

Inheritance diagram for PDF::SoftMask:

Public Member Functions
SoftMask	Create (const Document &doc)
bool	Equals (const SoftMask &that) const
PDESoftMaskSubtype	GetSubtype () const
void	SetSubtype (PDESoftMaskSubtype subtype)
XObject	GetGroup () const
void	SetGroup (const XObject &group)
PDColorValue	GetBackdropColor () const
void	SetBackdropColor (PDColorValue backdrop)
Function	GetTransferFunction () const
void	SetTransferFunction (const Function &transfer)
	SoftMask (PDESoftMask handle, bool adopt=false) noexcept
	SoftMask (const SoftMask &rhs) noexcept
SoftMask &	operator= (const SoftMask &rhs) noexcept
	SoftMask (SoftMask &&rhs) noexcept
SoftMask &	operator= (SoftMask &&rhs) noexcept

Detailed Description

Represents a soft mask in a PDF document.

ISO 32000-2:2020 - 11.6.5 Soft masks

Member Function Documentation

Create()

SoftMask PDF::SoftMask::Create

(

const Document &

doc

)

Creates a new soft mask for the specified document.

Parameters

doc	The document to create the soft mask for.

Returns

The created soft mask.

Equals()

bool PDF::SoftMask::Equals

(

const SoftMask &

that

)

const

Checks if the soft mask is equal to another soft mask.

Parameters

that	The soft mask to compare with.

Returns

True if the soft masks are equal, false otherwise.

GetBackdropColor()

PDColorValue PDF::SoftMask::GetBackdropColor

(

)

const

Gets the backdrop color of the soft mask.

Returns

The backdrop color of the soft mask.

GetGroup()

XObject PDF::SoftMask::GetGroup

(

)

const

Gets the group XObject associated with the soft mask.

Returns

The group XObject associated with the soft mask.

GetSubtype()

PDESoftMaskSubtype PDF::SoftMask::GetSubtype

(

)

const

Gets the subtype of the soft mask.

Returns

The subtype of the soft mask.

GetTransferFunction()

Function PDF::SoftMask::GetTransferFunction

(

)

const

Gets the transfer function of the soft mask.

Returns

The transfer function of the soft mask.

SetBackdropColor()

void PDF::SoftMask::SetBackdropColor

(

PDColorValue

backdrop

)

Sets the backdrop color of the soft mask.

Parameters

backdrop

The backdrop color to set.

SetGroup()

void PDF::SoftMask::SetGroup

(

const XObject &

group

)

Sets the group XObject associated with the soft mask.

Parameters

group

The group XObject to set.

SetSubtype()

void PDF::SoftMask::SetSubtype

(

PDESoftMaskSubtype

subtype

)

Sets the subtype of the soft mask.

Parameters

subtype

The subtype to set.

SetTransferFunction()

void PDF::SoftMask::SetTransferFunction

(

const Function &

transfer

)

Sets the transfer function of the soft mask.

Parameters

transfer

The transfer function to set.

---

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

• include/pdfsdk/cxx/soft_mask.h