SurfaceObserver is the main API portal for spatial mapping functionality in Unity.
Users should create an SurfaceObserver, call Update to generate SurfaceChanged events, call GetMeshAsync for those surfaces that are interesting, and call Dispose when finished with the object.
| SurfaceObserver | Basic constructor for SurfaceObserver. |
| Dispose | Call Dispose when the SurfaceObserver is no longer needed. This will ensure that the object is cleaned up appropriately but will not affect any Meshes, components, or objects returned by RequestMeshAsync. |
| SurfaceChangedDelegate | The SurfaceChanged delegate handles SurfaceChanged events as generated by calling Update on a SurfaceObserver. Applications can use the bounds, changeType, and updateTime to selectively generate mesh data for the set of known surfaces. |
| SurfaceDataReadyDelegate | The SurfaceDataReadyDelegate handles events generated when the engine has completed generating a mesh. Mesh generation is requested through GetMeshAsync and may take many frames to complete. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.