Struct ARWorldMap
The space-mapping state and set of planes and reference points from
an AR session. This is a wrapper for
ARKit's ARWorldMap
Note: The ARWorldMap must be explicitly disposed to avoid leaking native resources.
Syntax
public struct ARWorldMap : IDisposable, IEquatable<ARWorldMap>
Properties
valid
Use this to determine whether this ARWorldMap is valid, or
if it has been disposed.
Declaration
public bool valid { get; }
Property Value
Methods
Dispose()
Dispose of the world map. This will invalidate any NativeArrays
previously returned by .
Declaration
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| Object |
obj |
|
Returns
Overrides
Equals(ARWorldMap)
Declaration
public bool Equals(ARWorldMap other)
Parameters
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
Serialize(Allocator)
Serialize the ARWorldMap to an array of bytes. This array may be saved to disk
and loaded at another time to persist the session, or sent over a network
to another ARKit-enabled app to share the session.
It is an error to call this method after the ARWorldMap has been disposed.
Declaration
public NativeArray<byte> Serialize(Allocator allocator)
Parameters
| Type |
Name |
Description |
| Allocator |
allocator |
|
Returns
| Type |
Description |
| NativeArray<Byte> |
An array of bytes representing the serialized ARWorldMap.
|
TryDeserialize(NativeArray<Byte>, out ARWorldMap)
Create a new ARWorldMap from a NativeArray of bytes produced
from Serialize(Allocator). Use this to create an ARWorldMap from
a serialized array of bytes, either loaded from disk or sent from another device.
Declaration
public static bool TryDeserialize(NativeArray<byte> serializedWorldMap, out ARWorldMap worldMap)
Parameters
Returns
Operators
Equality(ARWorldMap, ARWorldMap)
Declaration
public static bool operator ==(ARWorldMap lhs, ARWorldMap rhs)
Parameters
Returns
Inequality(ARWorldMap, ARWorldMap)
Declaration
public static bool operator !=(ARWorldMap lhs, ARWorldMap rhs)
Parameters
Returns
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.