Scene Fusion 2 API Reference
KS::ksColor Struct Reference

#include <ksColor.h>

Public Member Functions

 ksColor ()
 
 ksColor (const ksColor &other)
 
 ksColor (float r, float g, float b, float a=1.0f)
 
 ~ksColor ()
 
float & R ()
 
const float & R () const
 
float & G ()
 
const float & G () const
 
float & B ()
 
const float & B () const
 
float & A ()
 
const float & A () const
 

Detailed Description

RGBA color values stored as floats. Expected range is 0.0 to 1.0 however some systems allow larger float values to be used during iterim calculations

Constructor & Destructor Documentation

◆ ksColor() [1/3]

KS::ksColor::ksColor ( )
inline

Default constructor. Black-Opaque

◆ ksColor() [2/3]

KS::ksColor::ksColor ( const ksColor other)
inline

Copy Constructor

Parameters
constksColor& - color to copy

◆ ksColor() [3/3]

KS::ksColor::ksColor ( float  r,
float  g,
float  b,
float  a = 1.0f 
)
inline

Float value constructor

Parameters
r- red value
g- green value
b- blue value
a- alpha value (default 1.0 = opaque)

◆ ~ksColor()

KS::ksColor::~ksColor ( )
inline

Destructor

Member Function Documentation

◆ A() [1/2]

float& KS::ksColor::A ( )
inline
Returns
float& alpha

◆ A() [2/2]

const float& KS::ksColor::A ( ) const
inline
Returns
const float& alpha

◆ B() [1/2]

float& KS::ksColor::B ( )
inline
Returns
float& blue

◆ B() [2/2]

const float& KS::ksColor::B ( ) const
inline
Returns
const float& blue

◆ G() [1/2]

float& KS::ksColor::G ( )
inline
Returns
float& green

◆ G() [2/2]

const float& KS::ksColor::G ( ) const
inline
Returns
const float& green

◆ R() [1/2]

float& KS::ksColor::R ( )
inline
Returns
float& red

◆ R() [2/2]

const float& KS::ksColor::R ( ) const
inline
Returns
const float& red

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