Interface RenderPassOptions

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

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

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.

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.

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

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

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

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

Whether this RenderPass should use an already created depth texture.

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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