Interface RenderPassParams

Parameters used to create this RenderPass.

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

Hierarchy (View Summary)

Properties

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

Properties

Optionallabel

label?: string

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

OptionalsampleCount

sampleCount?: number

Whether the view and depth textures should use multisampling or not.

OptionalqualityRatio

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.

OptionalfixedSize

fixedSize?: TextureSize

Force the all the RenderPass textures to be set at given size. Used mainly to lower the rendered definition.

OptionaluseColorAttachments

useColorAttachments?: boolean

Whether this RenderPass should handle a view texture.

OptionalrenderToSwapChain

renderToSwapChain?: boolean

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

OptionalcolorAttachments

colorAttachments?: ColorAttachmentParams[]

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

OptionaluseDepth

useDepth?: boolean

Whether this RenderPass should handle a depth texture.

OptionaldepthTexture

depthTexture?: Texture

Whether this RenderPass should use an already created depth texture.

OptionaldepthLoadOp

depthLoadOp?: GPULoadOp

The depth load operation to perform while drawing this RenderPass.

OptionaldepthStoreOp

depthStoreOp?: GPUStoreOp

The depth store operation to perform while drawing this RenderPass.

OptionaldepthClearValue

depthClearValue?: number

The depth clear value to clear to before drawing this RenderPass.

OptionaldepthFormat

depthFormat?: GPUTextureFormat

Optional format of the depth texture.

Settings

Member Visibility

On This Page

Properties