Incorrect documentation of color components in Stream_support (#8489)

The zero-th component is 0, and consequently the first is green, the
second is blue and the alpha component is the 3rd.
This commit is contained in:
Sebastien Loriot 2024-09-25 15:07:05 +02:00 committed by GitHub
commit b3d101dac8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions

View File

@ -151,13 +151,13 @@ public:
/*!
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]; }