Public Member Functions

override bool Equals (object obj)
 
bool Equals (RGBColorKeyframe k)
 
override int GetHashCode ()
 
 RGBColorKeyframe (UInt32 in_ticks, RGBColor in_value)
 

Static Public Member Functions

static bool operator!= (RGBColorKeyframe in_left, RGBColorKeyframe in_right)
 
static bool operator== (RGBColorKeyframe in_left, RGBColorKeyframe in_right)
 

Public Attributes

UInt32 time_in_ticks
 
RGBColor value
 

Constructor & Destructor Documentation

◆ RGBColorKeyframe()

HPS.RGBColorKeyframe.RGBColorKeyframe ( UInt32  in_ticks,
RGBColor  in_value 
)
inline

Creates a new RGBColorKeyframe, suitable for using with a RGBColorSampler 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

◆ Equals() [1/2]

override bool HPS.RGBColorKeyframe.Equals ( object  obj)
inline

Compares this RGBColorKeyframe object to another object.

Parameters
objThe object to compare to this object.
Returns
Returns true if the parameter is equivalent, false otherwise.

◆ Equals() [2/2]

bool HPS.RGBColorKeyframe.Equals ( RGBColorKeyframe  k)
inline

Compares a RGBColorKeyframe object to this RGBColorKeyframe.

Parameters
pThe object to compare to this object.
Returns
Returns true if the parameter is equivalent to this RGBColorKeyframe object, false otherwise.

◆ operator!=()

static bool HPS.RGBColorKeyframe.operator!= ( RGBColorKeyframe  in_left,
RGBColorKeyframe  in_right 
)
inlinestatic

Check if the source RGBColorKeyframe is different from this RGBColorKeyframe.

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

◆ operator==()

static bool HPS.RGBColorKeyframe.operator== ( RGBColorKeyframe  in_left,
RGBColorKeyframe  in_right 
)
inlinestatic

Check if the source RGBColorKeyframe is equal to this RGBColorKeyframe.

Parameters
in_thatThe source RGBColorKeyframe 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:
  • internals/hps_sprk/source/cs/HPS.RGBColorKeyframe.cs