Uranium
Application Framework
|
Base class for a rendering pass. More...
Public Member Functions | |
def | __init__ |
def | getName |
Get the name of this RenderPass. More... | |
def | getSize |
def | getPriority |
Get the priority of this RenderPass. More... | |
def | setSize |
Set the size of this render pass. More... | |
def | bind |
Bind the render pass so it can be rendered to. More... | |
def | release |
Release the render pass. More... | |
def | render |
Render the contents of this render pass. More... | |
def | getTextureId |
Get the texture ID of this render pass so it can be reused by other passes. More... | |
def | getOutput |
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.
def UM.View.RenderPass.RenderPass.bind | ( | self, | |
None | |||
) |
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.
def UM.View.RenderPass.RenderPass.getName | ( | self, | |
str | |||
) |
Get the name of this RenderPass.
def UM.View.RenderPass.RenderPass.getOutput | ( | self, | |
QImage | |||
) |
Get the pixel data produced by this render pass.
This returns an object that contains the pixel data for this render pass.
def UM.View.RenderPass.RenderPass.getPriority | ( | self, | |
int | |||
) |
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.
def UM.View.RenderPass.RenderPass.getTextureId | ( | self, | |
int | |||
) |
Get the texture ID of this render pass so it can be reused by other passes.
def UM.View.RenderPass.RenderPass.release | ( | self, | |
None | |||
) |
Release the render pass.
This makes sure the contents of this render pass are properly updated at the end of rendering.
def UM.View.RenderPass.RenderPass.render | ( | self, | |
None | |||
) |
Render the contents of this render pass.
This method should be reimplemented by subclasses to perform the actual rendering of the render pass.
def UM.View.RenderPass.RenderPass.setSize | ( | self, | |
width | |||
) |
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.