RenderPass QML Type

The RenderPass type defines a custom render pass for rendering 3D content. More...

• List of all members, including inherited members

Properties

• augmentShader : url
• clearColor : color
• commands : list<RenderCommand>
• depthClearValue : real
• enableClearBuffers : bool
• materialMode : RenderPass::MaterialModes
• overrideMaterial : Material
• passMode : RenderPass::PassMode
• stencilClearValue : int

Detailed Description

A RenderPass allows you to define a custom rendering step in the rendering pipeline. You can specify various properties such as clear color, material mode, and override materials. Additionally, you can define a list of render commands that dictate how the rendering should be performed.

Exposing data to the shaders

As with Effects and Custom Materials, the RenderPass will expose, and update, user defined properties to the shader automatically.

Property Documentation

augmentShader : url

This property holds the augment shader URL for the render pass when materialMode is set to AugmentMaterial.

The shader file should contain a function with the following signature:

void MAIN_FRAGMENT_AUGMENT() {
    // Custom shader code here
}

This function will be combined with the existing fragment shader of the material being used by the object being rendered in this render pass. Allowing users to augment the existing material shader with custom code.

clearColor : color [default: Qt.black]

This property holds the clear color for the render pass.

commands : list<RenderCommand>

This property holds the list of render commands for the render pass.

The commands in the list are executed in the order they appear in the list.

See also renderTargetBlend, PipelineStateOverride, RenderablesFilter, RenderPassTexture, ColorAttachment, DepthTextureAttachment, DepthStencilAttachment, and AddDefine.

depthClearValue : real [default: 1.0]

This property holds the depth clear value for the render pass.

enableClearBuffers : bool [default: true.]

This property holds whether the render pass should clear its buffers before rendering.

materialMode : RenderPass::MaterialModes [default: RenderPass.OriginalMaterial]

This property holds the material mode for the render pass.

overrideMaterial : Material

This property holds the override material for the render pass when materialMode is set to OverrideMaterial.

passMode : RenderPass::PassMode [default: RenderPass.UserPass]

This property holds the pass mode for the render pass.

In addition to standard user render passes, Qt Quick 3D supports users to manually triggering internal render passes for rendering the skybox and 2D items.

stencilClearValue : int [default: 0]

This property holds the stencil clear value for the render pass.