Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
HPS::RGBAColor Class Reference

#include <hps.h>

Collaboration diagram for HPS::RGBAColor:
Collaboration graph
[legend]

Public Member Functions

HPS_INLINE RGBAColor ()
 
HPS_INLINE RGBAColor (float gray, float a=1)
 
HPS_INLINE RGBAColor (float r, float g, float b, float a=1)
 
HPS_INLINE RGBAColor (RGBColor const &c)
 
HPS_INLINE RGBAColor (RGBColor const &c, float a)
 
HPS_INLINE RGBAColor (RGBA32Color const &c32)
 
HPS_INLINE RGBAColor (RGBAS32Color const &c32)
 
HPS_INLINE bool IsGray () const
 
HPS_INLINE float Gray () const
 
HPS_INLINE bool IsValid () const
 
HPS_INLINE bool operator== (RGBAColor const &c) const
 Determines RGBA equivalency between this object and argument. More...
 
HPS_INLINE bool operator!= (RGBAColor const &c) const
 Determines RGBA non-equivalency between this object and argument. More...
 
HPS_INLINE bool Equals (RGBAColor const &c, int in_tolerance=32) const
 
HPS_INLINE RGBAColor & operator*= (RGBAColor const &c)
 
HPS_INLINE RGBAColor & operator+= (RGBAColor const &c)
 
HPS_INLINE RGBAColor & operator-= (RGBAColor const &c)
 
HPS_INLINE RGBAColor const operator* (RGBAColor const &c) const
 
HPS_INLINE RGBAColor const operator+ (RGBAColor const &c) const
 
HPS_INLINE RGBAColor const operator- (RGBAColor const &c) const
 
HPS_INLINE RGBAColor & operator*= (float s)
 
HPS_INLINE RGBAColor & operator/= (float s)
 
HPS_INLINE RGBAColor & operator+= (float s)
 
HPS_INLINE RGBAColor & operator-= (float s)
 
HPS_INLINE RGBAColor const operator* (float s) const
 
HPS_INLINE RGBAColor const operator/ (float s) const
 
HPS_INLINE RGBAColor const operator+ (float s) const
 
HPS_INLINE RGBAColor const operator- (float s) const
 
HPS_INLINE RGBAColor & operator*= (RGBColor const &c)
 
HPS_INLINE RGBAColor & operator+= (RGBColor const &c)
 
HPS_INLINE RGBAColor & operator-= (RGBColor const &c)
 
HPS_INLINE RGBAColor const operator* (RGBColor const &c) const
 
HPS_INLINE RGBAColor const operator+ (RGBColor const &c) const
 
HPS_INLINE RGBAColor const operator- (RGBColor const &c) const
 

Static Public Member Functions

static HPS_INLINE RGBAColor Black ()
 
static HPS_INLINE RGBAColor White ()
 
static HPS_INLINE RGBAColor Nothing ()
 
static HPS_INLINE RGBAColor Invalid ()
 

Public Attributes

float red
 Red component of this color object, from 0.0 to 1.0. More...
 
float green
 Green component of this color object, from 0.0 to 1.0. More...
 
float blue
 Blue component of this color object, from 0.0 to 1.0. More...
 
float alpha
 Alpha component of this color object, from 0.0 to 1.0. More...
 

Constructor & Destructor Documentation

◆ RGBAColor() [1/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( )
inline

◆ RGBAColor() [2/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( float  gray,
float  a = 1 
)
inlineexplicit

◆ RGBAColor() [3/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( float  r,
float  g,
float  b,
float  a = 1 
)
inline

◆ RGBAColor() [4/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( RGBColor const &  c)
inline
Here is the call graph for this function:

◆ RGBAColor() [5/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( RGBColor const &  c,
float  a 
)
inline
Here is the call graph for this function:

◆ RGBAColor() [6/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( RGBA32Color const &  c32)
explicit
Here is the call graph for this function:

◆ RGBAColor() [7/7]

HPS_INLINE HPS::RGBAColor::RGBAColor ( RGBAS32Color const &  c32)
explicit
Here is the call graph for this function:

Member Function Documentation

◆ Black()

static HPS_INLINE RGBAColor HPS::RGBAColor::Black ( )
inlinestatic

◆ Equals()

HPS_INLINE bool HPS::RGBAColor::Equals ( RGBAColor const &  c,
int  in_tolerance = 32 
) const
inline
Here is the call graph for this function:

◆ Gray()

HPS_INLINE float HPS::RGBAColor::Gray ( ) const
inline

◆ Invalid()

static HPS_INLINE RGBAColor HPS::RGBAColor::Invalid ( )
inlinestatic

◆ IsGray()

HPS_INLINE bool HPS::RGBAColor::IsGray ( ) const
inline

◆ IsValid()

HPS_INLINE bool HPS::RGBAColor::IsValid ( ) const
inline
Here is the call graph for this function:

◆ Nothing()

static HPS_INLINE RGBAColor HPS::RGBAColor::Nothing ( )
inlinestatic

◆ operator!=()

HPS_INLINE bool HPS::RGBAColor::operator!= ( RGBAColor const &  c) const
inline

Determines RGBA non-equivalency between this object and argument.

Parameters
cThe color object to test against
Returns
true if the objects are not equivalent, false otherwise

◆ operator*() [1/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator* ( RGBAColor const &  c) const
inline

◆ operator*() [2/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator* ( float  s) const
inline

◆ operator*() [3/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator* ( RGBColor const &  c) const
inline

◆ operator*=() [1/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator*= ( RGBAColor const &  c)
inline

◆ operator*=() [2/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator*= ( float  s)
inline

◆ operator*=() [3/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator*= ( RGBColor const &  c)
inline

◆ operator+() [1/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator+ ( RGBAColor const &  c) const
inline

◆ operator+() [2/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator+ ( float  s) const
inline

◆ operator+() [3/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator+ ( RGBColor const &  c) const
inline

◆ operator+=() [1/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator+= ( RGBAColor const &  c)
inline

◆ operator+=() [2/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator+= ( float  s)
inline

◆ operator+=() [3/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator+= ( RGBColor const &  c)
inline

◆ operator-() [1/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator- ( RGBAColor const &  c) const
inline

◆ operator-() [2/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator- ( float  s) const
inline

◆ operator-() [3/3]

HPS_INLINE RGBAColor const HPS::RGBAColor::operator- ( RGBColor const &  c) const
inline

◆ operator-=() [1/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator-= ( RGBAColor const &  c)
inline

◆ operator-=() [2/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator-= ( float  s)
inline

◆ operator-=() [3/3]

HPS_INLINE RGBAColor& HPS::RGBAColor::operator-= ( RGBColor const &  c)
inline

◆ operator/()

HPS_INLINE RGBAColor const HPS::RGBAColor::operator/ ( float  s) const
inline
Here is the call graph for this function:

◆ operator/=()

HPS_INLINE RGBAColor& HPS::RGBAColor::operator/= ( float  s)
inline

◆ operator==()

HPS_INLINE bool HPS::RGBAColor::operator== ( RGBAColor const &  c) const
inline

Determines RGBA equivalency between this object and argument.

Parameters
cThe color object to test against
Returns
true if the objects are equivalent, false otherwise

◆ White()

static HPS_INLINE RGBAColor HPS::RGBAColor::White ( )
inlinestatic

Member Data Documentation

◆ alpha

float HPS::RGBAColor::alpha

Alpha component of this color object, from 0.0 to 1.0.

◆ blue

float HPS::RGBAColor::blue

Blue component of this color object, from 0.0 to 1.0.

◆ green

float HPS::RGBAColor::green

Green component of this color object, from 0.0 to 1.0.

◆ red

float HPS::RGBAColor::red

Red component of this color object, from 0.0 to 1.0.

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