.. meta::
  :description: HIP runtime API reference page
  :keywords: AMD, ROCm, HIP, CUDA, HIP runtime API, HIP runtime

.. _runtime_api_reference:

********************************************************************************
HIP runtime API
********************************************************************************

The HIP Runtime API reference includes descriptions of HIP functions, as well as global datatypes, enums, and structs. 

Modules
=======

The API is organized into modules based on functionality.

* :ref:`initialization_version_reference`
* :ref:`device_management_reference`
* :ref:`execution_control_reference`
* :ref:`error_handling_reference`
* :ref:`stream_management_reference`
* :ref:`stream_memory_operations_reference`
* :ref:`event_management_reference`
* :ref:`memory_management_reference`

  * :ref:`memory_management_deprecated_reference`
  * :ref:`external_resource_interoperability_reference`
  * :ref:`stream_ordered_memory_allocator_reference`
  * :ref:`unified_memory_reference`
  * :ref:`virtual_memory_reference`
  * :ref:`texture_management_reference`
  * :ref:`texture_management_deprecated_reference`
  * :ref:`surface_object_reference`

* :ref:`peer_to_peer_device_memory_access_reference`
* :ref:`execution_context_management_reference`
* :ref:`context_management_reference`
* :ref:`module_management_reference`
* :ref:`occupancy_reference`
* :ref:`profiler_control_reference`
* :ref:`launch_api_reference`
* :ref:`runtime_compilation_reference`
* :ref:`callback_activity_apis_reference`
* :ref:`graph_management_reference`
* :ref:`opengl_interoperability_reference`
* :ref:`graphics_interoperability_reference`
* :ref:`cooperative_groups_reference`

Global defines, enums, structs and files
========================================

The structs, define macros, enums and files in the HIP runtime API.

* :doc:`Global enum and defines <../../doxygen/html/group___global_defs>`
* :doc:`Driver types <../../doxygen/html/group___driver_types>`
* :doc:`../../doxygen/html/annotated`
* :doc:`../../doxygen/html/files`