Interface RenderTargetParams

Parameters used to create a RenderTarget

interface RenderTargetParams {
    label?: string;
    sampleCount?: number;
    qualityRatio?: number;
    useColorAttachments?: boolean;
    renderToSwapChain?: boolean;
    colorAttachments?: ColorAttachmentParams[];
    useDepth?: boolean;
    depthTexture?: Texture;
    depthLoadOp?: GPULoadOp;
    depthStoreOp?: GPUStoreOp;
    depthClearValue?: number;
    depthFormat?: GPUTextureFormat;
    autoRender?: boolean;
}

Hierarchy (view full)

Properties

label? sampleCount? qualityRatio? useColorAttachments? renderToSwapChain? colorAttachments? useDepth? depthTexture? depthLoadOp? depthStoreOp? depthClearValue? depthFormat? autoRender?

Properties

Optional label

label?: string

The label of the RenderPass, sent to various GPU objects for debugging purpose

Optional sampleCount

sampleCount?: number

Whether the view and depth textures should use multisampling or not

Optional qualityRatio

qualityRatio?: number

Force all the RenderPass textures size to be set to the given ratio of the renderer canvas size. Used mainly to lower the rendered definition.

Optional useColorAttachments

useColorAttachments?: boolean

Whether this RenderPass should handle a view texture

Optional renderToSwapChain

renderToSwapChain?: boolean

Whether the main (first colorAttachments) view texture should use the content of the swap chain and render to it each frame

Optional colorAttachments

colorAttachments?: ColorAttachmentParams[]

Array of one or multiple (Multiple Render Targets) color attachments parameters.

Optional useDepth

useDepth?: boolean

Whether this RenderPass should handle a depth texture

Optional depthTexture

depthTexture?: Texture

Whether this RenderPass should use an already created depth texture

Optional depthLoadOp

depthLoadOp?: GPULoadOp

The GPULoadOp | depth load operation to perform while drawing this RenderPass

Optional depthStoreOp

depthStoreOp?: GPUStoreOp

The GPUStoreOp | depth store operation to perform while drawing this RenderPass

Optional depthClearValue

depthClearValue?: number

The depth clear value to clear to before drawing this RenderPass

Optional depthFormat

depthFormat?: GPUTextureFormat

Optional format of the depth texture

Optional autoRender

autoRender?: boolean

Whether we should add this RenderTarget to our Scene to let it handle the rendering process automatically

Settings

Member Visibility

Theme

On This Page