World.OcclusionCapabilities

static OcclusionCaps OcclusionCapabilities{ get }

Description

Reports which occlusion methods are available on the current device. For example, on Quest this may return OcclusionCaps.Depth | OcclusionCaps.Hands, and on HoloLens it may return OcclusionCaps.Mesh.

Examples

Configuring Quality Occlusion

If you expect the user’s environment to change a lot, or you anticipate the user’s environment may not be well scanned already, then you may wish to boost the frequency of world data updates. By default, StereoKit is quite conservative about scanning to reduce computation, but this can be configured using the World.RefreshX properties as seen here.

// If occlusion is not available, the rest of the code will have no
// effect.
if (World.OcclusionCapabilities == OcclusionCaps.None)
	Log.Info("Occlusion not available!");

// Configure SK to update the world data as fast as possible, this
// allows occlusion to accomodate better for moving objects.
World.Occlusion       = World.OcclusionCapabilities;
World.RefreshType     = WorldRefresh.Timer; // Refresh on a timer
World.RefreshInterval = 0; // Refresh every 0 seconds
World.RefreshRadius   = 6; // Get everything in a 6m radius

Basic World Occlusion

A simple example of turning on occlusion. The method you use depends on what the device supports — check World.OcclusionCapabilities to see what’s available. For example, HoloLens supports OcclusionCaps.Mesh, while Quest supports OcclusionCaps.Depth.

OcclusionCaps prevOcclusion;

public void Start()
{
	OcclusionCaps available = World.OcclusionCapabilities;
	if (available == OcclusionCaps.None)
		Log.Info("Occlusion not available!");

	// Store current state so we can restore it later
	prevOcclusion = World.Occlusion;

	// Enable whatever occlusion the device supports
	World.Occlusion = available;
}

public void Stop()
{
	// Restore the previous occlusion state
	World.Occlusion = prevOcclusion;
}

Found an issue with these docs, or have some additional questions? Create an Issue on Github!