Skip to content

A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.

45.3 KB
Raw Blame

API surface — esengine/wasm

Symbols: 0 public · 0 beta · 8 experimental · 0 deprecated

CppEngineContext — interface @experimental

delete: () => void
init: (webglContextHandle: number) => boolean
isInitialized: () => boolean
shutdown: () => void

CppRegistry — interface @experimental

activityEpoch: () => number
addBillboard: (entity: Entity, component: Billboard) => void
addBitmapText: (entity: Entity, component: BitmapText) => void
addBoxCollider2D: (entity: Entity, component: BoxCollider2D) => void
addBoxCollider3D: (entity: Entity, component: BoxCollider3D) => void
addCamera: (entity: Entity, component: Camera) => void
addCanvas: (entity: Entity, component: Canvas) => void
addCapsuleCollider2D: (entity: Entity, component: CapsuleCollider2D) => void
addCapsuleCollider3D: (entity: Entity, component: CapsuleCollider3D) => void
addCharacterController3D: (entity: Entity, component: CharacterController3D) => void
addChildren: (entity: Entity, component: Children) => void
addCircleCollider2D: (entity: Entity, component: CircleCollider2D) => void
addContentRect: (entity: Entity, component: ContentRect) => void
addConvexCollider3D: (entity: Entity, component: ConvexCollider3D) => void
addDraggable: (entity: Entity, component: Draggable) => void
addDragonBonesAnimation: (entity: Entity, component: DragonBonesAnimation) => void
addFlexContainer: (entity: Entity, component: FlexContainer) => void
addGroupOpacity: (entity: Entity, component: GroupOpacity) => void
addImpostor: (entity: Entity, component: Impostor) => void
addInteractable: (entity: Entity, component: Interactable) => void
addLODGroup: (entity: Entity, component: LODGroup) => void
addLight: (entity: Entity, component: Light) => void
addLightProbeVolume: (entity: Entity, component: LightProbeVolume) => void
addMeshCollider3D: (entity: Entity, component: MeshCollider3D) => void
addMeshInstances: (entity: Entity, component: MeshInstances) => void
addMeshLightmap: (entity: Entity, component: MeshLightmap) => void
addMeshMorph: (entity: Entity, component: MeshMorph) => void
addMeshRenderer: (entity: Entity, component: MeshRenderer) => void
addMeshSkin: (entity: Entity, component: MeshSkin) => void
addOccluder: (entity: Entity, component: Occluder) => void
addParent: (entity: Entity, component: Parent) => void
addParticleCollider: (entity: Entity, component: ParticleCollider) => void
addParticleEmitter: (entity: Entity, component: ParticleEmitter) => void
addParticleForceField: (entity: Entity, component: ParticleForceField) => void
addPlanarReflection: (entity: Entity, component: PlanarReflection) => void
addReflectionProbe: (entity: Entity, component: ReflectionProbe) => void
addRigidBody2D: (entity: Entity, component: RigidBody2D) => void
addRigidBody3D: (entity: Entity, component: RigidBody3D) => void
addSegmentCollider2D: (entity: Entity, component: SegmentCollider2D) => void
addShadowCaster2D: (entity: Entity, component: ShadowCaster2D) => void
addShapeRenderer: (entity: Entity, component: ShapeRenderer) => void
addSortingGroup: (entity: Entity, component: SortingGroup) => void
addSphereCollider3D: (entity: Entity, component: SphereCollider3D) => void
addSpineAnimation: (entity: Entity, component: SpineAnimation) => void
addSpringBone: (entity: Entity, component: SpringBone) => void
addSpringBoneCollider: (entity: Entity, component: SpringBoneCollider) => void
addSprite: (entity: Entity, component: Sprite) => void
addSpriteMask: (entity: Entity, component: SpriteMask) => void
addTilemapLayer: (entity: Entity, component: TilemapLayer) => void
addTrailRenderer: (entity: Entity, component: TrailRenderer) => void
addTransform: (entity: Entity, component: Transform) => void
addUIInteraction: (entity: Entity, component: UIInteraction) => void
addUIMask: (entity: Entity, component: UIMask) => void
addUINode: (entity: Entity, component: UINode) => void
addUIScroll: (entity: Entity, component: UIScroll) => void
addUIVisual: (entity: Entity, component: UIVisual) => void
addVelocity: (entity: Entity, component: Velocity) => void
auditChanges: () => number
beginChangeRead: () => number
changeAuditTotal: () => number
changeTick: () => number
componentChangedSince: (component: number, entity: Entity, tick: number) => boolean
componentTypeId: ((name: string) => number) | undefined
create: () => Entity
delete: () => void
destroy: (entity: Entity) => void
destructionPending: (entity: Entity) => boolean
entityCount: () => number
getBillboard: (entity: Entity) => Billboard
getBitmapText: (entity: Entity) => BitmapText
getBoxCollider2D: (entity: Entity) => BoxCollider2D
getBoxCollider3D: (entity: Entity) => BoxCollider3D
getBuiltinComponentNames: ((entity: Entity) => string) | undefined
getCamera: (entity: Entity) => Camera
getCanvas: (entity: Entity) => Canvas
getCapsuleCollider2D: (entity: Entity) => CapsuleCollider2D
getCapsuleCollider3D: (entity: Entity) => CapsuleCollider3D
getCharacterController3D: (entity: Entity) => CharacterController3D
getChildren: (entity: Entity) => Children
getCircleCollider2D: (entity: Entity) => CircleCollider2D
getContentRect: (entity: Entity) => ContentRect
getConvexCollider3D: (entity: Entity) => ConvexCollider3D
getDraggable: (entity: Entity) => Draggable
getDragonBonesAnimation: (entity: Entity) => DragonBonesAnimation
getFlexContainer: (entity: Entity) => FlexContainer
getGroupOpacity: (entity: Entity) => GroupOpacity
getImpostor: (entity: Entity) => Impostor
getInteractable: (entity: Entity) => Interactable
getLODGroup: (entity: Entity) => LODGroup
getLight: (entity: Entity) => Light
getLightProbeVolume: (entity: Entity) => LightProbeVolume
getMeshCollider3D: (entity: Entity) => MeshCollider3D
getMeshInstances: (entity: Entity) => MeshInstances
getMeshLightmap: (entity: Entity) => MeshLightmap
getMeshMorph: (entity: Entity) => MeshMorph
getMeshRenderer: (entity: Entity) => MeshRenderer
getMeshSkin: (entity: Entity) => MeshSkin
getOccluder: (entity: Entity) => Occluder
getParent: (entity: Entity) => Parent
getParticleCollider: (entity: Entity) => ParticleCollider
getParticleEmitter: (entity: Entity) => ParticleEmitter
getParticleForceField: (entity: Entity) => ParticleForceField
getPlanarReflection: (entity: Entity) => PlanarReflection
getReflectionProbe: (entity: Entity) => ReflectionProbe
getRigidBody2D: (entity: Entity) => RigidBody2D
getRigidBody3D: (entity: Entity) => RigidBody3D
getSegmentCollider2D: (entity: Entity) => SegmentCollider2D
getShadowCaster2D: (entity: Entity) => ShadowCaster2D
getShapeRenderer: (entity: Entity) => ShapeRenderer
getSortingGroup: (entity: Entity) => SortingGroup
getSphereCollider3D: (entity: Entity) => SphereCollider3D
getSpineAnimation: (entity: Entity) => SpineAnimation
getSpringBone: (entity: Entity) => SpringBone
getSpringBoneCollider: (entity: Entity) => SpringBoneCollider
getSprite: (entity: Entity) => Sprite
getSpriteMask: (entity: Entity) => SpriteMask
getTilemapLayer: (entity: Entity) => TilemapLayer
getTrailRenderer: (entity: Entity) => TrailRenderer
getTransform: (entity: Entity) => Transform
getUIInteraction: (entity: Entity) => UIInteraction
getUIMask: (entity: Entity) => UIMask
getUINode: (entity: Entity) => UINode
getUIScroll: (entity: Entity) => UIScroll
getUIVisual: (entity: Entity) => UIVisual
getVelocity: (entity: Entity) => Velocity
hasBillboard: (entity: Entity) => boolean
hasBitmapText: (entity: Entity) => boolean
hasBoxCollider2D: (entity: Entity) => boolean
hasBoxCollider3D: (entity: Entity) => boolean
hasCamera: (entity: Entity) => boolean
hasCanvas: (entity: Entity) => boolean
hasCapsuleCollider2D: (entity: Entity) => boolean
hasCapsuleCollider3D: (entity: Entity) => boolean
hasCharacterController3D: (entity: Entity) => boolean
hasChildren: (entity: Entity) => boolean
hasCircleCollider2D: (entity: Entity) => boolean
hasContentRect: (entity: Entity) => boolean
hasConvexCollider3D: (entity: Entity) => boolean
hasDraggable: (entity: Entity) => boolean
hasDragonBonesAnimation: (entity: Entity) => boolean
hasFlexContainer: (entity: Entity) => boolean
hasGroupOpacity: (entity: Entity) => boolean
hasImpostor: (entity: Entity) => boolean
hasInactiveEntities: () => boolean
hasInteractable: (entity: Entity) => boolean
hasLODGroup: (entity: Entity) => boolean
hasLight: (entity: Entity) => boolean
hasLightProbeVolume: (entity: Entity) => boolean
hasMeshCollider3D: (entity: Entity) => boolean
hasMeshInstances: (entity: Entity) => boolean
hasMeshLightmap: (entity: Entity) => boolean
hasMeshMorph: (entity: Entity) => boolean
hasMeshRenderer: (entity: Entity) => boolean
hasMeshSkin: (entity: Entity) => boolean
hasOccluder: (entity: Entity) => boolean
hasParent: (entity: Entity) => boolean
hasParticleCollider: (entity: Entity) => boolean
hasParticleEmitter: (entity: Entity) => boolean
hasParticleForceField: (entity: Entity) => boolean
hasPlanarReflection: (entity: Entity) => boolean
hasReflectionProbe: (entity: Entity) => boolean
hasRigidBody2D: (entity: Entity) => boolean
hasRigidBody3D: (entity: Entity) => boolean
hasSegmentCollider2D: (entity: Entity) => boolean
hasShadowCaster2D: (entity: Entity) => boolean
hasShapeRenderer: (entity: Entity) => boolean
hasSortingGroup: (entity: Entity) => boolean
hasSphereCollider3D: (entity: Entity) => boolean
hasSpineAnimation: (entity: Entity) => boolean
hasSpringBone: (entity: Entity) => boolean
hasSpringBoneCollider: (entity: Entity) => boolean
hasSprite: (entity: Entity) => boolean
hasSpriteMask: (entity: Entity) => boolean
hasTilemapLayer: (entity: Entity) => boolean
hasTrailRenderer: (entity: Entity) => boolean
hasTransform: (entity: Entity) => boolean
hasUIInteraction: (entity: Entity) => boolean
hasUIMask: (entity: Entity) => boolean
hasUINode: (entity: Entity) => boolean
hasUIScroll: (entity: Entity) => boolean
hasUIVisual: (entity: Entity) => boolean
hasVelocity: (entity: Entity) => boolean
isEntityActive: (entity: Entity) => boolean
isEntityEnabled: (entity: Entity) => boolean
layoutEpoch: (() => number) | undefined
markComponentChanged: (component: number, entity: Entity) => void
releaseDestruction: (entity: Entity) => void
removeBillboard: (entity: Entity) => void
removeBitmapText: (entity: Entity) => void
removeBoxCollider2D: (entity: Entity) => void
removeBoxCollider3D: (entity: Entity) => void
removeCamera: (entity: Entity) => void
removeCanvas: (entity: Entity) => void
removeCapsuleCollider2D: (entity: Entity) => void
removeCapsuleCollider3D: (entity: Entity) => void
removeCharacterController3D: (entity: Entity) => void
removeChildren: (entity: Entity) => void
removeCircleCollider2D: (entity: Entity) => void
removeContentRect: (entity: Entity) => void
removeConvexCollider3D: (entity: Entity) => void
removeDraggable: (entity: Entity) => void
removeDragonBonesAnimation: (entity: Entity) => void
removeFlexContainer: (entity: Entity) => void
removeGroupOpacity: (entity: Entity) => void
removeImpostor: (entity: Entity) => void
removeInteractable: (entity: Entity) => void
removeLODGroup: (entity: Entity) => void
removeLight: (entity: Entity) => void
removeLightProbeVolume: (entity: Entity) => void
removeMeshCollider3D: (entity: Entity) => void
removeMeshInstances: (entity: Entity) => void
removeMeshLightmap: (entity: Entity) => void
removeMeshMorph: (entity: Entity) => void
removeMeshRenderer: (entity: Entity) => void
removeMeshSkin: (entity: Entity) => void
removeOccluder: (entity: Entity) => void
removeParent: (entity: Entity) => void
removeParticleCollider: (entity: Entity) => void
removeParticleEmitter: (entity: Entity) => void
removeParticleForceField: (entity: Entity) => void
removePlanarReflection: (entity: Entity) => void
removeReflectionProbe: (entity: Entity) => void
removeRigidBody2D: (entity: Entity) => void
removeRigidBody3D: (entity: Entity) => void
removeSegmentCollider2D: (entity: Entity) => void
removeShadowCaster2D: (entity: Entity) => void
removeShapeRenderer: (entity: Entity) => void
removeSortingGroup: (entity: Entity) => void
removeSphereCollider3D: (entity: Entity) => void
removeSpineAnimation: (entity: Entity) => void
removeSpringBone: (entity: Entity) => void
removeSpringBoneCollider: (entity: Entity) => void
removeSprite: (entity: Entity) => void
removeSpriteMask: (entity: Entity) => void
removeTilemapLayer: (entity: Entity) => void
removeTrailRenderer: (entity: Entity) => void
removeTransform: (entity: Entity) => void
removeUIInteraction: (entity: Entity) => void
removeUIMask: (entity: Entity) => void
removeUINode: (entity: Entity) => void
removeUIScroll: (entity: Entity) => void
removeUIVisual: (entity: Entity) => void
removeVelocity: (entity: Entity) => void
reserveDestruction: (entity: Entity) => boolean
setChangeAudit: (enabled: boolean) => void
setEntityEnabled: (entity: Entity, enabled: boolean) => boolean
setParent: (child: Entity, parent: Entity) => boolean
valid: (entity: Entity) => boolean

CppResourceManager — interface @experimental

acquireTextureByPath: (path: string) => number
adoptTextureContent: ((target: number, source: number) => boolean) | undefined
createCompressedTexture: ((width: number, height: number, format: number, dataPtr: number, dataLen: number, mipLevels: number, content: TextureContent) => number) | undefined
createLabelAtlasFont: (textureHandle: number, texWidth: number, texHeight: number, chars: string, charWidth: number, charHeight: number) => number
createShader: (vertSrc: string, fragSrc: string) => number
createTexture: (width: number, height: number, pixels: number, pixelsLen: number, format: number, flipY: boolean, content: TextureContent) => number
createTextureArray: ((width: number, height: number, layers: number, pixels: number, pixelsLen: number, format: number, filterMode: number, wrapMode: number, content: TextureContent) => number) | undefined
createTextureArrayFromBytes: ((width: number, height: number, layers: number, pixels: Uint8Array, format: number, filterMode: number, wrapMode: number, content: TextureContent) => number) | undefined
createTextureEx: (width: number, height: number, pixels: number, pixelsLen: number, format: number, flipY: boolean, filterMode: number, wrapMode: number, content: TextureContent) => number
createTextureFromBytes: ((width: number, height: number, pixels: Uint8Array, format: number, flipY: boolean, content: TextureContent, filterMode?: number, wrapMode?: number) => number) | undefined
createTextureFromKTX2: ((bytes: Uint8Array, srgb: boolean) => { handle: number; width: number; height: number; format?: number; blockRefused?: boolean; } | null) | undefined
forgoTextureContent: ((handle: number) => void) | undefined
getBitmapFontRefCount: (handle: number) => number
getResourceStats: () => { shaderCount: number; textureCount: number; vertexBufferCount: number; indexBufferCount: number; cacheHits: number; cacheMisses: number; textureBytes: number; textureBudget: number; textureEvictableCount: number; retainedBytes: number; }
getShaderRefCount: (handle: number) => number
getTextureDimensions: (handle: number) => { width: number; height: number; } | null
getTextureGLId: (handle: number) => number
getTextureNativeId: ((handle: number) => number) | undefined
getTextureRefCount: (handle: number) => number
invalidateTexturePath: (path: string) => boolean
loadBitmapFont: (fntContent: string, textureHandle: number, texWidth: number, texHeight: number) => number
measureBitmapText: (fontHandle: number, text: string, fontSize: number, spacing: number) => { width: number; height: number; }
meshRealizations: (() => string) | undefined
meshesAwaitingRemat: (() => string) | undefined
registerExternalTexture: (glTextureId: number, width: number, height: number, content: TextureContent) => number
registerExternalTextureSized: (glTextureId: number, width: number, height: number, bytes: number, content: TextureContent) => number
registerTextureWithPath: (handle: number, path: string) => void
releaseBitmapFont: (handle: number) => void
releaseShader: (handle: number) => void
releaseTexture: (handle: number) => void
restoreTextureContent: ((handle: number) => void) | undefined
setRetainedBudget: ((bytes: number) => void) | undefined
setTextureBudget: (bytes: number) => void
setTextureMetadata: (handle: number, left: number, right: number, top: number, bottom: number) => void
supportsCompressedFormat: ((format: number) => boolean) | undefined
texturesAwaitingReupload: (() => string) | undefined
trimTextureCache: () => number
updateTextureSubregion: (handle: number, x: number, y: number, width: number, height: number, pixels: number, pixelsLen: number) => void
updateTextureSubregionFromBytes: ((handle: number, x: number, y: number, width: number, height: number, pixels: Uint8Array) => void) | undefined
wrapDeviceTexture: ((textureId: number, width: number, height: number) => number) | undefined

ESEngineModule — interface @experimental

EstellaContext: new () => CppEngineContext
FS: EmscriptenFS
GL: { registerContext(ctx: WebGLRenderingContext | WebGL2RenderingContext, options: { majorVersion: number; minorVersion: number; enableExtensionsByDefault?: boolean; }): number; currentContext?: { GLctx: WebGLRenderingContext | WebGL2RenderingContext; }; contexts?: ({ GLctx: WebGLRenderingContext | WebGL2RenderingContext; } | null)[]; getNewId(pool: Record<number, unknown>): number; textures: Record<number, WebGLTexture>; }
HEAPF32: Float32Array<ArrayBufferLike>
HEAPU32: Uint32Array<ArrayBufferLike>
HEAPU8: Uint8Array<ArrayBufferLike>
Registry: new () => CppRegistry
_free: (ptr: number) => void
_malloc: (size: number) => number
anim_cancelAllTweens: (registry: CppRegistry, targetEntity: number) => void
anim_cancelTween: (registry: CppRegistry, tweenEntity: number) => void
anim_createTween: (registry: CppRegistry, entity: number, targetProp: number, from: number, to: number, duration: number, easing: number, delay: number, loopMode: number, loopCount: number) => number
anim_getTweenState: (registry: CppRegistry, tweenEntity: number) => number
anim_pauseTween: (registry: CppRegistry, tweenEntity: number) => void
anim_resumeTween: (registry: CppRegistry, tweenEntity: number) => void
anim_setSequenceNext: (registry: CppRegistry, tweenEntity: number, nextEntity: number) => void
anim_setTweenBezier: (registry: CppRegistry, tweenEntity: number, p1x: number, p1y: number, p2x: number, p2y: number) => void
anim_updateTweens: (registry: CppRegistry, deltaTime: number) => void
deviceIdentity: (() => string) | undefined
deviceLostReport: (() => string) | undefined
deviceStatus: (() => number) | undefined
draw_begin: (matrixPtr: number, viewportWidth: number, viewportHeight: number) => void
draw_circle: (centerX: number, centerY: number, radius: number, r: number, g: number, b: number, a: number, filled: boolean, segments: number) => void
draw_circleOutline: (centerX: number, centerY: number, radius: number, r: number, g: number, b: number, a: number, thickness: number, segments: number) => void
draw_deferBegin: (() => void) | undefined
draw_deferEnd: () => void
draw_end: () => void
draw_getDepthState: (() => number) | undefined
draw_getDrawCallCount: () => number
draw_getPrimitiveCount: () => number
draw_line3D: (fromX: number, fromY: number, fromZ: number, toX: number, toY: number, toZ: number, r: number, g: number, b: number, a: number, thickness: number) => void
draw_line3DScreen: (fromX: number, fromY: number, fromZ: number, toX: number, toY: number, toZ: number, r: number, g: number, b: number, a: number, thickness: number) => void
draw_line3DScreenOffset: (anchorX: number, anchorY: number, anchorZ: number, fromX: number, fromY: number, toX: number, toY: number, r: number, g: number, b: number, a: number, thickness: number) => void
draw_line: (fromX: number, fromY: number, toX: number, toY: number, r: number, g: number, b: number, a: number, thickness: number) => void
draw_mesh: (geometryHandle: number, shaderHandle: number, transformPtr: number) => void
draw_meshWithMaterial: (geometryHandle: number, materialId: number) => boolean
draw_meshWithUniforms: (geometryHandle: number, shaderHandle: number, transformPtr: number, uniformsPtr: number, uniformCount: number) => void
draw_rect: (x: number, y: number, width: number, height: number, r: number, g: number, b: number, a: number, filled: boolean) => void
draw_rectOutline: (x: number, y: number, width: number, height: number, r: number, g: number, b: number, a: number, thickness: number) => void
draw_setBlendMode: (mode: number) => void
draw_setDepth: (depth: number) => void
draw_setDepthState: ((flags: number) => void) | undefined
draw_setDepthTest: (enabled: boolean) => void
draw_setLayer: (layer: number) => void
draw_texture: (x: number, y: number, width: number, height: number, textureId: number, r: number, g: number, b: number, a: number) => void
draw_textureRotated: (x: number, y: number, width: number, height: number, rotation: number, textureId: number, r: number, g: number, b: number, a: number) => void
engine_getCounters: (() => string) | undefined
engine_getCpuScopes: (() => string) | undefined
engine_getGpuScopes: (() => string) | undefined
engine_prepareMeshPrograms: ((rowsPtr: number, count: number, outPtr: number) => void) | undefined
engine_setCpuProfiling: ((on: boolean) => void) | undefined
engine_setRandomSeed: ((seed: number) => void) | undefined
environment_create: ((shPtr: number, specularHandle: number, faceSize: number, mipCount: number, maxRange: number, columns: number) => number) | undefined
environment_release: ((environmentHandle: number) => void) | undefined
environment_setSky: ((environmentHandle: number, skyHandle: number) => void) | undefined
environment_setSun: ((environmentHandle: number, skyShPtr: number, dx: number, dy: number, dz: number, r: number, g: number, b: number) => void) | undefined
es_getMallocBytes: (() => number) | undefined
esshader_cookInfo: (source: string, featuresCsv: string) => { valid: boolean; error?: string; name: string; domain: string; hasWgslVertex: boolean; hasWgslFragment: boolean; hasSwitches: boolean; vertGlsl: string; fragGlsl: string; textures: Array<{ name: string; unit: number; }>; }
geometry_create: () => number
geometry_init: (handle: number, verticesPtr: number, vertexCount: number, layoutPtr: number, layoutCount: number, dynamic: boolean) => void
geometry_isValid: (handle: number) => boolean
geometry_release: (handle: number) => void
geometry_setIndices16: (handle: number, indicesPtr: number, indexCount: number) => void
geometry_setIndices32: (handle: number, indicesPtr: number, indexCount: number) => void
geometry_updateVertices: (handle: number, verticesPtr: number, vertexCount: number, offset: number) => void
getBoxCollider2DPtr: (registry: CppRegistry, entity: number) => number
getCameraPtr: (registry: CppRegistry, entity: number) => number
getChildEntities: (registry: CppRegistry, entity: number) => number[]
getCircleCollider2DPtr: (registry: CppRegistry, entity: number) => number
getResourceManager: () => CppResourceManager
getRigidBody2DPtr: (registry: CppRegistry, entity: number) => number
getSpritePtr: (registry: CppRegistry, entity: number) => number
getTransformPtr: (registry: CppRegistry, entity: number) => number
getUINodeAlphaInTree: ((registry: CppRegistry, entity: number) => number) | undefined
getUINodeComputedHeight: ((registry: CppRegistry, entity: number) => number) | undefined
getUINodeComputedWidth: ((registry: CppRegistry, entity: number) => number) | undefined
getUINodeHiddenInTree: ((registry: CppRegistry, entity: number) => boolean) | undefined
getUINodePtr: ((registry: CppRegistry, entity: number) => number) | undefined
getVelocityPtr: (registry: CppRegistry, entity: number) => number
gl_checkErrors: (context: string) => number
gl_enableErrorCheck: (enabled: boolean) => void
initRenderer: () => boolean
initRendererWebGPU: (canvasSelector: string, width: number, height: number, readback: boolean, preferBGRA: boolean) => boolean
initRendererWithContext: (contextHandle: number) => boolean
material_compileEsshader: (source: string, featuresCsv: string) => number
material_define: (materialId: number, shaderHandle: number, blendMode: number, flags: number, depthBias: number) => void
material_setTexture: (materialId: number, name: string, textureHandle: number) => void
material_setUniform: (materialId: number, name: string, arity: number, v0: number, v1: number, v2: number, v3: number) => void
material_undefine: (materialId: number) => void
meshInstances_set: ((registry: CppRegistry, entity: number, dataPtr: number, count: number) => void) | undefined
meshRenderer_localBounds: ((registry: CppRegistry, entity: number) => { minX: number; minY: number; maxX: number; maxY: number; } | null) | undefined
meshRenderer_makeAllResident: ((registry: CppRegistry) => number) | undefined
meshRenderer_setGeometry: ((registry: CppRegistry, entity: number, posUvPtr: number, vertexCount: number, colorsPtr: number, indicesPtr: number, indexCount: number) => void) | undefined
meshRenderer_setMaterialAll: ((registry: CppRegistry, materialId: number) => number) | undefined
meshRenderer_setMeshAll: ((registry: CppRegistry, meshHandle: number) => number) | undefined
mesh_createFromChannels: ((channelsPtr: number, channelCount: number, vertexStride: number, vertexPtr: number, vertexBytes: number, indexPtr: number, indexCount: number, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number, bindPtr: number, bindFloats: number, morphPtr: number, morphFloats: number, morphTargets: number, morphNormals: number) => number) | undefined
mesh_release: ((meshHandle: number) => void) | undefined
mesh_rematerializeFromChannels: ((targetHandle: number, channelsPtr: number, channelCount: number, vertexStride: number, vertexPtr: number, vertexBytes: number, indexPtr: number, indexCount: number, minX: number, minY: number, minZ: number, maxX: number, maxY: number, maxZ: number, bindPtr: number, bindFloats: number, morphPtr: number, morphFloats: number, morphTargets: number, morphNormals: number) => number) | undefined
notifyDeviceLost: ((reason: number, message: string) => void) | undefined
particle_collisionEventCount: (() => number) | undefined
particle_collisionEvents: (() => number) | undefined
particle_collisionQueries: (() => number) | undefined
particle_collisionQueryCount: (() => number) | undefined
particle_collisionResolve: ((registry: CppRegistry, ptr: number, count: number) => void) | undefined
particle_collisionSetBudget: ((queries: number, events: number, debug: boolean) => void) | undefined
particle_collisionStats: (() => number) | undefined
particle_collisionStatsCount: (() => number) | undefined
particle_emitAt: ((registry: CppRegistry, entity: number, count: number, px: number, py: number, pz: number, nx: number, ny: number, nz: number, vx: number, vy: number, vz: number) => number) | undefined
particle_getAliveCount: ((entity: number) => number) | undefined
particle_play: ((registry: CppRegistry, entity: number) => void) | undefined
particle_reset: ((registry: CppRegistry, entity: number) => void) | undefined
particle_set_bursts: ((entity: number, ptr: number, count: number) => void) | undefined
particle_set_color_lut: ((entity: number, ptr: number, count: number) => void) | undefined
particle_set_size_lut: ((entity: number, ptr: number, count: number) => void) | undefined
particle_set_speed_lut: ((entity: number, ptr: number, count: number) => void) | undefined
particle_stop: ((registry: CppRegistry, entity: number) => void) | undefined
particle_update: ((registry: CppRegistry, dt: number) => void) | undefined
postprocess_addComputePass: ((name: string, wgsl: string, params: string, workgroupX: number, workgroupY: number) => number) | undefined
postprocess_addNativePass: ((name: string, kind: string) => number) | undefined
postprocess_addPass: (name: string, shaderHandle: number) => number
postprocess_addScreenPass: (name: string, shaderHandle: number) => number
postprocess_begin: () => void
postprocess_beginScreenCapture: () => void
postprocess_clearPasses: () => void
postprocess_clearScreenPasses: () => void
postprocess_effectiveMsaaSamples: (() => number) | undefined
postprocess_end: () => void
postprocess_endScreenCapture: () => void
postprocess_executeScreenPasses: () => void
postprocess_giStats: ((dst: number, capacity: number) => number) | undefined
postprocess_hdrFormat: ((outPtr: number) => number) | undefined
postprocess_hdrFormatNames: (() => string) | undefined
postprocess_init: (width: number, height: number) => boolean
postprocess_isInitialized: () => boolean
postprocess_maxMsaaSamples: (() => number) | undefined
postprocess_pollSkyCapture: (() => number) | undefined
postprocess_requestSkyCapture: ((passName: string, width: number, height: number) => void) | undefined
postprocess_resize: (width: number, height: number) => void
postprocess_setBypass: (bypass: boolean) => void
postprocess_setDisplayLut: ((textureHandle: number, amount: number) => void) | undefined
postprocess_setGIScene: ((headerPtr: number, headerCount: number, sdfPtr: number, sdfCount: number, instancesPtr: number, instanceCount: number, pixelsPtr: number, pixelCount: number) => boolean) | undefined
postprocess_setMsaaSamples: (samples: number) => void
postprocess_setOutputTransform: ((transform: number) => void) | undefined
postprocess_setOutputViewport: (x: number, y: number, w: number, h: number) => void
postprocess_setPassContinuesEffect: (name: string) => void
postprocess_setPassScale: (name: string, scale: number) => void
postprocess_setPassTexture: (passName: string, uniform: string, textureHandle: number) => void
postprocess_setPresentRequired: ((required: boolean) => void) | undefined
postprocess_setScreenUniformFloat: (passName: string, uniform: string, value: number) => void
postprocess_setScreenUniformVec4: (passName: string, uniform: string, x: number, y: number, z: number, w: number) => void
postprocess_setUniformFloat: (passName: string, uniform: string, value: number) => void
postprocess_setUniformVec4: (passName: string, uniform: string, x: number, y: number, z: number, w: number) => void
postprocess_setViewExposure: ((ev: number) => void) | undefined
postprocess_shutdown: () => void
postprocess_supportsCompute: (() => boolean) | undefined
postprocess_takeSkyCapture: ((dst: number, bytes: number) => boolean) | undefined
postprocess_updateGIField: ((headerPtr: number, headerCount: number, sdfPtr: number, sdfOffset: number, sdfCount: number) => boolean) | undefined
probe_volume_create: ((resX: number, resY: number, resZ: number, shPtr: number) => number) | undefined
probe_volume_release: ((volumeHandle: number) => void) | undefined
probe_volume_setSkyVisibility: ((volumeHandle: number, visibilityPtr: number) => void) | undefined
provideReplacementDevice: (() => boolean) | undefined
recoverDevice: (() => boolean) | undefined
registryLayoutEpoch: (registry: CppRegistry) => number
registry_batchSyncPhysicsTransforms: (registry: CppRegistry, bufferPtr: number, count: number, ppu: number) => void
registry_componentMutationRevision: ((registry: CppRegistry, component: number, topology: boolean) => number) | undefined
registry_entityChangeResetEpoch: ((registry: CppRegistry) => number) | undefined
registry_entityChangeSequence: ((registry: CppRegistry) => number) | undefined
registry_getCameraEntities: (registry: CppRegistry) => number[]
registry_getCanvasEntities: ((registry: CppRegistry) => number[]) | undefined
registry_getCanvasEntity: (registry: CppRegistry) => number
registry_getGeneration: (registry: CppRegistry, entity: number) => number
registry_markComponentsChanged: ((registry: CppRegistry, pairsPtr: number, count: number) => void) | undefined
registry_readEntityChanges: ((registry: CppRegistry, after: number, outputPtr: number, capacity: number) => number) | undefined
registry_readWorldPoses2D: ((registry: CppRegistry, entitiesPtr: number, count: number, outputPtr: number) => number) | undefined
registry_unwatchEntityChanges: ((registry: CppRegistry, reader: number) => void) | undefined
registry_watchEntityChanges: ((registry: CppRegistry) => number) | undefined
renderer_begin: (matrixPtr: number, targetHandle: number, clearFlags: number, r: number, g: number, b: number, a: number, clearX: number, clearY: number, clearW: number, clearH: number) => void
renderer_beginFrame: (elapsedSec: number) => void
renderer_beginScreenOverlay: ((projectionPtr: number, vpX: number, vpY: number, vpW: number, vpH: number) => void) | undefined
renderer_captureFrame: ((w: number, h: number) => number) | undefined
renderer_captureNextFrame: () => void
renderer_createSkeletalPreview: (w: number, h: number) => number
renderer_createTarget: (width: number, height: number, flags: number) => number
renderer_destroySkeletalPreview: (preview: number) => void
renderer_deviceGeneration: (() => number) | undefined
renderer_diagnose: () => void
renderer_end: () => void
renderer_endFrame: (() => void) | undefined
renderer_endScreenOverlay: ((targetHandle: number) => void) | undefined
renderer_entityVisibleToCamera: ((registry: CppRegistry, entity: number, layer: number, minX: number, minY: number, maxX: number, maxY: number, outVisiblePtr: number) => void) | undefined
renderer_flush: () => void
renderer_getCapturedEntities: () => number
renderer_getCapturedEntityCount: () => number
renderer_getCapturedFrameData: () => number
renderer_getCapturedFrameSize: () => number
renderer_getCapturedPassCount: () => number
renderer_getCapturedTextureCount: () => number
renderer_getCapturedTextures: () => number
renderer_getCulled: () => number
renderer_getDrawCalls: () => number
renderer_getEstimatedGpuBytes: (() => number) | undefined
renderer_getGpuDrawCalls: (() => number) | undefined
renderer_getGpuTimeMs: (() => number) | undefined
renderer_getLiveObjects: (() => GfxLiveObjects | null) | undefined
renderer_getMeshes: () => number
renderer_getPendingShaders: (() => number) | undefined
renderer_getPlanarReflectionStatus: ((view: number, entity: number) => string) | undefined
renderer_getPreviewHeight: () => number
renderer_getPreviewPtr: () => number
renderer_getPreviewSize: () => number
renderer_getPreviewWidth: () => number
renderer_getSkeletal: (() => number) | undefined
renderer_getSkeletalPreviewHeight: (preview: number) => number
renderer_getSkeletalPreviewPtr: (preview: number) => number
renderer_getSkeletalPreviewSize: (preview: number) => number
renderer_getSkeletalPreviewWidth: (preview: number) => number
renderer_getSnapshotHeight: () => number
renderer_getSnapshotPtr: () => number
renderer_getSnapshotSize: () => number
renderer_getSnapshotWidth: () => number
renderer_getSprites: () => number
renderer_getTargetDepthTexture: (handle: number) => number
renderer_getTargetTexture: (handle: number) => number
renderer_getText: () => number
renderer_getTextureBytes: (() => number) | undefined
renderer_getTriangles: () => number
renderer_hasCapturedData: () => boolean
renderer_init: (width: number, height: number) => void
renderer_lightStatus: ((entity: number, outPtr: number) => number) | undefined
renderer_lodInspect: ((view: number, entity: number, outPtr: number) => number) | undefined
renderer_materialBakeState: (ticket: number) => number
renderer_pollFrameCapture: ((handle: number) => number) | undefined
renderer_pollPreviewReadback: () => number
renderer_pollProbeCapture: (() => number) | undefined
renderer_pollSkeletalPreview: (preview: number) => number
renderer_pollSnapshotReadback: () => number
renderer_programEpoch: (() => number) | undefined
renderer_queueMaterialBake: (material: number, shader: number, target: number, x: number, y: number, w: number, h: number, a0: number, a1: number, a2: number, a3: number, b0: number, b1: number, b2: number, b3: number) => number
renderer_releaseTarget: (handle: number) => void
renderer_renderMaterialPreview: (materialId: number, w: number, h: number, meshId: number, textureId: number) => void
renderer_renderMeshPreview: (meshId: number, w: number, h: number) => void
renderer_renderSkeletalPreview: (preview: number, viewProjectionPtr: number) => number
renderer_replayToDrawCall: (drawCallIndex: number) => void
renderer_requestProbeCapture: ((x: number, y: number, z: number, face: number) => void) | undefined
renderer_resize: (width: number, height: number) => void
renderer_retainedTextBatch: ((entity: number, verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, pageId: number, glyphMode: number) => void) | undefined
renderer_retainedTextBegin: ((entity: number, sdf: number, screen: number, hasBox: number, layer: number, boxWidth: number, boxHeight: number, autoKind: number) => void) | undefined
renderer_retainedTextClear: ((entity: number) => void) | undefined
renderer_retainedTextStale: ((registry: CppRegistry, outPtr: number, capacity: number) => number) | undefined
renderer_retainedTextSubmit: ((registry: CppRegistry, screen: number, projectionPtr: number) => void) | undefined
renderer_setAsyncShaderCompile: ((on: boolean) => void) | undefined
renderer_setClearColor: (r: number, g: number, b: number, a: number) => void
renderer_setColorSpace: ((linear: number) => void) | undefined
renderer_setCullingMask: ((mask: number) => void) | undefined
renderer_setDepthLayers: ((mask: number) => void) | undefined
renderer_setDepthPrepass: ((on: boolean) => void) | undefined
renderer_setEntityDrawOrder: ((registry: CppRegistry, entitiesPtr: number, count: number) => void) | undefined
renderer_setImpostorAtlas: ((entity: number, texture: number, frames: number) => void) | undefined
renderer_setLightingDirect: ((on: boolean) => void) | undefined
renderer_setLodPreview: ((view: number, entity: number, level: number) => void) | undefined
renderer_setMeshEdgeBuffers: ((enabled: boolean) => void) | undefined
renderer_setOrigin: ((x: number, y: number, z: number) => void) | undefined
renderer_setPlanarReflectionQuality: ((scale: number, maxSize: number, updatesPerSecond: number) => void) | undefined
renderer_setProbeVolumeOverride: ((entity: number, volumeHandle: number) => void) | undefined
renderer_setProbeVolumeReflection: ((entity: number, environmentHandle: number, slot: number) => void) | undefined
renderer_setQualityBudgets: ((atlasSize: number, cellSize: number, cascades: number, particleLimit: number) => void) | undefined
renderer_setShadow2DSoftSamples: ((samples: number) => void) | undefined
renderer_setShadowDistance: ((distance: number) => void) | undefined
renderer_setSkyEnvironment: ((environmentHandle: number) => void) | undefined
renderer_setStage: (stage: number) => void
renderer_setTextureParams: (textureId: number, minFilter: number, magFilter: number, wrapS: number, wrapT: number) => void
renderer_setTreeSortLayers: ((mask: number) => void) | undefined
renderer_setViewId: ((view: number) => void) | undefined
renderer_setViewLighting: ((mode: number, rotationDegrees: number, keyIntensity: number, fillIntensity: number, skyIntensity: number, showSky: boolean) => void) | undefined
renderer_setViewShading: ((view: number, mode: number) => void) | undefined
renderer_setViewSkinWeights: ((view: number, entity: number, joint: number) => void) | undefined
renderer_setViewport: (x: number, y: number, w: number, h: number) => void
renderer_setWorldUnitsPerMeter: ((units: number) => void) | undefined
renderer_setYSortLayers: ((mask: number) => void) | undefined
renderer_shadowStatus: ((entity: number, outPtr: number) => number) | undefined
renderer_snapshotMatchesCapture: () => boolean
renderer_submitAll: (registry: CppRegistry, vpX: number, vpY: number, vpW: number, vpH: number) => void
renderer_submitScreenOverlay: ((registry: CppRegistry) => void) | undefined
renderer_submitSkeletalBatchByEntity: ((registry: CppRegistry, verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, textureId: number, blendMode: number, entity: number, skelScale: number, flipX: boolean, flipY: boolean, layer: number, depth: number, materialId: number) => void) | undefined
renderer_submitSkeletalBatchByEntityEx: ((registry: CppRegistry, verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, textureId: number, blendMode: number, entity: number, skelScale: number, flipX: boolean, flipY: boolean, layer: number, depth: number, materialId: number, premultipliedColor: boolean) => void) | undefined
renderer_submitSkeletalPreviewBatch: (preview: number, verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, textureId: number, blendMode: number, transformPtr: number, layer: number, depth: number, materialId: number) => number
renderer_submitSkeletalPreviewBatchEx: (preview: number, verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, textureId: number, blendMode: number, transformPtr: number, layer: number, depth: number, materialId: number, premultipliedColor: boolean) => number
renderer_submitTextBatch: ((verticesPtr: number, vertexCount: number, indicesPtr: number, indexCount: number, textureId: number, transformPtr: number, entity: number, layer: number, depth: number, glyphMode: number, cullBit: number) => void) | undefined
renderer_takeFrameCapture: ((handle: number, dest: number, destSize: number) => boolean) | undefined
renderer_takeProbeCapture: ((dst: number, bytes: number) => boolean) | undefined
renderer_takeTextureWants: (() => string) | undefined
renderer_updateTransforms: (registry: CppRegistry) => void
sdfFromAlpha: ((alphaPtr: number, outPtr: number, width: number, height: number, spread: number) => void) | undefined
setActiveContext: (ctx: CppEngineContext | null) => void
shutdownRenderer: () => void
springbone_release: ((registry: CppRegistry, entity: number) => void) | undefined
springbone_reset: ((registry: CppRegistry, entity: number) => void) | undefined
springbone_snapshot: ((registry: CppRegistry, entity: number) => number) | undefined
springbone_snapshotCount: (() => number) | undefined
springbone_snapshotData: (() => number) | undefined
springbone_update: ((registry: CppRegistry, dt: number) => void) | undefined
tilemap_destroyLayer: ((entity: number) => void) | undefined
tilemap_exportChunks: ((entity: number) => string) | undefined
tilemap_fillRect: ((entity: number, x: number, y: number, w: number, h: number, tileId: number) => void) | undefined
tilemap_getEditRevision: ((entity: number) => number) | undefined
tilemap_getGeneration: ((entity: number) => number) | undefined
tilemap_getTile: ((entity: number, x: number, y: number) => number) | undefined
tilemap_hasLayer: ((entity: number) => boolean) | undefined
tilemap_importChunks: ((entity: number, encoded: string) => boolean) | undefined
tilemap_initInfinite: ((entity: number, tileWidth: number, tileHeight: number) => void) | undefined
tilemap_initLayer: ((entity: number, width: number, height: number, tileWidth: number, tileHeight: number) => void) | undefined
tilemap_readChunkIndex: ((entity: number, rowsPtr: number, capacity: number) => number) | undefined
tilemap_readChunkTiles: ((entity: number, chunkX: number, chunkY: number, tilesPtr: number, capacity: number) => boolean) | undefined
tilemap_setTile: ((entity: number, x: number, y: number, tileId: number) => void) | undefined
tilemap_setTiles: ((entity: number, tilesPtr: number, count: number) => void) | undefined
trail_clear: ((registry: CppRegistry, entity: number) => void) | undefined
trail_update: ((registry: CppRegistry, dt: number) => void) | undefined
transform_compositionChanges: (() => { serial: number; tracking: boolean; overflowed: boolean; count: number; visited: number; ptr: number; }) | undefined
transform_copyFlatRenderMatrix: ((registry: CppRegistry, entity: number, outputPtr: number) => boolean) | undefined
transform_ensureComposed: ((registry: CppRegistry) => void) | undefined
transform_epochAddress: (() => number) | undefined
transform_setChangeTracking: ((on: boolean) => void) | undefined
transform_takeChanges: (() => void) | undefined
transform_update: (registry: CppRegistry) => void
uiHitTest_getHitEntity: () => number
uiHitTest_pick: ((registry: CppRegistry, worldX: number, worldY: number) => number) | undefined
uiHitTest_pickAll: ((registry: CppRegistry, worldX: number, worldY: number) => number) | undefined
uiHitTest_pickResult: ((index: number) => number) | undefined
uiHitTest_update: (registry: CppRegistry, originX: number, originY: number, originZ: number, dirX: number, dirY: number, dirZ: number) => void
uiHitTest_updateDomains: ((registry: CppRegistry, worldOriginX: number, worldOriginY: number, worldOriginZ: number, worldDirX: number, worldDirY: number, worldDirZ: number, screenOriginX: number, screenOriginY: number, screenOriginZ: number, screenDirX: number, screenDirY: number, screenDirZ: number) => void) | undefined
uiLayout_update: (registry: CppRegistry, boxLeft: number, boxBottom: number, boxRight: number, boxTop: number, propertyDirty: boolean) => void
uiNode_computedHeight: (registry: CppRegistry, entity: number) => number
uiNode_computedWidth: (registry: CppRegistry, entity: number) => number
uiRenderOrder_update: (registry: CppRegistry) => void
ui_getCullBit: ((registry: CppRegistry, entity: number) => number) | undefined
ui_getRenderOrder: ((registry: CppRegistry, entity: number) => number) | undefined
ui_isScreenDomain: ((registry: CppRegistry, entity: number) => boolean) | undefined
wasmMemory: WebAssembly.Memory | undefined

EmscriptenFS — interface @experimental

analyzePath: (path: string) => { exists: boolean; parentExists: boolean; }
isDir: (mode: number) => boolean
isFile: (mode: number) => boolean
mkdir: (path: string) => void
mkdirTree: (path: string) => void
readFile: (path: string, opts?: { encoding?: string; }) => string | Uint8Array
stat: (path: string) => { mode: number; size: number; }
unlink: (path: string) => void
writeFile: (path: string, data: string | Uint8Array) => void

GfxLiveObjects — interface @experimental

buffers: number
layouts: number
pipelines: number
programs: number
readbacks: number
renderTargets: number
textures: number

TextureContent — type @experimental

typeof TextureContent[keyof typeof TextureContent]

textureContentName — function @experimental

(content: TextureContent): string