Open topic with navigation

# Contents of the zSpace Core SDK

## Overview of the SDK

The zSpace Core SDK version 3.0 includes the following C APIs:

- General API — These functions support high level tasks such as initialization and error handling.
- Display API — These functions manage the connected displays.
- Stereo Buffer API — These functions handle left/right frame detection.
- Stereo Viewport API — These functions manage the stereo viewport. In turn, the stereo viewport manages the stereo frustum. Note that the viewport is an abstract concept, not a window managed by the operating system.
- Coordinate Space API — These functions help you convert from one coordinate space to another.
- Stereo Frustum API — These functions define the visible area for each eye and contribute greatly to comfortable viewing.
- Tracker Device API — These functions define the device that tracks the individual targets. An example is the zSpace monitor with its cameras for tracking.
- Tracker Target API — These functions manage the peripheral devices that can provide their pose (position and orientation) in zSpace. Examples are the stylus and polarized glasses.
- Target Button API — These functions manage the buttons on a stylus or other target.
- Target LED API — These functions manage the LED light on a stylus or other target.
- Target Vibration API — These functions manage the vibration of a stylus or other target.
- Target Tap API — These functions track when a stylus or other target touches the zSpace display.
- Tracker Event API — These functions add and remove event handlers for targets and event types.
- Mouse Emulation API — These functions allow any target to emulate a mouse.

The SDK provides sample code to help you understand these APIs. These are in the Samples subdirectory where you installed the SDK.

The SDK includes complete documentation for every function in the above APIs as well as important conceptual information. In addition to the SDK documentation itself, you should refer to the following documents:

- Understanding the zSpace 3D System for Better Spatial Design & Aesthetics
- Getting Started with zSpace Development
- zSpace Coordinate Systems
- UI Guidelines

Note:
  We strongly recommend that you read the above documentation before you start coding.

If you are upgrading from a previous version of the zSpace SDK, be sure to read the zSpace SDK 3.0 Migration Guide.

Open topic with navigation