Holoscan API

page index

Holoviz composites real time streams of frames with multiple different other layers like segmentation mask layers, geometry layers and GUI layers.

For maximum performance Holoviz makes use of Vulkan, which is already installed as part of the Nvidia driver.

Holoviz uses the concept of the immediate mode design pattern for its API, inspired by the Dear ImGui library. The difference to the retained mode, for which most APIs are designed for, is, that there are no objects created and stored by the application. This makes it easy to quickly build and change an Holoviz app.

The code below creates a window and displays an image. First Holoviz needs to be initialized. This is done by calling holoscan::viz::Init().

The elements to display are defined in the render loop, termination of the loop is checked with holoscan::viz::WindowShouldClose().

The definition of the displayed content starts with holoscan::viz::Begin() and ends with holoscan::viz::End(). holoscan::viz::End() starts the rendering and displays the rendered result.

Finally Holoviz is shutdown with viz::Shutdown().

Page Hierarchy

Full API

Namespaces

Classes and Structs

Enums

Unions

Functions

Variables

Defines

Typedefs

© Copyright 2022-2023, NVIDIA. Last updated on Feb 9, 2024.