VTK/MultiPass Rendering

WORK IN PROGRESS

Overview

Modifying the logic of the rendering pipeline of VTK is cumbersome: it requires to modify several existing classes, and often requires a full understanding of most of the rendering classes. Modifying the rendering logic is really sensitive and error-prone. It's easy to break the code. More importantly, it also means that it is impossible from an external project to modify the rendering pipeline.

The multi-pass rendering framework try to address these issues by providing a hook in the vtkRenderer class where you can plug your own rendering algorithms (passes) and combine them with other algorithms at compile-time (statically) or a run-time (dynamically).

The approach is, even if the VTK source code is freely available (published under a (non-copyleft) free software license), to think of it as a closed-source package and see how it could be extended by relying only on its public API.

Note there is another way to hook your own rendering algorithm but it doesn't not provide a framework: you can subclass vtkRendererDelegate and call vtkRenderer::SetDelegate() .

Fundamental classes

The following classes are the building blocks of the multi-pass rendering framework:

• vtkRenderPass
• vtkRenderState
• vtkSequencePass (allow run-time combinations of passes)

vtkRenderPass

The gut of vtkRenderPass is to perform some rendering based on some render state. The central method is

 virtual void Render(const vtkRenderState *s)=0

Any concrete subclass will implement this method.

vtkRenderState

vtkRenderState aggregates information necessary for the vtkRenderPass to perform rendering. The state consists of:

• the vtkRenderer (which gives access to the vtkCamera, to the vtkRenderWindow and to the vtkProps)
• the list of props to render (it is a subset of the props on the renderer, usually the visible props that remain after the frustum culling operation) A RenderPass may ignore this cached list because it is not relevant for it and may work again directly on all the props from the Renderer. The typical example is a shadow mapping pass, that will change the active camera to be one of the light, so culling from the original camera does not make sense and will produce wrong result.
• the current framebuffer in use, as some passes can render in vtkFrameBufferObject, not only on the framebuffer provided by the vtkRenderWindow.
• a list of required property keys that have to be present on the props. this is a flexible way to filter props to render. Keys on the props allow to add customized properties. For example, the vtkShadowMapPass defined two types of keys OCCLUDER and RECEIVER to identify props that will cast the shadows and the props that will receive the shadows.

Putting things together

WORK IN PROGRESS

Link vtkRenderer and a vtkRenderPass

To hook render passes and VtkRenderer, use void vtkRenderer::SetPass(vtkRenderPass *p).

Combining passes

• vtkSequencePass: run-time combination
• write your own subclass of vtkRenderPass and add some delegate pass: compile-time combination

Elementary passes

• vtkCameraPass
• vtkClearZPass
• vtkLightsPass
• vtkDefaultPass
  • vtkOpaquePass
  • vtkTranslucentPass
  • vtkVolumetricPass
  • vtkOverlayPass

Existing passes

The following classes are provided with VTK. The key is they could have been written out of VTK. It demonstrates that you can customize and extent the rendering VTK pipeline in an external project without modifying VTK:

• vtkDepthPeelingPass
• vtkShadowMapPass
• post-processing image passes:
  • vtkGaussianBlurPass,
  • vtkSobelGradientMagnitudePass

Parallel rendering

• vtkCompositeZPass
• vtkCompositeRGBAPass

• Examples of passes
• 

  vtkDepthPeelingPass

• 

  vtkShadowMapPass

• 

  vtkGaussianBlurPass

• 

  vtkSobelGradientMagnitudePass

• 

  combination of post-processing image passes