rocm-systems/docs/index.rst

.. meta::
  :description: rocJPEG documentation and API reference library
  :keywords: rocJPEG, ROCm, API, documentation

********************************************************************
rocJPEG documentation
********************************************************************

rocJPEG provides APIs and samples that you can use to easily access the JPEG decoding
features of your media engines (VCNs). It also allows interoperability with other compute engines on
the GPU using Video Acceleration API (VA-API)/HIP. To learn more, see :doc:`what-is-rocJPEG`

The code is open and hosted at `GitHub repository <https://github.com/ROCm/rocJPEG>`_.

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Install

    * :doc:`Quick-start <./install/quick-start>`
    * :doc:`rocJPEG installation <./install/install>`

The documentation is structured as follows:

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Tutorials

    * `GitHub samples <https://github.com/ROCm/rocJPEG/tree/develop/samples>`_

  .. grid-item-card:: How to

    * :doc:`Use rocJPEG <how-to/using-rocjpeg>`

  .. grid-item-card:: API reference

    * :doc:`API library <../doxygen/html/files>`
    * :doc:`Functions <../doxygen/html/globals>`
    * :doc:`Data structures <../doxygen/html/annotated>`


To contribute to the documentation, refer to
`Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_.

You can find licensing information on the
`Licensing <https://rocm.docs.amd.com/en/latest/about/license.html>`_ page.