gpu-curtains
    Preparing search index...

    Interface RenderPassOptions

    Options used to create this RenderPass.

    interface RenderPassOptions {
        label: string;
        sampleCount: number;
        qualityRatio: number;
        fixedSize: TextureSize;
        useColorAttachments: boolean;
        renderToSwapChain: boolean;
        colorAttachments: ColorAttachmentParams[];
        useDepth: boolean;
        depthTexture?: Texture;
        depthLoadOp: GPULoadOp;
        forceDepthLoadOp: GPULoadOp;
        depthStoreOp: GPUStoreOp;
        forceDepthStoreOp: GPUStoreOp;
        depthClearValue: number;
        depthFormat: GPUTextureFormat;
        depthReadOnly: boolean;
        forceDepthReadOnly: boolean;
        stencilClearValue: number;
        stencilLoadOp: GPULoadOp;
        forceStencilLoadOp: GPULoadOp;
        stencilStoreOp: GPUStoreOp;
        forceStencilStoreOp: GPUStoreOp;
        stencilReadOnly: boolean;
        forceStencilReadOnly: boolean;
    }
    Index

    Properties

    label sampleCount qualityRatio fixedSize useColorAttachments renderToSwapChain colorAttachments useDepth depthTexture? depthLoadOp forceDepthLoadOp depthStoreOp forceDepthStoreOp depthClearValue depthFormat depthReadOnly forceDepthReadOnly stencilClearValue stencilLoadOp forceStencilLoadOp stencilStoreOp forceStencilStoreOp stencilReadOnly forceStencilReadOnly

    Properties

    label: string

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

    sampleCount: number

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

    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.

    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.

    useColorAttachments: boolean

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

    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.

    colorAttachments: ColorAttachmentParams[]

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

    useDepth: boolean

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

    depthTexture?: Texture

    Whether this RenderPass should use an already created depth texture.

    depthLoadOp: GPULoadOp

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

    forceDepthLoadOp: GPULoadOp

    Force the depthLoadOp behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    depthStoreOp: GPUStoreOp

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

    forceDepthStoreOp: GPUStoreOp

    Force the depthStoreOp behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    depthClearValue: number

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

    depthFormat: GPUTextureFormat

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

    depthReadOnly: boolean

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

    forceDepthReadOnly: boolean

    Force the depthReadOnly behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    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.

    stencilLoadOp: GPULoadOp

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

    forceStencilLoadOp: GPULoadOp

    Force the stencilLoadOp behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    stencilStoreOp: GPUStoreOp

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

    forceStencilStoreOp: GPUStoreOp

    Force the stencilStoreOp behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    stencilReadOnly: boolean

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

    forceStencilReadOnly: boolean

    Force the stencilReadOnly behaviour of this RenderPass instead on relying on the Scene default one. Default to null.

    Settings

    Member Visibility

    On This Page

    Properties