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.


Computer Requirements

Depth Sensors

Getting Started

Release Notes & Known Issues

Depthkit projects are not backwards compatible.

This means that you cannot open your current project in a previous version of Depthkit.

Depthkit for Visual Effects

OBJ Export Feature

Released 6/14/19

For best results when exporting OBJ sequences, make sure you have updated to the latest version of Depthkit.

Updates

  • Introduction of OBJ sequences as an export format. Note that this export format is only available for Depthkit Pro.
  • Introduction of mesh decimation - mesh decimation - The optimization of 3D geometry by reducing the number of triangles in a single mesh. to optimize your sequence exports.

Known Issues

  • The polygon normals of the OBJ sequence - OBJ sequence - A 3D geometry format used in a range of vfx pipelines. may need to be averaged when taken into your preferred DCC tool. Continued development is in progress to improve the per vertex normals on export from Depthkit.

Version 0.3.11

Released on 6/13/19

Updates

  • Solved an issue in the functionality of the depth range - depth range - The depth near and far planes represented as hue encoded ranges, red as the near plane and pink as the farthest plane before clipping. .
  • Solved an issue with the refinement mask file path.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
  • When recording in low light situations with the Kinect, the sensor may capture at 15 fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.

Version 0.3.10

Released on 5/31/19

Updates

  • Introduction of combined-per-pixel - combined-per-pixel - The export format optimized for Unity playback that is made up of the color video (top) and depth data (bottom). This format provides a performance friendly playback of your volumetric data. png sequences as an export format in Depthkit Pro (only). This promotes higher quality exports and is helpful for those taking their Depthkit exports into another video editing tool while avoiding extra video compression.
  • Depthkit now tracks available hard drive space. This is helpful when recording on a computer with limited space and will prevent any operating system issues related to low disk space.
  • Introduced support for the RealSense D435i.
  • Improved user interface for the depth range slider, which is helpful for those working in the minimum depth range.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
  • When recording in low light situations with the Kinect, the sensor may capture at 15 fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.

Version 0.3.9

Released on 5/15/19

Projects created in version 0.3.9 cannot be opened in previous versions of Depthkit.

Bug Fixes

  • Solved the following compiling issue: "error creating shader from source", which occurred on certain low performance computers.
  • Solved export and playback issues on computer with AMD graphics cards where the first frame of the video export would contain a blank frame and scrubbing the timeline occasionally fell out of synchronization between the color and depth inputs.

Updates

  • Introduction of a cancel button for easy export cancellations in the Edit window.
  • Automatic assignment of the preferred graphics processor for users with Nvidia discreet graphics cards. This will greatly increase capture performance for those working with this kind of GPU.
  • When switching between different kinds of depth sensors, the depth range now automatically updates to the range of the new sensor.
  • Improved functionality of take selection and playback in the Edit window.
  • Usability refinement of the timeline in the Edit window.
  • Improved error warnings for users running into issues in the Edit window.
  • The default camera view now accurately reflects the sensor's field of view, allowing for an accurate view of your capture space.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
  • When recording in low light situations with the Kinect, the sensor may capture at 15 fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.
  • Projects may not load if trying to open a Depthkit project located on an exFat external hard drive. If needing to open a project from an external drive, use NTFS.

Version 0.3.7

Released on 4/18/19

Projects created in version 0.3.7 cannot be opened in previous versions of Depthkit.

Bug Fixes

  • Solved installer bug that caused an error claiming that Visual Studio .dll files were missing.

Updates

  • Continued improvements to timeline functionality.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
    • If switching back and forth between senors, the depth range may not reset to the new sensor. This could cause clipping in your recording. To avoid this, simply re-adjust your depth range when you start to record with a new sensor.
  • When recording in low light situations with the Kinect, the sensor may capture at 15fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.
  • Projects may not load if trying to open a Depthkit project located on an exFat external hard drive. If needing to open a project from an external drive, use NTFS.
  • If you are working on a computer with a dedicated GPU, you may need to configure it so Depthkit will run with the most powerful option. See the instructions to select your preferred GPU with NVIDIA and AMD graphics cards.

Version 0.3.6

Released on 3/18/19

Projects created in version 0.3.6 cannot be opened in previous versions of Depthkit.

Updates

  • Improved timeline functionality.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
    • If switching back and forth between senors, the depth range may not reset to the new sensor. This could cause clipping in your recording. To avoid this, simply re-adjust your depth range when you start to record with a new sensor.
  • When recording in low light situations with the Kinect, the sensor may capture at 15fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.
  • Projects may not load if trying to open a Depthkit project located on an exFat external hard drive. If needing to open a project from an external drive, use NTFS.

Version 0.3.5

Released on 2/25/19

Updating Existing Depthkit Projects

Version 0.3.5 implements a change in project versioning. Projects created in v0.3.5 cannot be opened in previous versions of Depthkit. Similarly, once you open a project created with a previous version, the project will be converted and will also no longer work in versions prior to v0.3.5.

Updates

  • Fixed bug when the enhancement parameters and crop values may not save in the user interface sliders when re-launching Depthkit.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
    • If switching back and forth between senors, the depth range may not reset to the new sensor. This could cause clipping in your recording. To avoid this, simply re-adjust your depth range when you start to record with a new sensor.
  • When recording in low light situations with the Kinect, the sensor may capture at 15fps instead of 30 fps. You will be notified of this in the Depthkit console. If you the console reports "low light activated", your capture has dropped to 15 fps. Once the console reports "low light deactivated", it has reverted back to 30 fps.
  • Projects may not load if trying to open a Depthkit project located on an exFat external hard drive. If needing to open a project from an external drive, use NTFS.

Version 0.3.4

Released on 2/5/19

Updates

  • Refined sensor configuration for selecting sensor types and customizing capture resolution.
  • Fixed bug when projects did not refresh when opening a project via File -> Recent Projects.
  • Fixed bug with account badge so your account type can be viewed when offline.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Enhancement parameters and crop values may not save in the user interface sliders when re-launching Depthkit.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.

Version 0.3.3

Released on 1/18/19

Updates

  • Increased 3D viewport performance for reduced dropped frames during recording.
  • Reduction of minimum depth range - depth range - The depth near and far planes represented as hue encoded ranges, red as the near plane and pink as the farthest plane before clipping. . This is helpful for those looking to set very narrow depth ranges.
  • Implementation of a refinement preview in Depthkit Record.
  • Introduction of the Recent Project menu selection for ease of navigation back to the Depthkit launch menu.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.

Version 0.3.2

Released on 1/7/19

Updates

Increased Performance

  • Experience fewer dropped frames and during capture.
  • With the introduction of the Preferences menu drop down, users can now enable or disable GPU acceleration for switching between the GPU and CPU.

User Interface Updates

  • Toggle timeline playback by playing and pausing your clip with the spacebar.
  • Start or stop a recording with a click of the spacebar.

Known Issues

  • The window size of Depthkit may impact performance during recording. If experiencing dropped frames, reduce the size of the window for increased performance.
  • Low hard drive space may contribute to a lower performance and dropped frames. Keep and eye on your drive space during recording to make sure you computer has extra room.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.

Version 0.3.1

Released on 11/4/18

Updates

Introduction of Live Preview Enhancement
Gain valuable insight into your depth refinements with a live preview into all depth edits.

New Depth Refinement Parameters
Enhance your depth data with color and depth contribution values, allowing you to refine your capture based on the source color and depth data itself.

Increased Performance
Enjoy fewer dropped frames and increased performance during capture.

Version 0.3.0

Updates

Introduction of the Sensor Enhancement Workflow

  • Significantly increase sensor video capture quality by refining your depth data.
  • Apply an optional custom matte to captures filmed on a green screen to export with clean edges.
  • Crop the export frame to take advantage of every available depth pixel.
  • Set custom refinement parameters to fill in depth holes and increase your export quality.

Known Issues

  • When setting your near plane, the depth range represented in bright red may get clipped when viewed in Unity. When setting your near plane, avoid bright red and stick with dark orange as the representation of the nearest depth range.
  • Editing your source color video may create issues if you do not maintain the source codec. If color correcting the video, make sure to export it as H264(mp4) so the app can read the file properly.
  • Depthkit v0.3.0 is experiencing a drop in performance on the Dell G3 15 Gaming Laptop, one of our recommended capture machines. If experiencing issues, try you can download Depthkit v0.2.0.

Version 0.2.1

Updates

Introduction of the Depth Range

  • Set and preview the depth range - depth range - The depth near and far planes represented as hue encoded ranges, red as the near plane and pink as the farthest plane before clipping. before capture.
  • Adjust and preview the depth range - depth range - The depth near and far planes represented as hue encoded ranges, red as the near plane and pink as the farthest plane before clipping. in the Edit & Export window.

Known Issues

  • Depthkit v0.2.1 is experiencing increased dropped frames on lower performance computers. If experiencing this issue, you can revert to v0.2.0.
  • When setting your near plane, the depth range represented in bright red may get clipped when viewed in Unity. When setting your near plane, avoid bright red and stick with dark orange as the representation of the nearest depth range.

Version 0.2.0

Updates

Introduction of the Edit & Export Window

  • Experience 3D playback.
  • Visualize background subtraction options before export.
  • Set in and out points for your desired clip.

Live Preview of the Near & Far Planes

  • Visualize the depth values while you record so you know exactly when in being captured by the depth stream.

Increased Depth Range

  • Experience an extended shooting range with clear indication of when the sensor clips in the near or far plane.

Increased Capture Performance

  • Experience fewer dropped frames during capture.

Version 0.1.2

Updates

Increased Capture Stability and Performance

  • Take Diagnostics will alert you to any dropped frames that some may experience when working with an older or low powered computer.
  • A capture backlog - backlog - Some under powered computers are not able to keep up with writing frames as fast as they are captured. The frame backlog feature allows you to create flawless recordings even on these machines. Frames queue up in system memory and are written to disk after recording completes. The progress bar represents the maximum amount of frames that can be stored before the recording is automatically stopped. allows you to create flawless recordings even on these low powered machines by having your frames queue up in system memory and are write to disk after recording completes.
  • Live 3D preview of your capture, as well as individual displays of your color and depth streams provide complete clarity into what you are capturing and how it will look.

Optional Background Subtraction for the Kinect

  • Once capturing a take with the Kinect, you can now hide or show the environment background via your export settings with the help of 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. .

Optimized depth data Compression

  • This means efficient and fast processing of your volumetric captures. Now you can go from capture to export to Unity in seconds!

In App Video Encoding

  • Now with hardware accelerated video encoding, there is no need to encode an image sequence with an external tool.

Optimized for Unity

  • The combined-per-pixel - combined-per-pixel - The export format optimized for Unity playback that is made up of the color video (top) and depth data (bottom). This format provides a performance friendly playback of your volumetric data. video export format allows for direct import into Unity after your takes have been exported.

Release Notes & Known Issues


Suggested Edits are limited on API Reference Pages

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