HPS::RGBColorKeyframe Struct Reference

Public Member Functions

bool operator!= (RGBColorKeyframe const &in_that) const
 
bool operator== (RGBColorKeyframe const &in_that) const
 
 RGBColorKeyframe (uint32_t in_ticks, RGBColor const &in_value)
 

Public Attributes

uint32_t time_in_ticks
 
RGBColor value
 

Constructor & Destructor Documentation

◆ RGBColorKeyframe()

HPS::RGBColorKeyframe::RGBColorKeyframe ( uint32_t  in_ticks,
RGBColor const &  in_value 
)

Creates a new RGBColorKeyframe, suitable for using with a RGBSampler object. The correspondence between real time and ticks can be controlled through AnimationControl::SetTimePerTick The RGB components of RGBColorKeyframes cannot have values outside the [0 - 1] range. Setting a keyframe with such a value on a sampler will result in an InvalidSpecificationException being thrown

Parameters
in_ticksThe time, specified in ticks, when this keyframe should be executed.
in_valueThe value of this keyframe at the specified time.

Member Function Documentation

◆ operator!=()

bool HPS::RGBColorKeyframe::operator!= ( RGBColorKeyframe const &  in_that) const

Check if the source VectorKeyframe is different from this RGBColorKeyframe.

Parameters
in_thatThe source VectorKeyframe to compare to this VectorKeyframe.
Returns
true if the objects are different, false otherwise.

◆ operator==()

bool HPS::RGBColorKeyframe::operator== ( RGBColorKeyframe const &  in_that) const

Check if the source VectorKeyframe is equal to this RGBColorKeyframe.

Parameters
in_thatThe source VectorKeyframe to compare to this RGBColorKeyframe.
Returns
true if the objects are equal, false otherwise.

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