Welcome to the Depthkit Documentation Portal!

Depthkit is the first volumetric filmmaking tool designed to empower creators of all experience levels to participate in the cutting edge of immersive storytelling.


Verify Computer Performance

Computer Requirements

Depth Sensors

Tutorials

Sensor Capture

Sensor Capture offers a plug and capture solution for Depthkit. Get up and running quickly and easily with one of our supported depth sensors while capturing out in the field or in the studio.

Recording

Diagnostics

Once recording, you will notice the addition of a Diagnostics panel. This represents the performance of the capture and will alert you to dropped frames or issues during capture.

Dropped Frames mean data is being lost and is unrecoverable. A few dropped frames are OK (less than 10 per minute) and will not be too noticeable. However, large number of dropped frames means you have a serious performance issue. See our troubleshooting guide on how to diagnose frame drops.

Diagnostics
Description

Recording

Tracks the duration of the capture.

Frame Backlog

Our newest capture optimization. Some computers may not able to keep up writing frames to disk as fast as they are captured. The frame backlog feature allows you to create frame-drop free recordings even on these machines. Frames queue up in system memory and are written to disk after recording completes. The Frame Backlog meter represents the maximum amount of frames that can be stored in the backlog. If the meter fills up, the recording is automatically stopped. Depthkit then finalizes the recording by writing all frames to disk before the next capture can begin. You can click the backlog value to toggle the view between frames queued and the amount of memory being used.

Frames Dropped

Records how many frames are being dropped during capture so you can track any issues. Unlike frame backlog, dropped frames are actually lost data, which is not recoverable. This is helpful to know when capturing on a low performance computer so you can have visibility into the progress and quality of your capture.

Backlog

If your backlog is filling up but you are not dropping frames, that's OK, you'll still have a perfect recording. Capture on! Be aware that when your backlog fills all the way up, your recording will stop automatically so Depthkit can write this data to disk.

Computer Performance

During recording, you may notice a warning box that pops up above the Recording button. This warns you of a drop in performance that can be solved by verifying your computer performance.

Capturing with Automatic Background Segmentation

When shooting with a Kinect for Windows v2, Depthkit detects one or multiple bodies with body index - body index - The detection of one or multiple bodies in the depth data. When generating your assets, this acts as a body mask, allowing you to simply hide the background for clean exports of your subjects. This eliminates the need to shoot on a green screen. detection. This provides the flexibility to capture in any space and simply remove the background as an optional export setting.

To export with automatic background segmentation, simply enable automatic Kinect Mask in the Export panel as seen below.

Body Detection

Body index detection will not recognize partial bodies, or subjects that are too close to the sensor. When recording, make sure your subject is detected. When a body is detected, they appear illuminated in the 3D preview and depth preview. If there is nothing illuminated, you may not be capturing successfully and your take could be blank.

Finalizing the Take

When you have stopped your recording, the backlog will clear as the take is being processed. You will not be able to record again until this is complete and the Record button is activated again. Don't worry, this processing only takes a few moments!

The Library

Once the recording is complete, the take will be present in your Library. This houses all takes and reports the clip duration. Keep in mind, that you can change the prefix of your take at any time under Name Prefix.

Navigating the 3D Preview

Function
HotKey

Adjust viewing angle of the 3D scene.

Click+drag

Zoom in and out of the 3D view port.

Middle mouse scroll Or right click+drag

Move an object around your scene.

Middle mouse click

Reset your view.

Double click in view port

Rotate subject in frustum view.

Click and rotate area between near and far plane. See visual below.

Sensor Capture


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.