Version: 2018.4
  • C#


Suggest a change


Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.


Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.



public void Update(XR.WSA.SurfaceObserver.SurfaceChangedDelegate onSurfaceChanged);


onSurfaceChangedCallback called when SurfaceChanged events are detected.


Update generates SurfaceChanged events which are propagated through the specified callback. If no callback is specified, the system will throw an ArgumentNullException. Generated callbacks are synchronous with this call. Scenes containing multiple SurfaceObservers should consider using different callbacks so that events can be properly routed.

Update is a very expensive call. Its expense scales with the number of observable Surfaces. Thus, constraining your observation volume can help improve performance if you expect to call Update regularly. The engine provides the SpatialMapping.ObserverUpdate profiling tag to allow you to monitor spatial mapping performance.

using UnityEditor;
using UnityEngine;
using UnityEngine.XR.WSA;
using System;

public class ExampleScript : MonoBehaviour { public SurfaceObserver m_Observer;

void UpdateSurfaceObserver() { // Update your surface observer to generate onSurfaceChanged callbacks m_Observer.Update(SurfaceChangedHandler); // all Update callbacks are now complete }

void SurfaceChangedHandler(SurfaceId id, SurfaceChange changeType, Bounds bounds, DateTime updateTime) { switch (changeType) { case SurfaceChange.Added: // handle Surface adds here break; case SurfaceChange.Updated: // handle Surface updates here break; case SurfaceChange.Removed: // handle Surface removal here break; } } }