RenderPass QML Type

Définit un passage de rendu personnalisé pour le rendu de contenu 3D. En savoir plus...

• Liste de tous les membres, y compris les membres hérités

Propriétés

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

Description détaillée

Un RenderPass définit une étape de rendu et la cible de rendu dans laquelle il écrit. Il combine trois aspects :

• Où effectuer le rendu — une ou plusieurs textures de sortie déclarées à l’aide des commandes « ColorAttachment » ou « DepthTextureAttachment » dans commands.
• Ce qu’il faut rendre — les objets de la scène que le pass dessine, contrôlés par les commandes « RenderablesFilter ». Les subdivisions du travail au sein d’une même cible de rendu sont décrites à l’aide des commandes « SubRenderPass ».
• Comment effectuer le rendu: les commandes « materialMode » et toutes les commandes « PipelineStateOverride ».

Un RenderPass devient actif pour une scène lorsqu’il est placé en tant qu’enfant d’un View3D ou d’un Node.

L’exemple suivant configure un simple « pass » hors écran qui effectue le rendu de tous les objets de la scène dans une texture personnalisée, qui peut ensuite être utilisée par un matériau ou un « SimpleQuadRenderer » :

import QtQuick3D

View3D {
    // Declare the off-screen color buffer
    RenderPassTexture {
        id: myColorTexture
        format: RenderPassTexture.RGBA8
    }

    // The render pass: where + what + how
    RenderPass {
        id: myRenderPass
        commands: [
            // Where: attach the texture as the color output
            ColorAttachment {
                name: "color0"
                target: myColorTexture
            },
            // What: render all objects into it
            RenderablesFilter {
                renderableTypes: RenderablesFilter.Opaque | RenderablesFilter.Transparent
            }
        ]
    }
}

Exposition des données aux shaders

Comme pour les effets et les matériaux personnalisés, le RenderPass exposera et mettra à jour automatiquement les propriétés définies par l’utilisateur pour les shaders. Toutes les propriétés QML déclarées sur un sous-type de RenderPass seront disponibles en tant qu’uniformes dans le shader.

Voir également SubRenderPass, RenderOutputProvider et RenderablesFilter.

Documentation sur les propriétés

augmentShader : url

Cette propriété contient l'URL du shader d'augmentation pour le passage de rendu lorsque le paramètre « materialMode » est défini sur « AugmentMaterial ».

Le fichier de shader doit contenir une fonction présentant la signature suivante :

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

Cette fonction sera combinée avec le shader de fragment existant du matériau utilisé par l'objet rendu lors de ce passage de rendu. Cela permet aux utilisateurs d'étendre le shader de matériau existant avec du code personnalisé.

clearColor : color [default: Qt.black]

Cette propriété définit la couleur de transparence pour le passage de rendu.

commands : list<RenderCommand>

Cette propriété contient la liste des commandes de rendu pour la passe de rendu.

Les commandes de la liste sont exécutées dans l'ordre où elles apparaissent dans la liste.

Voir également SubRenderPass, PipelineStateOverride, RenderablesFilter, RenderPassTexture, ColorAttachment, DepthTextureAttachment, DepthStencilAttachment, AddDefine et renderTargetBlend.

depthClearValue : real [default: 1.0]

Cette propriété contient la valeur de « depth clear » pour le passage de rendu.

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

Détermine la manière dont les matériaux des objets sont traités lors du rendu dans cette passe.

overrideMaterial : Material

Cette propriété contient le matériau de remplacement pour le passage de rendu lorsque l'option « materialMode » est définie sur « OverrideMaterial ».

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

Cette propriété définit le mode de rendu pour la passe de rendu.

Outre les passes de rendu standard, Qt Quick 3D permet aux utilisateurs de déclencher manuellement des passes de rendu internes pour le rendu de la skybox et des éléments 2D.

renderTargetFlags : RenderPass::RenderTargetFlags [default: RenderPass.None]

Cette propriété contient les indicateurs de cible de rendu pour le passage de rendu. Ces indicateurs déterminent la manière dont le contenu de la cible de rendu est géré au début et à la fin de chaque image.

Voir également QRhiTextureRenderTarget::Flags.

stencilClearValue : int [default: 0]

Cette propriété contient la valeur « transparent » du pochoir pour le passage de rendu.