Developer Site
Discord
Forum
GitHub
Preparing search index...
The search index is not available
PlayCanvas Engine API
PlayCanvas Engine API
Index
Animation
Anim
Component
Anim
Component
Layer
Anim
Component
System
Anim
Curve
Anim
Data
Anim
Events
Anim
State
Graph
Anim
Track
Animation
Animation
Component
Animation
Component
System
Animation
Handler
Node
Skeleton
Graphics
Basic
Material
Batch
Batch
Group
Batch
Manager
Blend
State
Camera
Component
Camera
Component
System
Container
Handler
Container
Resource
Cubemap
Handler
Depth
State
Graphics
Device
Index
Buffer
Layer
Layer
Composition
Light
Component
Light
Component
System
Lighting
Params
Lightmapper
Lit
Shader
Options
Material
Material
Handler
Mesh
Mesh
Instance
Model
Model
Component
Model
Component
System
Model
Handler
Morph
Morph
Instance
Morph
Target
Particle
System
Component
Particle
System
Component
System
Picker
Post
Effect
Post
Effect
Queue
Quad
Render
Render
Component
Render
Component
System
Render
Handler
Render
Target
Scene
Scene
Handler
Scene
Registry
Scene
Registry
Item
Scope
Id
Scope
Space
Shader
Skin
Skin
Instance
Sprite
Sprite
Animation
Clip
Sprite
Component
Sprite
Component
System
Sprite
Handler
Standard
Material
Standard
Material
Options
Stencil
Parameters
Texture
Texture
Atlas
Texture
Atlas
Handler
Texture
Handler
Texture
Parser
Transform
Feedback
Vertex
Buffer
Vertex
Format
Vertex
Iterator
Webgl
Graphics
Device
Input
Controller
Game
Pads
Keyboard
Keyboard
Event
Mouse
Mouse
Event
Touch
Touch
Device
Touch
Event
Math
Bounding
Box
Bounding
Sphere
Color
Curve
Curve
Set
Frustum
Mat3
Mat4
Oriented
Box
Plane
Quat
Ray
Vec2
Vec3
Vec4
Other
guid
math
path
platform
script
string
App
Base
Application
Asset
Asset
List
Loader
Asset
Reference
Asset
Registry
Component
Component
System
Component
System
Registry
Entity
Event
Handler
Graph
Node
Http
I18n
Resource
Handler
Resource
Loader
Script
Attributes
Script
Component
Script
Component
System
Script
Handler
Script
Registry
Script
Type
Tags
Template
Tracing
Wasm
Module
ADDRESS_
CLAMP_
TO_
EDGE
ADDRESS_
MIRRORED_
REPEAT
ADDRESS_
REPEAT
ANIM_
BLEND_
1D
ANIM_
BLEND_
2
D_
CARTESIAN
ANIM_
BLEND_
2
D_
DIRECTIONAL
ANIM_
BLEND_
DIRECT
ANIM_
EQUAL_
TO
ANIM_
GREATER_
THAN
ANIM_
GREATER_
THAN_
EQUAL_
TO
ANIM_
INTERRUPTION_
NEXT
ANIM_
INTERRUPTION_
NEXT_
PREV
ANIM_
INTERRUPTION_
NONE
ANIM_
INTERRUPTION_
PREV
ANIM_
INTERRUPTION_
PREV_
NEXT
ANIM_
LAYER_
ADDITIVE
ANIM_
LAYER_
OVERWRITE
ANIM_
LESS_
THAN
ANIM_
LESS_
THAN_
EQUAL_
TO
ANIM_
NOT_
EQUAL_
TO
ANIM_
PARAMETER_
BOOLEAN
ANIM_
PARAMETER_
FLOAT
ANIM_
PARAMETER_
INTEGER
ANIM_
PARAMETER_
TRIGGER
ANIM_
STATE_
ANY
ANIM_
STATE_
END
ANIM_
STATE_
START
ASPECT_
AUTO
ASPECT_
MANUAL
ASSET_
ANIMATION
ASSET_
AUDIO
ASSET_
CONTAINER
ASSET_
CSS
ASSET_
CUBEMAP
ASSET_
HTML
ASSET_
IMAGE
ASSET_
JSON
ASSET_
MATERIAL
ASSET_
MODEL
ASSET_
SCRIPT
ASSET_
SHADER
ASSET_
TEXT
ASSET_
TEXTURE
ASSET_
TEXTUREATLAS
BAKE_
COLOR
BAKE_
COLORDIR
BLENDEQUATION_
ADD
BLENDEQUATION_
MAX
BLENDEQUATION_
MIN
BLENDEQUATION_
REVERSE_
SUBTRACT
BLENDEQUATION_
SUBTRACT
BLENDMODE_
CONSTANT
BLENDMODE_
DST_
ALPHA
BLENDMODE_
DST_
COLOR
BLENDMODE_
ONE
BLENDMODE_
ONE_
MINUS_
CONSTANT
BLENDMODE_
ONE_
MINUS_
DST_
ALPHA
BLENDMODE_
ONE_
MINUS_
DST_
COLOR
BLENDMODE_
ONE_
MINUS_
SRC_
ALPHA
BLENDMODE_
ONE_
MINUS_
SRC_
COLOR
BLENDMODE_
SRC_
ALPHA
BLENDMODE_
SRC_
ALPHA_
SATURATE
BLENDMODE_
SRC_
COLOR
BLENDMODE_
ZERO
BLEND_
ADDITIVE
BLEND_
ADDITIVEALPHA
BLEND_
MAX
BLEND_
MIN
BLEND_
MULTIPLICATIVE
BLEND_
MULTIPLICATIVE2X
BLEND_
NONE
BLEND_
NORMAL
BLEND_
PREMULTIPLIED
BLEND_
SCREEN
BLEND_
SUBTRACTIVE
BLUR_
BOX
BLUR_
GAUSSIAN
BODYTYPE_
DYNAMIC
BODYTYPE_
KINEMATIC
BODYTYPE_
STATIC
BUFFER_
DYNAMIC
BUFFER_
GPUDYNAMIC
BUFFER_
STATIC
BUFFER_
STREAM
BUTTON_
TRANSITION_
MODE_
SPRITE_
CHANGE
BUTTON_
TRANSITION_
MODE_
TINT
CHUNKAPI_
1_
51
CLEARFLAG_
COLOR
CLEARFLAG_
DEPTH
CLEARFLAG_
STENCIL
CUBEFACE_
NEGX
CUBEFACE_
NEGY
CUBEFACE_
NEGZ
CUBEFACE_
POSX
CUBEFACE_
POSY
CUBEFACE_
POSZ
CUBEPROJ_
BOX
CUBEPROJ_
NONE
CULLFACE_
BACK
CULLFACE_
FRONT
CULLFACE_
NONE
CURVE_
LINEAR
CURVE_
SMOOTHSTEP
CURVE_
SPLINE
CURVE_
STEP
DETAILMODE_
ADD
DETAILMODE_
MAX
DETAILMODE_
MIN
DETAILMODE_
MUL
DETAILMODE_
OVERLAY
DETAILMODE_
SCREEN
DEVICETYPE_
NULL
DEVICETYPE_
WEBGL1
DEVICETYPE_
WEBGL2
DEVICETYPE_
WEBGPU
DISTANCE_
EXPONENTIAL
DISTANCE_
INVERSE
DISTANCE_
LINEAR
ELEMENTTYPE_
GROUP
ELEMENTTYPE_
IMAGE
ELEMENTTYPE_
TEXT
EMITTERSHAPE_
BOX
EMITTERSHAPE_
SPHERE
EVENT_
GAMEPADCONNECTED
EVENT_
GAMEPADDISCONNECTED
EVENT_
KEYDOWN
EVENT_
KEYUP
EVENT_
MOUSEDOWN
EVENT_
MOUSEMOVE
EVENT_
MOUSEUP
EVENT_
MOUSEWHEEL
EVENT_
SELECT
EVENT_
SELECTEND
EVENT_
SELECTSTART
EVENT_
TOUCHCANCEL
EVENT_
TOUCHEND
EVENT_
TOUCHMOVE
EVENT_
TOUCHSTART
FILLMODE_
FILL_
WINDOW
FILLMODE_
KEEP_
ASPECT
FILLMODE_
NONE
FILTER_
LINEAR
FILTER_
LINEAR_
MIPMAP_
LINEAR
FILTER_
LINEAR_
MIPMAP_
NEAREST
FILTER_
NEAREST
FILTER_
NEAREST_
MIPMAP_
LINEAR
FILTER_
NEAREST_
MIPMAP_
NEAREST
FITMODE_
CONTAIN
FITMODE_
COVER
FITMODE_
STRETCH
FITTING_
BOTH
FITTING_
NONE
FITTING_
SHRINK
FITTING_
STRETCH
FOG_
EXP
FOG_
EXP2
FOG_
LINEAR
FOG_
NONE
FRESNEL_
NONE
FRESNEL_
SCHLICK
FUNC_
ALWAYS
FUNC_
EQUAL
FUNC_
GREATER
FUNC_
GREATEREQUAL
FUNC_
LESS
FUNC_
LESSEQUAL
FUNC_
NEVER
FUNC_
NOTEQUAL
GAMMA_
NONE
GAMMA_
SRGB
GAMMA_
SRGBHDR
INDEXFORMAT_
UINT16
INDEXFORMAT_
UINT32
INDEXFORMAT_
UINT8
INTERPOLATION_
CUBIC
INTERPOLATION_
LINEAR
INTERPOLATION_
STEP
KEY_
0
KEY_
1
KEY_
2
KEY_
3
KEY_
4
KEY_
5
KEY_
6
KEY_
7
KEY_
8
KEY_
9
KEY_
A
KEY_
ADD
KEY_
ALT
KEY_
B
KEY_
BACKSPACE
KEY_
BACK_
SLASH
KEY_
C
KEY_
CAPS_
LOCK
KEY_
CLOSE_
BRACKET
KEY_
COMMA
KEY_
CONTEXT_
MENU
KEY_
CONTROL
KEY_
D
KEY_
DECIMAL
KEY_
DELETE
KEY_
DIVIDE
KEY_
DOWN
KEY_
E
KEY_
END
KEY_
ENTER
KEY_
EQUAL
KEY_
ESCAPE
KEY_
F
KEY_
F1
KEY_
F10
KEY_
F11
KEY_
F12
KEY_
F2
KEY_
F3
KEY_
F4
KEY_
F5
KEY_
F6
KEY_
F7
KEY_
F8
KEY_
F9
KEY_
G
KEY_
H
KEY_
HOME
KEY_
I
KEY_
INSERT
KEY_
J
KEY_
K
KEY_
L
KEY_
LEFT
KEY_
M
KEY_
META
KEY_
MULTIPLY
KEY_
N
KEY_
NUMPAD_
0
KEY_
NUMPAD_
1
KEY_
NUMPAD_
2
KEY_
NUMPAD_
3
KEY_
NUMPAD_
4
KEY_
NUMPAD_
5
KEY_
NUMPAD_
6
KEY_
NUMPAD_
7
KEY_
NUMPAD_
8
KEY_
NUMPAD_
9
KEY_
O
KEY_
OPEN_
BRACKET
KEY_
P
KEY_
PAGE_
DOWN
KEY_
PAGE_
UP
KEY_
PAUSE
KEY_
PERIOD
KEY_
PRINT_
SCREEN
KEY_
Q
KEY_
R
KEY_
RETURN
KEY_
RIGHT
KEY_
S
KEY_
SEMICOLON
KEY_
SEPARATOR
KEY_
SHIFT
KEY_
SLASH
KEY_
SPACE
KEY_
SUBTRACT
KEY_
T
KEY_
TAB
KEY_
U
KEY_
UP
KEY_
V
KEY_
W
KEY_
WINDOWS
KEY_
X
KEY_
Y
KEY_
Z
LAYERID_
DEPTH
LAYERID_
IMMEDIATE
LAYERID_
SKYBOX
LAYERID_
UI
LAYERID_
WORLD
LIGHTFALLOFF_
INVERSESQUARED
LIGHTFALLOFF_
LINEAR
LIGHTSHAPE_
DISK
LIGHTSHAPE_
PUNCTUAL
LIGHTSHAPE_
RECT
LIGHTSHAPE_
SPHERE
LIGHTTYPE_
DIRECTIONAL
LIGHTTYPE_
OMNI
LIGHTTYPE_
SPOT
MOUSEBUTTON_
LEFT
MOUSEBUTTON_
MIDDLE
MOUSEBUTTON_
NONE
MOUSEBUTTON_
RIGHT
ORIENTATION_
HORIZONTAL
ORIENTATION_
VERTICAL
PAD_
1
PAD_
2
PAD_
3
PAD_
4
PAD_
DOWN
PAD_
FACE_
1
PAD_
FACE_
2
PAD_
FACE_
3
PAD_
FACE_
4
PAD_
LEFT
PAD_
L_
SHOULDER_
1
PAD_
L_
SHOULDER_
2
PAD_
L_
STICK_
BUTTON
PAD_
L_
STICK_
X
PAD_
L_
STICK_
Y
PAD_
RIGHT
PAD_
R_
SHOULDER_
1
PAD_
R_
SHOULDER_
2
PAD_
R_
STICK_
BUTTON
PAD_
R_
STICK_
X
PAD_
R_
STICK_
Y
PAD_
SELECT
PAD_
START
PAD_
UP
PAD_
VENDOR
PARTICLEORIENTATION_
EMITTER
PARTICLEORIENTATION_
SCREEN
PARTICLEORIENTATION_
WORLD
PARTICLESORT_
DISTANCE
PARTICLESORT_
NEWER_
FIRST
PARTICLESORT_
NONE
PARTICLESORT_
OLDER_
FIRST
PIXELFORMAT_
111110F
PIXELFORMAT_
A8
PIXELFORMAT_
ASTC_
4x4
PIXELFORMAT_
ATC_
RGB
PIXELFORMAT_
ATC_
RGBA
PIXELFORMAT_
DEPTH
PIXELFORMAT_
DEPTHSTENCIL
PIXELFORMAT_
DXT1
PIXELFORMAT_
DXT3
PIXELFORMAT_
DXT5
PIXELFORMAT_
ETC1
PIXELFORMAT_
ETC2_
RGB
PIXELFORMAT_
ETC2_
RGBA
PIXELFORMAT_
L8
PIXELFORMAT_
LA8
PIXELFORMAT_
PVRTC_
2BPP_
RGBA_
1
PIXELFORMAT_
PVRTC_
2BPP_
RGB_
1
PIXELFORMAT_
PVRTC_
4BPP_
RGBA_
1
PIXELFORMAT_
PVRTC_
4BPP_
RGB_
1
PIXELFORMAT_
R32F
PIXELFORMAT_
RGB16F
PIXELFORMAT_
RGB32F
PIXELFORMAT_
RGB565
PIXELFORMAT_
RGB8
PIXELFORMAT_
RGBA16F
PIXELFORMAT_
RGBA32F
PIXELFORMAT_
RGBA4
PIXELFORMAT_
RGBA5551
PIXELFORMAT_
RGBA8
PIXELFORMAT_
SRGB
PIXELFORMAT_
SRGBA
PRIMITIVE_
LINELOOP
PRIMITIVE_
LINES
PRIMITIVE_
LINESTRIP
PRIMITIVE_
POINTS
PRIMITIVE_
TRIANGLES
PRIMITIVE_
TRIFAN
PRIMITIVE_
TRISTRIP
PROJECTION_
ORTHOGRAPHIC
PROJECTION_
PERSPECTIVE
RENDERSTYLE_
POINTS
RENDERSTYLE_
SOLID
RENDERSTYLE_
WIREFRAME
RESOLUTION_
AUTO
RESOLUTION_
FIXED
SCALEMODE_
BLEND
SCALEMODE_
NONE
SCROLLBAR_
VISIBILITY_
SHOW_
ALWAYS
SCROLLBAR_
VISIBILITY_
SHOW_
WHEN_
REQUIRED
SCROLL_
MODE_
BOUNCE
SCROLL_
MODE_
CLAMP
SCROLL_
MODE_
INFINITE
SEMANTIC_
ATTR0
SEMANTIC_
ATTR1
SEMANTIC_
ATTR10
SEMANTIC_
ATTR11
SEMANTIC_
ATTR12
SEMANTIC_
ATTR13
SEMANTIC_
ATTR14
SEMANTIC_
ATTR15
SEMANTIC_
ATTR2
SEMANTIC_
ATTR3
SEMANTIC_
ATTR4
SEMANTIC_
ATTR5
SEMANTIC_
ATTR6
SEMANTIC_
ATTR7
SEMANTIC_
ATTR8
SEMANTIC_
ATTR9
SEMANTIC_
BLENDINDICES
SEMANTIC_
BLENDWEIGHT
SEMANTIC_
COLOR
SEMANTIC_
NORMAL
SEMANTIC_
POSITION
SEMANTIC_
TANGENT
SEMANTIC_
TEXCOORD0
SEMANTIC_
TEXCOORD1
SEMANTIC_
TEXCOORD2
SEMANTIC_
TEXCOORD3
SEMANTIC_
TEXCOORD4
SEMANTIC_
TEXCOORD5
SEMANTIC_
TEXCOORD6
SEMANTIC_
TEXCOORD7
SHADERLANGUAGE_
GLSL
SHADERLANGUAGE_
WGSL
SHADERPASS_
ALBEDO
SHADERPASS_
AO
SHADERPASS_
EMISSION
SHADERPASS_
FORWARD
SHADERPASS_
GLOSS
SHADERPASS_
LIGHTING
SHADERPASS_
METALNESS
SHADERPASS_
OPACITY
SHADERPASS_
SPECULARITY
SHADERPASS_
UV0
SHADERPASS_
WORLDNORMAL
SHADER_
DEPTH
SHADER_
FORWARD
SHADER_
FORWARDHDR
SHADOWUPDATE_
NONE
SHADOWUPDATE_
REALTIME
SHADOWUPDATE_
THISFRAME
SHADOW_
PCF1
SHADOW_
PCF3
SHADOW_
PCF5
SHADOW_
PCSS
SHADOW_
VSM16
SHADOW_
VSM32
SHADOW_
VSM8
SORTMODE_
BACK2FRONT
SORTMODE_
FRONT2BACK
SORTMODE_
MANUAL
SORTMODE_
MATERIALMESH
SORTMODE_
NONE
SPECOCC_
AO
SPECOCC_
GLOSSDEPENDENT
SPECOCC_
NONE
SPECULAR_
BLINN
SPECULAR_
PHONG
SPRITETYPE_
ANIMATED
SPRITETYPE_
SIMPLE
SPRITE_
RENDERMODE_
SIMPLE
SPRITE_
RENDERMODE_
SLICED
SPRITE_
RENDERMODE_
TILED
STENCILOP_
DECREMENT
STENCILOP_
DECREMENTWRAP
STENCILOP_
INCREMENT
STENCILOP_
INCREMENTWRAP
STENCILOP_
INVERT
STENCILOP_
KEEP
STENCILOP_
REPLACE
STENCILOP_
ZERO
TEXTURELOCK_
READ
TEXTURELOCK_
WRITE
TEXTUREPROJECTION_
CUBE
TEXTUREPROJECTION_
EQUIRECT
TEXTUREPROJECTION_
NONE
TEXTUREPROJECTION_
OCTAHEDRAL
TEXTURETYPE_
DEFAULT
TEXTURETYPE_
RGBE
TEXTURETYPE_
RGBM
TEXTURETYPE_
RGBP
TEXTURETYPE_
SWIZZLEGGGR
TONEMAP_
ACES
TONEMAP_
ACES2
TONEMAP_
FILMIC
TONEMAP_
HEJL
TONEMAP_
LINEAR
TRACEID_
BINDGROUPFORMAT_
ALLOC
TRACEID_
BINDGROUP_
ALLOC
TRACEID_
GPU_
TIMINGS
TRACEID_
PIPELINELAYOUT_
ALLOC
TRACEID_
RENDERPIPELINE_
ALLOC
TRACEID_
RENDER_
ACTION
TRACEID_
RENDER_
FRAME
TRACEID_
RENDER_
FRAME_
TIME
TRACEID_
RENDER_
PASS
TRACEID_
RENDER_
PASS_
DETAIL
TRACEID_
RENDER_
QUEUE
TRACEID_
RENDER_
TARGET_
ALLOC
TRACEID_
SHADER_
ALLOC
TRACEID_
SHADER_
COMPILE
TRACEID_
TEXTURES
TRACEID_
TEXTURE_
ALLOC
TRACEID_
VRAM_
IB
TRACEID_
VRAM_
TEXTURE
TRACEID_
VRAM_
VB
TRACE_
ID_
ELEMENT
TYPE_
FLOAT32
TYPE_
INT16
TYPE_
INT32
TYPE_
INT8
TYPE_
UINT16
TYPE_
UINT32
TYPE_
UINT8
VIEW_
CENTER
VIEW_
LEFT
VIEW_
RIGHT
XRDEPTHSENSINGFORMAT_
F32
XRDEPTHSENSINGFORMAT_
L8
A8
XRDEPTHSENSINGUSAGE_
CPU
XRDEPTHSENSINGUSAGE_
GPU
XRHAND_
LEFT
XRHAND_
NONE
XRHAND_
RIGHT
XRPAD_
A
XRPAD_
B
XRPAD_
SQUEEZE
XRPAD_
STICK_
BUTTON
XRPAD_
STICK_
X
XRPAD_
STICK_
Y
XRPAD_
TOUCHPAD_
BUTTON
XRPAD_
TOUCHPAD_
X
XRPAD_
TOUCHPAD_
Y
XRPAD_
TRIGGER
XRSPACE_
BOUNDEDFLOOR
XRSPACE_
LOCAL
XRSPACE_
LOCALFLOOR
XRSPACE_
UNBOUNDED
XRSPACE_
VIEWER
XRTARGETRAY_
GAZE
XRTARGETRAY_
POINTER
XRTARGETRAY_
SCREEN
XRTRACKABLE_
MESH
XRTRACKABLE_
PLANE
XRTRACKABLE_
POINT
XRTYPE_
AR
XRTYPE_
INLINE
XRTYPE_
VR
revision
shader
Chunks
version
basis
Initialize
calculate
Normals
calculate
Tangents
create
Box
create
Capsule
create
Cone
create
Cylinder
create
Graphics
Device
create
Mesh
create
Plane
create
Script
create
Shader
create
Shader
From
Code
create
Sphere
create
Torus
draco
Initialize
draw
Quad
With
Shader
draw
Texture
get
Touch
Target
Coords
register
Script
reproject
Texture
Physics
Collision
Component
Collision
Component
System
Contact
Point
Contact
Result
Raycast
Result
Rigid
Body
Component
Rigid
Body
Component
System
Single
Contact
Result
Sound
Audio
Handler
Audio
Listener
Component
Audio
Listener
Component
System
Sound
Sound
Component
Sound
Component
System
Sound
Instance
Sound
Instance3d
Sound
Manager
Sound
Slot
User Interface
Button
Component
Button
Component
System
Element
Component
Element
Component
System
Element
Drag
Helper
Element
Input
Element
Input
Event
Element
Mouse
Event
Element
Select
Event
Element
Touch
Event
Font
Font
Handler
Layout
Child
Component
Layout
Child
Component
System
Layout
Group
Component
Layout
Group
Component
System
Screen
Component
Screen
Component
System
Scroll
View
Component
Scroll
View
Component
System
Scrollbar
Component
Scrollbar
Component
System
XR
Xr
Anchor
Xr
Anchors
Xr
Depth
Sensing
Xr
Dom
Overlay
Xr
Hit
Test
Xr
Hit
Test
Source
Xr
Image
Tracking
Xr
Input
Xr
Input
Source
Xr
Light
Estimation
Xr
Manager
Xr
Plane
Xr
Plane
Detection
Xr
Tracked
Image
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
PlayCanvas Engine API
guid
math
path
platform
script
string
AnimComponent
AnimComponentLayer
AnimComponentSystem
AnimCurve
AnimData
AnimEvents
AnimStateGraph
AnimTrack
Animation
AnimationComponent
AnimationComponentSystem
AnimationHandler
AppBase
Application
Asset
Loading...
Generated using
TypeDoc