The FGradient class provides a mean of storing and manipulating gradients in various formats. More...

Inheritance diagram for FGradient:

Public Member Functions
	FGradient (const FGradient &)=delete

	FGradient (eFormat iFormat)

	~FGradient ()

void	AddAlphaStep (ufloat iParam, ufloat iAlpha)

void	AddColorStep (ufloat iParam, const ISample &iColor)

TArray< FSharedAlphaStep > &	AlphaSteps ()

const TArray< FSharedAlphaStep > &	AlphaSteps () const

TArray< FSharedColorStep > &	ColorSteps ()

const TArray< FSharedColorStep > &	ColorSteps () const

FGradient &	operator= (const FGradient &)=delete

void	ReinterpretInterpolationFormat (eFormat iFormat)

void	Reset ()

void	Reset (eFormat iFormat)

FSanitizedGradient	Sanitized () const

FSanitizedGradient	Sanitized (eFormat iFormat) const

void	Sort ()

Public Member Functions inherited from IHasFormat
	~IHasFormat ()

uint8	AlphaIndex () const

uint8	BytesPerPixel () const

uint8	BytesPerSample () const

uint8	DefaultProfileCode () const

eFormat	Format () const

const FFormatMetrics &	FormatMetrics () const

bool	HasAlpha () const

const uint8 *	IndexTable () const

bool	Linear () const

eColorModel	Model () const

uint8	NumColorChannels () const

bool	Planar () const

bool	Premultiplied () const

uint8	RedirectedIndex (uint8 iIndex) const

bool	Reversed () const

uint8	SamplesPerPixel () const

bool	Swapped () const

eType	Type () const

Public Member Functions inherited from IHasColorSpace
	~IHasColorSpace ()

void	AssignColorSpace (const FColorSpace *iColorSpace)

const FColorSpace *	ColorSpace () const

Additional Inherited Members
Protected Member Functions inherited from IHasFormat
	IHasFormat (eFormat iFormat)

void	ReinterpretFormat (eFormat iFormat)

Protected Member Functions inherited from IHasColorSpace
	IHasColorSpace (const FColorSpace *iColorSpace=nullptr)

Detailed Description

Gradients can have a single or no color. Steps are in [0;1]. Interpolation is linear in the preferred format.

Constructor & Destructor Documentation

◆ ~FGradient()

FGradient::~FGradient ( )

Destroy the gradient.

◆ FGradient() [1/2]

FGradient::FGradient ( eFormat iFormat )

Construct gradient with preferred interpolation format. By default, gradients are white to black.

◆ FGradient() [2/2]

FGradient::FGradient ( const FGradient & )

delete

Member Function Documentation

◆ AddAlphaStep()

void FGradient::AddAlphaStep	(	ufloat	iParam,
		ufloat	iAlpha
	)

Add alpha step.

◆ AddColorStep()

void FGradient::AddColorStep	(	ufloat	iParam,
		const ISample &	iColor
	)

Add color step.

◆ AlphaSteps() [1/2]

TArray< FSharedAlphaStep >& FGradient::AlphaSteps ( )

Getter for gradient alpha steps.

◆ AlphaSteps() [2/2]

const TArray< FSharedAlphaStep >& FGradient::AlphaSteps ( ) const

Getter for gradient alpha steps.

◆ ColorSteps() [1/2]

TArray< FSharedColorStep >& FGradient::ColorSteps ( )

Getter for gradient color steps.

◆ ColorSteps() [2/2]

const TArray< FSharedColorStep >& FGradient::ColorSteps ( ) const

Getter for gradient color steps.

◆ operator=()

FGradient& FGradient::operator= ( const FGradient & )

delete

◆ ReinterpretInterpolationFormat()

void FGradient::ReinterpretInterpolationFormat ( eFormat iFormat )

Change the preferred interpolation format.

◆ Reset() [1/2]

void FGradient::Reset ( )

Reset the gradient, keep the same format.

◆ Reset() [2/2]

void FGradient::Reset ( eFormat iFormat )

Reset the gradient, change the format.

◆ Sanitized() [1/2]

FSanitizedGradient FGradient::Sanitized ( ) const

Return the sanitized version of this gradient.

◆ Sanitized() [2/2]

FSanitizedGradient FGradient::Sanitized ( eFormat iFormat ) const

Return the sanitized version of this gradient in the specified format.

◆ Sort()

void FGradient::Sort ( )

Sort values in both steps containers in case they were changed / moved.

Public Member Functions

Additional Inherited Members