Gfx3Manager
[
Front page
] [
New
|
Page list
|
Search
|
Recent changes
|
Help
|
Log in
]
Start:
* Class: Gfx3Manager
Singleton 3D graphics manager.~
** Constructors
- ''new Gfx3Manager''(): Gfx3Manager~
** Methods
- ''beginDrawing''(): void~
Prepare the draw process.~
Warning: You need to call this method before your draw ca...
~
- ''beginPassRender''(viewIndex: number): void~
Prepare a render pass.~
Warning: You need to call this method before the render c...
-- ''viewIndex''~
~
- ''beginRender''(): void~
Prepare the render process.~
Warning: You need to call this method before your render ...
~
- ''changeView''(index: number, view: Gfx3View): void~
Change the view at a specified index.~
-- ''index'': The index of the view should be changed.~
-- ''view'': The view.~
~
- ''createCubeMapFromBitmap''(bitmaps): Gfx3Texture~
Creates a cubemap texture from a list of bitmaps or canva...
-- ''bitmaps'': The list of six bitmaps.~
~
- ''createDynamicGroup''(pipelineId: string, groupIndex: ...
Creates a dynamic group for a given pipeline and group in...
-- ''pipelineId'': The unique identifier of a pipeline.~
-- ''groupIndex'': The uniform group index in the shader.~
~
- ''createEmptyTexture''(width: number, height: number, f...
Creates an empty GPU texture with the given size.~
-- ''width'': The texture width.~
-- ''height'': The texture height.~
-- ''format''~
-- ''samplerDescriptor'': The sampler texture configurati...
~
- ''createRenderingTexture''(format: GPUTextureFormat): G...
Creates a default rendering texture.~
-- ''format''~
~
- ''createStaticGroup''(pipelineId: string, groupIndex: n...
Creates a static group for a given pipeline and group ind...
-- ''pipelineId'': The unique identifier of a pipeline.~
-- ''groupIndex'': The uniform group index in the shader.~
~
- ''createTextureFromBitmap''(bitmap, is8bit: boolean, sa...
Creates a GPU texture from a given bitmap image or canvas...
-- ''bitmap'': The source image.~
-- ''is8bit'': Indicates whether the texture should be tr...
-- ''samplerDescriptor'': The sampler texture configurati...
~
- ''createVertexBuffer''(size: number): VertexSubBuffer~
Creates a vertex sub-buffer and returns it.~
Note: A sub-buffer is just a reference offset/size pointi...
-- ''size'': The number of vertices.~
~
- ''createView''(): Gfx3View~
Create a new view and return it.~
~
- ''deletePipeline''(id: string): void~
Delete a GPU render pipeline.~
-- ''id'': The identifier of the pipeline.~
~
- ''destroyVertexBuffer''(sub: VertexSubBuffer): void~
Removes a vertex sub-buffer.~
-- ''sub'': The vertex sub-buffer.~
~
- ''endDrawing''(): void~
Close the draw process.~
Warning: You need to call this method after your draw cal...
~
- ''endPassRender''(): void~
Close a render pass.~
Warning: You need to call this method after the render ca...
~
- ''endRender''(): void~
Close the render process.~
Warning: You need to call this method after your render c...
~
- ''getClientHeight''(): number~
Returns the client height of the canvas.~
~
- ''getClientWidth''(): number~
Returns the client width of the canvas.~
~
- ''getCommandEncoder''(): GPUCommandEncoder~
Returns the GPUCommandEncoder.~
~
- ''getContext''(): GPUCanvasContext~
Returns the GPUCanvasContext object.~
~
- ''getCurrentRenderingTexture''(): GPUTexture~
Returns the current rendering texture.~
Note: Is the texture used for final rendering.~
~
- ''getCurrentView''(): Gfx3View~
Returns the current view.~
Note: Current view is set by the "begin" function.~
~
- ''getDepthTexture''(): Gfx3Texture~
Returns the depth texture.~
~
- ''getDevice''(): GPUDevice~
Returns the GPU device.~
~
- ''getHeight''(): number~
Returns the resolution height of the canvas.~
~
- ''getIdsTexture''(): Gfx3Texture~
Returns the rendering texture contains ids.~
~
- ''getLastRenderTime''(): number~
Returns the last render time.~
~
- ''getNormalsTexture''(): Gfx3Texture~
Returns the rendering texture contains normals.~
~
- ''getNumViews''(): number~
Returns the number of views.~
~
- ''getPassEncoder''(): GPURenderPassEncoder~
Returns the current WebGPU render pass encoder.~
~
- ''getPipeline''(id: string): GPURenderPipeline~
Returns a GPU render pipeline.~
-- ''id'': The identifier of the pipeline.~
~
- ''getVertexBuffer''(): GPUBuffer~
Returns the big one vertex buffer.~
~
- ''getView''(index: number): Gfx3View~
Returns the view at the specified index.~
-- ''index'': The index.~
~
- ''getWidth''(): number~
Returns the resolution width of the canvas.~
~
- ''hasFilter''(): boolean~
Checks if the canvas element has an active filter.~
~
- ''initialize''(): Promise~
Initializes the WebGPU rendering context (internal use on...
~
- ''loadPipeline''(id: string, vertexShader: string, frag...
Creates and returns a GPU render pipeline using the provi...
-- ''id'': A unique identifier for the render pipeline.~
-- ''vertexShader'': The code for the vertex shader.~
-- ''fragmentShader'': The code for the fragment shader.~
-- ''pipelineDesc'': The configuration of the pipeline, s...
~
- ''removeView''(view: Gfx3View): void~
Removes a view.~
-- ''view'': The view.~
~
- ''removeViewAt''(index: number): void~
Removes a view at specified index.~
-- ''index'': The index of the view.~
~
- ''setDestinationTexture''(destinationTexture): void~
The destination texture is used for multi-pass rendering.~
Note: If destination texture is set, we render to the des...
otherwise we are rendering to the screen directly.~
-- ''destinationTexture'': The destination texture.~
~
- ''setFilter''(filter: string): void~
Sets the css filter property of the canvas.~
-- ''filter'': The filter parameter is a string that repr...
It can be used to apply various visual effects to an elem...
grayscale, etc.~
~
- ''writeVertexBuffer''(sub: VertexSubBuffer, vertices: n...
Write data on vertex sub-buffer.~
-- ''sub'': The vertex sub-buffer.~
-- ''vertices'': The vertex data.~
End:
* Class: Gfx3Manager
Singleton 3D graphics manager.~
** Constructors
- ''new Gfx3Manager''(): Gfx3Manager~
** Methods
- ''beginDrawing''(): void~
Prepare the draw process.~
Warning: You need to call this method before your draw ca...
~
- ''beginPassRender''(viewIndex: number): void~
Prepare a render pass.~
Warning: You need to call this method before the render c...
-- ''viewIndex''~
~
- ''beginRender''(): void~
Prepare the render process.~
Warning: You need to call this method before your render ...
~
- ''changeView''(index: number, view: Gfx3View): void~
Change the view at a specified index.~
-- ''index'': The index of the view should be changed.~
-- ''view'': The view.~
~
- ''createCubeMapFromBitmap''(bitmaps): Gfx3Texture~
Creates a cubemap texture from a list of bitmaps or canva...
-- ''bitmaps'': The list of six bitmaps.~
~
- ''createDynamicGroup''(pipelineId: string, groupIndex: ...
Creates a dynamic group for a given pipeline and group in...
-- ''pipelineId'': The unique identifier of a pipeline.~
-- ''groupIndex'': The uniform group index in the shader.~
~
- ''createEmptyTexture''(width: number, height: number, f...
Creates an empty GPU texture with the given size.~
-- ''width'': The texture width.~
-- ''height'': The texture height.~
-- ''format''~
-- ''samplerDescriptor'': The sampler texture configurati...
~
- ''createRenderingTexture''(format: GPUTextureFormat): G...
Creates a default rendering texture.~
-- ''format''~
~
- ''createStaticGroup''(pipelineId: string, groupIndex: n...
Creates a static group for a given pipeline and group ind...
-- ''pipelineId'': The unique identifier of a pipeline.~
-- ''groupIndex'': The uniform group index in the shader.~
~
- ''createTextureFromBitmap''(bitmap, is8bit: boolean, sa...
Creates a GPU texture from a given bitmap image or canvas...
-- ''bitmap'': The source image.~
-- ''is8bit'': Indicates whether the texture should be tr...
-- ''samplerDescriptor'': The sampler texture configurati...
~
- ''createVertexBuffer''(size: number): VertexSubBuffer~
Creates a vertex sub-buffer and returns it.~
Note: A sub-buffer is just a reference offset/size pointi...
-- ''size'': The number of vertices.~
~
- ''createView''(): Gfx3View~
Create a new view and return it.~
~
- ''deletePipeline''(id: string): void~
Delete a GPU render pipeline.~
-- ''id'': The identifier of the pipeline.~
~
- ''destroyVertexBuffer''(sub: VertexSubBuffer): void~
Removes a vertex sub-buffer.~
-- ''sub'': The vertex sub-buffer.~
~
- ''endDrawing''(): void~
Close the draw process.~
Warning: You need to call this method after your draw cal...
~
- ''endPassRender''(): void~
Close a render pass.~
Warning: You need to call this method after the render ca...
~
- ''endRender''(): void~
Close the render process.~
Warning: You need to call this method after your render c...
~
- ''getClientHeight''(): number~
Returns the client height of the canvas.~
~
- ''getClientWidth''(): number~
Returns the client width of the canvas.~
~
- ''getCommandEncoder''(): GPUCommandEncoder~
Returns the GPUCommandEncoder.~
~
- ''getContext''(): GPUCanvasContext~
Returns the GPUCanvasContext object.~
~
- ''getCurrentRenderingTexture''(): GPUTexture~
Returns the current rendering texture.~
Note: Is the texture used for final rendering.~
~
- ''getCurrentView''(): Gfx3View~
Returns the current view.~
Note: Current view is set by the "begin" function.~
~
- ''getDepthTexture''(): Gfx3Texture~
Returns the depth texture.~
~
- ''getDevice''(): GPUDevice~
Returns the GPU device.~
~
- ''getHeight''(): number~
Returns the resolution height of the canvas.~
~
- ''getIdsTexture''(): Gfx3Texture~
Returns the rendering texture contains ids.~
~
- ''getLastRenderTime''(): number~
Returns the last render time.~
~
- ''getNormalsTexture''(): Gfx3Texture~
Returns the rendering texture contains normals.~
~
- ''getNumViews''(): number~
Returns the number of views.~
~
- ''getPassEncoder''(): GPURenderPassEncoder~
Returns the current WebGPU render pass encoder.~
~
- ''getPipeline''(id: string): GPURenderPipeline~
Returns a GPU render pipeline.~
-- ''id'': The identifier of the pipeline.~
~
- ''getVertexBuffer''(): GPUBuffer~
Returns the big one vertex buffer.~
~
- ''getView''(index: number): Gfx3View~
Returns the view at the specified index.~
-- ''index'': The index.~
~
- ''getWidth''(): number~
Returns the resolution width of the canvas.~
~
- ''hasFilter''(): boolean~
Checks if the canvas element has an active filter.~
~
- ''initialize''(): Promise~
Initializes the WebGPU rendering context (internal use on...
~
- ''loadPipeline''(id: string, vertexShader: string, frag...
Creates and returns a GPU render pipeline using the provi...
-- ''id'': A unique identifier for the render pipeline.~
-- ''vertexShader'': The code for the vertex shader.~
-- ''fragmentShader'': The code for the fragment shader.~
-- ''pipelineDesc'': The configuration of the pipeline, s...
~
- ''removeView''(view: Gfx3View): void~
Removes a view.~
-- ''view'': The view.~
~
- ''removeViewAt''(index: number): void~
Removes a view at specified index.~
-- ''index'': The index of the view.~
~
- ''setDestinationTexture''(destinationTexture): void~
The destination texture is used for multi-pass rendering.~
Note: If destination texture is set, we render to the des...
otherwise we are rendering to the screen directly.~
-- ''destinationTexture'': The destination texture.~
~
- ''setFilter''(filter: string): void~
Sets the css filter property of the canvas.~
-- ''filter'': The filter parameter is a string that repr...
It can be used to apply various visual effects to an elem...
grayscale, etc.~
~
- ''writeVertexBuffer''(sub: VertexSubBuffer, vertices: n...
Write data on vertex sub-buffer.~
-- ''sub'': The vertex sub-buffer.~
-- ''vertices'': The vertex data.~
Page: