The pair of Quantity_Color and Alpha component (1.0 opaque, 0.0 transparent).
More...
#include <Quantity_ColorRGBA.hxx>
|
| Quantity_ColorRGBA () |
| Creates a color with the default value. More...
|
|
| Quantity_ColorRGBA (const Quantity_Color &theRgb) |
| Creates the color with specified RGB value. More...
|
|
| Quantity_ColorRGBA (const Quantity_Color &theRgb, float theAlpha) |
| Creates the color with specified RGBA values. More...
|
|
| Quantity_ColorRGBA (const NCollection_Vec4< float > &theRgba) |
| Creates the color from RGBA vector. More...
|
|
| Quantity_ColorRGBA (float theRed, float theGreen, float theBlue, float theAlpha) |
| Creates the color from RGBA values. More...
|
|
void | SetValues (float theRed, float theGreen, float theBlue, float theAlpha) |
| Assign new values to the color. More...
|
|
const Quantity_Color & | GetRGB () const |
| Return RGB color value. More...
|
|
Quantity_Color & | ChangeRGB () |
| Modify RGB color components without affecting alpha value. More...
|
|
void | SetRGB (const Quantity_Color &theRgb) |
| Assign RGB color components without affecting alpha value. More...
|
|
Standard_ShortReal | Alpha () const |
| Return alpha value (1.0 means opaque, 0.0 means fully transparent). More...
|
|
void | SetAlpha (const Standard_ShortReal theAlpha) |
| Assign the alpha value. More...
|
|
| operator const NCollection_Vec4< float > & () const |
| Return the color as vector of 4 float elements. More...
|
|
bool | IsDifferent (const Quantity_ColorRGBA &theOther) const |
| Returns true if the distance between colors is greater than Epsilon(). More...
|
|
bool | operator!= (const Quantity_ColorRGBA &theOther) const |
| Returns true if the distance between colors is greater than Epsilon(). More...
|
|
bool | IsEqual (const Quantity_ColorRGBA &theOther) const |
| Two colors are considered to be equal if their distance is no greater than Epsilon(). More...
|
|
bool | operator== (const Quantity_ColorRGBA &theOther) const |
| Two colors are considered to be equal if their distance is no greater than Epsilon(). More...
|
|
void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream. More...
|
|
Standard_Boolean | InitFromJson (const Standard_SStream &theSStream, Standard_Integer &theStreamPos) |
| Inits the content of me from the stream. More...
|
|
The pair of Quantity_Color and Alpha component (1.0 opaque, 0.0 transparent).
◆ Quantity_ColorRGBA() [1/5]
Quantity_ColorRGBA::Quantity_ColorRGBA |
( |
| ) |
|
|
inline |
Creates a color with the default value.
◆ Quantity_ColorRGBA() [2/5]
Quantity_ColorRGBA::Quantity_ColorRGBA |
( |
const Quantity_Color & |
theRgb | ) |
|
|
inlineexplicit |
Creates the color with specified RGB value.
◆ Quantity_ColorRGBA() [3/5]
Quantity_ColorRGBA::Quantity_ColorRGBA |
( |
const Quantity_Color & |
theRgb, |
|
|
float |
theAlpha |
|
) |
| |
|
inline |
Creates the color with specified RGBA values.
◆ Quantity_ColorRGBA() [4/5]
Quantity_ColorRGBA::Quantity_ColorRGBA |
( |
const NCollection_Vec4< float > & |
theRgba | ) |
|
|
inlineexplicit |
Creates the color from RGBA vector.
◆ Quantity_ColorRGBA() [5/5]
Quantity_ColorRGBA::Quantity_ColorRGBA |
( |
float |
theRed, |
|
|
float |
theGreen, |
|
|
float |
theBlue, |
|
|
float |
theAlpha |
|
) |
| |
|
inline |
Creates the color from RGBA values.
◆ Alpha()
Return alpha value (1.0 means opaque, 0.0 means fully transparent).
◆ ChangeRGB()
Modify RGB color components without affecting alpha value.
◆ ColorFromHex()
static bool Quantity_ColorRGBA::ColorFromHex |
( |
const char *const |
theHexColorString, |
|
|
Quantity_ColorRGBA & |
theColor, |
|
|
const bool |
theAlphaComponentIsOff = false |
|
) |
| |
|
static |
Parses the string as a hex color (like "#FF0" for short sRGB color, "#FF0F" for short sRGBA color, "#FFFF00" for RGB color, or "#FFFF00FF" for RGBA color)
- Parameters
-
theHexColorString | the string to be parsed |
theColor | a color that is a result of parsing |
theAlphaComponentIsOff | the flag that indicates if a color alpha component is presented in the input string (false) or not (true) |
- Returns
- true if parsing was successful, or false otherwise
◆ ColorFromName()
Finds color from predefined names. For example, the name of the color which corresponds to "BLACK" is Quantity_NOC_BLACK. An alpha component is set to 1.0.
- Parameters
-
theColorNameString | the color name |
theColor | a found color |
- Returns
- false if the color name is unknown, or true if the search by color name was successful
◆ ColorToHex()
Returns hex sRGBA string in format "#RRGGBBAA".
◆ Convert_LinearRGB_To_sRGB()
Convert linear RGB components into sRGB using OpenGL specs formula.
◆ Convert_sRGB_To_LinearRGB()
Convert sRGB components into linear RGB using OpenGL specs formula.
◆ DumpJson()
Dumps the content of me into the stream.
◆ GetRGB()
◆ InitFromJson()
Inits the content of me from the stream.
◆ IsDifferent()
Returns true if the distance between colors is greater than Epsilon().
◆ IsEqual()
Two colors are considered to be equal if their distance is no greater than Epsilon().
◆ operator const NCollection_Vec4< float > &()
Return the color as vector of 4 float elements.
◆ operator!=()
Returns true if the distance between colors is greater than Epsilon().
◆ operator==()
Two colors are considered to be equal if their distance is no greater than Epsilon().
◆ SetAlpha()
◆ SetRGB()
Assign RGB color components without affecting alpha value.
◆ SetValues()
void Quantity_ColorRGBA::SetValues |
( |
float |
theRed, |
|
|
float |
theGreen, |
|
|
float |
theBlue, |
|
|
float |
theAlpha |
|
) |
| |
|
inline |
Assign new values to the color.
The documentation for this class was generated from the following file: