ULIS  dev4.0.7
Utility Library for Imaging Systems
Public Member Functions | Static Public Attributes | List of all members
FSanitizedGradient Class Referencefinal

The FSanitizedGradient class provides a mean of storing gradients in various formats, with constraints the help in rasterizing them more efficiently than their non-Sanitized counterparts, which are meant for modification and editing. More...

Inheritance diagram for FSanitizedGradient:

Public Member Functions

 FSanitizedGradient (const FSanitizedGradient &)=delete
 
 FSanitizedGradient (eFormat iFormat, const FGradient &iGradient)
 
 ~FSanitizedGradient ()
 
const TArray< FAlphaStep > & AlphaSteps () const
 
const TArray< FColorStep > & ColorSteps () const
 
uint8 FastAlphaIndexAtParameter (ufloat iParam) const
 
uint8 FastColorIndexAtParameter (ufloat iParam) const
 
const uint8IndexLUTAlpha () const
 
const uint8IndexLUTColor () const
 
FSanitizedGradientoperator= (const FSanitizedGradient &)=delete
 
void ReinterpretInterpolationFormat (eFormat iFormat)
 
- Public Member Functions inherited from IHasFormat
 ~IHasFormat ()
 
uint8 AlphaIndex () const
 
uint8 BytesPerPixel () const
 
uint8 BytesPerSample () const
 
uint8 DefaultProfileCode () const
 
eFormat Format () const
 
const FFormatMetricsFormatMetrics () const
 
bool HasAlpha () const
 
const uint8IndexTable () 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 FColorSpaceColorSpace () const
 

Static Public Attributes

static constexpr uint8 range = 100
 

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

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

Constructor & Destructor Documentation

◆ ~FSanitizedGradient()

FSanitizedGradient::~FSanitizedGradient ( )

Destroy the gradient.

◆ FSanitizedGradient() [1/2]

FSanitizedGradient::FSanitizedGradient ( eFormat  iFormat,
const FGradient iGradient 
)

Construct sanitized gradient from regular gradient

◆ FSanitizedGradient() [2/2]

FSanitizedGradient::FSanitizedGradient ( const FSanitizedGradient )
delete

Member Function Documentation

◆ AlphaSteps()

const TArray< FAlphaStep >& FSanitizedGradient::AlphaSteps ( ) const

Getter for gradient alpha steps.

◆ ColorSteps()

const TArray< FColorStep >& FSanitizedGradient::ColorSteps ( ) const

Getter for gradient color steps.

◆ FastAlphaIndexAtParameter()

uint8 FSanitizedGradient::FastAlphaIndexAtParameter ( ufloat  iParam) const

Retrieve index of a alpha step in the array given an input parameter, using fast LUT retrieval.

◆ FastColorIndexAtParameter()

uint8 FSanitizedGradient::FastColorIndexAtParameter ( ufloat  iParam) const

Retrieve index of a color step in the array given an input parameter, using fast LUT retrieval.

◆ IndexLUTAlpha()

const uint8* FSanitizedGradient::IndexLUTAlpha ( ) const

Getter for gradient index lut alpha.

◆ IndexLUTColor()

const uint8* FSanitizedGradient::IndexLUTColor ( ) const

Getter for gradient index lut color.

◆ operator=()

FSanitizedGradient& FSanitizedGradient::operator= ( const FSanitizedGradient )
delete

◆ ReinterpretInterpolationFormat()

void FSanitizedGradient::ReinterpretInterpolationFormat ( eFormat  iFormat)

Change the preferred interpolation format.

Member Data Documentation

◆ range

constexpr uint8 FSanitizedGradient::range = 100
staticconstexpr