HEBI C++ API  1.0.0-rc1
hebi::Color Struct Reference

Structure to describe an RGB color. More...

#include <color.hpp>

Public Member Functions

 Color (uint8_t r, uint8_t g, uint8_t b)
 Creates a color from the given red, green, and blue channel values. More...
 
uint8_t getRed () const
 Returns the red channel; value is between 0 and 255. More...
 
uint8_t getGreen () const
 Returns the green channel; value is between 0 and 255. More...
 
uint8_t getBlue () const
 Returns the blue channel; value is between 0 and 255. More...
 

Detailed Description

Structure to describe an RGB color.

Constructor & Destructor Documentation

hebi::Color::Color ( uint8_t  r,
uint8_t  g,
uint8_t  b 
)
inline

Creates a color from the given red, green, and blue channel values.

Each parameter should be between 0 and 255.

Member Function Documentation

uint8_t hebi::Color::getRed ( ) const
inline

Returns the red channel; value is between 0 and 255.

uint8_t hebi::Color::getGreen ( ) const
inline

Returns the green channel; value is between 0 and 255.

uint8_t hebi::Color::getBlue ( ) const
inline

Returns the blue channel; value is between 0 and 255.


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