xiiReflectionProbeUpdater Class Reference

Renders reflection probes and stores filtered mipmap chains into an atlas texture as well as computing sky irradiance Rendering sky irradiance is optional and only done if m_iIrradianceOutputIndex != -1. More...

#include <ReflectionProbeUpdater.h>

Classes
struct	TargetSlot
	Defines the target specular reflection probe atlas and index as well as the sky irradiance atlas and index in case the rendered cube map is a sky light. More...

Public Member Functions
	xiiReflectionProbeUpdater ()
	xiiReflectionProbeUpdater
xiiUInt32	GetFreeUpdateSlots (xiiDynamicArray< xiiReflectionProbeRef > &out_updatesFinished)
	Returns how many new probes can be started this frame.
xiiResult	StartDynamicUpdate (const xiiReflectionProbeRef &probe, const xiiReflectionProbeDesc &desc, const xiiTransform &globalTransform, const TargetSlot &target)
	Starts rendering a new reflection probe.
xiiResult	StartFilterUpdate (const xiiReflectionProbeRef &probe, const xiiReflectionProbeDesc &desc, xiiTextureCubeResourceHandle hSourceTexture, const TargetSlot &target)
	Starts filtering an existing cube map into a new reflection probe.
void	CancelUpdate (const xiiReflectionProbeRef &probe)
	Cancel a previously started update.
void	GenerateUpdateSteps ()
	Generates update steps. Should be called in PreExtraction phase.
void	ScheduleUpdateSteps ()
	Schedules probe rendering views. Should be called at some point during the extraction phase. Can be called multiple times. It will only do work on the first call after GenerateUpdateSteps.

Detailed Description

Renders reflection probes and stores filtered mipmap chains into an atlas texture as well as computing sky irradiance Rendering sky irradiance is optional and only done if m_iIrradianceOutputIndex != -1.

Member Function Documentation

GetFreeUpdateSlots()

xiiUInt32 xiiReflectionProbeUpdater::GetFreeUpdateSlots

(

xiiDynamicArray< xiiReflectionProbeRef > &

out_updatesFinished

)

Returns how many new probes can be started this frame.

Parameters

out_updatesFinished

Contains the probes that finished last frame.

Returns

The number of new probes can be started this frame.

StartDynamicUpdate()

xiiResult xiiReflectionProbeUpdater::StartDynamicUpdate	(	const xiiReflectionProbeRef &	probe,
		const xiiReflectionProbeDesc &	desc,
		const xiiTransform &	globalTransform,
		const TargetSlot &	target )

Starts rendering a new reflection probe.

Parameters

probe	The world and probe index to be rendered. Used as an identifier.
desc	Probe render settings.
globalTransform	World position to be rendered.
target	Where the probe should be rendered into.

Returns

Returns XII_FAILURE if no more free slots are available.

StartFilterUpdate()

xiiResult xiiReflectionProbeUpdater::StartFilterUpdate	(	const xiiReflectionProbeRef &	probe,
		const xiiReflectionProbeDesc &	desc,
		xiiTextureCubeResourceHandle	hSourceTexture,
		const TargetSlot &	target )

Starts filtering an existing cube map into a new reflection probe.

Parameters

probe	The world and probe index to be rendered. Used as an identifier.
desc	Probe render settings.
sourceTexture	Cube map that should be filtered into a reflection probe.
target	Where the probe should be rendered into.

Returns

Returns XII_FAILURE if no more free slots are available.

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Lights/Implementation/ReflectionProbeUpdater.h
• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Lights/Implementation/ReflectionProbeUpdater.cpp