Class CanvasRenderTargetAdaptor`Advanced`

Canvas adaptor for render targets.

Index

Constructors

Methods

clear copyToTexture destroyGpuRenderTarget finishRenderPass init initGpuRenderTarget resizeGpuRenderTarget startRenderPass

Constructors

constructor

new CanvasRenderTargetAdaptor(): CanvasRenderTargetAdaptor
Returns CanvasRenderTargetAdaptor

Methods

clear

clear(
    renderTarget: RenderTarget,
    _clear: CLEAR_OR_BOOL,
    clearColor?: number[],
    viewport?: Rectangle,
): void
Advanced
Clears the render target.
Parameters
- renderTarget: RenderTarget
  Target to clear.
- _clear: CLEAR_OR_BOOL
  Clear mode (unused).
- OptionalclearColor: number[]
  Optional clear color.
- Optionalviewport: Rectangle
  Optional viewport rectangle.
Returns void
Implementation of RenderTargetAdaptor.clear

copyToTexture

copyToTexture(
    sourceRenderSurfaceTexture: RenderTarget,
    destinationTexture: Texture,
    originSrc: { x: number; y: number },
    size: { height: number; width: number },
    originDest?: { x: number; y: number },
): Texture
Advanced
Copies a render target into a texture source.
Parameters
- sourceRenderSurfaceTexture: RenderTarget
  Source render target.
- destinationTexture: Texture
  Destination texture.
- originSrc: { x: number; y: number }
  Source origin.
  - x: number
    Source x origin.
  - y: number
    Source y origin.
- size: { height: number; width: number }
  Copy size.
  - height: number
    Copy height.
  - width: number
    Copy width.
- OptionaloriginDest: { x: number; y: number }
  Destination origin.
  - x: number
    Destination x origin.
  - y: number
    Destination y origin.
Returns Texture
Implementation of RenderTargetAdaptor.copyToTexture

destroyGpuRenderTarget

destroyGpuRenderTarget(_gpuRenderTarget: CanvasRenderTarget): void
Advanced
Destroys a GPU render target (no-op for canvas).
Parameters
- _gpuRenderTarget: CanvasRenderTarget
  Target to destroy.
Returns void
Implementation of RenderTargetAdaptor.destroyGpuRenderTarget

finishRenderPass

finishRenderPass(): void
Advanced
Finishes the render pass (no-op for canvas).

Returns void
Implementation of RenderTargetAdaptor.finishRenderPass

init

init(
renderer: CanvasRenderer,
renderTargetSystem: RenderTargetSystem<CanvasRenderTarget>,
): void
Advanced
Initializes the adaptor.
Parameters
- renderer: CanvasRenderer
  Canvas renderer instance.
- renderTargetSystem: RenderTargetSystem<CanvasRenderTarget>
  The render target system.
Returns void
Implementation of RenderTargetAdaptor.init

initGpuRenderTarget

initGpuRenderTarget(renderTarget: RenderTarget): CanvasRenderTarget
Advanced
Creates a GPU render target for canvas.
Parameters
- renderTarget: RenderTarget
  Render target to initialize.
Returns CanvasRenderTarget
Implementation of RenderTargetAdaptor.initGpuRenderTarget

resizeGpuRenderTarget

resizeGpuRenderTarget(renderTarget: RenderTarget): void
Advanced
Resizes the backing canvas for a render target.
Parameters
- renderTarget: RenderTarget
  Render target to resize.
Returns void
Implementation of RenderTargetAdaptor.resizeGpuRenderTarget

startRenderPass

startRenderPass(
    renderTarget: RenderTarget,
    clear: CLEAR_OR_BOOL,
    clearColor?: number[],
    viewport?: Rectangle,
): void
Advanced
Starts a render pass on the canvas target.
Parameters
- renderTarget: RenderTarget
  Target to render to.
- clear: CLEAR_OR_BOOL
  Clear mode.
- OptionalclearColor: number[]
  Optional clear color.
- Optionalviewport: Rectangle
  Optional viewport.
Returns void
Implementation of RenderTargetAdaptor.startRenderPass