.. meta::
  :description: hipFFT documentation and API reference library
  :keywords: FFT, hipFFT, rocFFT, ROCm, API, documentation

.. _hipfft-docs-home:

********************************************************************
hipFFT documentation
********************************************************************

Welcome to the hipFFT documentation home page. hipFFT is an FFT marshalling library. Currently, hipFFT supports either rocFFT_ or NVIDIA cuFFT_ as the backend, as explained in :ref:`hipfft-overview`.

.. _rocFFT: https://rocm.docs.amd.com/projects/rocFFT/en/latest/index.html
.. _cuFFT: https://developer.nvidia.com/cufft

The hipFFT documentation is structured as follows:

.. grid:: 2
  :gutter: 3

  .. grid-item-card:: Reference

    * :ref:`hipfft-overview`
    * :ref:`hipfft-api-usage`
    * :ref:`genindex`


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.
