Skip to content

Latest commit

 

History

History

basic_cpp

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
template
template
 
 
README.md
README.md
 
 

README.md

Basic C++ Extension Template

Overview

The Basic C++ Extension Template is a starting point for developers looking to build C++ based extensions within the NVIDIA Omniverse ecosystem. This template offers a best practices foundation and structure to easily integrate with the broader capabilities of the Omniverse Kit SDK.

Note for Windows C++ Developers : This template requires that Visual Studio is installed on the host. Additionally, "platform:windows-x86_64".enabled and link_host_toolchain within the repo.toml file be set to true. For additional C++ configuration information see here.

Use Cases

This template is ideal for developers looking to build:

  • A reusable C++ extension that can be easily integrated with Omniverse Kit SDK applications.
  • Performance sensitive extensions that require the performance benefits of C++.
  • Extensions that require direct access to the Omniverse Kit or Carbonite SDK C++ API.
  • Integrating with existing C++ libraries or codebases.

Key Features

  • Structure well suited for the build, test and packaging tooling within this repository.
  • All required setup code for use with the Omniverse Kit SDK.

Usage

This section provides instructions for the setup and use of the Basic C++ Extension Template.

Getting Started

To get started with the Basic C++ Extension, ensure your development environment meets the prerequisites outlined in the top-level README.

Cloning the Repository

git clone https://github.com/NVIDIA-Omniverse/kit-app-template.git
cd kit-app-template

Create New Extension

Linux:

./repo.sh template new

Windows:

.\repo.bat template new

Follow the prompt instructions:

  • ? Select with arrow keys what you want to create: Extension
  • ? Select with arrow keys your desired template: Basic C++ Extension
  • ? Enter name of extension [name-spaced, lowercase, alphanumeric]: [set extension name]
  • ? Enter extension_display_name: [set extension display name]
  • ? Enter version: [set extension version]

Build and Launch

While C++ extensions do require compilation this is typically not done in isolation, this template is structured to properly interact with the Omniverse Kit SDK application build and packaging tooling.

Launching the extension typically requires that they be a part of an Omniverse Service or Editor application.

Adding an Extension to an Application

To add your extension to an application, declare it in the dependencies section of the application's .kit file:

[dependencies]
"my_company.my_extension" = {}

Build with New Extensions

After a new extension has been added to the .kit file, the application should be rebuilt to ensure extensions are populated to the build directory.

Customization

Customization of a C++ Extension might involve writing new C++ classes or functions, or integrating existing libraries.

As is the case with Applications, extensions can also depend on and be depended on by other extensions. These can be custom developed extensions or those provided by the NVIDIA managed extension registry. It should be noted that a limited number of registry extensions expose a C++ API. A view of available registry extensions can be found within the Extension Manager accessible via the developer bundle available when running ./repo.sh launch --dev-bundle(Linux) or .\repo.bat launch --dev-bundle(Windows) to launch the Base Editor or USD Explorer Application Templates (select Developer > Utilities > Extensions)

Additional Learning