cpe::color Class Reference

Container class for (r,g,b) color. Each component is between [0,1]. More...

Public Member Functions

 color ()
 empty constructor (0,0,0) More...
 
 color (color_component gray)
 direct constructor with gray value (r,b,g)=(gray,gray,gray) More...
 
 color (color_component r, color_component g, color_component b)
 direct constructor with (r,b,g) value More...
 
 color (const vec3 &c)
 
color_component r () const
 get red value More...
 
color_componentr ()
 get red value More...
 
color_component g () const
 get green value More...
 
color_componentg ()
 get green value More...
 
color_component b () const
 get blue value More...
 
color_componentb ()
 get blue value More...
 
void clamp ()
 return clamp the color (between 0 and 1) More...
 

Private Attributes

color_component internal_r
 internal red component More...
 
color_component internal_g
 internal green component More...
 
color_component internal_b
 internal blue component More...
 

Detailed Description

Container class for (r,g,b) color. Each component is between [0,1].

Constructor & Destructor Documentation

cpe::color::color ( )

empty constructor (0,0,0)

cpe::color::color ( color_component  gray)

direct constructor with gray value (r,b,g)=(gray,gray,gray)

cpe::color::color ( color_component  r,
color_component  g,
color_component  b 
)

direct constructor with (r,b,g) value

cpe::color::color ( const vec3 c)

Member Function Documentation

color_component & cpe::color::b ( )

get blue value

References internal_b.

void cpe::color::clamp ( )

return clamp the color (between 0 and 1)

References internal_b, internal_g, and internal_r.

Referenced by cpe::export_ppm().

color_component cpe::color::g ( ) const
color_component & cpe::color::g ( )

get green value

References internal_g.

color_component & cpe::color::r ( )

get red value

References internal_r.

Member Data Documentation

color_component cpe::color::internal_b
private

internal blue component

Referenced by b(), and clamp().

color_component cpe::color::internal_g
private

internal green component

Referenced by clamp(), and g().

color_component cpe::color::internal_r
private

internal red component

Referenced by clamp(), and r().


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