Uranium
Application Framework
|
Base class for a rendering pass. More...
Public Member Functions | |
None | __init__ (self, str name, int width, int height, int priority=0) |
str | getName (self) |
Get the name of this RenderPass. More... | |
Tuple[int, int] | getSize (self) |
int | getPriority (self) |
Get the priority of this RenderPass. More... | |
None | setSize (self, int width, int height) |
Set the size of this render pass. More... | |
None | bind (self) |
Bind the render pass so it can be rendered to. More... | |
None | release (self) |
Release the render pass. More... | |
None | render (self) |
Render the contents of this render pass. More... | |
int | getTextureId (self) |
Get the texture ID of this render pass so it can be reused by other passes. More... | |
QImage | getOutput (self) |
Get the pixel data produced by this render pass. More... | |
Static Public Attributes | |
int | MaximumPriority = 999 |
The maximum priority of a render pass. More... | |
Base class for a rendering pass.
The RenderPass class encapsulates a render pass, that is a single step in the rendering process.
None UM.View.RenderPass.RenderPass.bind | ( | self | ) |
Bind the render pass so it can be rendered to.
This will make sure everything is set up so the contents of this render pass will be updated correctly. It should be called as part of your render() implementation.
str UM.View.RenderPass.RenderPass.getName | ( | self | ) |
Get the name of this RenderPass.
QImage UM.View.RenderPass.RenderPass.getOutput | ( | self | ) |
Get the pixel data produced by this render pass.
This returns an object that contains the pixel data for this render pass.
int UM.View.RenderPass.RenderPass.getPriority | ( | self | ) |
Get the priority of this RenderPass.
The priority is used for ordering the render passes. Lower priority render passes are rendered earlier and are available for later render passes to use as texture sources.
int UM.View.RenderPass.RenderPass.getTextureId | ( | self | ) |
Get the texture ID of this render pass so it can be reused by other passes.
None UM.View.RenderPass.RenderPass.release | ( | self | ) |
Release the render pass.
This makes sure the contents of this render pass are properly updated at the end of rendering.
None UM.View.RenderPass.RenderPass.render | ( | self | ) |
Render the contents of this render pass.
This method should be reimplemented by subclasses to perform the actual rendering of the render pass.
Reimplemented in UM.View.CompositePass.CompositePass, UM.View.SelectionPass.SelectionPass, and UM.View.DefaultPass.DefaultPass.
None UM.View.RenderPass.RenderPass.setSize | ( | self, | |
int | width, | ||
int | height | ||
) |
Set the size of this render pass.
width | The new width of the render pass. |
height | The new height of the render pass. |
|
static |
The maximum priority of a render pass.
Priority should always be less than this.