Skip to main content

Enumerations

[DEPRECATED] AnimationClip.PostInfinity

Used by AnimationMixerLayer for setting animation looping behavior.

Lens Studio v1.5.0+
Outer Classes: AnimationClip

[DEPRECATED] AnimationClip.RangeType

Used by AnimationMixerLayer for setting animation clip range type.

Lens Studio v1.5.0+
Outer Classes: AnimationClip

AnimationLayerBlendMode

How animation layers are blended.

Lens Studio v5.0.14+

AnimationLayerScaleMode

The method in which an Animation Layer should be scaled to other layers in an AnimationClip.

Lens Studio v5.0.14+

AttachmentPointType

Used by Head.setAttachmentPointType() to specify the type of attachment used with a Head binding.

Lens Studio v1.5.0+

Audio.DistanceCurveType

The curve that specifies how sound fades with the distance from Audio Component to the Audio Listener.****

Lens Studio v4.0+

Axis

Cardinal axis enumeration.

Lens Studio v4.4+

BlendMode

Lens Studio v4.0+

Camera.CubemapFace

Different faces of the cubemap that a camera can render into.

Lens Studio v4.40.0+
Outer Classes: Camera

Camera.DepthBufferMode

Used in Camera's depthBufferMode property. Each mode is suited for handling objects at a certain distance range. For more information on depth modes, see the Camera and Layers guide.

Lens Studio v2.0.0+
Outer Classes: Camera

Camera.DeviceProperty

Used in Camera's devicePropertyUsage property. Specifies which camera properties should be overridden by device properties.

Lens Studio v2.0.0+
Outer Classes: Camera

Camera.Type

Returned from Camera's type property.

Lens Studio v2.0.0+
Outer Classes: Camera

Canvas.SortingType

Used by Canvas to set how an object is sorted during rendering.

Lens Studio v5.0.1+
Outer Classes: Canvas

Canvas.UnitType

Used by Canvas to set how an object is positioned.

Lens Studio v5.0.1+
Outer Classes: Canvas

CapitilizationOverride

Changes the capitalization of the text component. Useful when using dynamic texts.

Lens Studio v5.0.2+

ClearColorOption

Settings for how color will be cleared before rendering.

Lens Studio v3.4+

ClothVisual.BendMode

Cloth bend mode to use for cloth simulation.

Lens Studio v4.0+
Outer Classes: ClothVisual

Colorspace

Data type used for color values.

Lens Studio v3.0+

CompressionQuality

Enum used to define the quality of image or texture compression. Higher quality typically results in larger file sizes. Used with Base64.

Lens Studio v5.3.0+

ConnectedLensModule.SessionShareType

Used by ConnectedLensesModule to specify the session share type.

Lens Studio v4.0+
Outer Classes: ConnectedLensModule

ConnectedLensSessionOptions.SessionCreationType

Type of the created Connected Lens session.

Lens Studio v4.0+

CullMode

Used with Pass's cullMode property. Determines which faces of a surface are culled (not rendered).

Lens Studio v2.0.0+

DepthClearOption

Settings for the depth clear option modes on a DepthStencilRenderTargetProvider.

Lens Studio v4.1+

DeviceTrackingMode

Tracking modes used by the DeviceTracking component to specify what type of tracking to use.

Lens Studio v1.6.0+

EncodingType

Specifies the format for encoding textures, used with Base64.

Lens Studio v5.3.0+

FaceInsetRegion

Used with FaceInsetVisual.faceRegion for setting the face region to draw.

Lens Studio v1.6.0+

FilteringMode

Lens Studio v4.0+

FrustumCullMode

Mode for setting frustum culling on Pass

Lens Studio v4.1+

GeoLocationAccuracy

Enumeration of supported GPS location accuracy.

Lens Studio v5.0.0+

HapticFeedbackType

The method in which haptic feedback is provided. Use with the HapticFeedbackSystem.

Lens Studio v5.0.2+

HingeMotorType

Enum that defines motor type.

Lens Studio v5.3.0+

HorizontalAlignment

Used by the horizontalAlignment property in MeshVisual. When a ScreenTransform is attached to the same SceneObject, this determines how the mesh will be positioned horizontally.

Lens Studio v2.1+

HorizontalOverflow

Options for wrapping text horizontally. Used by Text component's horizontalOverflow property.

Lens Studio v2.0.0+

Leaderboard.OrderingType

Describes how the leaderboard should be ordered.

Lens Studio v5.0.20+
Outer Classes: Leaderboard

Leaderboard.UsersType

The type of user to be retrieved.

Lens Studio v5.0.20+
Outer Classes: Leaderboard

LoadStatus

Lens Studio v4.0+

LocationProximityStatus

Used by DeviceLocationTrackingComponent to indicate the user's distance from the landmarker location. See the Landmarker guide for more information.

Lens Studio v2.0.0+

LookAtComponent.AimVectors

The "aim" and "up" vectors used with LookAtComponent when determining rotation. LookAtComponent will try to point the Aim axis of the SceneObject towards the target, while keeping the Up axis of the SceneObject pointing towards worldUpVector.

Lens Studio v1.6.0+
Outer Classes: LookAtComponent

LookAtComponent.LookAtMode

Modes used in LookAtComponent.lookAtMode to determine the rotation method being used.

Lens Studio v3.0+
Outer Classes: LookAtComponent

LookAtComponent.WorldUpVector

Used with LookAtComponent to set the "up" vector when determining rotation.

Lens Studio v1.6.0+
Outer Classes: LookAtComponent

MachineLearning.FrameTiming

Timing options for when MLComponent should start or stop running. Used with MLComponent.runScheduled(). For more information, see the MLComponent Scripting guide.

Lens Studio v3.0+
Outer Classes: MachineLearning

MachineLearning.InferenceMode

Inference modes used by MLComponent.inferenceMode. Each mode describes how the neural network will be run.

Lens Studio v3.0+
Outer Classes: MachineLearning

MachineLearning.ModelState

Describes the current state of the MLComponent model. For more information, see the MLComponent Scripting guide.

Lens Studio v3.0+
Outer Classes: MachineLearning

MachineLearning.OutputMode

Types of output used by OutputPlaceholder.

Lens Studio v3.0+
Outer Classes: MachineLearning

ManipulateType

Enum values specifying each type of manipulation. See ManipulateComponent.

Lens Studio v1.0.0+

MappingSession.MappingThrottling

Lens Studio v5.0.0+
Outer Classes: MappingSession

MeshClassificationFormat

Formats of mesh classification used by WorldRenderObjectProvider.

Lens Studio v3.2+

MeshIndexType

Possible index data types used by MeshBuilder. MeshIndexType.UInt16 is the value normally used.

Lens Studio v1.0.0+

MeshShadowMode

Lens Studio v4.12.0+

MeshTopology

Mesh topology types used by MeshBuilder.

Lens Studio v1.0.0+

NativePlaneTrackingType

Tracking type used by the Device Tracking component to specify what type of plane to detect.

Lens Studio v3.4+

OS

Types of operating system that may be running on the device.

Lens Studio v3.0+

ObjectTracking3D.TrackingMode

Strategies for updating attached objects. Used by the ObjectTracking3D component.

Lens Studio v3.4+
Outer Classes: ObjectTracking3D

Physics.ConstraintType

Constraint type used by a Constraint. See also: Physics.Constraint.create(), ConstraintComponent.

Lens Studio v4.10.0+
Outer Classes: Physics

Physics.ForceMode

Type of force to use when applying force or torque to a BodyComponent.

Lens Studio v4.10.0+
Outer Classes: Physics

PinToMeshComponent.Orientation

Used with PinToMeshComponent.orientation.

Lens Studio v1.7.0+
Outer Classes: PinToMeshComponent

PlaybackMode

Used with AnimationClip to describe how the clip should be played.

Lens Studio v5.0.10+

RealtimeStoreCreateOptions.Ownership

The ownership model of a realtime store.

Lens Studio v4.19.0+

RealtimeStoreCreateOptions.Persistence

The persistence model for a realtime store.

Lens Studio v4.19.0+

RenderTargetProvider.TextureType

Specifies what kind of render target it is. Some texture types, for example TextureCubemap, need additional properties set on the rendering camera to work correctly.

Lens Studio v4.40.0+
Outer Classes: RenderTargetProvider

ScreenRegionType

Types of screen regions that can be used with ScreenRegionComponent.

Lens Studio v2.0.0+

SortOrder

Order that inTensor will be sorted when applying TensorMath.argSortMasked().

Lens Studio v4.31.0+

StencilClearOption

Stencil buffer clear option.

Lens Studio v4.1+

StencilFace

Specifies whether the front and/or back face stencil test will be applied. The initial value is "FrontAndBack"

Lens Studio v4.1+

StencilFunction

Specifies the stencil test function. The initial value is "Always".

Lens Studio v4.1+

StencilOperation

Options for specifying the action to take when stencil and depth tests resolve.

Lens Studio v4.1+

StorageScope

Specifies a scope for storing or retrieving values from a MultiplayerSession.

Lens Studio v4.0+

StretchMode

Options for stretching a mesh to fit a ScreenTransform's bounding box. Used in MeshVisual's stretchMode property, as long as the SceneObject has a ScreenTransform attached. Also used in TextFill's textureStretch property to control texture stretching when drawing text.

See the Image guide for more information about stretch modes.

Lens Studio v2.0.0+

TangentType

Used with AnimationKeyFrame.

Lens Studio v5.0.1+

TensorMath.BorderType

Lens Studio v4.28.0+
Outer Classes: TensorMath

TensorMath.ThresholdMethod

Lens Studio v4.28.0+
Outer Classes: TensorMath

TextFillMode

Used in TextFill's mode property. Controls which drawing method is used for the TextFill.

Lens Studio v2.0.0+

TextInputSystem.KeyboardType

The different input style of keyboard input.

Lens Studio v4.13.0+
Outer Classes: TextInputSystem

TextInputSystem.ReturnKeyType

The return key style of keyboard input.

Lens Studio v4.13.0+
Outer Classes: TextInputSystem

[DEPRECATED] TextureStretchMode

Lens Studio v4.0+

TileZone

Defines the bounding area used for texture tiling with TextFill's tileZone property.

Lens Studio v3.0+

TouchState

Lens Studio v5.3.0+

TrackedMeshFaceClassification

Classifications of mesh face. See TrackedMeshHitTestResult.

Lens Studio v3.4+

TrackedPlaneOrientation

Lens Studio v3.4+

TransformerRotation

Rotation types used by TransformBuilder.

Lens Studio v3.0+

VerticalAlignment

Used by the verticalAlignment property in MeshVisual. When a ScreenTransform is attached to the same SceneObject, this determines how the mesh will be positioned vertically.

Lens Studio v2.1+

VerticalOverflow

Options for handling vertical text overflow. Used by Text component's verticalOverflow property.

Lens Studio v2.0.0+

VideoStatus

Describes the current status of a VideoTextureProvider.

Lens Studio v1.5.0+

VoiceMLModule.AnswerStatusCodes

Lens Studio v4.28.0+
Outer Classes: VoiceMLModule

VoiceMLModule.NlpResponsesStatusCodes

Status Codes for NLP Responses.

Lens Studio v4.4+
Outer Classes: VoiceMLModule

WeatherCondition

Types of weather returned by UserContextSystem's requestWeatherCondition() callback.

Lens Studio v2.1+

WeightedMode

Lens Studio v5.0.1+

WrapMode

Describes how a texture should be sampled when using coordinates outside of the normal range.

Lens Studio v4.0+

Zodiac

Lens Studio v5.0.10+
Was this page helpful?
Yes
No

AI-Powered Search