AcademySoftwareFoundation · cary-ilm · Feb 1, 2021 · Jan 13, 2021 · Jan 27, 2021 · Jan 31, 2021
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -4,14 +4,20 @@ GENERATE_LATEX   = NO
 GENERATE_MAN     = NO
 GENERATE_RTF     = NO
 CASE_SENSE_NAMES = NO
-INPUT            = ../src/Imath ../src/Half
+INPUT            = ../src/Imath/
 RECURSIVE        = YES
 QUIET            = YES
 JAVADOC_AUTOBRIEF    = YES
 GENERATE_HTML        = NO
 GENERATE_XML         = YES
+DISTRIBUTE_GROUP_DOC = YES
 MACRO_EXPANSION      = YES
 ENABLE_PREPROCESSING = YES
 PREDEFINED = IMATH_CONSTEXPR14=constexpr \
-             IMATH_HOSTDEVICE=
+             IMATH_HOSTDEVICE= \
+             IMATH_INTERNAL_NAMESPACE=Imath \
+             IMATH_INTERNAL_NAMESPACE_SOURCE_ENTER="namespace Imath {" \
+             IMATH_INTERNAL_NAMESPACE_SOURCE_EXIT="}" \
+             IMATH_INTERNAL_NAMESPACE_HEADER_ENTER="namespace Imath {" \
+             IMATH_INTERNAL_NAMESPACE_HEADER_EXIT="}" 
 
diff --git a/docs/classes/Box.rst b/docs/classes/Box.rst
@@ -32,16 +32,16 @@ Example:
 .. doxygentypedef:: Box3d
 
 .. doxygenclass:: Imath::Box
-   :members:
    :undoc-members:
+   :members:
 
 .. doxygenclass:: Imath::Box< Vec2< T > >
-   :members:
    :undoc-members:
+   :members:
 
 .. doxygenclass:: Imath::Box< Vec3< T > >
-   :members:
    :undoc-members:
+   :members:
 
 
 
diff --git a/docs/classes/Color3.rst b/docs/classes/Color3.rst
@@ -4,7 +4,7 @@ Color3
 The ``Color3`` class template represents a 3-component color, with
 pre-defined typedefs of ``unsigned char``, ``half``, and ``float``.
 
-The ``Color3`` class is derived from ``Imath::Vec3`` and thus has
+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.
 
@@ -26,6 +26,6 @@ Example:
 .. doxygentypedef:: C3f
 
 .. doxygenclass:: Imath::Color3
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Color4.rst b/docs/classes/Color4.rst
@@ -5,8 +5,8 @@ The ``Color4`` class template represents a 4-component color (red,
 green, blue, and alpha), with pre-defined typedefs of ``unsigned
 char``, ``half``, and ``float``.
 
-The ``Color4`` class is *not* derived from ``Imath::Vec4``. Its
-fields are named ``r``, ``g``, ``b``, and ``a``. The class itself implies no
+The ``Color4`` class is *not* derived from ``Vec4``. Its fields are
+named ``r``, ``g``, ``b``, and ``a``. The class itself implies no
 specific interpretation of the values.
 
 Example:
@@ -27,6 +27,6 @@ Example:
 .. doxygentypedef:: C4f
 
 .. doxygenclass:: Imath::Color4
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Euler.rst b/docs/classes/Euler.rst
@@ -20,8 +20,8 @@ Example:
 .. doxygentypedef:: Eulerd
 
 .. doxygenclass:: Imath::Euler
-   :members:
    :undoc-members:
+   :members:
 
 
 
diff --git a/docs/classes/Frustum.rst b/docs/classes/Frustum.rst
@@ -14,7 +14,7 @@ Example:
 .. doxygentypedef:: Frustumd
 
 .. doxygenclass:: Imath::Frustum
-   :members:
    :undoc-members:
+   :members:
 
 
diff --git a/docs/classes/Interval.rst b/docs/classes/Interval.rst
@@ -21,7 +21,7 @@ Example:
 .. doxygentypedef:: Intervald
 
 .. doxygenclass:: Imath::Interval
-   :members:
    :undoc-members:
+   :members:
 
 
diff --git a/docs/classes/Line3.rst b/docs/classes/Line3.rst
@@ -14,8 +14,8 @@ Example:
 .. doxygentypedef:: Line3d
 
 .. doxygenclass:: Imath::Line3
-   :members:
    :undoc-members:
+   :members:
 
 
 
diff --git a/docs/classes/Matrix22.rst b/docs/classes/Matrix22.rst
@@ -14,6 +14,6 @@ Example:
 .. doxygentypedef:: M22d
 
 .. doxygenclass:: Imath::Matrix22
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Matrix44.rst b/docs/classes/Matrix44.rst
@@ -14,6 +14,6 @@ Example:
 .. doxygentypedef:: M44d
 
 .. doxygenclass:: Imath::Matrix44
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Plane3.rst b/docs/classes/Plane3.rst
@@ -14,8 +14,8 @@ Example:
 .. doxygentypedef:: Plane3d
 
 .. doxygenclass:: Imath::Plane3
-   :members:
    :undoc-members:
+   :members:
 
 
 
diff --git a/docs/classes/Quat.rst b/docs/classes/Quat.rst
@@ -13,5 +13,5 @@ Example:
 .. doxygentypedef:: Quatf
 
 .. doxygenclass:: Imath::Quat
-   :members:
    :undoc-members:
+   :members:
diff --git a/docs/classes/Rand32.rst b/docs/classes/Rand32.rst
@@ -6,8 +6,8 @@ generates a uniformly distributed sequence with a period length of
 2^32.
 
 .. doxygenclass:: Imath::Rand32
-   :members:
    :undoc-members:
+   :members:
 
 
 
diff --git a/docs/classes/Rand48.rst b/docs/classes/Rand48.rst
@@ -6,7 +6,7 @@ the C Standard Library functions erand48(), nrand48() & company. It
 generates a uniformly distributed sequence.
 
 .. doxygenclass:: Imath::Rand48
-   :members:
    :undoc-members:
+   :members:
 
 
diff --git a/docs/classes/Shear6.rst b/docs/classes/Shear6.rst
@@ -12,6 +12,6 @@ Example:
 .. doxygentypedef:: Shear6f
 
 .. doxygenclass:: Imath::Shear6
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Sphere3.rst b/docs/classes/Sphere3.rst
@@ -12,6 +12,6 @@ Example:
 .. doxygentypedef:: Sphere3f
 
 .. doxygenclass:: Imath::Sphere3
-   :members:
    :undoc-members:
+   :members:
 
diff --git a/docs/classes/Vec2.rst b/docs/classes/Vec2.rst
@@ -18,5 +18,6 @@ Example:
 .. doxygentypedef:: V2d
 
 .. doxygenclass:: Imath::Vec2
+   :undoc-members:
    :members:
 
diff --git a/docs/classes/Vec3.rst b/docs/classes/Vec3.rst
@@ -18,5 +18,6 @@ Example:
 .. doxygentypedef:: V3d
 
 .. doxygenclass:: Imath::Vec3
+   :undoc-members:
    :members:
 
diff --git a/docs/classes/Vec4.rst b/docs/classes/Vec4.rst
@@ -18,5 +18,6 @@ Example:
 .. doxygentypedef:: V4d
 
 .. doxygenclass:: Imath::Vec4
+   :undoc-members:
    :members:
 
diff --git a/docs/classes/half.rst b/docs/classes/half.rst
@@ -9,5 +9,5 @@ Example:
    :language: c++
 
 .. doxygenclass:: Imath::half
-   :members:
    :undoc-members:
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -61,16 +61,16 @@
 
 # General information about the project.
 project = 'Imath'
-copyright = '2020, Contributors to the OpenEXR Project'
+copyright = '2021, Contributors to the OpenEXR Project'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '3.0'
+version = '1.0'
 # The full version, including alpha/beta/rc tags.
-release = '3.0.0'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -116,10 +116,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #html_theme = 'agogo'
-#html_theme = 'default'
+#html_theme = 'default' # good
 #html_theme = 'nature' # too green
-#html_theme = 'bizstyle' # OK
-html_theme = 'sphinxdoc'
+html_theme = 'bizstyle' # OK
+#html_theme = 'sphinxdoc'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/functions/box.rst b/docs/functions/box.rst
@@ -0,0 +1,20 @@
+Box
+###
+
+Functions to operate on bounding boxes.
+
+.. doxygenfunction:: clip
+
+.. doxygenfunction:: closestPointInBox
+
+.. doxygenfunction:: transform
+
+.. doxygenfunction:: affineTransform
+
+.. doxygenfunction:: findEntryAndExitPoints
+
+.. doxygenfunction:: intersects
+
+
+
+
diff --git a/docs/functions/color.rst b/docs/functions/color.rst
@@ -0,0 +1,22 @@
+Color
+#####
+
+Functions that operate on colors.
+
+.. doxygenfunction:: hsv2rgb
+
+.. doxygenfunction:: template<class T> constexpr Color4<T> hsv2rgb(const Color4<T> &hsv) noexcept
+
+.. doxygenfunction:: template<class T> constexpr Vec3<T> hsv2rgb(const Vec3<T> &hsv) noexcept
+
+.. doxygenfunction:: template<class T> constexpr Color4<T> rgb2hsv(const Color4<T> &rgb) noexcept
+
+.. doxygenfunction:: template<class T> constexpr Vec3<T> rgb2hsv(const Vec3<T> &rgb) noexcept
+
+.. doxygenfunction:: template<class T> constexpr PackedColor rgb2packed(const Color4<T> &c) noexcept
+
+.. doxygenfunction:: template<class T> constexpr PackedColor rgb2packed(const Vec3<T> &c) noexcept
+
+.. doxygenfunction:: template<class T> void packed2rgb(PackedColor packed, Color4<T> &out) noexcept
+
+.. doxygenfunction:: template<class T> void packed2rgb(PackedColor packed, Vec3<T> &out) noexcept
diff --git a/docs/functions/limits.rst b/docs/functions/limits.rst
@@ -9,53 +9,3 @@ template specializations for most basic types.
    :members:
    :undoc-members:
 
-.. doxygenstruct:: Imath::limits< char >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< signed char >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< unsigned char >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< short >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< unsigned short >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< int >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< unsigned int >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< long >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< unsigned long >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< float >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< double >
-   :members:
-   :undoc-members:
-
-.. doxygenstruct:: Imath::limits< long double >
-   :members:
-   :undoc-members:
-
-
-
diff --git a/docs/functions/roots.rst b/docs/functions/roots.rst
@@ -3,13 +3,13 @@ Roots
 
 Functions to compute roots of simple equations.
 
-.. doxygenfunction:: solveLinear(T a, T b, T& x)
+.. doxygenfunction:: solveLinear
 
-.. doxygenfunction:: solveQuadratic(T a, T b, T c, T x[2])
+.. doxygenfunction:: solveQuadratic
 
-.. doxygenfunction:: solveNormalizedCubic(T r, T s, T t, T x[3])
+.. doxygenfunction:: solveNormalizedCubic
 
-.. doxygenfunction:: solveCubic(T a, T b, T c, T d, T x[3])
+.. doxygenfunction:: solveCubic
 
 
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -38,6 +38,8 @@ Imath Documentation
    :caption: Imath Functions
    :maxdepth: 3
 
+   functions/box
+   functions/color
    functions/frame
    functions/gl
    functions/glu