class
render::Renderer
Primarily rendering class that allows you to specify how to render objects that exist in the scene graph.
You need to provide your own implementation of your class.
Public
Constructors
Renderer
Methods
~Renderer
GetCurrentCommandBufferPool
Returns the command buffer pool for the current frame.
GetParameterSetPool
Returns the parameter set pool used for allocating GPU parameter sets.
Initialize
Initializes the renderer with the provided GPU device.
Must be called before using the renderer.
Update
Called every frame.
Triggers render task callbacks.
Destroy
Cleans up the renderer.
Must be called before the renderer is deleted.
GetName
Name of the renderer.
Used by materials to find an appropriate variation for this renderer.
RenderAll
Called in order to render all currently active cameras.
CaptureSceneCubeMap
Captures the scene at the specified location into a cubemap.
CreateScene
CreateMeshDataInternal
Creates a new empty renderer mesh data.
CreateMeshDataInternal
Creates a new renderer mesh data using an existing generic mesh data buffer.
RequestDebugFrameCapture
Queues GPU command capture of the next frame, if a frame capture is set up (e.g.
RenderDoc capture).
RequestScreenCapture
Requests a screen capture for the specified camera.
- camera
- The camera whose view should be captured.
- asyncOp
- Async operation to complete when capture finishes.
AddExtension
Registers an extension object that will be called every frame, for each scene and view.
Allows external code to perform custom rendering interleaved with the renderer's output.
RemoveExtension
Unregisters an extension registered with AddRendererExtension().
AddTask
Registers a new task for execution on the render thread.
SetOptions
Sets options used for controlling the rendering.
GetOptions
Returns current set of options used for controlling the rendering.
Protected
Methods
InitializeOnRenderThread
Performs the initialization on the render thread.
DestroyOnRenderThread
Performs tear-down on the render thread.
ProcessTasks
Executes all renderer tasks queued for this frame.
- forceAll
- If true, multi-frame tasks will be forced to execute fully within this call.
- upToFrame
- Only tasks that were queued before or during the frame with the provided index will be processed.
ProcessTask
Executes the provided renderer task.
- task
- Task to execute.
- forceAll
- If true, multi-frame tasks will be forced to execute fully within this call.