AxioDL
/
zeus
mirror of https://github.com/AxioDL/zeus.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9 from lioncash/docs 

General: Amend documentation comments
This commit is contained in:
Phillip Stephens 2019-09-03 19:52:56 -07:00 committed by GitHub
parent f0a7db2282 53ac7d96b0
commit 35127116f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/zeus/CColor.hpp
View File

@ -245,12 +245,12 @@ public:
fromRGBA8(tmp.r, tmp.g, tmp.b, tmp.a); fromRGBA8(tmp.r, tmp.g, tmp.b, tmp.a);
} }
/*! /**
* \brief Converts a CColor to RGBA8 * @brief Converts a CColor to RGBA8
* \param r * @param ro Red component
* \param g * @param go Green component
* \param b * @param bo Blue component
* \param a * @param ao Alpha component
*/ */
void toRGBA8(Comp8& ro, Comp8& go, Comp8& bo, Comp8& ao) const { void toRGBA8(Comp8& ro, Comp8& go, Comp8& bo, Comp8& ao) const {
ro = Comp8(r() * 255); ro = Comp8(r() * 255);
@ -261,19 +261,18 @@ public:
/** /**
* @brief Assigns rgba from hsv * @brief Assigns rgba from hsv
* @param h[0-1] The hue percentagee of the color. * @param h[0-1] The hue percentage of the color.
* @param s[0-1] The saturation percentage of the color. * @param s[0-1] The saturation percentage of the color.
* @param v[0-1] The value percentage of the color. * @param v[0-1] The value percentage of the color.
* @param a[0-1] The alpha percentage of the color. * @param _a[0-1] The alpha percentage of the color.
*/ */
void fromHSV(float h, float s, float v, float _a = 1.0); void fromHSV(float h, float s, float v, float _a = 1.0);
/** /**
* @brief Converts rgba to hsv * @brief Converts rgba to hsv
* @param h[0-1] The hue percentagee of the color. * @param h[0-1] The hue percentage of the color.
* @param s[0-1] The saturation percentage of the color. * @param s[0-1] The saturation percentage of the color.
* @param v[0-1] The value percentage of the color. * @param v[0-1] The value percentage of the color.
* @param a[0-1] The alpha percentage of the color.
*/ */
void toHSV(float& h, float& s, float& v) const; void toHSV(float& h, float& s, float& v) const;