Home

Learn

API Reference

Asset

  • Asset
    • Error
    • Loaded
    • Loading
    • Unloaded
    • filename
    • id
    • isLoaded
    • isLoading
    • isValid
    • name
    • onError
    • onLoad
    • onLoading
    • onModified
    • onNameChanged
    • onStateChange
    • onUpdate
    • path
    • state
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • AssetLoader
    • load
  • AssetManager
    • add
    • deleteAsset
    • get
    • getAssetPath
    • getLoaderForExtension
    • getLoaderForFilename
    • has
    • initialize
    • isAssetInvalid
    • load
    • registerLoader
    • updateAsset
  • AudioAsset
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • pause
    • play
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • MeshAsset
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • ModelAsset
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • ScriptAsset
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset

Asset Loader

  • AudioLoader
    • load
  • DracoLoader
    • load
  • GlbLoader
    • decode
    • load
  • GlslLoader
    • load
  • HdrLoader
    • load
  • ImageLoader
    • load
  • KtxLoader
    • load
  • MaterialLoader
    • load
  • SceneLoader
    • load
  • ScriptLoader
    • load
  • ShaderLoader
    • load
  • VideoLoader
    • load

Engine

  • Engine
    • active
    • onFixedUpdate
    • onPlay
    • onPostDraw
    • onPostUpdate
    • onPreDraw
    • onPreUpdate
    • onStop
    • onUpdate
    • canvas
    • drawFrame
    • pause
    • play
    • requestFrame
    • step
    • stop
    • update

GL

  • GL
  • GLBuffer
    • bind
    • destroy
    • unbind
    • upload
    • uploadRange
  • GLContext
    • cloneCanvas
    • createCanvas
    • animate
    • destroy
    • drawFrame
    • exitPointerLock
    • fullscreen
    • getAspectRatio
    • getUniformFunction
    • getViewport
    • requestFrame
    • requestPointerLock
    • reset
    • setViewport
    • snapshot
    • updateResolution
    • viewport
  • GLDraw
    • createSurfaceShader
    • drawCylinder
    • drawLines
    • drawMesh
    • drawPoints
    • drawPointsWithSize
    • drawRoundPoints
    • reset
    • setAlpha
    • setColor
    • setLineWidth
    • setPointSize
    • toGlobalMesh
  • GLFramebuffer
    • active
    • colorTexture
    • bind
    • blit
    • destroy
    • setTextures
    • unbind
    • update
  • GLMesh
    • load
    • addBuffer
    • addBuffers
    • bindBuffers
    • clone
    • cloneShared
    • createIndexBuffer
    • createVertexBuffer
    • deleteBuffers
    • freeData
    • getBuffer
    • getIndexBuffer
    • getVertexBuffer
    • removeIndexBuffer
    • removeVertexBuffer
    • totalMemory
    • unbindBuffers
    • updateVertexBuffer
    • upload
  • GLRenderbuffer
  • GLResourceManager
    • getBlitShader
    • getFullscreenMesh
    • releaseFramebuffer
    • releaseFramebufferTexture
    • requestFramebuffer
  • GLSampler
    • bind
    • configure
    • create
    • destroy
    • unbind
    • update
  • GLShader
    • precision
    • isBound
    • injectCode
    • attributeLocation
    • bind
    • drawBuffers
    • drawMesh
    • drawRange
    • setUniform
    • setUniforms
    • unbind
    • uniformLocation
  • GLState
    • setFlag
  • GLTexture
    • blit
    • generateMipmap
    • init
    • readPixels

GPU

  • GPUContext
    • destroy
  • GPUResourceManager

Geometry

  • AttributeList
  • CylinderPrimitive
    • scale
    • transformBy
  • DiscPrimitive
    • scale
    • transformBy
  • FloatAttribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • Geometry
    • accelAttribute
    • addFloatAttribute
    • addIntAttribute
    • addPointGroup
    • addPoints
    • addPrimitive
    • addPrimitiveGroup
    • addVec2Attribute
    • addVec3Attribute
    • addVec4Attribute
    • append
    • clear
    • colorAttribute
    • copy
    • copyAttribute
    • findAttribute
    • findPointGroup
    • findPrimitiveById
    • findPrimitiveGroup
    • generateNormals
    • generateTangents
    • getAttribute
    • getBoundingBox
    • getMesh
    • getPoint
    • getPointGroup
    • getPrimitive
    • getPrimitiveGroup
    • lifeAttribute
    • normalAttribute
    • pstateAttribute
    • rayIntersect
    • removeAttribute
    • removePointRange
    • removePoints
    • renameAttribute
    • resetBoundingBox
    • resetRayAccel
    • setPoint
    • tangentAttribute
    • texture2Attribute
    • textureAttribute
    • translatePoint
    • updateBoundingBox
    • updateRayAccel
    • velocityAttribute
    • weightAttribute
  • GeometryAttribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • GeometryPrimitive
    • getBoundingBox
    • getPoint
    • rayIntersect
    • setPoint
    • transformBy
  • IntAttribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • LinePrimitive
    • addPoints
    • clone
    • getBoundingBox
    • getPoint
    • getVertex
    • rayIntersect
    • removeVertices
    • setPoint
    • setVertex
    • transformBy
  • MeshPrimitive
    • _intersectTriangle
    • _intersectTriangleFan
    • _intersectTriangles
    • _intersectTriangleStrip
    • addFloatAttribute
    • addIntAttribute
    • addVec2Attribute
    • addVec3Attribute
    • addVec4Attribute
    • attribute
    • colorAttribute
    • copyAttribute
    • findAttribute
    • getAllAttributeNames
    • getBoundingBox
    • getPoint
    • getPolyVertices
    • interpolateAttribute
    • normalAttribute
    • rayIntersect
    • removeAttribute
    • renameAttribute
    • setPoint
    • textureAttribute
    • transformBy
    • weightAttribute
  • ParticlePrimitive
    • addPoints
    • clone
    • getBoundingBox
    • getPoint
    • getVertex
    • rayIntersect
    • removeVertices
    • setPoint
    • setVertex
    • transformBy
  • PointGroup
    • add
    • clear
    • clone
    • copy
    • get
    • getBoundingBox
    • getPoint
    • getPoints
    • remove
    • removeRange
    • set
    • setPoint
  • PointGroupList
    • add
    • clear
    • copy
    • get
    • set
  • PrimitiveGroup
  • PrimitiveGroupList
    • add
    • clear
    • copy
    • get
    • set
  • PrimitiveList
    • add
    • clear
    • copy
    • findById
    • get
    • getBoundingBox
  • QuadricPrimitive
    • scale
    • transformBy
  • RayHitInfo
  • SpherePrimitive
    • rayIntersect
    • scale
    • transformBy
  • TorusPrimitive
    • rayIntersect
    • scale
    • transformBy
  • Uint16Attribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • Vec2Attribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • Vec3Attribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero
  • Vec4Attribute
    • addElements
    • append
    • clear
    • clone
    • copy
    • copyFrom
    • copyRange
    • fillRange
    • invalidateDisplay
    • makeMutable
    • removeRange
    • resize
    • zero

Graph

  • EnvironmentTexture
  • Graph
    • addInput
    • addNode
    • addOutput
    • attachCanvas
    • change
    • clear
    • clearError
    • clone
    • collapse
    • configure
    • connectionChanged
    • createSceneObjects
    • detachCanvas
    • findNodeById
    • getDynamicType
    • getInput
    • getOutput
    • getPropertyInfo
    • getTypeFromData
    • initialize
    • initializeAudioNode
    • initializeBehaviorNode
    • initializeConstraintNode
    • initializeGeometryNode
    • initializeImageCompositeNode
    • initializeImageFilterNode
    • initializeImageNode
    • initializeParticleNode
    • initializeSceneNode
    • initializeTransformNode
    • mouseMove
    • removeNode
    • removeOutput
    • renameInput
    • renameOutput
    • sendActionToCanvas
    • sendActionToNodes
    • serialize
    • setDependency
    • setDirty
    • setError
    • setModified
    • setNodePosition
    • timeChanged
    • toJSON
    • updateMaterial
    • validateInputs
  • GraphManager
    • createNode
    • getNodeClass
    • registerNodeType
    • unregisterNodeType
    • updateCategoryMap
  • GraphNode
    • Types
    • bypass
    • disabled
    • enabled
    • graph
    • id
    • inputs
    • isPlaying
    • name
    • nodePositionX
    • nodePositionY
    • nodeType
    • numInputs
    • numOutputs
    • onModified
    • onNameChanged
    • outputs
    • scene
    • state
    • timeDependent
    • title
    • addInput
    • addOutput
    • clearError
    • clone
    • collapse
    • configure
    • connectionChanged
    • getDynamicType
    • getInput
    • getOutput
    • getPropertyInfo
    • getTypeFromData
    • initialize
    • initializeAudioNode
    • initializeBehaviorNode
    • initializeConstraintNode
    • initializeGeometryNode
    • initializeImageCompositeNode
    • initializeImageFilterNode
    • initializeImageNode
    • initializeParticleNode
    • initializeSceneNode
    • initializeTransformNode
    • removeOutput
    • renameInput
    • renameOutput
    • serialize
    • setDependency
    • setDirty
    • setError
    • setModified
    • setNodePosition
    • timeChanged
    • toJSON
    • updateMaterial
    • validateInputs
  • GraphTexture
  • NodeInput
    • canConnectFrom
    • configure
    • connectFrom
    • disconnect
    • get
    • getConnection
    • isConnectedTo
    • set
    • setDirty
  • NodeOutput
    • configure
    • disconnect
    • disconnectAll
    • execute
    • get
    • set
    • setDirty
  • ParticleContext
    • getParticle
    • updateSimulation
  • ShaderContext

Input

  • InputManager
    • captureGamepads
    • captureKeys
    • getGamepads

Material

  • GLSLCode
    • clone
    • configure
    • destroy
    • getFinalCode
    • getPropertyInfo
    • getRenderAsset
    • isReady
    • parse
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • Material
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • setProperty
    • toJSON
    • updateRenderAsset
  • Shader
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • getRenderShader
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • ShaderBlock
    • addCode
    • getFinalCode
  • ShaderManager
    • compileShader
    • deviceShaderCode
    • getGlobalExtraShaderCode
    • getShaderBlock
    • getShaderBlockMask
    • registerShaderBlock
  • Texture
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • TextureSampler
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • VideoTexture
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset

Math

  • BoundingBox
    • Empty
    • depth
    • dominantAxis
    • height
    • max
    • min
    • width
    • fromCenterHalfSize
    • fromMinMax
    • fromPoint
    • clear
    • clone
    • contains
    • copy
    • expand
    • getCenter
    • getCorner
    • getExtents
    • getSize
    • include
    • interpolate
    • overlaps
    • rayIntersect
    • set
    • setMinMax
    • testSphere
    • transform
    • transformed
    • translate
    • volume
  • BoundingSphere
    • setCenter
  • Frustum
    • setMatrix
    • testBoundingBox
    • testBoundingSphere
  • Matrix3
    • Identity
    • Zero
    • clone
    • determinant
    • invert
    • rotate
    • scale
    • setFrom
    • setIdentity
    • setQuaternion
    • setRotate
    • setScale
    • setTranslate
    • toArray
    • transformVector2
    • transformVector3
    • translate
    • transpose
    • invert
    • multiply
    • rotate
    • scale
    • translate
    • transpose
  • Matrix4
    • Identity
    • Zero
    • clone
    • determinant
    • getColumn
    • getColumn3
    • getEulerAngles
    • getMatrix3
    • getQuaternion
    • getRow
    • getRow3
    • getScale
    • getTranslation
    • getX
    • getY
    • getZ
    • invert
    • invertToMatrix3
    • isIdentity
    • normalizeScale
    • rotateAxisAngle
    • rotateEuler
    • rotateQuaternion
    • rotateX
    • rotateY
    • rotateZ
    • scale
    • setAlignToVector
    • setAxisAngle
    • setColumn
    • setColumns
    • setEulerAngles
    • setFrom
    • setIdentity
    • setLookAt
    • setOrtho
    • setPerspective
    • setQuaternion
    • setRotateX
    • setRotateY
    • setRotateZ
    • setRow
    • setScale
    • setTransform
    • setTranslate
    • toArray
    • transformVector3
    • transformVector4
    • translate
    • transpose
    • invert
    • multiply
    • scale
    • translate
    • transpose
  • Noise
    • perlinNoise2
    • perlinNoise3
    • turbulence
    • fbm
    • perlinNoise2
    • perlinNoise3
    • turbulence
  • Plane
    • testBoundingBox
    • testPoint
    • testSphere
    • distanceToPoint
    • dotNormal
    • rayIntersect
  • Quaternion
    • conjugate
    • fromEulerAngles
    • inverse
    • conjugate
    • invert
  • Random
    • randomDouble
    • randomFloat
    • randomUint32
    • reset
  • Ray
    • pointAlongRay
    • reflect
    • transform
  • Vector2
  • Vector3
    • dominantAxis
    • isZero
    • x
    • y
    • z
    • Back
    • Down
    • Front
    • Left
    • One
    • Right
    • Up
    • X
    • Y
    • Yoffset
    • Z
    • Zero
    • abs
    • add
    • clone
    • divide
    • getLength
    • getLengthSquared
    • map
    • multiply
    • negate
    • normalize
    • remap
    • scale
    • setFrom
    • setZero
    • subtract
    • sum
    • toArray
    • toString
    • abs
    • add
    • cross
    • distance
    • distanceSquared
    • divide
    • dot
    • length
    • lengthSquared
    • lerp
    • max
    • min
    • multiply
    • negated
    • normalize
    • project
    • reflect
    • refract
    • scale
    • scaleAndAdd
    • subtract
  • Vector4

Render

  • ForwardRenderer
    • clearBuffer
    • disableFrameShaderBlock
    • enableCamera
    • enableFrameShaderBlock
    • getNearLights
    • processVisibleData
    • render
    • renderCamera
    • renderFrameCameras
    • renderInstances
    • resetGLState
    • setFullViewport
    • updateRenderQueues
  • RenderAsset
    • destroy
    • update
  • RenderInstance
    • clone
    • configure
    • getPropertyInfo
    • serialize
    • setModified
    • toJSON
  • RenderPass
    • Color
    • Selection
    • Shadow
  • RenderQueue
    • Background
    • Geometry
    • NoSort
    • Overlay
    • ReadbackColor
    • SortByPriority
    • SortFarToNear
    • SortNearToFar
    • Transparent
    • add
    • clear
    • finish
    • sort
    • start
  • RenderSettings
    • defaultShadowmapResolution
    • defaultShadowMapResolution
    • frustumCulling
    • ignoreClear
    • ignoreViewports
    • keepViewport
    • layers
    • lightsDisabled
    • renderToFramebuffer
    • shadowsEnabled
    • targetFramebuffer
    • updateAllShadowmaps
    • updateShadowmaps
  • RenderState
    • reset
  • RenderTexture
    • bind
    • blit
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • resolve
    • serialize
    • setModified
    • toJSON
    • unbind
    • updateRenderAsset
  • Shadowmap
  • Viewport
    • displayImage
    • handleEvent

Scene

  • Component
    • clone
    • configure
    • getPropertyInfo
    • serialize
    • setModified
    • toJSON
  • ComponentManager
  • ObjectTransform
    • configure
    • getWorldForward
    • getWorldMatrix
    • getWorldPosition
    • getWorldRight
    • getWorldRotation
    • getWorldToLocalMatrix
    • getWorldUp
    • lookAt
    • onDestroy
    • reset
    • rotate
    • rotateQuaternion
    • serialize
    • setDirty
    • setLocalDirty
    • setWorldDirty
    • update
    • worldVectorToLocal
  • Scene
    • clone
    • configure
    • destroy
    • getPropertyInfo
    • getRenderAsset
    • requestUpdate
    • reset
    • serialize
    • setModified
    • toJSON
    • updateRenderAsset
  • SceneManager
  • SceneMessages
  • SceneObject
    • clone
    • configure
    • getCamera
    • getLight
    • getPropertyInfo
    • serialize
    • setModified
    • toJSON

Util

  • FileSaver
    • download
  • Guid
    • generate
  • Log
    • messages
    • onClear
    • onCodeError
    • onMessage
    • alert
    • assert
    • clear
    • codeError
    • debug
    • error
    • info
    • messageToString
    • warning
    • write
  • LokiObject
    • clone
    • configure
    • getPropertyInfo
    • serialize
    • setModified
    • toJSON
  • ObjectUtil
    • cloneObject
    • decodeObject
    • encodeObject
    • extendClass
    • getClassName
    • getObjectClassName
    • getPropertyDescriptor
    • hasProperty
    • instanceOf
    • isEmpty
    • setDefaultOptions
    • setEnumerable
    • stringToValue
  • Platform
  • Script
    • onError
    • showErrorsInConsole
    • applyToConstructor
    • cleanCode
    • computeLineFromError
    • expandCode
    • showCodeInConsole
    • callMethod
    • compile
    • hasMethod
  • Signal
    • enabled
    • hasListeners
    • disable
    • disconnect
    • enable
    • getSignals
    • addListener
    • disconnect
    • emit
    • isListening
  • SortedSet
  • StopWatch
    • start
    • stop
  • Time
    • deltaTime
    • fixedDeltaTime
    • frame
    • frameRate
    • lastFixedTime
    • lastTime
    • milliseconds
    • seconds
    • startTime
    • time
    • timeSinceStart
    • unscaledTime
  • Uri
    • cleanFullpath
    • getBasename
    • getExtension
    • getFilename
    • getFolder
    • getNoCache
    • getProtocol
    • parseQueryString
    • removeExtension
    • replaceExtension
  • Video
    • create
    • isVideoFile
  • WebRequest
    • Get
    • Head
    • Post
    • Put
    • abort
    • getAllResponseHeaders
    • getResponseHeader
    • overrideMimeType
    • send
    • setRequestHeader

XR

  • XRManager
  • color
    • hslToRGB
    • parseHtmlColor
    • rgb8ToHex
    • rgbToHex
    • rgbToLuminance
  • geom
    • closestPointBetweenLines
    • intersectCircle
    • intersectCylinder
    • intersectPlane
    • intersectSphere
    • projectPointOnPlane
  • initializeLoki
    • initializeLoki
  • math
    • Axis
    • ClipTest
    • DegreeToRadian
    • Epsilon
    • MaxValue
    • PI
    • PI2
    • PI_2
    • RadianToDegree
    • RotationOrder
    • clamp
    • copysign
    • equals
    • isPowerOfTwo
    • ldexp
    • length3
    • lerp
    • nearestPowerOfTwo
    • pingpong
    • radiansToDegrees
    • repeat
    • solveCubic
    • solveQuadratic
    • solveQuartic
    • toFloat16
    • abs
    • acos
    • asin
    • ceil
    • cos
    • floor
    • log
    • sign
    • sin
    • sqrt
    • sqrt
    • tan
  • search
    • find_element
    • lower_bound
    • upper_bound
    • less_than
  • ASTNode
  • BinaryOperatorAST
    • optimize
    • toString
  • BspRayAccel
  • CallAST
  • ConditionalAST
  • ConstraintContext
  • DataReader
  • ExprAST
  • ExprBytecode
    • _generateBytecode
    • eval
    • toString
  • ExprContext
    • callFunction
    • getSymbol
    • getVariableValue
    • import
    • setVariable
  • Expression
    • eval
    • import
    • parse
    • eval
    • toString
  • ExprFunction
    • clone
    • eval
  • ExprLexer
    • _isAlpha
    • _isAlphaNumber
    • _isDigit
    • _isWhitespace
    • _nextCode
    • getNextToken
  • ExprVariable
  • GeoRepulse
  • GfxContext
  • ImgChromaKey
  • ImgMask
  • Loki
    • allowScripts
    • allowXR
    • catchExceptions
    • classes
    • components
    • debug
    • graph
    • hasUserInteraction
    • initialized
    • loaderClasses
    • loaderExtensions
    • onComputeNode
    • onException
    • onRefreshGraph
    • onRequestFrame
    • onUpdateAsset
    • onUserInteraction
    • onVariableChange
    • onXRSupportChanged
    • scene
    • skipDraws
    • version
    • webPath
    • escapeString
    • getVariable
    • hasVariable
    • isArray
    • isArrayOrTypedArray
    • isEmpty
    • isEqual
    • isFunction
    • isNullOrUndefined
    • isNumber
    • isString
    • isTypedArray
    • requestFrame
    • requestUpdate
    • setVariable
    • validateName
  • Model
  • ModelAssetNode
    • addChild
  • NumberAST
  • StringAST
  • UnaryOperatorAST
  • VariableAST
  • _registerExprSymbols
  • shader
Loki3D Home Learn API Reference