Uranium
Application Framework
Loading...
Searching...
No Matches
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

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

Protected Attributes

 _render_passes
 

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()

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

Add a render pass that should be rendered.

Parameters
render_passThe render pass to add.

Reimplemented in UM.Qt.QtRenderer.QtRenderer.

◆ beginRendering()

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.

◆ endRendering()

UM.View.Renderer.Renderer.endRendering (   self)

Finish rendering, finalize and clear state.

Reimplemented in UM.Qt.QtRenderer.QtRenderer.

◆ getRenderPass()

UM.View.Renderer.Renderer.getRenderPass (   self,
  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()

UM.View.Renderer.Renderer.queueNode (   self,
  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.

Reimplemented in UM.Qt.QtRenderer.QtRenderer.

◆ removeRenderPass()

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

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

Parameters
render_passThe render pass to remove.

◆ render()

UM.View.Renderer.Renderer.render (   self)

Render everything that was set up to be rendered.

Reimplemented in UM.Qt.QtRenderer.QtRenderer.


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