@tmrw-realityos/charm / Exports
@tmrw-realityos/charm
Table of contents
Classes
- Animation
- Camera
- FrameGraph
- FrameGraphPass
- HDRELoader
- HDRLoader
- KTX2EnvironmentLoader
- KTX2TextureLoader
- KTXLoader
- Material
- Mesh
- Node
- OrbitControl
- ROSEvent
- ROSGrid
- ROSModel
- ROSPlayer
- ResizeObserverHelper
- ResourceStats
- Scene
- TextureHandler
- TinyGltf
- WebGPUBuffer
- WebGPUFramebuffer
- WebGPUMesh
- WebGPUMeshPicker
- WebGPUPBRShaderBuilder
- WebGPUPostFX
- WebGPURenderContext
- WebGPURenderer
- WebGPUSceneToRenderables
- WebGPUShader
- WebGPUTexture
Interfaces
Type Aliases
Functions
Type Aliases
GlTfId
Ƭ GlTfId: number
Defined in
packages/charm/src/fileFormats/GLTF.ts:2
Functions
createTextureFromImage
▸ createTextureFromImage(device, image): WebGPUTexture
Create WebGPU texture from HTML image
Parameters
| Name | Type | Description |
|---|---|---|
device | GPUDevice | GPU device |
image | HTMLImageElement | Image |
Returns
WebGPU texture in rgba8unorm format
Defined in
packages/charm/src/graphics/WebGPU/WebGPUTextureTools.ts:14
createTextureFromKTX2Data
▸ createTextureFromKTX2Data(device, data, existingLoader?): WebGPUTexture
Create a GPU texture in compressed or uncompressed format, depending on device features.
Parameters
| Name | Type | Description |
|---|---|---|
device | GPUDevice | GPU device |
data | ArrayBuffer | KTX data as arraybuffer |
existingLoader? | KTX2TextureLoader | Existing KTX2 texture loader. |
Returns
WebGPU texture in compressed format
Defined in
packages/charm/src/graphics/WebGPU/WebGPUTextureTools.ts:30
getDevice
▸ getDevice(): Promise<GPUDevice>
Returns
Promise<GPUDevice>
Defined in
packages/charm/src/graphics/WebGPU/WebGPUDevice.ts:1
on
▸ on<T>(el, evt, cb): RemoveEventListener
Utility function to register and unregister event handlers in the DOM.
Normally, many things can go wrong in the traditional pattern of addEventListener and removeEventListener. If the function ref being passed to removeEventListener is not exactly identical to the function passed to addEventListener, the callback will not be removed and thus cause a leak. This pattern takes care of this issue.
Encourages a naming convention of "on" to register an event listener and "off" to remove it.
Type parameters
| Name | Type |
|---|---|
T | extends Element |
Parameters
| Name | Type |
|---|---|
el | T |
evt | string |
cb | (event: Event) => void |
Returns
RemoveEventListener
Defined in
packages/charm/src/helpers/events.ts:11
readDepthTexture
▸ readDepthTexture(context, depthTexture, pixelCoordinates, flipY?): Promise<Float32Array>
Read pixel values from a depth texture
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
context | WebGPURenderContext | undefined | Rendering context |
depthTexture | GPUTexture | undefined | Depth texture to read from, must be created with GPUTextureUsage.TEXTURE_BINDING. Can be multisampled. |
pixelCoordinates | vec3[] | [number, number][] | [number, number, number][] | vec2[] | undefined | Array of coordinates to read |
flipY | boolean | false | Flip the y pixel coordinate |
Returns
Promise<Float32Array>
Array of length pixelCoordinates.length containing the depth texture values
Defined in
packages/charm/src/graphics/WebGPU/WebGPUTextureTools.ts:123