Incremental six-face HDR scene capture for a runtime reflection probe. 更多...

#include <ReflectionProbeCapture.h>

Public 成员函数
	ReflectionProbeCapture (Graphics *gfx)
	Reflection probe capture.

	~ReflectionProbeCapture ()
	Detach this probe from every registry before script-owned destruction.

void	configure (float x, float y, float z, int resolution=128, float nearZ=0.1f, float farZ=100.f)
	Configure the probe origin, face resolution and clipping planes.

void	requestCapture ()
	Mark all six faces dirty and restart capture at +X.

void	queueCapture ()
	Queue a coherent recapture without restarting a revision already in progress.

bool	update (int faceBudget=1)
	Capture up to `faceBudget` dirty faces.

Canvas *	getFaceCanvas (int face) const
	Return one captured HDR face Canvas in +X,-X,+Y,-Y,+Z,-Z order. @lifetime Returned canvas is borrowed from this capture until destruction.

bool	isCapturePending () const
	True while one or more faces still need capture.

bool	isRecaptureQueued () const
	True when changed capture inputs are queued behind the current revision.

bool	isCaptureComplete () const
	True after at least one complete six-face capture.

uint32_t	getRevision () const
	Monotonic revision incremented after each complete six-face capture.

bool	stageCapturedFaces ()
	Copy a complete capture revision into a backend HDR staging cubemap. @compatibility Preserves the scripting API's boolean submitted result.

Texture *	getStagingCubemap () const
	Backend HDR staging cubemap; not yet filtered or safe for lighting. @lifetime Returned texture is Graphics-owned and borrowed by this capture.

uint32_t	getStagedRevision () const
	Last capture revision fully copied into the staging cubemap.

bool	filterAndPublish (int sampleCount=64)
	Filter with 8-512 samples and atomically publish the active cubemap. @compatibility Preserves the scripting API's boolean publication result.

Texture *	getActiveCubemap () const
	Last fully filtered cubemap, safe to assign to Camera3D reflection probes. @lifetime Returned texture is Graphics-owned and borrowed by this capture.

uint32_t	getPublishedRevision () const
	Last capture revision atomically published for lighting.

void	setUpdateMode (const std::string &mode)
	Set refresh mode: static, on_demand, time_sliced, or realtime.

std::string	getUpdateMode () const
	Return the current refresh mode.

void	setRefreshInterval (int frames)
	Set automatic refresh interval in frames for time_sliced mode.

int	getRefreshInterval () const
	Return the automatic refresh interval in frames.

void	setCaptureMask (int mask)
	Set the object-layer mask visible to this reflection capture.

int	getCaptureMask () const
	Return the object-layer mask visible to this reflection capture.

void	setEnvironmentLighting (Texture *environment, float intensity=1.f)
	Set non-recursive global environment lighting for captured geometry.

Texture *	getEnvironmentLighting () const
	Return the global environment texture used while capturing. @lifetime Returned texture is borrowed; its owner must outlive this capture.

float	getEnvironmentLightingIntensity () const
	Return the global environment-lighting intensity used while capturing.

void	setSkyColor (float r, float g, float b, float intensity=1.f)
	Set a linear HDR backup sky color for empty capture pixels.

void	setSkyFaceColor (int face, float r, float g, float b)
	Override one directional backup sky face in +X,-X,+Y,-Y,+Z,-Z order.

void	setSkyFaceTexture (int face, Texture *texture)
	Set a directional per-pixel sky texture for one capture face.

Texture *	getSkyFaceTexture (int face) const
	Return one directional per-pixel sky texture, or nullptr. @lifetime Returned texture is borrowed; its owner must outlive this capture.

void	setSkyFaceTextureScale (int face, float scale)
	Set the linear HDR radiance multiplier for one sky face texture.

float	getSkyFaceTextureScale (int face) const
	Return one sky face texture's linear HDR radiance multiplier.

float	getSkyFaceColor (int face, int component) const
	Return one directional sky-face color component, or zero for invalid indices.

float	getSkyR () const
	Return the unscaled backup sky red channel.

float	getSkyG () const
	Return the unscaled backup sky green channel.

float	getSkyB () const
	Return the unscaled backup sky blue channel.

float	getSkyIntensity () const
	Return the backup sky HDR multiplier.

int	getPendingFaceCount () const
	Number of cubemap faces remaining in the current capture revision.

int	getLastCapturedFaceCount () const
	Number of faces rendered by the most recent update call.

uint32_t	getTotalCapturedFaceCount () const
	Total number of face renders performed by this capture object.

int	getLastFilterSampleCount () const
	Sample count used by the most recently published filter pass.

void	setGpuBudgetMs (float milliseconds)
	Set the GPU-time budget used by adaptive capture scheduling, in milliseconds.

float	getGpuBudgetMs () const
	Return the adaptive capture GPU-time budget in milliseconds.

void	reportGpuDurationMs (float milliseconds)
	Report a backend timestamp duration for the most recent probe workload.

float	getSmoothedGpuDurationMs () const
	Return the exponentially smoothed reported GPU duration.

int	getAdaptiveFaceBudget () const
	Return the current adaptive cubemap-face budget.

int	getAdaptiveFilterSamples () const
	Return the current adaptive filter sample count.

bool	tickAdaptive ()
	Advance capture and filtering using the GPU-budget controller's workload.

bool	tick (int faceBudget=1, int filterSamples=64)
	Advance capture, staging, filtering and publishing under the selected policy.

void	configureInfluence (float extentX, float extentY, float extentZ, float intensity=1.f, float blendDistance=1.f, int priority=0)
	Configure the persistent box influence used for lighting and editor display.

float	getInfluenceExtentX () const
	Return persistent influence half extent X.

float	getInfluenceExtentY () const
	Return persistent influence half extent Y.

float	getInfluenceExtentZ () const
	Return persistent influence half extent Z.

float	getInfluenceIntensity () const
	Return persistent reflection intensity.

float	getInfluenceBlendDistance () const
	Return persistent edge blend distance.

int	getInfluencePriority () const
	Return persistent overlap-selection priority.

bool	applyConfiguredToCamera (Camera3D *camera, int slot)
	Submit the persistent influence and active cubemap to a Camera3D slot. @compatibility Preserves the scripting API's boolean assignment result.

bool	applyToCamera (Camera3D *camera, int slot, float extentX, float extentY, float extentZ, float intensity=1.f, float blendDistance=1.f, int priority=0)
	Assign the active cubemap to a Camera3D local reflection-probe slot.

int	getResolution () const
	Current square face resolution.

float	getCenterX () const
	Return probe world-space center X.

float	getCenterY () const
	Return probe world-space center Y.

float	getCenterZ () const
	Return probe world-space center Z.

float	getCaptureFarDistance () const
	Return the capture far distance used for spatial dirty culling.

void	setCaptureLodDistanceScale (float scale)
	Set capture LOD distance scale; below one retains higher-detail LODs farther away.

float	getCaptureLodDistanceScale () const
	Return capture LOD distance scale.

void	setCaptureTransparent (bool enabled)
	Enable or disable transparent/hair surfaces in probe captures.

bool	getCaptureTransparent () const
	Return whether transparent/hair surfaces are captured.

void	setCaptureClusteredLighting (bool enabled)
	Enable clustered lighting for captures that exceed the legacy light pack.

bool	getCaptureClusteredLighting () const
	Return whether probe captures can build clustered light tables.

友元
class	ReflectionProbeRegistry

详细描述

Incremental six-face HDR scene capture for a runtime reflection probe.

Captured faces remain linear RGBA16F Canvas resources. Publishing them as a filtered cubemap is a separate backend operation, so capture completion never exposes an unfiltered or partially updated probe to lighting.

在文件 ReflectionProbeCapture.h 第 26 行定义.

构造及析构函数说明

◆ ReflectionProbeCapture()

eve::graphics::ReflectionProbeCapture::ReflectionProbeCapture ( Graphics * gfx )

explicit

Reflection probe capture.

在文件 ReflectionProbeCapture.cpp 第 15 行定义.

◆ ~ReflectionProbeCapture()

eve::graphics::ReflectionProbeCapture::~ReflectionProbeCapture ( )

Detach this probe from every registry before script-owned destruction.

在文件 ReflectionProbeCapture.cpp 第 17 行定义.

成员函数说明

◆ applyConfiguredToCamera()

bool eve::graphics::ReflectionProbeCapture::applyConfiguredToCamera	(	Camera3D *	camera,
		int	slot
	)

Submit the persistent influence and active cubemap to a Camera3D slot. @compatibility Preserves the scripting API's boolean assignment result.

在文件 ReflectionProbeCapture.cpp 第 398 行定义.

引用了 camera.

被这些函数引用 applyToCamera() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ applyToCamera()

bool eve::graphics::ReflectionProbeCapture::applyToCamera	(	Camera3D *	camera,
		int	slot,
		float	extentX,
		float	extentY,
		float	extentZ,
		float	intensity = `1.f`,
		float	blendDistance = `1.f`,
		int	priority = `0`
	)

Assign the active cubemap to a Camera3D local reflection-probe slot.

返回: False when no filtered revision has been published yet. @compatibility Preserves the scripting API's boolean assignment result.

在文件 ReflectionProbeCapture.cpp 第 406 行定义.

引用了 applyConfiguredToCamera(), camera, configureInfluence() , 以及 priority.

◆ configure()

void eve::graphics::ReflectionProbeCapture::configure	(	float	x,
		float	y,
		float	z,
		int	resolution = `128`,
		float	nearZ = `0.1f`,
		float	farZ = `100.f`
	)

Configure the probe origin, face resolution and clipping planes.

参数

x	Probe world-space X position.
y	Probe world-space Y position.
z	Probe world-space Z position.
resolution	Square face resolution, clamped to [16, 2048].
nearZ	Near clipping distance.
farZ	Far clipping distance.

在文件 ReflectionProbeCapture.cpp 第 34 行定义.

引用了 requestCapture(), x, y , 以及 z.

◆ configureInfluence()

void eve::graphics::ReflectionProbeCapture::configureInfluence	(	float	extentX,
		float	extentY,
		float	extentZ,
		float	intensity = `1.f`,
		float	blendDistance = `1.f`,
		int	priority = `0`
	)

Configure the persistent box influence used for lighting and editor display.

参数

extentX	Positive world-space X half extent.
extentY	Positive world-space Y half extent.
extentZ	Positive world-space Z half extent.
intensity	Non-negative reflection intensity.
blendDistance	Non-negative edge blend distance.
priority	Stable overlap-selection priority.

在文件 ReflectionProbeCapture.cpp 第 387 行定义.

引用了 priority.

被这些函数引用 applyToCamera() , 以及 eve::editor::ReflectionProbeVisualizer::setExtents().

◆ filterAndPublish()

bool eve::graphics::ReflectionProbeCapture::filterAndPublish ( int sampleCount = 64 )

Filter with 8-512 samples and atomically publish the active cubemap. @compatibility Preserves the scripting API's boolean publication result.

在文件 ReflectionProbeCapture.cpp 第 188 行定义.

引用了 eve::graphics::Graphics::filterHDRReflectionCubemap(), eve::graphics::Graphics::getLastOffscreen3DGpuDurationMs() , 以及 reportGpuDurationMs().

被这些函数引用 tick().

◆ getActiveCubemap()

Texture * eve::graphics::ReflectionProbeCapture::getActiveCubemap ( ) const

inline

Last fully filtered cubemap, safe to assign to Camera3D reflection probes. @lifetime Returned texture is Graphics-owned and borrowed by this capture.

在文件 ReflectionProbeCapture.h 第 95 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getAdaptiveFaceBudget()

int eve::graphics::ReflectionProbeCapture::getAdaptiveFaceBudget ( ) const

inline

Return the current adaptive cubemap-face budget.

在文件 ReflectionProbeCapture.h 第 185 行定义.

◆ getAdaptiveFilterSamples()

int eve::graphics::ReflectionProbeCapture::getAdaptiveFilterSamples ( ) const

inline

Return the current adaptive filter sample count.

在文件 ReflectionProbeCapture.h 第 187 行定义.

◆ getCaptureClusteredLighting()

bool eve::graphics::ReflectionProbeCapture::getCaptureClusteredLighting ( ) const

inline

Return whether probe captures can build clustered light tables.

在文件 ReflectionProbeCapture.h 第 258 行定义.

◆ getCaptureFarDistance()

float eve::graphics::ReflectionProbeCapture::getCaptureFarDistance ( ) const

inline

Return the capture far distance used for spatial dirty culling.

在文件 ReflectionProbeCapture.h 第 244 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::queueCaptureAABB().

◆ getCaptureLodDistanceScale()

float eve::graphics::ReflectionProbeCapture::getCaptureLodDistanceScale ( ) const

inline

Return capture LOD distance scale.

在文件 ReflectionProbeCapture.h 第 250 行定义.

◆ getCaptureMask()

int eve::graphics::ReflectionProbeCapture::getCaptureMask ( ) const

inline

Return the object-layer mask visible to this reflection capture.

在文件 ReflectionProbeCapture.h 第 109 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::queueCaptureAABB().

◆ getCaptureTransparent()

bool eve::graphics::ReflectionProbeCapture::getCaptureTransparent ( ) const

inline

Return whether transparent/hair surfaces are captured.

在文件 ReflectionProbeCapture.h 第 254 行定义.

◆ getCenterX()

float eve::graphics::ReflectionProbeCapture::getCenterX ( ) const

inline

Return probe world-space center X.

在文件 ReflectionProbeCapture.h 第 238 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getCenterX(), eve::graphics::ReflectionProbeRegistry::queueCaptureAABB() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getCenterY()

float eve::graphics::ReflectionProbeCapture::getCenterY ( ) const

inline

Return probe world-space center Y.

在文件 ReflectionProbeCapture.h 第 240 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getCenterY(), eve::graphics::ReflectionProbeRegistry::queueCaptureAABB() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getCenterZ()

float eve::graphics::ReflectionProbeCapture::getCenterZ ( ) const

inline

Return probe world-space center Z.

在文件 ReflectionProbeCapture.h 第 242 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getCenterZ(), eve::graphics::ReflectionProbeRegistry::queueCaptureAABB() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getEnvironmentLighting()

Texture * eve::graphics::ReflectionProbeCapture::getEnvironmentLighting ( ) const

inline

Return the global environment texture used while capturing. @lifetime Returned texture is borrowed; its owner must outlive this capture.

在文件 ReflectionProbeCapture.h 第 121 行定义.

◆ getEnvironmentLightingIntensity()

float eve::graphics::ReflectionProbeCapture::getEnvironmentLightingIntensity ( ) const

inline

Return the global environment-lighting intensity used while capturing.

在文件 ReflectionProbeCapture.h 第 123 行定义.

◆ getFaceCanvas()

Canvas * eve::graphics::ReflectionProbeCapture::getFaceCanvas ( int face ) const

Return one captured HDR face Canvas in +X,-X,+Y,-Y,+Z,-Z order. @lifetime Returned canvas is borrowed from this capture until destruction.

在文件 ReflectionProbeCapture.cpp 第 167 行定义.

◆ getGpuBudgetMs()

float eve::graphics::ReflectionProbeCapture::getGpuBudgetMs ( ) const

inline

Return the adaptive capture GPU-time budget in milliseconds.

在文件 ReflectionProbeCapture.h 第 176 行定义.

◆ getInfluenceBlendDistance()

float eve::graphics::ReflectionProbeCapture::getInfluenceBlendDistance ( ) const

inline

Return persistent edge blend distance.

在文件 ReflectionProbeCapture.h 第 220 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::setExtents().

◆ getInfluenceExtentX()

float eve::graphics::ReflectionProbeCapture::getInfluenceExtentX ( ) const

inline

Return persistent influence half extent X.

在文件 ReflectionProbeCapture.h 第 212 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getInfluenceExtentY()

float eve::graphics::ReflectionProbeCapture::getInfluenceExtentY ( ) const

inline

Return persistent influence half extent Y.

在文件 ReflectionProbeCapture.h 第 214 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getInfluenceExtentZ()

float eve::graphics::ReflectionProbeCapture::getInfluenceExtentZ ( ) const

inline

Return persistent influence half extent Z.

在文件 ReflectionProbeCapture.h 第 216 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getInfluenceIntensity()

float eve::graphics::ReflectionProbeCapture::getInfluenceIntensity ( ) const

inline

Return persistent reflection intensity.

在文件 ReflectionProbeCapture.h 第 218 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::setExtents() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getInfluencePriority()

int eve::graphics::ReflectionProbeCapture::getInfluencePriority ( ) const

inline

Return persistent overlap-selection priority.

在文件 ReflectionProbeCapture.h 第 222 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::setExtents() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getLastCapturedFaceCount()

int eve::graphics::ReflectionProbeCapture::getLastCapturedFaceCount ( ) const

inline

Number of faces rendered by the most recent update call.

在文件 ReflectionProbeCapture.h 第 168 行定义.

◆ getLastFilterSampleCount()

int eve::graphics::ReflectionProbeCapture::getLastFilterSampleCount ( ) const

inline

Sample count used by the most recently published filter pass.

在文件 ReflectionProbeCapture.h 第 172 行定义.

◆ getPendingFaceCount()

int eve::graphics::ReflectionProbeCapture::getPendingFaceCount ( ) const

inline

Number of cubemap faces remaining in the current capture revision.

在文件 ReflectionProbeCapture.h 第 166 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getStatusLabel().

◆ getPublishedRevision()

uint32_t eve::graphics::ReflectionProbeCapture::getPublishedRevision ( ) const

inline

Last capture revision atomically published for lighting.

在文件 ReflectionProbeCapture.h 第 97 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getColorB(), eve::editor::ReflectionProbeVisualizer::getColorG(), eve::editor::ReflectionProbeVisualizer::getColorR(), eve::editor::ReflectionProbeVisualizer::getStatusLabel() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ getRefreshInterval()

int eve::graphics::ReflectionProbeCapture::getRefreshInterval ( ) const

inline

Return the automatic refresh interval in frames.

在文件 ReflectionProbeCapture.h 第 105 行定义.

◆ getResolution()

int eve::graphics::ReflectionProbeCapture::getResolution ( ) const

inline

Current square face resolution.

在文件 ReflectionProbeCapture.h 第 236 行定义.

◆ getRevision()

uint32_t eve::graphics::ReflectionProbeCapture::getRevision ( ) const

inline

Monotonic revision incremented after each complete six-face capture.

在文件 ReflectionProbeCapture.h 第 73 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getColorB(), eve::editor::ReflectionProbeVisualizer::getColorG(), eve::editor::ReflectionProbeVisualizer::getColorR() , 以及 eve::editor::ReflectionProbeVisualizer::getStatusLabel().

◆ getSkyB()

float eve::graphics::ReflectionProbeCapture::getSkyB ( ) const

inline

Return the unscaled backup sky blue channel.

在文件 ReflectionProbeCapture.h 第 162 行定义.

◆ getSkyFaceColor()

float eve::graphics::ReflectionProbeCapture::getSkyFaceColor	(	int	face,
		int	component
	)		const

Return one directional sky-face color component, or zero for invalid indices.

在文件 ReflectionProbeCapture.cpp 第 302 行定义.

引用了 index.

◆ getSkyFaceTexture()

Texture * eve::graphics::ReflectionProbeCapture::getSkyFaceTexture ( int face ) const

Return one directional per-pixel sky texture, or nullptr. @lifetime Returned texture is borrowed; its owner must outlive this capture.

在文件 ReflectionProbeCapture.cpp 第 283 行定义.

◆ getSkyFaceTextureScale()

float eve::graphics::ReflectionProbeCapture::getSkyFaceTextureScale ( int face ) const

Return one sky face texture's linear HDR radiance multiplier.

在文件 ReflectionProbeCapture.cpp 第 297 行定义.

◆ getSkyG()

float eve::graphics::ReflectionProbeCapture::getSkyG ( ) const

inline

Return the unscaled backup sky green channel.

在文件 ReflectionProbeCapture.h 第 160 行定义.

◆ getSkyIntensity()

float eve::graphics::ReflectionProbeCapture::getSkyIntensity ( ) const

inline

Return the backup sky HDR multiplier.

在文件 ReflectionProbeCapture.h 第 164 行定义.

◆ getSkyR()

float eve::graphics::ReflectionProbeCapture::getSkyR ( ) const

inline

Return the unscaled backup sky red channel.

在文件 ReflectionProbeCapture.h 第 158 行定义.

◆ getSmoothedGpuDurationMs()

float eve::graphics::ReflectionProbeCapture::getSmoothedGpuDurationMs ( ) const

inline

Return the exponentially smoothed reported GPU duration.

在文件 ReflectionProbeCapture.h 第 183 行定义.

◆ getStagedRevision()

uint32_t eve::graphics::ReflectionProbeCapture::getStagedRevision ( ) const

inline

Last capture revision fully copied into the staging cubemap.

在文件 ReflectionProbeCapture.h 第 85 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getStatusLabel().

◆ getStagingCubemap()

Texture * eve::graphics::ReflectionProbeCapture::getStagingCubemap ( ) const

inline

Backend HDR staging cubemap; not yet filtered or safe for lighting. @lifetime Returned texture is Graphics-owned and borrowed by this capture.

在文件 ReflectionProbeCapture.h 第 83 行定义.

◆ getTotalCapturedFaceCount()

uint32_t eve::graphics::ReflectionProbeCapture::getTotalCapturedFaceCount ( ) const

inline

Total number of face renders performed by this capture object.

在文件 ReflectionProbeCapture.h 第 170 行定义.

◆ getUpdateMode()

std::string eve::graphics::ReflectionProbeCapture::getUpdateMode ( ) const

Return the current refresh mode.

在文件 ReflectionProbeCapture.cpp 第 215 行定义.

◆ isCaptureComplete()

bool eve::graphics::ReflectionProbeCapture::isCaptureComplete ( ) const

inline

True after at least one complete six-face capture.

在文件 ReflectionProbeCapture.h 第 71 行定义.

被这些函数引用 stageCapturedFaces() , 以及 update().

◆ isCapturePending()

bool eve::graphics::ReflectionProbeCapture::isCapturePending ( ) const

inline

True while one or more faces still need capture.

在文件 ReflectionProbeCapture.h 第 67 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getColorB(), eve::editor::ReflectionProbeVisualizer::getColorG(), eve::editor::ReflectionProbeVisualizer::getColorR() , 以及 eve::editor::ReflectionProbeVisualizer::getStatusLabel().

◆ isRecaptureQueued()

bool eve::graphics::ReflectionProbeCapture::isRecaptureQueued ( ) const

inline

True when changed capture inputs are queued behind the current revision.

在文件 ReflectionProbeCapture.h 第 69 行定义.

被这些函数引用 eve::editor::ReflectionProbeVisualizer::getStatusLabel().

◆ queueCapture()

void eve::graphics::ReflectionProbeCapture::queueCapture ( )

Queue a coherent recapture without restarting a revision already in progress.

If no face has been submitted yet the current input snapshot is refreshed immediately.

在文件 ReflectionProbeCapture.cpp 第 84 行定义.

被这些函数引用 eve::graphics::ReflectionProbeRegistry::queueCaptureAABB() , 以及 eve::graphics::ReflectionProbeRegistry::updateCamera().

◆ reportGpuDurationMs()

void eve::graphics::ReflectionProbeCapture::reportGpuDurationMs ( float milliseconds )

Report a backend timestamp duration for the most recent probe workload.

参数

milliseconds GPU duration in milliseconds; non-positive values are ignored.

在文件 ReflectionProbeCapture.cpp 第 334 行定义.

引用了 milliseconds.

被这些函数引用 filterAndPublish(), stageCapturedFaces(), tick() , 以及 update().

◆ requestCapture()

void eve::graphics::ReflectionProbeCapture::requestCapture ( )

Mark all six faces dirty and restart capture at +X.

在文件 ReflectionProbeCapture.cpp 第 51 行定义.

引用了 eve::graphics::Camera3D::setEnvIntensity() , 以及 eve::graphics::Camera3D::setEnvMap().

被这些函数引用 configure() , 以及 setCaptureMask().

◆ setCaptureClusteredLighting()

void eve::graphics::ReflectionProbeCapture::setCaptureClusteredLighting ( bool enabled )

Enable clustered lighting for captures that exceed the legacy light pack.

在文件 ReflectionProbeCapture.cpp 第 323 行定义.

引用了 enabled.

◆ setCaptureLodDistanceScale()

void eve::graphics::ReflectionProbeCapture::setCaptureLodDistanceScale ( float scale )

Set capture LOD distance scale; below one retains higher-detail LODs farther away.

在文件 ReflectionProbeCapture.cpp 第 310 行定义.

引用了 scale.

◆ setCaptureMask()

void eve::graphics::ReflectionProbeCapture::setCaptureMask ( int mask )

Set the object-layer mask visible to this reflection capture.

在文件 ReflectionProbeCapture.cpp 第 229 行定义.

引用了 mask , 以及 requestCapture().

◆ setCaptureTransparent()

void eve::graphics::ReflectionProbeCapture::setCaptureTransparent ( bool enabled )

Enable or disable transparent/hair surfaces in probe captures.

在文件 ReflectionProbeCapture.cpp 第 317 行定义.

引用了 enabled.

◆ setEnvironmentLighting()

void eve::graphics::ReflectionProbeCapture::setEnvironmentLighting	(	Texture *	environment,
		float	intensity = `1.f`
	)

Set non-recursive global environment lighting for captured geometry.

This affects material IBL but does not draw a sky background into empty pixels. Local reflection probes remain disabled on the capture camera.

在文件 ReflectionProbeCapture.cpp 第 236 行定义.

被这些函数引用 eve::daynight::DayNight::applyReflectionProbeSky().

◆ setGpuBudgetMs()

void eve::graphics::ReflectionProbeCapture::setGpuBudgetMs ( float milliseconds )

Set the GPU-time budget used by adaptive capture scheduling, in milliseconds.

在文件 ReflectionProbeCapture.cpp 第 329 行定义.

引用了 milliseconds.

◆ setRefreshInterval()

void eve::graphics::ReflectionProbeCapture::setRefreshInterval ( int frames )

Set automatic refresh interval in frames for time_sliced mode.

在文件 ReflectionProbeCapture.cpp 第 225 行定义.

◆ setSkyColor()

void eve::graphics::ReflectionProbeCapture::setSkyColor	(	float	r,
		float	g,
		float	b,
		float	intensity = `1.f`
	)

Set a linear HDR backup sky color for empty capture pixels.

参数

r	Linear red channel before intensity scaling.
g	Linear green channel before intensity scaling.
b	Linear blue channel before intensity scaling.
intensity	Non-negative HDR multiplier.

在文件 ReflectionProbeCapture.cpp 第 245 行定义.

引用了 b, g , 以及 r.

◆ setSkyFaceColor()

void eve::graphics::ReflectionProbeCapture::setSkyFaceColor	(	int	face,
		float	r,
		float	g,
		float	b
	)

Override one directional backup sky face in +X,-X,+Y,-Y,+Z,-Z order.

参数

face	Face index in [0,5].
r	Linear red channel.
g	Linear green channel.
b	Linear blue channel.

在文件 ReflectionProbeCapture.cpp 第 262 行定义.

引用了 b, g, index , 以及 r.

被这些函数引用 eve::daynight::DayNight::applyReflectionProbeSky().

◆ setSkyFaceTexture()

void eve::graphics::ReflectionProbeCapture::setSkyFaceTexture	(	int	face,
		Texture *	texture
	)

Set a directional per-pixel sky texture for one capture face.

参数

face	Face index in +X,-X,+Y,-Y,+Z,-Z order.
texture	RGBA sky face matching cubemap projection, or nullptr for color backup.

在文件 ReflectionProbeCapture.cpp 第 275 行定义.

引用了 index.

被这些函数引用 eve::daynight::DayNight::applyReflectionProbeSky().

◆ setSkyFaceTextureScale()

void eve::graphics::ReflectionProbeCapture::setSkyFaceTextureScale	(	int	face,
		float	scale
	)

Set the linear HDR radiance multiplier for one sky face texture.

在文件 ReflectionProbeCapture.cpp 第 288 行定义.

引用了 index , 以及 scale.

被这些函数引用 eve::daynight::DayNight::applyReflectionProbeSky().

◆ setUpdateMode()

void eve::graphics::ReflectionProbeCapture::setUpdateMode ( const std::string & mode )

Set refresh mode: static, on_demand, time_sliced, or realtime.

在文件 ReflectionProbeCapture.cpp 第 204 行定义.

◆ stageCapturedFaces()

bool eve::graphics::ReflectionProbeCapture::stageCapturedFaces ( )

Copy a complete capture revision into a backend HDR staging cubemap. @compatibility Preserves the scripting API's boolean submitted result.

在文件 ReflectionProbeCapture.cpp 第 172 行定义.

引用了 eve::graphics::Graphics::copyHDRCanvasesToCubemap(), eve::graphics::Graphics::getLastOffscreen3DGpuDurationMs(), isCaptureComplete(), eve::graphics::Graphics::newHDRCubemap() , 以及 reportGpuDurationMs().

被这些函数引用 tick().

◆ tick()

bool eve::graphics::ReflectionProbeCapture::tick	(	int	faceBudget = `1`,
		int	filterSamples = `64`
	)

Advance capture, staging, filtering and publishing under the selected policy.

返回: True only when this call publishes a new active revision. @compatibility Preserves the scripting API's boolean publication result.

在文件 ReflectionProbeCapture.cpp 第 378 行定义.

引用了 filterAndPublish(), eve::graphics::Graphics::getLastOffscreen3DGpuDurationMs(), reportGpuDurationMs(), stageCapturedFaces() , 以及 update().

◆ tickAdaptive()

bool eve::graphics::ReflectionProbeCapture::tickAdaptive ( )

Advance capture and filtering using the GPU-budget controller's workload.

返回: True only when this call publishes a new active revision. @compatibility Preserves the scripting API's boolean publication result.

在文件 ReflectionProbeCapture.cpp 第 361 行定义.

引用了 tick.

◆ update()

bool eve::graphics::ReflectionProbeCapture::update ( int faceBudget = 1 )

Capture up to faceBudget dirty faces.

返回: True when all six HDR faces are complete. @compatibility Preserves the scripting API's boolean completion result.

在文件 ReflectionProbeCapture.cpp 第 147 行定义.

引用了 eve::graphics::Graphics::getLastOffscreen3DGpuDurationMs(), isCaptureComplete() , 以及 reportGpuDurationMs().

被这些函数引用 tick().

友元及相关函数文档

◆ ReflectionProbeRegistry

friend class ReflectionProbeRegistry

friend

在文件 ReflectionProbeCapture.h 第 261 行定义.

该类的文档由以下文件生成:

src/modules/graphics/ReflectionProbeCapture.h
src/modules/graphics/ReflectionProbeCapture.cpp

Public 成员函数

友元

详细描述

构造及析构函数说明

◆ ReflectionProbeCapture()

◆ ~ReflectionProbeCapture()

成员函数说明

◆ applyConfiguredToCamera()

◆ applyToCamera()

◆ configure()

◆ configureInfluence()

◆ filterAndPublish()

◆ getActiveCubemap()

◆ getAdaptiveFaceBudget()

◆ getAdaptiveFilterSamples()

◆ getCaptureClusteredLighting()

◆ getCaptureFarDistance()

◆ getCaptureLodDistanceScale()

◆ getCaptureMask()

◆ getCaptureTransparent()

◆ getCenterX()

◆ getCenterY()

◆ getCenterZ()

◆ getEnvironmentLighting()

◆ getEnvironmentLightingIntensity()

◆ getFaceCanvas()

◆ getGpuBudgetMs()

◆ getInfluenceBlendDistance()

◆ getInfluenceExtentX()

◆ getInfluenceExtentY()

◆ getInfluenceExtentZ()

◆ getInfluenceIntensity()

◆ getInfluencePriority()

◆ getLastCapturedFaceCount()

◆ getLastFilterSampleCount()

◆ getPendingFaceCount()

◆ getPublishedRevision()

◆ getRefreshInterval()

◆ getResolution()

◆ getRevision()

◆ getSkyB()

◆ getSkyFaceColor()

◆ getSkyFaceTexture()

◆ getSkyFaceTextureScale()

◆ getSkyG()

◆ getSkyIntensity()

◆ getSkyR()

◆ getSmoothedGpuDurationMs()

◆ getStagedRevision()

◆ getStagingCubemap()

◆ getTotalCapturedFaceCount()

◆ getUpdateMode()

◆ isCaptureComplete()

◆ isCapturePending()

◆ isRecaptureQueued()

◆ queueCapture()

◆ reportGpuDurationMs()

◆ requestCapture()

◆ setCaptureClusteredLighting()

◆ setCaptureLodDistanceScale()

◆ setCaptureMask()

◆ setCaptureTransparent()

◆ setEnvironmentLighting()

◆ setGpuBudgetMs()

◆ setRefreshInterval()

◆ setSkyColor()

◆ setSkyFaceColor()

◆ setSkyFaceTexture()

◆ setSkyFaceTextureScale()

◆ setUpdateMode()

◆ stageCapturedFaces()

◆ tick()

◆ tickAdaptive()

◆ update()

友元及相关函数文档

◆ ReflectionProbeRegistry