############################
HOOPS Luminate Documentation
############################

Welcome to the HOOPS Luminate product documentation! HOOPS Luminate is a graphics API for all your visualization needs for photorealism and real time in high quality. 

HOOPS Luminate is a C++ API, meaning it can be used immediately to start writing C/C++ applications and has no dependencies. 

In this document you will find guides called books that provide collections of information on subjects within the HOOPS Luminate package. You will also find tutorials to demonstrate Luminate features and sample code in the form of tasks designed to help you in your HOOPS Luminate journey.

To get started please see our link boxes below. If it is your first time, we recommend starting with the book: :doc:`/getting_started/beginning_with_luminate`.

If you have any questions, please see our Additional Resources section in the table of contents, check out our :doc:`additional_resources/contact_us` page, or visit our `Support Portal <https://techsoft3d.atlassian.net/servicedesk/customer/portal/25>`__.


.. toctree::
   :maxdepth: 1
   :caption: Getting Started
   :titlesonly:
   :hidden:

   getting_started/beginning_with_luminate
   getting_started/licensing
   getting_started/evaluating_luminate

.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   :titlesonly:
   :hidden:

   tutorials/workflowindex

.. toctree::
   :maxdepth: 1
   :caption: Tasks
   :titlesonly:
   :hidden:

   tasks/taskindex

.. toctree::
   :maxdepth: 1
   :caption: Programming Guide
   :titlesonly:
   :hidden:

   book/bookindex

.. toctree::
   :maxdepth: 1
   :caption: API References
   :titlesonly:
   :hidden:

   HOOPS Luminate API Reference <api/api>

.. toctree::
   :maxdepth: 1
   :caption: Additional Resources
   :titlesonly:
   :hidden:

   additional_resources/release_notes
   additional_resources/bk_legacy_releasenotes
   additional_resources/acknowledgements
   Downloads <https://developer.techsoft3d.com/hoops/luminate/downloads/latest>
   additional_resources/samples/using_cmake_with_luminate_samples
   
   
.. toctree::
   :maxdepth: 1
   :caption: Support
   :titlesonly:
   :hidden:

   Community Forum <https://forum.techsoft3d.com/c/hoops-luminate>
   Knowledge Base <https://forum.techsoft3d.com/docs>
   Support <https://techsoft3d.atlassian.net/servicedesk/customer/portal/25>
   additional_resources/contact_us
 

.. container:: linkbox-grid-container

   .. container:: linkbox

      .. rubric:: Getting Started
         :class: title

      .. container:: tagline

            Beginning your journey with HOOPS Luminate, including what it is capable of, where we recommend to start, and how to find information

      * :doc:`Beginning with Luminate <getting_started/beginning_with_luminate>` 
      * :doc:`HL Features at a Glance <book/subjects/bk_ba/bk_ba_luminate_features_at_a_glance>`
      * :doc:`getting_started/licensing` 
      * :doc:`getting_started/evaluating_luminate`
      

   .. container:: linkbox

      .. rubric:: Programming Guide
         :class: title

      .. container:: tagline

            Collections of information particular to subjects within Luminate's features and capabilities

      * :doc:`Building an HL Application <book/subjects/bk_buildingapp>`
      * :doc:`Scene Graph Overview <book/subjects/bk_scenegraph>`
      * :doc:`book/subjects/bk_rendering` and :doc:`book/subjects/bk_advancedrealtimerendering`
      * :doc:`book/subjects/bk_importingdata` and :doc:`book/subjects/bk_redfileformat`


   .. container:: linkbox

      .. rubric:: Tutorials
         :class: title

      .. container:: tagline

            Example implementations demonstrating HOOPS Luminate features

      * :doc:`tutorials/workflows/wf_startup`
      * :doc:`tutorials/workflows/wf_realtime`
      * :doc:`tutorials/workflows/wf_advancedrealtime`
      * :doc:`tutorials/workflows/wf_rendering`

   .. container:: linkbox

      .. rubric:: Tasks
         :class: title

      .. container:: tagline

            Code excerpts which demonstrate the implementation of an atomic task with HOOPS Luminate

      * :doc:`tasks/ta_ca/ta_ca_application` and :doc:`tasks/ta_ca/ta_ca_scenegraph`
      * :doc:`tasks/ta_ca/ta_ca_material`, :doc:`tasks/ta_ca/ta_ca_image`, and :doc:`tasks/ta_ca/ta_ca_light`
      * :doc:`tasks/ta_ca/ta_ca_rendering` and :doc:`tasks/ta_ca/ta_ca_art`
      * :doc:`tasks/ta_ca/ta_ca_animation` and :doc:`Miscellaneous <tasks/ta_ca/ta_ca_misc>`


   .. container:: linkbox

      .. rubric:: API Reference
         :class: title

      .. container:: tagline

            HOOPS Luminate reference manual, listing all API methods, functions, and data structures

      * :doc:`api/functions`

      * :doc:`api/classes`
         
      * :doc:`api/files`

      * :doc:`api/namespaces`
   
   
   .. container:: linkbox

      .. rubric:: Additional Resources & Support
         :class: title

      .. container:: tagline

            Stay up to date with the latest changes and improvements, and find more help, if needed

      * :doc:`additional_resources/release_notes`
      * :doc:`additional_resources/acknowledgements` 
      * `Community Forum <https://forum.techsoft3d.com/c/hoops-luminate>`__
      * `Knowledge Base <https://forum.techsoft3d.com/docs>`__
      * `Support <https://techsoft3d.atlassian.net/servicedesk/customer/portal/25>`__
      * :doc:`additional_resources/contact_us`


