Interface: ClearOptions

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:57

The options for clearing the render target.

Advanced

Extended by

• RenderOptions

Properties

clear?

> optional clear?: CLEAR_OR_BOOL

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:66

The clear mode to use.

clearColor?

> optional clearColor?: ColorSource

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:64

The color to clear with.

layer?

> optional layer?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:84

Array layer index to render/clear to when the target is an array-backed texture source (e.g. arrayLayerCount > 1).

This maps to WebGPU's GPUTextureViewDescriptor.baseArrayLayer when creating render-attachment views.

Default

0

Advanced

mipLevel?

> optional mipLevel?: number

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:76

Mip level to render/clear to when the target is a texture-backed render surface.

Default

0

Note: When rendering to a Texture target, Pixi renders into the underlying TextureSource (via an internal RenderTarget). The texture's frame is interpreted in mip 0 space and is scaled/clamped to the requested mip level.

Advanced

target?

> optional target?: RenderSurface

Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/system/AbstractRenderer.d.ts:62

The render target to render. if this target is a canvas and you are using the WebGL renderer, please ensure you have set multiView to true on renderer.