class BufferDescriptor

Low level buffer wrapper.

• bufferDescriptor.getBytes()
  • Gets a view of the WASM heap referenced by the buffer descriptor.
  • returns Uint8Array

Clients should use the Buffer helper function to contruct BufferDescriptor objects.

class BufferObject

Represents a single GPU buffer.

• bufferObject.setBuffer(engine, buffer, byteOffset)
  • engine Engine
  • buffer asset string, or Uint8Array, or Buffer
  • byteOffset non-negative integer

class Camera

Represents the eye through which the scene is viewed.

See also the Engine methods createCamera and destroyCamera.

class Engine

Central manager and resource owner.

• engine.addEntities(entities)
  • entities array of entities
• Engine.create(canvas, options)
  • Creates an Engine instance for the given canvas.
  • canvas the canvas DOM element
  • options optional WebGL 2.0 context configuration
  • returns an instance of Engine
• engine.createAssetLoader()
  • returns an instance of AssetLoader
• engine.createCamera(entity)
  • entity the Entity to add the camera component to
  • returns an instance of Camera
• engine.createIblFromKtx1(buffer, options)
  • Utility that creates an [IndirectLight] from a KTX file.
  • buffer asset string, or Uint8Array, or Buffer with KTX file contents
  • options Options dictionary.
  • returns IndirectLight
• engine.createMaterial(package)
  • package asset string, or Uint8Array, or Buffer with filamat contents
  • returns an instance of createMaterial
• engine.createRenderer()
  • returns an instance of Renderer
• engine.createScene()
  • returns an instance of Scene
• engine.createSkyFromKtx1(buffer, options)
  • Utility function that creates a [Skybox] from a KTX file.
  • buffer asset string, or Uint8Array, or Buffer with KTX file contents
  • options Options dictionary.
  • returns Skybox
• engine.createSwapChain()
  • returns an instance of SwapChain
• engine.createTextureFromJpeg(buffer, options)
  • Creates a 2D [Texture] from the contents of a JPEG file.
  • buffer asset string, or Uint8Array, or Buffer with JPEG file contents
  • options JavaScript object with optional srgb and nomips keys.
  • returns Texture
• engine.createTextureFromKtx1(buffer, options)
  • Utility function that creates a [Texture] from a KTX1 file.
  • buffer asset string, or Uint8Array, or Buffer with KTX1 file contents
  • options Options dictionary.
  • returns Texture
• engine.createTextureFromKtx2(buffer, options)
  • Utility function that creates a [Texture] from a KTX2 file.
  • buffer asset string, or Uint8Array, or Buffer with KTX2 file contents
  • options Options dictionary.
  • returns Texture
• engine.createTextureFromPng(buffer, options)
  • Creates a 2D [Texture] from the raw contents of a PNG file.
  • buffer asset string, or Uint8Array, or Buffer with PNG file contents
  • options object with optional srgb, noalpha, and nomips keys.
  • returns Texture
• engine.createView()
  • returns an instance of View
• Engine.destroy(engine)
  • Destroys an engine instance and cleans up resources.
  • engine the instance to destroy
• engine.destroyCameraComponent(camera)
  • camera an Entity with a camera component
• engine.destroyColorGrading(entity)
  • entity an ColorGrading
• engine.destroyEntity(entity)
  • entity an Entity
• engine.destroyIndexBuffer(ib)
  • ib the IndexBuffer to destroy
• engine.destroyIndirectLight(light)
  • light the IndirectLight to destroy
• engine.destroyMaterial(material)
  • material an instance of Material
• engine.destroyMaterial(instance)
  • instance the MaterialInstance to destroy
• engine.destroyRenderTarget(rt)
  • rt the RenderTarget to destroy
• engine.destroyRenderer(renderer)
  • renderer an instance of Renderer
• engine.destroyScene(scene)
  • scene an instance of Scene
• engine.destroySkybox(skybox)
  • skybox the Skybox to destroy
• engine.destroySwapChain(swapChain)
  • swapChain an instance of SwapChain
• engine.destroyTexture(texture)
  • texture the Texture to destroy
• engine.destroyVertexBuffer(vb)
  • vb the VertexBuffer to destroy
• engine.destroyView(view)
  • view an instance of View
• engine.getCameraComponent()
  • returns an instance of Camera
• engine.getEntityManager()
• engine.getLightManager()
  • returns an instance of LightManager
• engine.getRenderableManager()
  • returns an instance of RenderableManager
• engine.getTransformManager()
  • returns an instance of TransformManager
• engine.loadFilamesh(buffer, definstance, matinstances)
  • Consumes the contents of a filamesh file and creates a renderable.
  • buffer asset string, or Uint8Array, or Buffer with filamesh contents
  • definstance Optional default MaterialInstance
  • matinstances Optional in-out object that gets populated with a name-to-MaterialInstance mapping. Clients can also optionally provide individual material instances using this argument.
  • returns JavaScript object with keys renderable, vertexBuffer, and indexBuffer. These are of type Entity, VertexBuffer, and IndexBuffer.
• engine.removeEntities(entities)
  • entities array of entities
• engine.setAmbientOcclusionOptions()
• engine.setBloomOptions()
• engine.setClearOptions(overrides)
  • overrides Dictionary with one or more of the following properties: clearColor, clear, discard.
• engine.setDepthOfFieldOptions()
• engine.setFogOptions()
• engine.setGuardBandOptions()
• engine.setMultiSampleAntiAliasingOptions()
• engine.setScreenSpaceReflectionsOptions()
• engine.setShadowOptions(instance, overrides)
  • instance Instance of a light component obtained from getInstance.
  • overrides Dictionary with one or more of the following properties: mapSize, shadowCascades, constantBias, normalBias, shadowFar, shadowNearHint, shadowFarHint, stable, polygonOffsetConstant, polygonOffsetSlope, \
• engine.setStereoscopicOptions()
• engine.setTemporalAntiAliasingOptions()
• engine.setVignetteOptions()

class Entity

Handle to an object consisting of a set of components.

• entity.delete()
  • Frees an entity.

To create an entity with no components, use EntityManager. TODO: It would be better to expose these as JS numbers rather than as JS objects. This would also be more consistent with Filament's Java bindings.

class EntityManager

Singleton used for constructing entities in Filament's ECS.

• entityManager.create()
  • returns an Entity without any components
• EntityManager.get()
  • Gets the singleton entity manager instance.
  • returns the one and only entity manager

class Frustum

Represents the six planes of a truncated viewing pyramid

class IcoSphere

Utility class for constructing spheres (requires glMatrix).

The constructor takes an integer subdivision level, with 0 being an icosahedron. Exposes three arrays as properties:

• icosphere.vertices Float32Array of XYZ coordinates.
• icosphere.tangents Uint16Array (interpreted as half-floats) encoding the surface orientation as quaternions.
• icosphere.triangles Uint16Array with triangle indices.

class IndexBuffer

Array of 16-bit or 32-bit unsigned integers consumed by the GPU.

• indexBuffer.setBuffer(engine, buffer, byteOffset)
  • engine Engine
  • buffer asset string, or Uint8Array, or Buffer
  • byteOffset non-negative integer

class Ktx1Bundle

In-memory representation of a KTX file.

• ktx1Bundle.getArrayLength()
  • Obtains length of the texture array.
  • returns The number of elements in the texture array
• ktx1Bundle.getCompressedPixelDataType()
  • returns CompressedPixelDataType
• ktx1Bundle.getInternalFormat(srgb)
  • srgb boolean that forces the resulting format to SRGB if possible.
  • returns Texture$InternalFormat
• ktx1Bundle.getMetadata(key)
  • Obtains arbitrary metadata from the KTX file.
  • key string
  • returns string
• ktx1Bundle.getPixelDataFormat()
  • returns PixelDataFormat
• ktx1Bundle.getPixelDataType()
  • returns PixelDataType
• ktx1Bundle.info()
  • Obtains properties of the KTX header.
  • returns The KtxInfo property accessor object.
• ktx1Bundle.info()
  • Obtains properties of the KTX header.
  • returns The KtxInfo property accessor object.
• ktx1Bundle.isCompressed()
  • returns boolean

Most clients should use one of the create*FromKtx utility methods in the JavaScript Engine wrapper rather than interacting with Ktx1Bundle directly.

class KtxInfo

Property accessor for KTX1 header.

• ktxInfo.createAsset(buffer)
  • buffer asset string, or Uint8Array, or Buffer
  • returns an instance of FilamentAsset
• ktxInfo.createInstancedAsset(buffer)
  • buffer asset string, or Uint8Array, or Buffer
  • returns an instance of FilamentAsset

For example, Ktx1Bundle.info().pixelWidth. See the KTX spec for the list of properties.

class LightManager$Instance

Component instance returned by LightManager

• lightManager$Instance.delete()
  • Frees an instance obtained via getInstance

Be sure to call the instance's delete method when you're done with it.

class PixelBufferDescriptor

Low level pixel buffer wrapper.

• pixelBufferDescriptor.getBytes()
  • Gets a view of the WASM heap referenced by the buffer descriptor.
  • returns Uint8Array

Clients should use the PixelBuffer helper function to contruct PixelBufferDescriptor objects.

class RenderableManager

Allows access to properties of drawable objects.

• renderableManager.getInstance(entity)
  • Gets an instance of the renderable component for an entity.
  • entity an Entity
  • returns a renderable component

class RenderableManager$Instance

Component instance returned by RenderableManager

• renderableManager$Instance.delete()
  • Frees an instance obtained via getInstance

Be sure to call the instance's delete method when you're done with it.

class Renderer

Represents the platform's native window.

• renderer.render(swapChain, view)
  • requests rendering for a single frame on the given [View]
  • swapChain the SwapChain corresponding to the canvas
  • view the View corresponding to the canvas

See also the Engine methods createRenderer and destroyRenderer.

class Scene

Flat container of renderables and lights.

See also the Engine methods createScene and destroyScene.

class SwapChain

Represents the platform's native rendering surface.

See also the Engine methods createSwapChain and destroySwapChain.

class Texture

2D image or cubemap that can be sampled by the GPU, possibly mipmapped.

class TransformManager

Adds transform components to entities.

• transformManager.getInstance(entity)
  • Gets an instance representing the transform component for an entity.
  • entity an Entity
  • returns a transform component that can be passed to setTransform.
• transformManager.setTransform(instance, matrix)
  • Sets the mat4 value of a transform component.
  • instance The transform instance of entity, obtained via getInstance.
  • matrix Array of 16 numbers (mat4)

class TransformManager$Instance

Component instance returned by TransformManager

• transformManager$Instance.delete()
  • Frees an instance obtained via getInstance
• transformManager$Instance.getInstance(entity)
  • Gets an instance of the light component for an entity.
  • entity an Entity
  • returns a light source component

Be sure to call the instance's delete method when you're done with it.

class VertexBuffer

Bundle of buffers and associated vertex attributes.

• vertexBuffer.setBufferAt(engine, bufferIndex, buffer, byteOffset)
  • engine Engine
  • bufferIndex non-negative integer
  • buffer asset string, or Uint8Array, or Buffer
  • byteOffset non-negative integer

class View

Encompasses all the state needed for rendering a Scene.

A view is associated with a particular Scene, Camera, and viewport. See also the Engine methods createView and destroyView.