mirror of
https://github.com/recp/cglm.git
synced 2026-02-17 03:39:05 +00:00
complete documentation
This commit is contained in:
34
docs/source/color.rst
Normal file
34
docs/source/color.rst
Normal file
@@ -0,0 +1,34 @@
|
||||
.. default-domain:: C
|
||||
|
||||
color
|
||||
================================================================================
|
||||
|
||||
Header: cglm/color.h
|
||||
|
||||
Table of contents (click to go):
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Functions:
|
||||
|
||||
1. :c:func:`glm_luminance`
|
||||
|
||||
Functions documentation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. c:function:: float glm_luminance(vec3 rgb)
|
||||
|
||||
| averages the color channels into one value
|
||||
|
||||
This function uses formula in COLLADA 1.5 spec which is
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
luminance = (color.r * 0.212671) +
|
||||
(color.g * 0.715160) +
|
||||
(color.b * 0.072169)
|
||||
|
||||
It is based on the ISO/CIE color standards (see ITU-R Recommendation BT.709-4),
|
||||
that averages the color channels into one value
|
||||
|
||||
Parameters:
|
||||
| *[in]* **rgb** RGB color
|
||||
Reference in New Issue
Block a user