RenderPass QML Type
Define un paso de renderizado personalizado para renderizar contenido 3D. Más información...
| Import Statement: | import QtQuick3D |
| Since: | Qt 6.11 |
| Inherits: |
Propiedades
- augmentShader : url
- clearColor : color
- commands : list<RenderCommand>
- depthClearValue : real
- materialMode : RenderPass::MaterialModes
- overrideMaterial : Material
- passMode : RenderPass::PassMode
- renderTargetFlags : RenderPass::RenderTargetFlags
- stencilClearValue : int
Descripción detallada
Un RenderPass define un paso de renderizado y el destino de renderizado en el que se escribe. Es la combinación de tres aspectos:
- Dónde renderizar: una o más texturas de salida declaradas mediante los comandos « ColorAttachment » o « DepthTextureAttachment » en commands.
- Qué renderizar: qué objetos de la escena dibuja el paso, controlado por los comandos « RenderablesFilter ». Las subdivisiones del trabajo dentro del mismo destino de renderizado se describen mediante los comandos « SubRenderPass ».
- Cómo renderizar: los comandos materialMode y cualquier comando PipelineStateOverride.
Un «RenderPass» se activa para una escena cuando se coloca como elemento secundario de un « View3D » o de un « Node ».
El siguiente ejemplo configura un sencillo paso fuera de pantalla que renderiza todos los objetos de la escena en una textura personalizada, que luego puede ser utilizada por un material o 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
}
]
}
}Exposición de datos a los shaders
Al igual que con los efectos y los materiales personalizados, el `RenderPass` expondrá y actualizará automáticamente las propiedades definidas por el usuario para los sombreadores. Cualquier propiedad QML declarada en un subtipo de `RenderPass` estará disponible como «uniform» en el sombreador.
Véase también SubRenderPass, RenderOutputProvider y RenderablesFilter.
Documentación de propiedades
augmentShader : url
Esta propiedad contiene la URL del shader de ampliación para la pasada de renderizado cuando la opción « materialMode » está configurada en « AugmentMaterial ».
El archivo de sombreador debe contener una función con la siguiente firma:
void MAIN_FRAGMENT_AUGMENT() {
// Custom shader code here
}Esta función se combinará con el shader de fragmento existente del material que utiliza el objeto que se está renderizando en esta pasada de renderizado. De este modo, los usuarios pueden ampliar el shader del material existente con código personalizado.
clearColor : color [default: Qt.black]
Esta propiedad establece el color de transparencia para la pasada de renderizado.
commands : list<RenderCommand>
Esta propiedad contiene la lista de comandos de renderizado para la pasada de renderizado.
Los comandos de la lista se ejecutan en el orden en que aparecen en ella.
Nota: Los comandos de « RenderPass » y «Effects» son similares, pero no idénticos; solo los marcados como compatibles pueden utilizarse con este « RenderPass ».
Véase también « SubRenderPass» , « PipelineStateOverride », « RenderablesFilter », « RenderPassTexture », « ColorAttachment », « DepthTextureAttachment », « DepthStencilAttachment », « AddDefine » y « renderTargetBlend ».
depthClearValue : real [default: 1.0]
Esta propiedad contiene el valor de «clear» de profundidad para la pasada de renderizado.
materialMode : RenderPass::MaterialModes [default: RenderPass.OriginalMaterial]
Determina cómo se gestionan los materiales de los objetos al renderizar en esta pasada.
| Constante | Descripción |
|---|---|
RenderPass.OriginalMaterial | Los objetos se renderizan utilizando los materiales que se les han asignado, con la iluminación, las texturas y las propiedades de los materiales aplicadas de forma normal. Este es el modo estándar para renderizar una copia fiel de la escena en un destino de renderizado personalizado; por ejemplo, un punto de vista secundario para una sonda de reflexión, una cámara de visión trasera o un efecto de imagen en imagen. Las propiedades ` overrideMaterial`, ` augmentShader` y ` shaders ` no se utilizan en este modo. |
RenderPass.AugmentMaterial | Cada objeto se renderiza con su propio material, pero el contenido de la función ` MAIN_FRAGMENT_AUGMENT() ` definida en ` augmentShader ` se inyecta tras la definición de salida del material original. Esto permite que el código de aumento lea el color calculado del material y escriba en salidas de color adicionales definidas por los comandos ` ColorAttachment ` en el paso. Esto resulta útil para pasadas con múltiples objetivos de renderizado (MRT) que requieren sombreado por material, como escribir el color iluminado en un anexo y una normal en el espacio mundial en otro, todo ello en una única llamada de dibujo. |
RenderPass.OverrideMaterial | Todos los objetos renderizados por este paso utilizan el único « overrideMaterial » en lugar de su propio « ». Esto resulta útil para pasos de solo profundidad, mapas de sombras, efectos de silueta o contorno, y cualquier otro caso en el que se desee que toda la geometría se sombree de forma idéntica, independientemente del material que se le haya asignado. La propiedad « augmentShader » no se utiliza en este modo. |
overrideMaterial : Material
Esta propiedad contiene el material de sustitución para la pasada de renderizado cuando la opción « materialMode » está configurada en « OverrideMaterial ».
passMode : RenderPass::PassMode [default: RenderPass.UserPass]
Esta propiedad define el modo de renderizado para el paso de renderizado.
Además de las pasadas de renderizado estándar del usuario, « Qt Quick » 3D permite a los usuarios activar manualmente pasadas de renderizado internas para renderizar el skybox y los elementos 2D.
| Constante | Descripción |
|---|---|
RenderPass.UserPass | Un paso de renderizado especificado por el usuario. |
RenderPass.SkyboxPass | Qt Quick Pase de renderizado de skybox integrado en 3D. |
RenderPass.Item2DPass | Qt Quick El paso de renderizado de elementos 2D integrado en 3D. |
renderTargetFlags : RenderPass::RenderTargetFlags [default: RenderPass.None]
Esta propiedad contiene los indicadores del destino de renderizado para la pasada de renderizado. Estos indicadores influyen en cómo se gestiona el contenido del destino de renderizado al principio y al final de cada fotograma.
| Constante | Descripción |
|---|---|
RenderPass.None | Sin comportamiento especial. El contenido de color y profundidad/plantilla se borra al inicio de cada fotograma. |
RenderPass.PreserveColorContents | Conserva el contenido de color del destino de renderizado entre fotogramas, de modo que la salida del fotograma anterior permanece hasta que se sobrescriba explícitamente. |
RenderPass.PreserveDepthStencilContents | Conserva los contenidos de profundidad y estarcido del destino de renderizado entre fotogramas. |
RenderPass.DoNotStoreDepthStencilContents | No almacena el contenido de profundidad y plantilla del destino de renderizado tras el renderizado (puede mejorar el rendimiento en GPU con arquitectura en mosaico). |
Véase también QRhiTextureRenderTarget::Flags.
stencilClearValue : int [default: 0]
Esta propiedad contiene el valor de transparencia de la plantilla para la pasada de renderizado.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.