Typescript API v0.3.2

Enumerations

Enumeration	Description
AssetType	Supported asset types.
ComponentType	Supported component types.
ColliderType	Supported collider types.
MovementType	Supported movement types for grab interactions.
ForceMode	Supported force application modes.
ProjectionType	Supported camera projection types.
LightShadowMode	Supported shadow modes for a light.
LightType	Supported light types.
MaterialProperty	Supported material properties.
AlphaMode	Supported alpha modes for a material.
ShadowCastingMode	Supported shadow casting modes for a renderable component.
TextureFormat	Supported texture data formats.
RenderTextureFormat	Supported render texture formats.
TextureDimension	Supported texture dimensions.
TextureFilterMode	Texture filtering modes.
TextureWrapMode	Texture wrapping modes.

Classes

Class	Description
Device	Reads and subscribes to device input values.
EntityManager	Creates and manages entities.
GrabInteractableManager	Creates and updates grab interactable components.
Networking	Provides networking utilities for state synchronization, messaging, and user session events.
ColliderManager	Creates and updates colliders and collider event callbacks.
RigidbodyManager	Creates and updates rigidbody components.
Project	Represents a project.
CameraManager	Creates and updates camera components.
LightManager	Creates and updates light components.
MaterialManager	Creates and updates materials.
MeshManager	Creates and updates meshes.
RenderableManager	Creates and updates renderable components.
RendererManager	Updates renderer settings.
TextureManager	Creates, updates, and reads textures.
TransformManager	Reads and updates entity transforms.
User	Represents a user.

Interfaces

Interface	Description
TextureTransform	Texture transform data.
SparseMorphData	Sparse morph target data.
MeshPrimitive	Mesh primitive data.
Asset	Base asset data.
TextureAsset	Texture asset data.
MaterialAsset	Material asset data.
MeshAsset	Mesh asset data.
Component	Base component data.
PropertyComponent	Property component data.
TransformComponent	Transform component data.
RenderableComponent	Renderable component data.
GrabbleComponent	Grabble component data.
RigidbodyComponent	Rigidbody component data.
CameraComponent	Camera component data.
LightComponent	Light component data.
ColliderBase	Base collider data.
BoxCollider	Box collider data.
SphereCollider	Sphere collider data.
CapsuleCollider	Capsule collider data.
ColliderComponent	Collider component data.
PrefabAsset	Prefab asset data.
WorldProperty	World-level project settings.
ProjectMetadata	Project metadata.
ProjectDescription	Project description data.
ProjectBundle	Project bundle data.
NetworkState	Network state.
ProjectCallbacks	Project lifecycle callbacks.
ImageReadbackResult	Image data returned from a texture readback operation.

Type Aliases

Type Alias	Description
Version	Semantic version string.
DeviceSubscription	Opaque numeric handle that identifies a device subscription.
Entity	Opaque numeric handle that identifies an entity.
Collider	Opaque numeric handle that identifies a collider.
Material	Opaque numeric handle that identifies a material.
Mesh	Opaque numeric handle that identifies a mesh.
Texture	Opaque numeric handle that identifies a texture.

Variables

Variable	Description
DevicePath	Built-in device input paths.
cubeMeshAsset	Mesh asset data for a cube.
quadMeshAsset	Mesh asset data for a quad.
sphereMeshAsset	Mesh asset data for a sphere.
capsuleMeshAsset	Mesh asset data for a capsule.
cylinderMeshAsset	Mesh asset data for a cylinder.

Functions

Function	Description
NewCubeMesh	Creates a cube mesh.
NewQuadMesh	Creates a quad mesh.
NewSphereMesh	Creates a sphere mesh.
NewCapsuleMesh	Creates a capsule mesh.
NewCylinderMesh	Creates a cylinder mesh.
base64Encode	Encodes binary data as a base64 string.
base64EncodeAsync	Encodes binary data as a base64 string.
base64Decode	Decodes a base64 string into binary data.
base64DecodeAsync	Decodes a base64 string into binary data.