API Reference Manual

1. Getting started
   1. C++ API
   2. Engine Plugins
2. System
   1. Architecture
   2. Interfaces
   3. Devices
3. Application Guidelines

Getting started

The LeiaSR Software Development Kit (SDK) allows developers to create applications for LeiaSR devices by providing an API to interact with users and make optimal use of the LeiaSR device. Get started immediately!

The SDK comprises API options for different types of developers. There are options for programmers who want direct control from their C++ applications. In addition, Leia provides plugins for Unity and Unreal Engine that enable developers to use tools that they are familiar with and unlock the graphical potential that these engines offer.

C++ API

If you would like to get started immediately, install firstly our SDK and then check out our:

• Getting Started Guide - C++/DirectX
• Getting Started Guide - C++/OpenGL

Engine Plugins

For more high-level application development Unity or Unreal Engine are recommended. Plugins for both engines are available.

• Read more about the Unreal Plugin to get started. Unreal Engine is open-source and C++ based which allows for the direct integration of the C++ based SDK features LeiaSR API .
• Read more about the Unity Plugin to get started. Unity allows for the use of C# to add custom features which enables the use of the LeiaSR C API .

System

A LeiaSR System consists of hardware components, LeiaSR runtime software components and LeiaSR applications developed by you, the developer!

Architecture

LeiaSR devices run a server application to provide access to the different sensors and components. Multiple applications can connect to this server application and gain access to the same interfaces. The server application ensures that different interfaces are calibrated with respect to one-another.

You can read more about the architecture here.

Interfaces

The LeiaSR SDK contains precompiled C++ based libraries for developing applications. There is a C++ API that coveres a variety of LeiaSR features. There is also a C API which provides access to the same functionality.

You can read more about the possibilities here.

Hardware

LeiaSR devices are a combination of Leia display technology with a variety of sensors and output devices. The LeiaSR SDK allows developers to create applications which will work on all LeiaSR devices.

You can read more about LeiaSR devices here.

Application Guidelines

Once you have everything set up, read more about best practices in our LeiaSR Application Guidelines.