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

Release Notes & Known Issues

A breaking change if updating from v0.1.9 or v0.2.3.

This package contains a new folder structure for the plugin as well as some variable name changes and video player changes that may break any links you added to the plugin. If you're planning to use this in your existing project that has used an older plugin version, we highly recommend deleting your current plugin, then importing the latest.

Previous Applicable Versions

  • v0.1.9
  • v0.2.3

Version 0.2.7

Fixes

  • Solved an issue where different crop values from Depthkit will impact the orientation of the Depthkit clip in Unity.

Known Issues

  • Multi-editing may cause errors or clips may fail to recognize your intended changes when more than one clip is selected. Please be aware of this when trying to edit many clips at once.
  • Disabling/re-enabling a Depthkit clip after playback may cause a material error in the form of a pink box above your clip. Simply click anywhere in the editor to clear this.
  • When your Depthkit clip is hidden (the game object is disabled), the editor claims that your "Depthkit clip is not setup". Don't worry, this will switch back to setup when the clip is re-enabled.

The Zero Days Look

  • iOS is not yet supported for the Zero Days Renderer.
  • The Zero Days Look does not currently work on builds for Magic Leap.
  • When importing the Depthkit Unity Plugin and a Looks Package, you must be importing packages with the same version number. If importing Zero Days Look v0.2.5, you need to have already imported Depthkit Unity Plugin v0.2.5 into your project.

Version 0.2.6

Fixes

  • Refined default values of Spike Removal for ease of cleaning up edge artifacts in the editor.
  • Fixed bug in which the Zero Days Line Layer caused a geometry shader warning on OSX.
  • Improved functionality between the Unity Plugin and the corresponding Look version, meaning that if you import the Plugin with an old version of the Look package, you will be warned in the console.

Known Issues

  • When upgrading the Unity Plugin in an existing project, your existing Depthkit clips under the Zero Days Look may generate an extra Depthkit_Photo Look (script) component. This will not break your clip, however, it will cause conflicting mesh density settings. To solve, simply remove the extra Depthkit_Photo Look (script) component as outlined below.
  • Multi-editing may cause errors or clips may fail to recognize your intended changes when more than one clip is selected. Please be aware of this when trying to edit many clips at once.
  • Disabling/re-enabling a Depthkit clip after playback may cause a material error in the form of a pink box above your clip. Simply click anywhere in the editor to clear this.
  • When your Depthkit clip is hidden (the game object is disabled), the editor claims that your "Depthkit clip is not setup". Don't worry, this will switch back to setup when the clip is re-enabled.

The Zero Days Renderer

  • iOS is not yet supported for the Zero Days Renderer.
  • The Zero Days Look does not currently work on builds for Magic Leap.
  • Point and Line Layers blend, if blended with 100% black, may not show up in your clip.

Version 0.2.5

Fixes

  • Improved functionality of switching between video players.
  • Fixed playback issues for AVPro Direct Show when the clip would have delayed playback in a build.
  • Fixed bug where the Zero Days Look Fill Layer - Fill Layer - The base layer of the Hologram Renderer, in which you can adjust opacity and blending. would not show up in a build if it is the only layer used.
  • Sprite orientation has been corrected for applying sprites in the Zero Days Look.

Known Issues

  • Multi-editing may cause errors or clips may fail to recognize your intended changes when more than one clip is selected. Please be aware of this when trying to edit many clips at once.
  • Disabling/re-enabling a Depthkit clip after playback may cause a material error in the form of a pink box above your clip. Simply click anywhere in the editor to clear this.
  • When your Depthkit clip is hidden (the game object is disabled), the editor claims that your "Depthkit clip is not setup". Don't worry, this will switch back to setup when the clip is re-enabled.

The Zero Days Renderer

  • iOS is not yet supported for the Zero Days Renderer.
  • The Zero Days Look does not currently work on builds for Magic Leap.
  • When importing the Depthkit Unity Plugin and a Looks Package, you must be importing packages with the same version number. If importing Zero Days Look v0.2.5, you need to have already imported Depthkit Unity Plugin v0.2.5 into your project.

Version 0.2.4

Changes

New in v0.2.4

  • Clean up of the Depthkit editor and video players. When updating your Unity project to v0.2.4, you may need to re-enable the startup and playback settings of your existing Depthkit clips.
  • Support for the Zero Days Renderer.
  • Edge clean up and improved functionality of the point and line components.
  • Improved self occlusion that is now controlled with the Zero Days Renderer instead of through individual layers.
  • Support for MPMP Video Player has been removed.

Known Issues

Video Players

  • When converting your clip video player from Unity Player to AVPro, the clip will retain the file path relative to the project folder. This means that an AVPro clip may not appear in a build. Make sure that when using AVPro, your video file source path is set to “Relative to Streaming Assets Folder”.
  • When using AVPro as your video player, the clips doesn't always show up in a build when your Preferred Video API is set to Direct Show in your AVPro global settings. We recommend that you do not use Direct Show. Stick with the default Windows Media Foundation.
  • Unity video player may cause more edge artifacts than AVPro when playing you clips. This is easily solved by adjusting the Clean Up Filter parameters.

Working with your Depthkit Clips

  • Multi-editing may cause errors or clips may fail to recognize your intended changes when more than one clip is selected. Please be aware of this when trying to edit many clips at once.
  • Disabling/re-enabling a Depthkit clip after playback may cause a material error in the form of a pink box above your clip. Simply click anywhere in the editor to clear this.
  • When your Depthkit clip is hidden (the game object is disabled), the editor claims that your "Depthkit clip is not setup". Don't worry, this will switch back to setup when the clip is re-enabled.

The Zero Days Renderer

  • iOS is not yet supported for the Zero Days Renderer.
  • When applying a sprite image to the Line Layer, the sprite image will appear flipped.
  • The Fill Layer does not show up on Mac if the fill layer is the only layer being used. This only applies to the Unity Player, so you can avoid this by using AVPro or by applying a Point or Line layer.

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.