Skip to main content

Enums

Every enum, nested ones included, with its topic.

176 in Lens API 387. Topic says where the sidebar lists each one.

NameTopicDescription
AccountTypeUser & FriendsThe kind of account backing a User.
AnchorModule.AnchorScopeAR & Tracking › World › AnchorModuleWho can access an anchor.
AnchorModule.AnchorTrackingStateAR & Tracking › World › AnchorModuleThe tracking state of an AnchorComponent.
AnchorModule.AnchorTypeAR & Tracking › World › AnchorModuleThe kind of anchor.
AnimationLayerBlendModeAnimationHow animation layers are blended.
AnimationLayerScaleModeAnimationThe method in which an Animation Layer should be scaled to other layers in an AnimationClip.
AsrModule.AsrContentTypeAudio & Voice › Speech › AsrModuleThe kind of content the speech is expected to carry.
AsrModule.AsrModeAudio & Voice › Speech › AsrModuleThe mode of the transcription to prioritise, between speed and accuracy.
AsrModule.AsrStatusCodeAudio & Voice › Speech › AsrModuleAn enum stating the status of the transcription.
AttachmentPointTypeAR & Tracking › Face
Audio.DistanceCurveTypeAudio & Voice › Playback & Effects › AudioThe curve that specifies how sound fades with the distance from Audio Component to the Audio Listener.****
Audio.PlaybackModeAudio & Voice › Playback & Effects › AudioThe Playback Mode property of the AudioComponent used in Lenses targeting Spectacles.
AxisPhysics › Shapes & Collision MeshesCardinal axis enumeration.
Bitmoji3DOptions.AvatarScopeBitmoji › Bitmoji3DOptionsEnum representing avatar scope used in custom params of bitmoji3d options.
Bitmoji3DOptions.BodyTypeBitmoji › Bitmoji3DOptionsEnum representing different body types for the avatar.
Bitmoji3DOptions.BreastTypeBitmoji › Bitmoji3DOptionsEnum representing different breast types for the avatar.
Bitmoji3DOptions.ClothingTypeBitmoji › Bitmoji3DOptionsEnum representing different types of clothing
Bitmoji3DOptions.GenderBitmoji › Bitmoji3DOptionsEnum representing the gender of the avatar.
Bitmoji3DOptions.RequestTypeBitmoji › Bitmoji3DOptionsEnum representing different request types.
BlendModeGraphics, Materials & Particles › Rendering & Materials
Bluetooth.BluetoothStatusCloud, Networking & Storage › BluetoothThe statuses for Bluetooth availability.
Bluetooth.CharacteristicPropertyCloud, Networking & Storage › BluetoothProperties of a Bluetooth.BluetoothGattCharacteristic.
Bluetooth.ScanModeCloud, Networking & Storage › BluetoothDefines how Bluetooth devices should be scanned.
Camera.CubemapFaceGraphics, Materials & Particles › Rendering & Materials › CameraDifferent faces of the cubemap that a camera can render into.
Camera.DepthBufferModeGraphics, Materials & Particles › Rendering & Materials › CameraUsed in Camera's depthBufferMode property.
Camera.DevicePropertyGraphics, Materials & Particles › Rendering & Materials › CameraUsed in Camera's devicePropertyUsage property.
Camera.TypeGraphics, Materials & Particles › Rendering & Materials › CameraReturned from Camera's type property.
CameraModule.CameraFacingAR & Tracking › Camera › CameraModuleWhich way a camera faces, reported on CameraModule.CameraInfo#facing.
CameraModule.CameraIdAR & Tracking › Camera › CameraModuleA handle to specify which camera on the Spectacles to request from.
CameraModule.CameraLocationAR & Tracking › Camera › CameraModuleCamera position on the device, reported on CameraModule.CameraInfo#location.
CameraModule.CameraTypeAR & Tracking › Camera › CameraModuleCamera sensor type, reported on CameraModule.CameraInfo#type.
CameraModule.ConfigKeyAR & Tracking › Camera › CameraModuleTyped keys for camera tuning parameters.
CameraModule.ImageFormatAR & Tracking › Camera › CameraModuleImage format for camera image data.
CameraModule.MetadataKeyAR & Tracking › Camera › CameraModuleTyped keys for querying per-frame metadata.
CameraModule.OperationAR & Tracking › Camera › CameraModuleWhich session a stream capability works with, reported by CameraModule.StreamInfo#operation.
CameraModule.QualityAR & Tracking › Camera › CameraModuleProcessing quality tier of a stream configuration.
CameraModule.ResultAR & Tracking › Camera › CameraModuleResult codes from camera session operations.
CameraModule.StreamStatusAR & Tracking › Camera › CameraModuleSession lifecycle status delivered via onStatusChanged event.
CameraRollMediaTypeGraphics, Materials & Particles › Textures & VideoEnum representing the type of media selected from camera roll.
Canvas.OffsetUnitUI › CanvasThe unit system for child ScreenTransform offsets on a Canvas.
Canvas.SortingTypeUI › CanvasUsed by Canvas to set how an object is sorted during rendering.
Canvas.UnitTypeUI › CanvasUsed by Canvas to set how an object is positioned.
CapitalizationOverrideText & FontsChanges the capitalization of the text component.
ClearColorOptionGraphics, Materials & Particles › Rendering & MaterialsSettings for how color will be cleared before rendering.
ClothVisual.BendModePhysics › Cloth & Hair › ClothVisualCloth bend mode to use for cloth simulation.
Commerce.ProductTypeCommerce › Commerce Kit › CommerceDefines the type of product that can be purchased in a Lens.
Commerce.PurchaseStateCommerce › Commerce Kit › CommerceRepresents the state of a purchase in a Lens.
Commerce.RecurrenceModeCommerce › Commerce Kit › CommerceDescribes how a subscription pricing phase repeats over time.
Commerce.ResponseCodeCommerce › Commerce Kit › CommerceDefines the possible outcomes of a purchase attempt in a Lens
CompassTrackingData.AccuracyAR & Tracking › Location & Navigation › CompassTrackingData
CompositionLayer.Render.UpdateModeGraphics, Materials & Particles › Rendering & Materials › CompositionLayerDetermines when a composition layer should be (re-)rendered.
CompressionQualityGraphics, Materials & Particles › Textures & VideoEnum used to define the quality of image or texture compression.
ConnectedLensModule.MatchmakingAvailabilityConnected Lenses (Multiplayer) › ConnectedLensModuleWhether matchmaking is available, and if not, why.
ConnectedLensModule.MatchmakingConfig.LobbyModeConnected Lenses (Multiplayer) › ConnectedLensModuleHow matchmaking fills a session.
ConnectedLensModule.MatchmakingConfig.LobbyStateConnected Lenses (Multiplayer) › ConnectedLensModuleOpen/close gate of an open-lobby session.
ConnectedLensModule.SessionShareTypeConnected Lenses (Multiplayer) › ConnectedLensModuleUsed by ConnectedLensModule to specify the session share type.
ConnectedLensSessionOptions.SessionCreationTypeConnected Lenses (Multiplayer) › ConnectedLensSessionOptionsType of the created Connected Lens session.
CullModeGraphics, Materials & Particles › Rendering & MaterialsUsed with Pass's cullMode property.
DepthClearOptionGraphics, Materials & Particles › Rendering & MaterialsSettings for the depth clear option modes on a DepthStencilRenderTargetProvider.
DeviceTrackingModeAR & Tracking › WorldTracking modes used by the DeviceTracking component to specify what type of tracking to use.
EncodingTypeUtilities › Data & EncodingSpecifies the format for encoding textures, used with Base64.
ExpressionsAR & Tracking › Face
EyeToRenderAR & Tracking › FaceSpecifies which eye to apply an EyeColorVisual effect to.
FaceInsetRegionAR & Tracking › Face
FalloffTypeGraphics, Materials & Particles › Rendering & MaterialsThe types of light falloff from a LightSource.
FilteringModeGraphics, Materials & Particles › Textures & Video
FontStylesText & Fonts
FrustumCullModeGraphics, Materials & Particles › Rendering & MaterialsMode for setting frustum culling on Pass
GameControllerModule.ButtonInteraction › GameControllerModuleCommon gamepad button identifiers.
GameControllerModule.ButtonEventTypeInteraction › GameControllerModuleWhether a button changed to pressed or released.
GameControllerModule.ControllerCapabilityInteraction › GameControllerModuleOptional capabilities a controller may support.
GameControllerModule.ControllerTypeInteraction › GameControllerModuleController family as reported by the device.
GameControllerModule.SideInteraction › GameControllerModuleWhich side of the controller a thumbstick or trigger belongs to.
GameControllerModule.TouchStateInteraction › GameControllerModuleState of a single touch point on the controller touchpad.
GeoLocationAccuracyAR & Tracking › Location & NavigationEnumeration of supported GPS location accuracy.
GestureModule.HandTypeInteraction › GestureModuleThe hand used in gesture detection with GestureModule.
HapticFeedbackTypeInteractionThe method in which haptic feedback is provided.
HorizontalAlignmentText & FontsUsed by the horizontalAlignment property in MeshVisual.
HorizontalOverflowText & FontsOptions for wrapping text horizontally.
ImageUploadCompressionMethodCloud, Networking & Storage › Remote Assets & MediaSpecifies the compression format to use when uploading an image.
KeyModifiersInteraction
KeysInteraction
Leaderboard.OrderingTypeUser & Friends › LeaderboardDescribes how the leaderboard should be ordered.
Leaderboard.UsersTypeUser & Friends › LeaderboardThe type of user to be retrieved.
LightTypeGraphics, Materials & Particles › Rendering & MaterialsThe types of light emission from a LightSource.
LoadStatusBase Classes
LocationProximityStatusAR & Tracking › Location & NavigationUsed by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location.
LookAtComponent.AimVectorsScene › LookAtComponentThe "aim" and "up" vectors used with LookAtComponent when determining rotation.
LookAtComponent.LookAtModeScene › LookAtComponentModes used in LookAtComponent.lookAtMode to determine the rotation method being used.
LookAtComponent.WorldUpVectorScene › LookAtComponentUsed with LookAtComponent to set the "up" vector when determining rotation.
LyricsTypeAudio & Voice › Music & LyricsTypes of granularity for lyric data.
MachineLearning.DataLayoutSnapML › MachineLearningUsed with BasePlaceHolder.
MachineLearning.FrameTimingSnapML › MachineLearningTiming options for when MLComponent should start or stop running.
MachineLearning.InferenceModeSnapML › MachineLearningInference modes used by MLComponent.inferenceMode.
MachineLearning.ModelStateSnapML › MachineLearningDescribes the current state of the MLComponent model.
MachineLearning.OutputModeSnapML › MachineLearningTypes of output used by OutputPlaceholder.
ManipulateTypeInteractionEnum values specifying each type of manipulation.
MappingSession.MappingScopeAR & Tracking › Location & Navigation › MappingSessionDetermines what data is included in the checkpoint of the @MappingSession.
MappingSession.MappingThrottlingAR & Tracking › Location & Navigation › MappingSessionThrottling levels for a MappingSession.
MeshClassificationFormatAR & Tracking › WorldFormats of mesh classification used by WorldRenderObjectProvider.
MeshIndexTypeGraphics, Materials & Particles › Meshes & EffectsPossible index data types used by MeshBuilder.
MeshShadowModeGraphics, Materials & Particles › Rendering & Materials
MeshTopologyGraphics, Materials & Particles › Meshes & EffectsMesh topology types used by MeshBuilder.
MotionController.HapticFeedbackInteraction › MotionControllerDefines a set of haptic feedback patterns that can be requested.
MotionController.MotionTypeInteraction › MotionControllerEnum for describing the motion type.
MotionController.TouchPhaseInteraction › MotionControllerEnum that defines a current state of a touch interaction with the touchpad of the motion controller.
MotionController.TrackingQualityInteraction › MotionControllerDescribes Motion Controller tracking quality state, whether the data received from the Motion Controller is accurate or not.
NativeARTrackingStateAR & Tracking › WorldDescribes the state of the native AR tracking (SLAM) system that backs DeviceTracking.
NativePlaneTrackingTypeAR & Tracking › WorldTracking type used by the DeviceTracking component to specify what type of plane to detect.
ObjectTracking3D.TrackingModeAR & Tracking › Body › ObjectTracking3DStrategies for updating attached objects.
OSUtilities › Device & RuntimeTypes of operating system that may be running on the device.
Physics.ConstraintTypePhysics › Bodies & Colliders › PhysicsConstraint type used by a Constraint.
Physics.ForceModePhysics › Bodies & Colliders › PhysicsType of force to use when applying force or torque to a BodyComponent.
Physics.HingeMotorTypePhysics › Bodies & Colliders › PhysicsEnum that defines motor type.
PinToMeshComponent.OrientationGraphics, Materials & Particles › Meshes & Effects › PinToMeshComponentUsed with PinToMeshComponent.orientation.
PlaybackModeAnimationUsed with AnimationClip to describe how the clip should be played.
RealtimeStoreCreateOptions.OwnershipConnected Lenses (Multiplayer) › RealtimeStoreCreateOptionsThe ownership model of a realtime store.
RealtimeStoreCreateOptions.PersistenceConnected Lenses (Multiplayer) › RealtimeStoreCreateOptionsThe persistence model for a realtime store.
RecordingStateLifecycle EventsDescribes the current recording state of the Lens.
RemoteServiceHttpRequest.HttpRequestMethodCloud, Networking & Storage › Internet Access › RemoteServiceHttpRequestThe http method which should be used to send this http request.
RenderTargetProvider.AntialiasingModeGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderThe anti-aliasing technique to use on a render target.
RenderTargetProvider.AntialiasingQualityGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderThe fidelity of the anti-aliasing technique to apply.
RenderTargetProvider.DepthBufferUsageGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderControls depth buffer usage strategy for the render target.
RenderTargetProvider.MSAAStrategyGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderHow MSAA should be applied to the render target.
RenderTargetProvider.OutputResolutionGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderControls the resolution source for the render target.
RenderTargetProvider.TextureTypeGraphics, Materials & Particles › Rendering & Materials › RenderTargetProviderSpecifies what kind of render target it is.
SceneActivityPhaseLifecycle EventsRepresents the current lifecycle activity phase of the Scene.
ScreenRegionTypeUITypes of screen regions that can be used with ScreenRegionComponent.
ShadowMapQualityGraphics, Materials & Particles › Rendering & Materials
ShadowTypeGraphics, Materials & Particles › Rendering & MaterialsThe types of shadows that a LightSource can cast.
SortOrderSnapMLOrder that inTensor will be sorted when applying TensorMath.argSortMasked().
SpecsInteractionModule.CursorVisualModeInteraction › SpecsInteractionModuleCursor visual treatment.
SpecsInteractionModule.FieldStateInteraction › SpecsInteractionModuleThe targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), h…
SpecsInteractionModule.InteractorKindInteraction › SpecsInteractionModuleThe category of an interactor.
SpecsInteractionModule.TargetingModeInteraction › SpecsInteractionModuleHow an interactor can target an Interactable, as a bitmask of interaction methods.
SpecsInteractionModule.TargetingPriorityInteraction › SpecsInteractionModuleTargeting priority for this Interactable.
SpecsInteractionModule.TargetingVisualInteraction › SpecsInteractionModuleThe targeting visual shown while an interactor targets an Interactable or InteractionPlane.
StencilClearOptionGraphics, Materials & Particles › Rendering & MaterialsStencil buffer clear option.
StencilFaceGraphics, Materials & Particles › Rendering & MaterialsSpecifies whether the front and/or back face stencil test will be applied.
StencilFunctionGraphics, Materials & Particles › Rendering & MaterialsSpecifies the stencil test function.
StencilOperationGraphics, Materials & Particles › Rendering & MaterialsOptions for specifying the action to take when stencil and depth tests resolve.
StorageScopeCloud, Networking & Storage › StorageSpecifies a scope for storing or retrieving values from a MultiplayerSession.
StretchModeUIOptions for stretching a mesh to fit a ScreenTransform Used in RenderMeshVisual stretchMode property, as long as the SceneObject has a ScreenTransform attached.
SurfaceClassificationAR & Tracking › WorldThe classification of the surface at the position where the ray intersects with the environment.
TangentTypeAnimationUsed with AnimationKeyFrame.
TensorMath.BorderTypeSnapML › TensorMath
TensorMath.ThresholdMethodSnapML › TensorMath
Text3DExtrudeDirectionText & FontsControls the direction in which Text3D meshes are extruded relative to the component's local position.
TextFillModeText & FontsUsed in TextFill's mode property.
TextInputSystem.KeyboardKindInteraction › TextInputSystemThe kind of keyboard currently serving the text input session.
TextInputSystem.KeyboardTypeInteraction › TextInputSystemThe different input style of keyboard input.
TextInputSystem.ReturnKeyTypeInteraction › TextInputSystemThe return key style of keyboard input.
TextInputSystem.TextFieldActionInteraction › TextInputSystemEditor action for the text field (e.g. when user presses action key on keyboard).
TextureFormatGraphics, Materials & Particles › Textures & Video
TextureUsageGraphics, Materials & Particles › Textures & VideoTexture capabilities that can be queried for a TextureFormat with DeviceInfoSystem#isFormatSupported.
ThrottleModeUtilities › Device & RuntimeThe device's thermal/power throttle level as reported by the SnapOS Dynamic Power Manager.
TileZoneText & FontsDefines the bounding area used for texture tiling with TextFill's tileZone property.
TouchStateInteraction
TrackedMeshFaceClassificationAR & Tracking › WorldClassifications of mesh face.
TrackedPlaneClassificationAR & Tracking › WorldThe semantic class of a TrackedPlane.
TrackedPlaneOrientationAR & Tracking › World
TransformerRotationSnapMLRotation types used by TransformBuilder.
UserActivityModule.ModeOfActionUser & Friends › UserActivityModuleAn enumeration describing which activity is currently performed by the user.
UserActivityModule.PostureUser & Friends › UserActivityModuleAn enumeration describing the user's current posture.
VectorComposite.FillRuleGraphics, Materials & Particles › Vector Graphics › VectorCompositeFill rule for closed path regions; determines which points are "inside" when fill contours overlap or self-intersect.
VectorComposite.GradientKindGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe kind of a built VectorGradient.
VectorComposite.LineCapGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe line cap style for a stroked path — how the ends of open sub-paths and dash segments are rendered.
VectorComposite.LineJoinGraphics, Materials & Particles › Vector Graphics › VectorCompositeThe line join style for a stroked path — how corners between connected path segments are rendered.
VectorComposite.SpreadModeGraphics, Materials & Particles › Vector Graphics › VectorCompositeHow a gradient extends beyond its [0, 1] parameter range.
VerticalAlignmentText & FontsUsed by the verticalAlignment property in MeshVisual.
VerticalOverflowText & FontsOptions for handling vertical text overflow.
VideoStatusGraphics, Materials & Particles › Textures & VideoDescribes the current status of a VideoTextureProvider.
WeatherConditionUser & FriendsTypes of weather returned by UserContextSystem's callback.
WeightedModeAnimationDifferent coordinate representations for tangent points
WrapModeGraphics, Materials & Particles › Textures & VideoDescribes how a texture should be sampled when using coordinates outside of the normal range.
ZodiacUser & Friends