#include <SamplingRenderer.h>

Inheritance diagram for ph::SamplingRenderer:

Public Member Functions
	SamplingRenderer (std::unique_ptr< IRayEnergyEstimator > estimator, Viewport viewport, SampleFilter filter, uint32 numWorkers)

void	doUpdate (const CoreCookedUnit &cooked, const VisualWorld &world) override=0
	Perform necessary updates for rendering. No asynchronous operation is allowed during update.

void	doRender () override=0
	Perform rendering.

void	retrieveFrame (std::size_t layerIndex, HdrRgbFrame &out_frame) override=0
	Get the rendered result.

std::size_t	asyncPollUpdatedRegions (TSpan< RenderRegionStatus > out_regions) override=0
	Get the rendering regions that have been updated. Status of a region will always transition to `ERegionStatus::Finished`, and this ordering guarantee is valid for one or across multiple calls. Note that if the renderer has multiple workers working on the same region, you may observe a region transition from `ERegionStatus::Finished` to other status multiple times, but in the end it will eventually be `ERegionStatus::Finished`.

RenderStats	asyncQueryRenderStats () override=0
	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=0
	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 &region, HdrRgbFrame &out_frame) override=0
	Get the intermediate render result. This method is similar to `retrieveFrame()`, except that correctness is not guaranteed for the returned frame.

RenderObservationInfo	getObservationInfo () const override=0
	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::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()`.

Protected Attributes
SampleFilter	m_filter

std::unique_ptr< IRayEnergyEstimator >	m_estimator

Constructor & Destructor Documentation

◆ SamplingRenderer()

ph::SamplingRenderer::SamplingRenderer	(	std::unique_ptr< IRayEnergyEstimator >	estimator,
		Viewport	viewport,
		SampleFilter	filter,
		uint32	numWorkers )

Member Function Documentation

◆ asyncPeekFrame()

void ph::SamplingRenderer::asyncPeekFrame	(	std::size_t	layerIndex,
		const Region &	region,
		HdrRgbFrame &	out_frame )

overridepure virtual

Get the intermediate render result. This method is similar to retrieveFrame(), except that correctness is not guaranteed for the returned frame.

Implements ph::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ asyncPollUpdatedRegions()

std::size_t ph::SamplingRenderer::asyncPollUpdatedRegions ( TSpan< RenderRegionStatus > out_regions )

overridepure virtual

Get the rendering regions that have been updated. Status of a region will always transition to ERegionStatus::Finished, and this ordering guarantee is valid for one or across multiple calls. Note that if the renderer has multiple workers working on the same region, you may observe a region transition from ERegionStatus::Finished to other status multiple times, but in the end it will eventually be ERegionStatus::Finished.

Parameters

out_regions Output buffer for storing the updated regions.

Returns: Number of regions actually stored in the output buffer.

Implements ph::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ asyncQueryRenderProgress()

RenderProgress ph::SamplingRenderer::asyncQueryRenderProgress ( )

overridepure virtual

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::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ asyncQueryRenderStats()

RenderStats ph::SamplingRenderer::asyncQueryRenderStats ( )

overridepure virtual

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::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ doRender()

void ph::SamplingRenderer::doRender ( )

overridepure virtual

Perform rendering.

Implements ph::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ doUpdate()

void ph::SamplingRenderer::doUpdate	(	const CoreCookedUnit &	cooked,
		const VisualWorld &	world )

overridepure virtual

Perform necessary updates for rendering. No asynchronous operation is allowed during update.

Implements ph::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ getObservationInfo()

RenderObservationInfo ph::SamplingRenderer::getObservationInfo ( ) const

overridepure 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::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

◆ retrieveFrame()

void ph::SamplingRenderer::retrieveFrame	(	std::size_t	layerIndex,
		HdrRgbFrame &	out_frame )

overridepure virtual

Get the rendered result.

Implements ph::Renderer.

Implemented in ph::AdaptiveSamplingRenderer, and ph::EqualSamplingRenderer.

Member Data Documentation

◆ m_estimator

std::unique_ptr<IRayEnergyEstimator> ph::SamplingRenderer::m_estimator

protected

◆ m_filter

SampleFilter ph::SamplingRenderer::m_filter

protected

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

Source/Core/Renderer/Sampling/SamplingRenderer.h
Source/Core/Renderer/Sampling/SamplingRenderer.cpp

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ SamplingRenderer()

Member Function Documentation

◆ asyncPeekFrame()

◆ asyncPollUpdatedRegions()

◆ asyncQueryRenderProgress()

◆ asyncQueryRenderStats()

◆ doRender()

◆ doUpdate()

◆ getObservationInfo()

◆ retrieveFrame()

Member Data Documentation

◆ m_estimator

◆ m_filter