File: Color3.rst

package info (click to toggle)
imath 3.1.12-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,468 kB
  • sloc: cpp: 44,687; ansic: 171; sh: 153; python: 60; makefile: 32
file content (42 lines) | stat: -rw-r--r-- 932 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
..
  SPDX-License-Identifier: BSD-3-Clause
  Copyright Contributors to the OpenEXR Project.

Color3
######

.. code-block::

   #include <Imath/ImathColor.h>

The ``Color3`` class template represents a 3-component color, with
pre-defined typedefs of ``unsigned char``, ``half``, and ``float``.

The ``Color3`` class inherits from ``Vec3`` and thus has
fields named ``x``, ``y``, and ``z``. The class itself implies no
specific interpretation of the values.

There are also various utility functions that operate on colors
defined in ``ImathColorAlgo.h`` and described in :ref:`Color Functions
<color-functions>`.

Example:

.. literalinclude:: ../examples/Color3.cpp
   :language: c++

.. doxygentypedef:: Color3c

.. doxygentypedef:: Color3h

.. doxygentypedef:: Color3f

.. doxygentypedef:: C3c

.. doxygentypedef:: C3h

.. doxygentypedef:: C3f
                    
.. doxygenclass:: Imath::Color3
   :undoc-members:
   :members: