Skip to main content

Enumerations

AnimationClip.PostInfinity

Used by AnimationMixerLayer for setting animation looping behavior.

Lens Studio v1.5.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

AnimationClip.RangeType

Used by AnimationMixerLayer for setting animation clip range type.

Lens Studio v1.5.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

AttachmentPointType

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

Lens Studio v1.5.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

Audio.DistanceCurveType

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

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

Axis

Cardinal axis enumeration.

Lens Studio v4.4+

This is the API for Lens Studio 4. For the latest API documentation, click here.

BlendMode

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

Camera.CubemapFace

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

Lens Studio v4.40.0+
Outer Classes: Camera

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

Camera.Type

Returned from Camera's type property.

Lens Studio v2.0.0+
Outer Classes: Camera

This is the API for Lens Studio 4. For the latest API documentation, click here.

ClearColorOption

Settings for how color will be cleared before rendering.

Lens Studio v3.4+

This is the API for Lens Studio 4. For the latest API documentation, click here.

ClothVisual.BendMode

Cloth bend mode to use for cloth simulation.

Lens Studio v4.0+
Outer Classes: ClothVisual

This is the API for Lens Studio 4. For the latest API documentation, click here.

Colorspace

Data type used for color values.

Lens Studio v3.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensModule.SessionShareType

Used by ConnectedLensesModule to specify the session share type.

Lens Studio v4.0+
Outer Classes: ConnectedLensModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

ConnectedLensSessionOptions.SessionCreationType

Type of the created Connected Lens session.

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

CullMode

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

Lens Studio v2.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

DepthClearOption

Settings for the depth clear option modes on a DepthStencilRenderTargetProvider.

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

DeviceTrackingMode

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

Lens Studio v1.6.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

FaceInsetRegion

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

Lens Studio v1.6.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

FilteringMode

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

FrustumCullMode

Mode for setting frustum culling on Pass

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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+

This is the API for Lens Studio 4. For the latest API documentation, click here.

HorizontalOverflow

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

Lens Studio v2.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

LoadStatus

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

LookAtComponent.LookAtMode

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

Lens Studio v3.0+
Outer Classes: LookAtComponent

This is the API for Lens Studio 4. For the latest API documentation, click here.

LookAtComponent.WorldUpVector

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

Lens Studio v1.6.0+
Outer Classes: LookAtComponent

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

MachineLearning.OutputMode

Types of output used by OutputPlaceholder.

Lens Studio v3.0+
Outer Classes: MachineLearning

This is the API for Lens Studio 4. For the latest API documentation, click here.

ManipulateType

Enum values specifying each type of manipulation. See ManipulateComponent.

Lens Studio v1.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

MeshClassificationFormat

Formats of mesh classification used by WorldRenderObjectProvider.

Lens Studio v3.2+

This is the API for Lens Studio 4. For the latest API documentation, click here.

MeshIndexType

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

Lens Studio v1.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

MeshShadowMode

Lens Studio v4.12.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

MeshTopology

Mesh topology types used by MeshBuilder.

Lens Studio v1.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

NativePlaneTrackingType

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

Lens Studio v3.4+

This is the API for Lens Studio 4. For the latest API documentation, click here.

OS

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

Lens Studio v3.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

ObjectTracking3D.TrackingMode

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

Lens Studio v3.4+
Outer Classes: ObjectTracking3D

This is the API for Lens Studio 4. For the latest API documentation, click here.

Physics.ConstraintType

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

Lens Studio v4.10.0+
Outer Classes: Physics

This is the API for Lens Studio 4. For the latest API documentation, click here.

Physics.ForceMode

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

Lens Studio v4.10.0+
Outer Classes: Physics

This is the API for Lens Studio 4. For the latest API documentation, click here.

PinToMeshComponent.Orientation

Used with PinToMeshComponent.orientation.

Lens Studio v1.7.0+
Outer Classes: PinToMeshComponent

This is the API for Lens Studio 4. For the latest API documentation, click here.

RealtimeStoreCreateOptions.Ownership

The ownership model of a realtime store.

Lens Studio v4.19.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

RealtimeStoreCreateOptions.Persistence

The persistence model for a realtime store.

Lens Studio v4.19.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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

This is the API for Lens Studio 4. For the latest API documentation, click here.

ScreenRegionType

Types of screen regions that can be used with ScreenRegionComponent.

Lens Studio v2.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

SortOrder

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

Lens Studio v4.31.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

StencilClearOption

Stencil buffer clear option.

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

StencilFace

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

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

StencilFunction

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

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

StencilOperation

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

Lens Studio v4.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

StorageScope

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

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TensorMath.BorderType

Lens Studio v4.28.0+
Outer Classes: TensorMath

This is the API for Lens Studio 4. For the latest API documentation, click here.

TensorMath.ThresholdMethod

Lens Studio v4.28.0+
Outer Classes: TensorMath

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextFillMode

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

Lens Studio v2.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextInputSystem.KeyboardType

The different input style of keyboard input.

Lens Studio v4.13.0+
Outer Classes: TextInputSystem

This is the API for Lens Studio 4. For the latest API documentation, click here.

TextInputSystem.ReturnKeyType

The return key style of keyboard input.

Lens Studio v4.13.0+
Outer Classes: TextInputSystem

This is the API for Lens Studio 4. For the latest API documentation, click here.

[DEPRECATED] TextureStretchMode

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TileZone

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

Lens Studio v3.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedMeshFaceClassification

Classifications of mesh face. See TrackedMeshHitTestResult.

Lens Studio v3.4+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TrackedPlaneOrientation

Lens Studio v3.4+

This is the API for Lens Studio 4. For the latest API documentation, click here.

TransformerRotation

Rotation types used by TransformBuilder.

Lens Studio v3.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

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+

This is the API for Lens Studio 4. For the latest API documentation, click here.

VerticalOverflow

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

Lens Studio v2.0.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

VideoStatus

Describes the current status of a VideoTextureProvider.

Lens Studio v1.5.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceMLModule.AnswerStatusCodes

Lens Studio v4.28.0+
Outer Classes: VoiceMLModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

VoiceMLModule.NlpResponsesStatusCodes

Status Codes for NLP Responses.

Lens Studio v4.4+
Outer Classes: VoiceMLModule

This is the API for Lens Studio 4. For the latest API documentation, click here.

WeatherCondition

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

Lens Studio v2.1+

This is the API for Lens Studio 4. For the latest API documentation, click here.

WrapMode

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

Lens Studio v4.0+

This is the API for Lens Studio 4. For the latest API documentation, click here.

Was this page helpful?
Yes
No