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

LabelFilter Struct

A struct that can filter certain labels.
The default is to allow all labels.

Fields

A list of labels to include, null is equivalent to all labels.
Optional enum flags representing component types to include, null is equivalent to all component types.

Member Functions

Creates a label filter that includes only the specified labels and component types.
Parameters
labelFlags
Enum flags representing labels to include.
componentTypes
Enum flags representing component types to include.
Checks if the specified string labels pass the current filter.
This method is obsolete. Use the enum-based 'PassesFilter' method instead for type safety and better performance.
Parameters
labels
A list of labels to check, specified as strings.
Returns
True if the labels pass the filter, false otherwise.
Checks if the given enum of labels passes the filter.
Parameters
labelFlags
Enum flags representing labels to check.
Returns
True if the labels pass the filter, false otherwise.

Static Member Functions

Creates a label filter that includes the specified labels.
This method is obsolete. Use the enum-based 'Included' method instead for type safety and better performance.
Parameters
included
A list of labels to include, specified as strings.
Returns
A LabelFilter that includes the specified labels.
Creates a label filter that excludes the specified labels.
This method is obsolete. Use the enum-based 'Excluded' method instead for type safety and better performance.
Parameters
excluded
A list of labels to exclude, specified as strings.
Returns
A LabelFilter that excludes the specified labels.
Creates a label filter from the specified enum labels.
This method is obsolete. Use the 'Included' method instead which directly accepts an enum of labels.
Parameters
labels
The labels specified as an enum.
Returns
A LabelFilter that includes the specified labels.
OVRSemanticLabels.DeprecationMessage
Creates a label filter that includes only the specified labels.
Parameters
labelFlags
Enum flags representing labels to include.
Returns
A LabelFilter that includes specified labels.
Creates a label filter that excludes the specified labels.
Parameters
labelFlags
Enum flags representing labels to exclude.
Returns
A LabelFilter that excludes specified labels.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta