Skip to content

Commit

Permalink
Incorrect documentation of color components in Stream_support (#8489)
Browse files Browse the repository at this point in the history
The zero-th component is 0, and consequently the first is green, the
second is blue and the alpha component is the 3rd.
  • Loading branch information
sloriot authored Sep 25, 2024
2 parents 1bbcbce + 25bd968 commit b3d101d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Stream_support/include/CGAL/IO/Color.h
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,13 @@ class Color

/*!
returns the \f$i^{th}\f$ component of the rgb color (the
\f$0^{th}\f$ is red, the \f$1^{st}\f$ is blue, etc.).
\f$0^{th}\f$ is red, the \f$1^{st}\f$ is green, the \f$2^{nd}\f$ is blue and the \f$3^{rd}\f$ is alpha).
*/
unsigned char operator[] (std::size_t i) const { return m_data[i]; }

/*!
returns a reference on the \f$i^{th}\f$ component of `c` (the
\f$0^{th}\f$ is red, the \f$1^{st}\f$ is blue, etc.).
returns a reference on the \f$i^{th}\f$ component of the rgb color (the
\f$0^{th}\f$ is red, the \f$1^{st}\f$ is green, the \f$2^{nd}\f$ is blue and the \f$3^{rd}\f$ is alpha).
*/
unsigned char& operator[] (std::size_t i) { return m_data[i]; }

Expand Down

0 comments on commit b3d101d

Please sign in to comment.