Interface RenderTargetOptions

Options used to create a RenderTarget.

interface RenderTargetOptions {
    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;
    depthReadOnly?: boolean;
    stencilClearValue?: number;
    stencilLoadOp?: GPULoadOp;
    stencilStoreOp?: GPUStoreOp;
    stencilReadOnly?: boolean;
    autoRender: boolean;
    renderTextureName: string;
}

Hierarchy (View Summary)

Properties

label? sampleCount? qualityRatio? fixedSize? useColorAttachments? renderToSwapChain? colorAttachments? useDepth? depthTexture? depthLoadOp? depthStoreOp? depthClearValue? depthFormat? depthReadOnly? stencilClearValue? stencilLoadOp? stencilStoreOp? stencilReadOnly? autoRender renderTextureName

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. Default to 4.

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. Default to 1.

OptionalfixedSize

fixedSize?: TextureSize

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

OptionaluseColorAttachments

useColorAttachments?: boolean

Whether this RenderPass should handle a view texture. Default to true.

OptionalrenderToSwapChain

renderToSwapChain?: boolean

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

OptionalcolorAttachments

colorAttachments?: ColorAttachmentParams[]

Array of one or multiple (Multiple Render Targets) color attachments parameters. Default to [].

OptionaluseDepth

useDepth?: boolean

Whether this RenderPass should handle a depth texture. Default to true.

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. Default to 'clear.

OptionaldepthStoreOp

depthStoreOp?: GPUStoreOp

The depth store operation to perform while drawing this RenderPass. Default to 'store'.

OptionaldepthClearValue

depthClearValue?: number

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

OptionaldepthFormat

depthFormat?: GPUTextureFormat

Optional format of the depth texture. Default to 'depth24plus'.

OptionaldepthReadOnly

depthReadOnly?: boolean

Indicates that the depth component of the depth texture view is read only. Default to false.

OptionalstencilClearValue

stencilClearValue?: number

A number indicating the value to clear view's stencil component to prior to executing the render pass. This is ignored if stencilLoadOp is not set to "clear". Default to 0.

OptionalstencilLoadOp

stencilLoadOp?: GPULoadOp

The stencil load operation to perform while drawing this RenderPass. Default to 'clear.

OptionalstencilStoreOp

stencilStoreOp?: GPUStoreOp

The stencil store operation to perform while drawing this RenderPass. Default to 'store'.

OptionalstencilReadOnly

stencilReadOnly?: boolean

Indicates that the stencil component of the depth texture view is read only. Default to false.

autoRender

autoRender: boolean

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

renderTextureName

renderTextureName: string

Texture name to use for the RenderTarget render texture. Default to 'renderTexture'.

Settings

Member Visibility

On This Page

Properties