API reference
API reference
Select your platform
No SDKs available
No versions available

OVRSpace Struct

Extends IEquatable< OVRSpace >
Represents a "space" in the Oculus Runtime.

Constructors

OVRSpace ( handle )
Constructs an OVRSpace object from an existing runtime handle and UUID.
This constructor does not create a new space. An OVRSpace is a wrapper for low-level functionality in the Oculus Runtime. To create a new spatial anchor, use OVRSpatialAnchor.
Signature
OVRSpace.OVRSpace(ulong handle)
Parameters
handle: ulong  The runtime handle associated with the space.

Properties

Handle : ulong
[Get]
A runtime handle associated with this OVRSpace.
This could change between subsequent sessions or apps.
Signature
ulong OVRSpace.Handle
Valid : bool
[Get]
Indicates whether this OVRSpace represents a valid space (vs a default constructed OVRSpace).
Signature
bool OVRSpace.Valid

Methods

Equals ( other )
Signature
bool OVRSpace.Equals(OVRSpace other)
Parameters
other: OVRSpace
Returns
bool
Equals ( obj )
Signature
override bool OVRSpace.Equals(object obj)
Parameters
obj: object
Returns
override bool
GetHashCode ()
Signature
override int OVRSpace.GetHashCode()
Returns
override int
ToString ()
Generates a string representation of this OVRSpace of the form "0xYYYYYYYY" where "Y" are the hexadecimal digits of the Handle.
Signature
override string OVRSpace.ToString()
Returns
override string  Returns a string representation of this OVRSpace.
TryGetUuid ( uuid )
Retrieve the universally unique identifier (UUID) associated with this OVRSpace.
Every space that can be persisted will have a UUID associated with it. UUIDs are consistent across different sessions and apps.
The UUID of a space does not change over time, but not all spaces are guaranteed to have a UUID.
Signature
bool OVRSpace.TryGetUuid(out Guid uuid)
Parameters
uuid: out Guid  If successful, the uuid associated with this OVRSpace, otherwise, Guid.Empty.
Returns
bool  Returns true if the uuid could be retrieved, otherwise false.

Static Methods

operator OVRSpace ( handle )
Signature
static implicit OVRSpace.operator OVRSpace(ulong handle)
Parameters
handle: ulong
Returns
implicit
operator ulong ( space )
Signature
static implicit OVRSpace.operator ulong(OVRSpace space)
Parameters
space: OVRSpace
Returns
implicit
operator!= ( lhs , rhs )
Signature
static bool OVRSpace.operator!=(OVRSpace lhs, OVRSpace rhs)
Parameters
Returns
bool
operator== ( lhs , rhs )
Signature
static bool OVRSpace.operator==(OVRSpace lhs, OVRSpace rhs)
Parameters
Returns
bool

Inner Enum

StorageLocation Enum

Represents a storage location for an OVRSpace.

Enumeration Constants

MemberDescription
Local
The storage location is local to the device.
Cloud
The storage location is in the cloud.