Jetson Linux Graphics API Reference Documentation

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

API Documentation

This product implements NVIDIA APIs and certain graphics and media APIs. To provide unified API documentation, the API content of this volume was generated from code comments.

Warning

The API content represents a set of APIs you can use directly. Some graphics APIs are not documented. NVIDIA does not recommend using such APIs directly. Using undocumented APIs can lead to incompatibility when upgrading to later releases.

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

The APIs described in this documentation are logically grouped into a hierarchy of modules. Header files that contribute to the same API are grouped into the same section. Each such section may be subdivided by function into subsections. To view the API descriptions, 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 Developer 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 Developer Guide has these benefits:

• Ability to use the * wildcard
• Ability to search for phrases by wrapping them in quotation marks
• Unified search results for the Developer Guide, this API document, and the PDFs included with the HTML documents

For full-text search, click this link to open the Developer 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.