Enums
Every enum, nested ones included, with its topic.
176 in Lens API 387. Topic says where the sidebar lists each one.
| Name | Topic | Description |
|---|---|---|
| AccountType | User & Friends | The kind of account backing a User. |
| AnchorModule.AnchorScope | AR & Tracking › World › AnchorModule | Who can access an anchor. |
| AnchorModule.AnchorTrackingState | AR & Tracking › World › AnchorModule | The tracking state of an AnchorComponent. |
| AnchorModule.AnchorType | AR & Tracking › World › AnchorModule | The kind of anchor. |
| AnimationLayerBlendMode | Animation | How animation layers are blended. |
| AnimationLayerScaleMode | Animation | The method in which an Animation Layer should be scaled to other layers in an AnimationClip. |
| AsrModule.AsrContentType | Audio & Voice › Speech › AsrModule | The kind of content the speech is expected to carry. |
| AsrModule.AsrMode | Audio & Voice › Speech › AsrModule | The mode of the transcription to prioritise, between speed and accuracy. |
| AsrModule.AsrStatusCode | Audio & Voice › Speech › AsrModule | An enum stating the status of the transcription. |
| AttachmentPointType | AR & Tracking › Face | |
| Audio.DistanceCurveType | Audio & Voice › Playback & Effects › Audio | The curve that specifies how sound fades with the distance from Audio Component to the Audio Listener.**** |
| Audio.PlaybackMode | Audio & Voice › Playback & Effects › Audio | The Playback Mode property of the AudioComponent used in Lenses targeting Spectacles. |
| Axis | Physics › Shapes & Collision Meshes | Cardinal axis enumeration. |
| Bitmoji3DOptions.AvatarScope | Bitmoji › Bitmoji3DOptions | Enum representing avatar scope used in custom params of bitmoji3d options. |
| Bitmoji3DOptions.BodyType | Bitmoji › Bitmoji3DOptions | Enum representing different body types for the avatar. |
| Bitmoji3DOptions.BreastType | Bitmoji › Bitmoji3DOptions | Enum representing different breast types for the avatar. |
| Bitmoji3DOptions.ClothingType | Bitmoji › Bitmoji3DOptions | Enum representing different types of clothing |
| Bitmoji3DOptions.Gender | Bitmoji › Bitmoji3DOptions | Enum representing the gender of the avatar. |
| Bitmoji3DOptions.RequestType | Bitmoji › Bitmoji3DOptions | Enum representing different request types. |
| BlendMode | Graphics, Materials & Particles › Rendering & Materials | |
| Bluetooth.BluetoothStatus | Cloud, Networking & Storage › Bluetooth | The statuses for Bluetooth availability. |
| Bluetooth.CharacteristicProperty | Cloud, Networking & Storage › Bluetooth | Properties of a Bluetooth.BluetoothGattCharacteristic. |
| Bluetooth.ScanMode | Cloud, Networking & Storage › Bluetooth | Defines how Bluetooth devices should be scanned. |
| Camera.CubemapFace | Graphics, Materials & Particles › Rendering & Materials › Camera | Different faces of the cubemap that a camera can render into. |
| Camera.DepthBufferMode | Graphics, Materials & Particles › Rendering & Materials › Camera | Used in Camera's depthBufferMode property. |
| Camera.DeviceProperty | Graphics, Materials & Particles › Rendering & Materials › Camera | Used in Camera's devicePropertyUsage property. |
| Camera.Type | Graphics, Materials & Particles › Rendering & Materials › Camera | Returned from Camera's type property. |
| CameraModule.CameraFacing | AR & Tracking › Camera › CameraModule | Which way a camera faces, reported on CameraModule.CameraInfo#facing. |
| CameraModule.CameraId | AR & Tracking › Camera › CameraModule | A handle to specify which camera on the Spectacles to request from. |
| CameraModule.CameraLocation | AR & Tracking › Camera › CameraModule | Camera position on the device, reported on CameraModule.CameraInfo#location. |
| CameraModule.CameraType | AR & Tracking › Camera › CameraModule | Camera sensor type, reported on CameraModule.CameraInfo#type. |
| CameraModule.ConfigKey | AR & Tracking › Camera › CameraModule | Typed keys for camera tuning parameters. |
| CameraModule.ImageFormat | AR & Tracking › Camera › CameraModule | Image format for camera image data. |
| CameraModule.MetadataKey | AR & Tracking › Camera › CameraModule | Typed keys for querying per-frame metadata. |
| CameraModule.Operation | AR & Tracking › Camera › CameraModule | Which session a stream capability works with, reported by CameraModule.StreamInfo#operation. |
| CameraModule.Quality | AR & Tracking › Camera › CameraModule | Processing quality tier of a stream configuration. |
| CameraModule.Result | AR & Tracking › Camera › CameraModule | Result codes from camera session operations. |
| CameraModule.StreamStatus | AR & Tracking › Camera › CameraModule | Session lifecycle status delivered via onStatusChanged event. |
| CameraRollMediaType | Graphics, Materials & Particles › Textures & Video | Enum representing the type of media selected from camera roll. |
| Canvas.OffsetUnit | UI › Canvas | The unit system for child ScreenTransform offsets on a Canvas. |
| Canvas.SortingType | UI › Canvas | Used by Canvas to set how an object is sorted during rendering. |
| Canvas.UnitType | UI › Canvas | Used by Canvas to set how an object is positioned. |
| CapitalizationOverride | Text & Fonts | Changes the capitalization of the text component. |
| ClearColorOption | Graphics, Materials & Particles › Rendering & Materials | Settings for how color will be cleared before rendering. |
| ClothVisual.BendMode | Physics › Cloth & Hair › ClothVisual | Cloth bend mode to use for cloth simulation. |
| Commerce.ProductType | Commerce › Commerce Kit › Commerce | Defines the type of product that can be purchased in a Lens. |
| Commerce.PurchaseState | Commerce › Commerce Kit › Commerce | Represents the state of a purchase in a Lens. |
| Commerce.RecurrenceMode | Commerce › Commerce Kit › Commerce | Describes how a subscription pricing phase repeats over time. |
| Commerce.ResponseCode | Commerce › Commerce Kit › Commerce | Defines the possible outcomes of a purchase attempt in a Lens |
| CompassTrackingData.Accuracy | AR & Tracking › Location & Navigation › CompassTrackingData | |
| CompositionLayer.Render.UpdateMode | Graphics, Materials & Particles › Rendering & Materials › CompositionLayer | Determines when a composition layer should be (re-)rendered. |
| CompressionQuality | Graphics, Materials & Particles › Textures & Video | Enum used to define the quality of image or texture compression. |
| ConnectedLensModule.MatchmakingAvailability | Connected Lenses (Multiplayer) › ConnectedLensModule | Whether matchmaking is available, and if not, why. |
| ConnectedLensModule.MatchmakingConfig.LobbyMode | Connected Lenses (Multiplayer) › ConnectedLensModule | How matchmaking fills a session. |
| ConnectedLensModule.MatchmakingConfig.LobbyState | Connected Lenses (Multiplayer) › ConnectedLensModule | Open/close gate of an open-lobby session. |
| ConnectedLensModule.SessionShareType | Connected Lenses (Multiplayer) › ConnectedLensModule | Used by ConnectedLensModule to specify the session share type. |
| ConnectedLensSessionOptions.SessionCreationType | Connected Lenses (Multiplayer) › ConnectedLensSessionOptions | Type of the created Connected Lens session. |
| CullMode | Graphics, Materials & Particles › Rendering & Materials | Used with Pass's cullMode property. |
| DepthClearOption | Graphics, Materials & Particles › Rendering & Materials | Settings for the depth clear option modes on a DepthStencilRenderTargetProvider. |
| DeviceTrackingMode | AR & Tracking › World | Tracking modes used by the DeviceTracking component to specify what type of tracking to use. |
| EncodingType | Utilities › Data & Encoding | Specifies the format for encoding textures, used with Base64. |
| Expressions | AR & Tracking › Face | |
| EyeToRender | AR & Tracking › Face | Specifies which eye to apply an EyeColorVisual effect to. |
| FaceInsetRegion | AR & Tracking › Face | |
| FalloffType | Graphics, Materials & Particles › Rendering & Materials | The types of light falloff from a LightSource. |
| FilteringMode | Graphics, Materials & Particles › Textures & Video | |
| FontStyles | Text & Fonts | |
| FrustumCullMode | Graphics, Materials & Particles › Rendering & Materials | Mode for setting frustum culling on Pass |
| GameControllerModule.Button | Interaction › GameControllerModule | Common gamepad button identifiers. |
| GameControllerModule.ButtonEventType | Interaction › GameControllerModule | Whether a button changed to pressed or released. |
| GameControllerModule.ControllerCapability | Interaction › GameControllerModule | Optional capabilities a controller may support. |
| GameControllerModule.ControllerType | Interaction › GameControllerModule | Controller family as reported by the device. |
| GameControllerModule.Side | Interaction › GameControllerModule | Which side of the controller a thumbstick or trigger belongs to. |
| GameControllerModule.TouchState | Interaction › GameControllerModule | State of a single touch point on the controller touchpad. |
| GeoLocationAccuracy | AR & Tracking › Location & Navigation | Enumeration of supported GPS location accuracy. |
| GestureModule.HandType | Interaction › GestureModule | The hand used in gesture detection with GestureModule. |
| HapticFeedbackType | Interaction | The method in which haptic feedback is provided. |
| HorizontalAlignment | Text & Fonts | Used by the horizontalAlignment property in MeshVisual. |
| HorizontalOverflow | Text & Fonts | Options for wrapping text horizontally. |
| ImageUploadCompressionMethod | Cloud, Networking & Storage › Remote Assets & Media | Specifies the compression format to use when uploading an image. |
| KeyModifiers | Interaction | |
| Keys | Interaction | |
| Leaderboard.OrderingType | User & Friends › Leaderboard | Describes how the leaderboard should be ordered. |
| Leaderboard.UsersType | User & Friends › Leaderboard | The type of user to be retrieved. |
| LightType | Graphics, Materials & Particles › Rendering & Materials | The types of light emission from a LightSource. |
| LoadStatus | Base Classes | |
| LocationProximityStatus | AR & Tracking › Location & Navigation | Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location. |
| LookAtComponent.AimVectors | Scene › LookAtComponent | The "aim" and "up" vectors used with LookAtComponent when determining rotation. |
| LookAtComponent.LookAtMode | Scene › LookAtComponent | Modes used in LookAtComponent.lookAtMode to determine the rotation method being used. |
| LookAtComponent.WorldUpVector | Scene › LookAtComponent | Used with LookAtComponent to set the "up" vector when determining rotation. |
| LyricsType | Audio & Voice › Music & Lyrics | Types of granularity for lyric data. |
| MachineLearning.DataLayout | SnapML › MachineLearning | Used with BasePlaceHolder. |
| MachineLearning.FrameTiming | SnapML › MachineLearning | Timing options for when MLComponent should start or stop running. |
| MachineLearning.InferenceMode | SnapML › MachineLearning | Inference modes used by MLComponent.inferenceMode. |
| MachineLearning.ModelState | SnapML › MachineLearning | Describes the current state of the MLComponent model. |
| MachineLearning.OutputMode | SnapML › MachineLearning | Types of output used by OutputPlaceholder. |
| ManipulateType | Interaction | Enum values specifying each type of manipulation. |
| MappingSession.MappingScope | AR & Tracking › Location & Navigation › MappingSession | Determines what data is included in the checkpoint of the @MappingSession. |
| MappingSession.MappingThrottling | AR & Tracking › Location & Navigation › MappingSession | Throttling levels for a MappingSession. |
| MeshClassificationFormat | AR & Tracking › World | Formats of mesh classification used by WorldRenderObjectProvider. |
| MeshIndexType | Graphics, Materials & Particles › Meshes & Effects | Possible index data types used by MeshBuilder. |
| MeshShadowMode | Graphics, Materials & Particles › Rendering & Materials | |
| MeshTopology | Graphics, Materials & Particles › Meshes & Effects | Mesh topology types used by MeshBuilder. |
| MotionController.HapticFeedback | Interaction › MotionController | Defines a set of haptic feedback patterns that can be requested. |
| MotionController.MotionType | Interaction › MotionController | Enum for describing the motion type. |
| MotionController.TouchPhase | Interaction › MotionController | Enum that defines a current state of a touch interaction with the touchpad of the motion controller. |
| MotionController.TrackingQuality | Interaction › MotionController | Describes Motion Controller tracking quality state, whether the data received from the Motion Controller is accurate or not. |
| NativeARTrackingState | AR & Tracking › World | Describes the state of the native AR tracking (SLAM) system that backs DeviceTracking. |
| NativePlaneTrackingType | AR & Tracking › World | Tracking type used by the DeviceTracking component to specify what type of plane to detect. |
| ObjectTracking3D.TrackingMode | AR & Tracking › Body › ObjectTracking3D | Strategies for updating attached objects. |
| OS | Utilities › Device & Runtime | Types of operating system that may be running on the device. |
| Physics.ConstraintType | Physics › Bodies & Colliders › Physics | Constraint type used by a Constraint. |
| Physics.ForceMode | Physics › Bodies & Colliders › Physics | Type of force to use when applying force or torque to a BodyComponent. |
| Physics.HingeMotorType | Physics › Bodies & Colliders › Physics | Enum that defines motor type. |
| PinToMeshComponent.Orientation | Graphics, Materials & Particles › Meshes & Effects › PinToMeshComponent | Used with PinToMeshComponent.orientation. |
| PlaybackMode | Animation | Used with AnimationClip to describe how the clip should be played. |
| RealtimeStoreCreateOptions.Ownership | Connected Lenses (Multiplayer) › RealtimeStoreCreateOptions | The ownership model of a realtime store. |
| RealtimeStoreCreateOptions.Persistence | Connected Lenses (Multiplayer) › RealtimeStoreCreateOptions | The persistence model for a realtime store. |
| RecordingState | Lifecycle Events | Describes the current recording state of the Lens. |
| RemoteServiceHttpRequest.HttpRequestMethod | Cloud, Networking & Storage › Internet Access › RemoteServiceHttpRequest | The http method which should be used to send this http request. |
| RenderTargetProvider.AntialiasingMode | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | The anti-aliasing technique to use on a render target. |
| RenderTargetProvider.AntialiasingQuality | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | The fidelity of the anti-aliasing technique to apply. |
| RenderTargetProvider.DepthBufferUsage | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Controls depth buffer usage strategy for the render target. |
| RenderTargetProvider.MSAAStrategy | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | How MSAA should be applied to the render target. |
| RenderTargetProvider.OutputResolution | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Controls the resolution source for the render target. |
| RenderTargetProvider.TextureType | Graphics, Materials & Particles › Rendering & Materials › RenderTargetProvider | Specifies what kind of render target it is. |
| SceneActivityPhase | Lifecycle Events | Represents the current lifecycle activity phase of the Scene. |
| ScreenRegionType | UI | Types of screen regions that can be used with ScreenRegionComponent. |
| ShadowMapQuality | Graphics, Materials & Particles › Rendering & Materials | |
| ShadowType | Graphics, Materials & Particles › Rendering & Materials | The types of shadows that a LightSource can cast. |
| SortOrder | SnapML | Order that inTensor will be sorted when applying TensorMath.argSortMasked(). |
| SpecsInteractionModule.CursorVisualMode | Interaction › SpecsInteractionModule | Cursor visual treatment. |
| SpecsInteractionModule.FieldState | Interaction › SpecsInteractionModule | The targeting field an interactor is in, resolved by SpecsInteractionModule against the registered InteractionPlanes: targeting from a distance (FarField), h… |
| SpecsInteractionModule.InteractorKind | Interaction › SpecsInteractionModule | The category of an interactor. |
| SpecsInteractionModule.TargetingMode | Interaction › SpecsInteractionModule | How an interactor can target an Interactable, as a bitmask of interaction methods. |
| SpecsInteractionModule.TargetingPriority | Interaction › SpecsInteractionModule | Targeting priority for this Interactable. |
| SpecsInteractionModule.TargetingVisual | Interaction › SpecsInteractionModule | The targeting visual shown while an interactor targets an Interactable or InteractionPlane. |
| StencilClearOption | Graphics, Materials & Particles › Rendering & Materials | Stencil buffer clear option. |
| StencilFace | Graphics, Materials & Particles › Rendering & Materials | Specifies whether the front and/or back face stencil test will be applied. |
| StencilFunction | Graphics, Materials & Particles › Rendering & Materials | Specifies the stencil test function. |
| StencilOperation | Graphics, Materials & Particles › Rendering & Materials | Options for specifying the action to take when stencil and depth tests resolve. |
| StorageScope | Cloud, Networking & Storage › Storage | Specifies a scope for storing or retrieving values from a MultiplayerSession. |
| StretchMode | UI | Options for stretching a mesh to fit a ScreenTransform Used in RenderMeshVisual stretchMode property, as long as the SceneObject has a ScreenTransform attached. |
| SurfaceClassification | AR & Tracking › World | The classification of the surface at the position where the ray intersects with the environment. |
| TangentType | Animation | Used with AnimationKeyFrame. |
| TensorMath.BorderType | SnapML › TensorMath | |
| TensorMath.ThresholdMethod | SnapML › TensorMath | |
| Text3DExtrudeDirection | Text & Fonts | Controls the direction in which Text3D meshes are extruded relative to the component's local position. |
| TextFillMode | Text & Fonts | Used in TextFill's mode property. |
| TextInputSystem.KeyboardKind | Interaction › TextInputSystem | The kind of keyboard currently serving the text input session. |
| TextInputSystem.KeyboardType | Interaction › TextInputSystem | The different input style of keyboard input. |
| TextInputSystem.ReturnKeyType | Interaction › TextInputSystem | The return key style of keyboard input. |
| TextInputSystem.TextFieldAction | Interaction › TextInputSystem | Editor action for the text field (e.g. when user presses action key on keyboard). |
| TextureFormat | Graphics, Materials & Particles › Textures & Video | |
| TextureUsage | Graphics, Materials & Particles › Textures & Video | Texture capabilities that can be queried for a TextureFormat with DeviceInfoSystem#isFormatSupported. |
| ThrottleMode | Utilities › Device & Runtime | The device's thermal/power throttle level as reported by the SnapOS Dynamic Power Manager. |
| TileZone | Text & Fonts | Defines the bounding area used for texture tiling with TextFill's tileZone property. |
| TouchState | Interaction | |
| TrackedMeshFaceClassification | AR & Tracking › World | Classifications of mesh face. |
| TrackedPlaneClassification | AR & Tracking › World | The semantic class of a TrackedPlane. |
| TrackedPlaneOrientation | AR & Tracking › World | |
| TransformerRotation | SnapML | Rotation types used by TransformBuilder. |
| UserActivityModule.ModeOfAction | User & Friends › UserActivityModule | An enumeration describing which activity is currently performed by the user. |
| UserActivityModule.Posture | User & Friends › UserActivityModule | An enumeration describing the user's current posture. |
| VectorComposite.FillRule | Graphics, Materials & Particles › Vector Graphics › VectorComposite | Fill rule for closed path regions; determines which points are "inside" when fill contours overlap or self-intersect. |
| VectorComposite.GradientKind | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The kind of a built VectorGradient. |
| VectorComposite.LineCap | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The line cap style for a stroked path — how the ends of open sub-paths and dash segments are rendered. |
| VectorComposite.LineJoin | Graphics, Materials & Particles › Vector Graphics › VectorComposite | The line join style for a stroked path — how corners between connected path segments are rendered. |
| VectorComposite.SpreadMode | Graphics, Materials & Particles › Vector Graphics › VectorComposite | How a gradient extends beyond its [0, 1] parameter range. |
| VerticalAlignment | Text & Fonts | Used by the verticalAlignment property in MeshVisual. |
| VerticalOverflow | Text & Fonts | Options for handling vertical text overflow. |
| VideoStatus | Graphics, Materials & Particles › Textures & Video | Describes the current status of a VideoTextureProvider. |
| WeatherCondition | User & Friends | Types of weather returned by UserContextSystem's callback. |
| WeightedMode | Animation | Different coordinate representations for tangent points |
| WrapMode | Graphics, Materials & Particles › Textures & Video | Describes how a texture should be sampled when using coordinates outside of the normal range. |
| Zodiac | User & Friends |