Loading...
Searching...
No Matches
ph::VanillaPMRenderer Class Reference
#include <VanillaPMRenderer.h>
Inheritance diagram for ph::VanillaPMRenderer:
Public Member Functions | |
| VanillaPMRenderer (PMCommonParams commonParams, Viewport viewport, SampleFilter filter, uint32 numWorkers) | |
| void | doRender () override |
| Perform rendering. | |
| void | retrieveFrame (std::size_t layerIndex, HdrRgbFrame &out_frame) override |
| Get the rendered result. | |
| RenderStats | asyncQueryRenderStats () override |
Get general information of the ongoing rendering process. More information can be provided by the implementation. The meaning of each stat can be obtained via getObservationInfo(). | |
| RenderProgress | asyncQueryRenderProgress () override |
| Get progress of the ongoing rendering process. Implementation is advised to provide this information as it is vital for the caller to be able to observe the progress of a potentially long-running rendering process. | |
| void | asyncPeekFrame (std::size_t layerIndex, const Region ®ion, HdrRgbFrame &out_frame) override |
Get the intermediate render result. This method is similar to retrieveFrame(), except that correctness is not guaranteed for the returned frame. | |
| RenderObservationInfo | getObservationInfo () const |
| Get information about available transient outputs of an ongoing render operation. This information will be determined after each update (constant throughout the following rendering process). The actual data and can be retrieved via async<X>() methods. | |
 Public Member Functions inherited from ph::PMRendererBase | |
| PMRendererBase (PMCommonParams commonParams, Viewport viewport, SampleFilter filter, uint32 numWorkers) | |
| void | doUpdate (const CoreCookedUnit &cooked, const VisualWorld &world) override |
| Gather cooked data. Perform any required initialization before render. | |
| std::size_t | asyncPollUpdatedRegions (TSpan< RenderRegionStatus > out_regions) override |
| Get updated regions based on the state of primary film. | |
| const SampleFilter & | getFilter () const |
| const PMCommonParams & | getCommonParams () const |
| const Scene * | getScene () const |
| const Receiver * | getReceiver () const |
| const SampleGenerator * | getSampleGenerator () const |
| TSynchronized< HdrRgbFilm > & | getPrimaryFilm () |
| PMAtomicStatistics & | getStatistics () |
| void | asyncDevelopPrimaryFilm (const Region ®ion, HdrRgbFrame &out_frame) |
| void | asyncMergeToPrimaryFilm (const HdrRgbFilm &srcFilm) |
| void | asyncReplacePrimaryFilm (const HdrRgbFilm &srcFilm) |
| Public Member Functions inherited from ph::Renderer | |
| Renderer (Viewport viewport, uint32 numWorkers) | |
| virtual | ~Renderer () |
| void | update (const CoreCookedUnit &cooked, const VisualWorld &world) |
| Start updating. | |
| void | render () |
| Start rendering. | |
| void | setNumWorkers (uint32 numWorkers) |
| Set number of workers for the renderer. | |
| uint32 | numWorkers () const |
| uint32 | getRenderWidthPx () const |
| uint32 | getRenderHeightPx () const |
| math::TAABB2D< int64 > | getCropWindowPx () const |
The region to work on. The user may specify a window to confine all operations to this region. Note that this is not necessary the region that will be rendered (see getRenderRegionPx()). | |
| math::TAABB2D< int64 > | getRenderRegionPx () const |
The region that is going to be rendered. The difference between render region and crop window is that render region will never exceed the area defined by the base render size ([0, 0] to [getRenderWidthPx(), getRenderHeightPx()]). | |
| const Viewport & | getViewport () const |
| Descriptions regarding dimensions for the rendered frame. Viewport is set on ctor and stayed constant during the lifetime of the renderer. | |
| bool | asyncIsUpdating () const |
| bool | asyncIsRendering () const |
| std::size_t | asyncPollMergedUpdatedRegions (TSpan< RenderRegionStatus > out_regions, std::size_t mergeSize) |
Get the rendering region that has been updated. This variant polls for combined regions. Note that this variant does not guarantee any status ordering for a region. If a more fine-grained result is desired, use asyncPollUpdatedRegions(). | |
Constructor & Destructor Documentation
◆ VanillaPMRenderer()
| ph::VanillaPMRenderer::VanillaPMRenderer | ( | PMCommonParams | commonParams, |
| Viewport | viewport, | ||
| SampleFilter | filter, | ||
| uint32 | numWorkers ) |
Member Function Documentation
◆ asyncPeekFrame()
|
overridevirtual |
Get the intermediate render result. This method is similar to retrieveFrame(), except that correctness is not guaranteed for the returned frame.
Implements ph::PMRendererBase.
◆ asyncQueryRenderProgress()
|
overridevirtual |
Get progress of the ongoing rendering process. Implementation is advised to provide this information as it is vital for the caller to be able to observe the progress of a potentially long-running rendering process.
Implements ph::PMRendererBase.
◆ asyncQueryRenderStats()
|
overridevirtual |
Get general information of the ongoing rendering process. More information can be provided by the implementation. The meaning of each stat can be obtained via getObservationInfo().
Implements ph::PMRendererBase.
◆ doRender()
|
overridevirtual |
Perform rendering.
Implements ph::PMRendererBase.
◆ getObservationInfo()
|
virtual |
Get information about available transient outputs of an ongoing render operation. This information will be determined after each update (constant throughout the following rendering process). The actual data and can be retrieved via async<X>() methods.
Implements ph::PMRendererBase.
◆ retrieveFrame()
|
overridevirtual |
Get the rendered result.
Implements ph::PMRendererBase.
The documentation for this class was generated from the following files:
- Source/Core/Renderer/PM/VanillaPMRenderer.h
- Source/Core/Renderer/PM/VanillaPMRenderer.cpp
