NVIDIA DRIVE OS Linux API Reference

5.1.3.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NVIDIA DRIVE OS Linux API Reference Documentation

Welcome to the NVIDIA DRIVE Linux API Reference.Documentation is preliminary and subject to change. Please see your customer engineer for additional information and to request documentation updates.

Release Notes

For release-specific information, including software version numbers, what's new, and known issues, read the Release Notes. These notes are available on NVONLINE.

API Documentation

This product implements NVIDIA APIs and certain Graphics and Media APIs.

This API Documentation describes the NVIDIA APIs that you can use to customize aspects of your device's behavior. To provide unified API documentation, the API content of this volume was generated from code comments.

Warning
The API content represents the set of APIs you can use directly. Some APIs are not documented and we advise you do not use them directly. Using undocumented APIs can lead to incompatibility when upgrading to later releases.

This API Documentation also includes 3rd-party specifications and other documents that are referenced here and in the Development Guide. The 3rd-party documents are provided as a convenience to readers. NVIDIA takes no responsibility for the accuracy of their contents.

The APIs included in this documentation are logically grouped into a hierarchy of modules. Header files that contribute to the same capability are grouped into a single, high-level module. Each high-level module may be further broken down into functional subcategories. To view the modules in this documentation, click the API Modules tab.

Searching for APIs

Attention
Full-text search is now available for the complete documentation included in this document set. Read this section for details.

You can search for APIs using both full-text search (from the Development Guide) and keyword search (from this API document).

  • Full-text search supports searching for any word or phrase.
  • Keyword search only supports searching for the keyword itself.
Benefits of Full-Text Search

Using full-text search from within the Development Guide has these benefits:

  • Ability to use the * wildcard
  • Ability to search for phrases by wrapping them in quotation marks
  • Search results for both the Development Guide and this API document
  • Search results for content of PDFs that are included within the HTML documents

For full-text search, click this link to open the Development Guide and enter the search phrase in the Search field at the upper-right of the window. For more information about searching, see the "About this Documentation" appendix in the Development Guide.

Keyword Search

For keyword search in this document, enter the API name in the Search field at the upper-right of this window. Typing the beginning letters of an API results in populating a drop-down results list containing all APIs starting with the same letters. You can select the API of interest from the results list, or by floating your cursor over the magnifying glass icon you can narrow down the results list to:

  • a type of API (like enumerations)
  • a file
  • a group
  • a page

This search is case-insensitive. Dismiss the search results by clicking the X at the right of the Search field.