Full API List
Find every Lens Studio class in the Full API List below. Explore different types in the Classes folder in the sidebar.
This is the API for Lens Studio 4. For the latest API documentation, click here.
BodyTrackingAsset
handTrackingEnabled
Hips
Spine
Spine1
Spine2
Neck
Head
LeftShoulder
LeftArm
LeftForeArm
LeftHand
RightShoulder
RightArm
RightForeArm
RightHand
LeftUpLeg
LeftLeg
LeftFoot
LeftToeBase
RightUpLeg
RightLeg
RightFoot
RightToeBase
LeftHandThumb1
LeftHandThumb2
LeftHandThumb3
LeftHandIndex1
LeftHandIndex2
LeftHandIndex3
LeftHandMiddle1
LeftHandMiddle2
LeftHandMiddle3
LeftHandRing1
LeftHandRing2
LeftHandRing3
LeftHandPinky1
LeftHandPinky2
LeftHandPinky3
RightHandThumb1
RightHandThumb2
RightHandThumb3
RightHandIndex1
RightHandIndex2
RightHandIndex3
RightHandMiddle1
RightHandMiddle2
RightHandMiddle3
RightHandRing1
RightHandRing2
RightHandRing3
RightHandPinky1
RightHandPinky2
RightHandPinky3
Camera
getOrthographicSize()
screenSpaceToWorldSpace()
worldSpaceToScreenSpace()
project()
unproject()
isSphereVisible()
removeRenderLayer()
addRenderLayer()
checkRenderLayer()
getAllRenderLayers()
depthStencilRenderTargetSupported()
getSupportedColorRenderTargetCount()
createColorRenderTarget()
createDepthStencilRenderTarget()
near
far
fov
aspect
size
type
depthBufferMode
renderLayer
devicePropertyUsage
colorRenderTargets
depthStencilRenderTarget
renderOrder
maskTexture
inputTexture
renderTarget
enableClearDepth
clearColor
renderTargetCubemapFace
enableClearColor
isPhysical
supportedColorRenderTargetCount
rayTracing
ClothVisual
isHardwareSupported()
isInitialized()
resetSimulation()
clearColliders()
addCollider()
removeColliderByIndex()
getPointIndicesByColor()
getPointIndicesByMask()
getPointColorByIndex()
getAllColors()
setVertexBinding()
getVertexBinding()
getVertexSettings()
setVertexSettings()
createVertexSettings()
onInitialized
colliders
mesh
simulatedMesh
bendMode
gravity
iterationsPerStep
mass
massVertexWeight
stretchStiffness
stretchStiffnessVertexWeight
bendStiffness
bendStiffnessVertexWeight
friction
frictionVertexWeight
repulsionEnabled
repulsionOffset
repulsionStiffness
repulsionFriction
maxAcceleration
updateNormalsEnabled
mergeCloseVerticesEnabled
mergeCloseVerticesThreshold
externalBodyMeshWeight
DeviceTracking
setWorldOriginOffset()
resetTracking()
hitTestWorldMesh()
raycastWorldMesh()
calculateWorldMeshHistogram()
createTrackedWorldPoint()
isDeviceTrackingModeSupported()
requestDeviceTrackingMode()
getRequestedDeviceTrackingMode()
getActualDeviceTrackingMode()
getDevicePath()
getDevicePathIndex()
getPointCloud()
surfaceTrackingTarget
rotationOptions
surfaceOptions
worldOptions
worldTrackingCapabilities
Expressions
EyeBlinkLeft
EyeBlinkRight
EyeSquintLeft
EyeSquintRight
EyeDownLeft
EyeDownRight
EyeInLeft
EyeInRight
EyeOpenLeft
EyeOpenRight
EyeOutLeft
EyeOutRight
EyeUpLeft
EyeUpRight
BrowsDownLeft
BrowsDownRight
BrowsUpCenter
BrowsUpLeft
BrowsUpRight
JawForward
JawLeft
JawOpen
JawRight
MouthLeft
MouthRight
MouthFrownLeft
MouthFrownRight
MouthSmileLeft
MouthSmileRight
MouthDimpleLeft
MouthDimpleRight
MouthUpLeft
MouthUpRight
UpperLipClose
LowerLipClose
UpperLipUpLeft
UpperLipUpRight
LowerLipDownLeft
LowerLipDownRight
LipsFunnel
LipsPucker
LowerLipRaise
UpperLipRaise
Puff
CheekSquintLeft
CheekSquintRight
SneerLeft
SneerRight
MouthStretchLeft
MouthStretchRight
MouthClose
GeneralDataStore
getInt()
getDouble()
getBool()
getString()
putInt()
putDouble()
putBool()
putString()
getFloat()
putFloat()
clear()
getMaxSizeInBytes()
getSizeInBytes()
has()
remove()
getVec2()
putVec2()
getVec3()
putVec3()
getVec4()
putVec4()
getMat2()
putMat2()
getMat3()
putMat3()
getMat4()
putMat4()
getQuat()
putQuat()
putIntArray()
getIntArray()
putFloatArray()
getFloatArray()
putBoolArray()
getBoolArray()
putStringArray()
getStringArray()
putVec2Array()
getVec2Array()
putVec3Array()
getVec3Array()
putVec4Array()
getVec4Array()
putMat2Array()
getMat2Array()
putMat3Array()
getMat3Array()
putMat4Array()
getMat4Array()
putQuatArray()
getQuatArray()
putUint8Array()
getUint8Array()
putInt8Array()
getInt8Array()
putUint16Array()
getUint16Array()
putInt16Array()
getInt16Array()
putUint32Array()
getUint32Array()
putInt32Array()
getInt32Array()
putFloat32Array()
getFloat32Array()
putFloat64Array()
getFloat64Array()
getAllKeys()
create()
onStoreFull
HairVisual
isHardwareSupported()
isInitialized()
resetSimulation()
clearColliders()
addCollider()
removeColliderByIndex()
colliders
hairResolution
primaryHairMaterial
hairMaterial
fallbackHairMaterial
strandWidth
strandTaper
clumpDensity
clumpRadius
clumpTipScale
density
noise
stiffness
damp
friction
gravity
collisionEnabled
collisionStiffness
collisionOffset
collisionFriction
selfCollisionEnabled
selfCollisionStiffness
selfCollisionRadius
selfCollisionFriction
windEnabled
windForce
fallbackModeEnabled
onInitialized
LightSource
color
intensity
castsShadows
shadowColor
shadowDensity
shadowBlurRadius
autoLightSourcePosition
autoShadowFrustumSize
shadowFrustumSize
shadowFrustumNearClipPlane
shadowFrustumFarClipPlane
useEnvmap
envmapExposure
envmapRotation
diffuseEnvmapTexture
specularEnvmapTexture
gaussianBlurSigma
renderLayer
LocalizationSystem
getLanguage()
localize()
getDateFormatted()
getDateShortFormatted()
getTimeFormatted()
getDateAndTimeFormatted()
getMonth()
getDayOfWeek()
getFormattedSeconds()
getFormattedNumber()
getFormattedTemperatureFromCelsius()
getFormattedTemperatureFromFahrenheit()
getFormattedDistanceFromMeters()
language
LookAtComponent.AimVectors
XAimYUp
XAimZUp
YAimXUp
YAimZUp
ZAimXUp
ZAimYUp
XAimNegativeYUp
XAimNegativeZUp
YAimNegativeXUp
YAimNegativeZUp
ZAimNegativeXUp
ZAimNegativeYUp
NegativeXAimYUp
NegativeXAimZUp
NegativeYAimXUp
NegativeYAimZUp
NegativeZAimXUp
NegativeZAimYUp
NegativeXAimNegativeYUp
NegativeXAimNegativeZUp
NegativeYAimNegativeXUp
NegativeYAimNegativeZUp
NegativeZAimNegativeXUp
NegativeZAimNegativeYUp
MultiplayerSession
getLocalUserId()
getLocalUserInfo()
getServerTimestamp()
sendMessage()
sendMessageWithTimeout()
getStoredValue()
listStoredValues()
setStoredValue()
deleteStoredValue()
createRealtimeStore()
deleteRealtimeStore()
requestRealtimeStoreOwnership()
clearRealtimeStoreOwnership()
getRealtimeStoreInfo()
activeUserCount
allRealtimeStores
activeUsersInfo