Uranium
Application Framework
UM.View.Renderer.Renderer Class Reference

Abstract base class for different rendering implementations. More...

Inheritance diagram for UM.View.Renderer.Renderer:
UM.Qt.QtRenderer.QtRenderer

Public Member Functions

None __init__ (self)
 
None beginRendering (self)
 Signal the beginning of the rendering process. More...
 
None queueNode (self, SceneNode node, **kwargs)
 Queue a node to be rendered. More...
 
None render (self)
 Render everything that was set up to be rendered.
 
None endRendering (self)
 Finish rendering, finalize and clear state.
 
None addRenderPass (self, RenderPass render_pass)
 Add a render pass that should be rendered. More...
 
None removeRenderPass (self, RenderPass render_pass)
 Remove a render pass from the list of render passes to render. More...
 
Optional[RenderPassgetRenderPass (self, str name)
 Get a render pass by name. More...
 
SortedListWithKey getRenderPasses (self)
 Get the list of all render passes that should be rendered.
 

Detailed Description

Abstract base class for different rendering implementations.

The renderer is used to perform rendering of objects. It abstracts away any details about the underlying graphics API that is used to render. It is designed to perform different stages of rendering, with the application indicating which objects should be rendered but the actual rendering process happening after a sorting step.

Member Function Documentation

◆ addRenderPass()

None UM.View.Renderer.Renderer.addRenderPass (   self,
RenderPass  render_pass 
)

Add a render pass that should be rendered.

Parameters
render_passThe render pass to add.

◆ beginRendering()

None UM.View.Renderer.Renderer.beginRendering (   self)

Signal the beginning of the rendering process.

This should set up any required state before any actual rendering happens.

Reimplemented in UM.Qt.QtRenderer.QtRenderer.

◆ getRenderPass()

Optional[RenderPass] UM.View.Renderer.Renderer.getRenderPass (   self,
str  name 
)

Get a render pass by name.

Parameters
nameThe name of the render pass to get.
Returns
The named render pass or None if not found.

◆ queueNode()

None UM.View.Renderer.Renderer.queueNode (   self,
SceneNode  node,
**  kwargs 
)

Queue a node to be rendered.

Parameters
nodeThe node to queue for rendering.
kwargsKeyword arguments. Most of these are passed to the RenderBatch constructor directly. See RenderBatch for all available options. In addition, the parameter "shader" is available, which determines the shader to render with. When not specified, it defaults to a simple vertex color shader.

◆ removeRenderPass()

None UM.View.Renderer.Renderer.removeRenderPass (   self,
RenderPass  render_pass 
)

Remove a render pass from the list of render passes to render.

Parameters
render_passThe render pass to remove.

The documentation for this class was generated from the following file: