API reference
OVRRoomLayout Struct
Extends IOVRAnchorComponent< OVRRoomLayout >, IEquatable< OVRRoomLayout >
Represents a room described by its floor, ceiling and walls OVRAnchors.
This component can be accessed from an OVRAnchor that supports it by calling OVRAnchor.GetComponent<T> from the anchor.
See Also
Properties
SpaceComponentType IOVRAnchorComponent< OVRRoomLayout >. Type[Get]
ulong IOVRAnchorComponent< OVRRoomLayout >. Handle[Get]
bool IsNull[Get]
Whether this object represents a valid anchor component.
bool IsEnabled[Get]
True if this component is enabled and no change to its enabled status is pending.
SpaceComponentType Type[Get]
ulong Handle[Get]
Public Statics
static readonly OVRRoomLayout Null[Get]
A null representation of an OVRRoomLayout.
Use this to compare with another component to determine whether it is null.
Member Functions
OVRRoomLayoutIOVRAnchorComponent< OVRRoomLayout >. FromAnchor
( OVRAnchor anchor )
OVRTask< bool > IOVRAnchorComponent< OVRRoomLayout >. SetEnabledAsync
( bool enabled,
double timeout )
bool Equals
( OVRRoomLayout other )
Compares this component for equality with other .
Parameters
other
The other component to compare with.
Returns
True if both components belong to the same OVRAnchor, otherwise false.
override bool Equals
( object obj )
Compares this component for equality with obj .
Parameters
obj
The object to compare with.
Returns
True if obj is an OVRRoomLayout and Equals(OVRRoomLayout) is true, otherwise false.
override int GetHashCode ( )
Gets a hashcode suitable for use in a Dictionary or HashSet.
Returns
A hashcode for this component.
override string ToString ( )
Gets a string representation of this component.
Returns
A string representation of this component.
(Obsolete) Asynchronous method that fetches anchors contained in the Room Layout.
Dispose of the returned task if you don't use the results
Parameters
Deprecatedanchors
List that will get cleared and populated with the requested anchors.
This method is obsolete. Use FetchAnchorsAsync instead.
Returns
A task that will eventually let you test if the fetch was successful or not. If the result is true, then the anchors parameter has been populated with the requested anchors.
Exceptions
InvalidOperationException
If it fails to retrieve the Room Layout
ArgumentNullException
If parameter anchors is null
OVRTask< OVRResult< List< OVRAnchor >, OVRAnchor.FetchResult > > FetchAnchorsAsync
( List< OVRAnchor > anchors )
Fetches the anchors contained in the Room Layout.
Dispose of the returned task if you don't use the results.
Parameters
anchors
List that will get cleared and populated with the requested anchors.
Returns
A task that will eventually let you test if the fetch was successful or not. If the result is true, then the anchors parameter has been populated with the requested anchors.
Exceptions
InvalidOperationException
Thrown if the method fails to retrieve the Room Layout. This is usually because the anchor does not have a RoomLayout component.
ArgumentNullException
Thrown if anchors is null.
bool TryGetRoomLayout
( out Guid ceiling,
out Guid floor,
out Guid[] walls )
Tries to get the Ceiling, Floor and Walls unique identifiers.
These can then be used to Fetch their anchors.
Parameters
ceiling
Out Guid representing the ceiling of the room.
floor
Out Guid representing the floor of the room.
walls
Out array of Guids representing the walls of the room.
Returns
bool true if the request succeeds and false if it fails.
Static Member Functions
static bool operator==
( OVRRoomLayout lhs,
OVRRoomLayout rhs )
Compares two components for equality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if both components belong to the same OVRAnchor, otherwise false.
static bool operator!=
( OVRRoomLayout lhs,
OVRRoomLayout rhs )
Compares two components for inequality.
Parameters
lhs
The component to compare with rhs .
rhs
The component to compare with lhs .
Returns
True if the components do not belong to the same OVRAnchor, otherwise false.
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta