EVENGINE_API_BACKENDS public API. 更多...

#include <RenderSystem3D.h>

类 eve::graphics::Camera3D 继承关系图:

类
struct	Data
	Data public API. 更多...

Public 成员函数
void	release () override
	Entity.

void	setEye (float x, float y, float z)

float	getEyeX ()
	Camera eye position (world space).

float	getEyeY ()

float	getEyeZ ()

void	setTarget (float x, float y, float z)

float	getTargetX ()
	Look-at target (world space).

float	getTargetY ()

float	getTargetZ ()

void	setUp (float x, float y, float z)

void	setFov (float fovYDeg)

float	getFov ()
	Vertical field of view in degrees.

void	setOrthographic (float height)
	Enable an orthographic projection with the given vertical world-space span.

void	setPerspective ()
	Return to perspective projection, retaining the configured field of view.

void	setClipPlanes (float nearZ, float farZ)
	Set positive near/far clipping distances; far is kept beyond near.

float	getNearClip ()
	Return the positive near clipping distance.

float	getFarClip ()
	Return the far clipping distance.

void	setPhysicalLens (float aperture, float focalLength)
	Set positive physical-camera aperture and focal length metadata.

float	getAperture ()
	Return physical-camera aperture.

float	getFocalLength ()
	Return physical-camera focal length in millimetres.

void	setLayerCullDistance (int layer, float distance)
	Set the camera cull distance for one render layer; zero disables the override.

float	getLayerCullDistance (int layer)
	Return the camera cull-distance override for one render layer.

void	setShadowLayerCullDistance (int layer, float distance)
	Set the shadow-caster cull distance for one render layer; zero disables it.

float	getShadowLayerCullDistance (int layer)
	Return the shadow-caster cull-distance override for one render layer.

void	setActive (bool active)

void	setAmbient (float r, float g, float b)

void	setEnvMap (Texture *cube)
	Specular IBL cubemap (Graphics::newCubemap). nullptr disables IBL.

void	setEnvIntensity (float intensity)

void	setExposure (float ev)
	Set exposure compensation in photographic stops. Positive values brighten.

float	getExposure ()
	Return exposure compensation in photographic stops.

void	setAutoExposure (bool enabled, float minEV=-8.f, float maxEV=8.f)
	Enable log-average automatic exposure and set its EV clamp range.

bool	isAutoExposure ()
	Return whether automatic exposure is enabled.

void	setBloom (float intensity, float threshold=1.f)
	Configure HDR bloom. Zero intensity disables it.

float	getBloomIntensity ()
	Return bloom intensity.

float	getBloomThreshold ()
	Return bloom threshold in linear HDR units.

void	setDepthOfField (float focusDistance, float maxBlurPx, float focusRange=8.f)
	Configure Gaussian depth-of-field on the final HDR resolve.

void	clearDepthOfField ()
	Disable depth-of-field while retaining the current focus settings.

float	getDofFocusDistance ()
	Return DOF focus distance.

float	getDofMaxBlur ()
	Return DOF max blur in texels (0 when disabled).

float	getDofFocusRange ()
	Return DOF focus range.

void	setEnvProbe (float centerX, float centerY, float centerZ, float extentX, float extentY, float extentZ)
	Enable box-projected IBL for the camera environment cubemap.

void	clearEnvProbe ()
	Disable box projection and return to an infinite-distance environment.

bool	hasEnvProbe ()
	True when all three box-probe extents are positive.

float	getEnvProbeCenterX ()

float	getEnvProbeCenterY ()

float	getEnvProbeCenterZ ()

float	getEnvProbeExtentX ()

float	getEnvProbeExtentY ()

float	getEnvProbeExtentZ ()

void	setReflectionProbe (int slot, Texture *cubemap, float centerX, float centerY, float centerZ, float extentX, float extentY, float extentZ, float intensity=1.f, float blendDistance=1.f, int priority=0)
	Configure one local reflection probe slot.

void	clearReflectionProbe (int slot)
	Disable one local reflection probe slot.

int	getReflectionProbeCount ()
	Return the number of enabled local reflection probes.

void	screenToRay (float screenX, float screenY, float viewW, float viewH)
	Build a world-space picking ray from a screen pixel. Stores origin (camera eye) and normalized direction; read via getScreenRay*. viewW/viewH must match the drawable used for rendering.

float	getScreenRayOriginX ()

float	getScreenRayOriginY ()

float	getScreenRayOriginZ ()

float	getScreenRayDirX ()

float	getScreenRayDirY ()

float	getScreenRayDirZ ()

静态 Public 成员函数
static Camera3D *	createCamera ()

详细描述

EVENGINE_API_BACKENDS public API.

在文件 RenderSystem3D.h 第 29 行定义.

成员函数说明

◆ clearDepthOfField()

void eve::graphics::Camera3D::clearDepthOfField ( )

Disable depth-of-field while retaining the current focus settings.

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

◆ clearEnvProbe()

void eve::graphics::Camera3D::clearEnvProbe ( )

Disable box projection and return to an infinite-distance environment.

在文件 RenderSystem3D.cpp 第 335 行定义.

◆ clearReflectionProbe()

void eve::graphics::Camera3D::clearReflectionProbe ( int slot )

Disable one local reflection probe slot.

在文件 RenderSystem3D.cpp 第 362 行定义.

引用了 eve::graphics::Camera3D::Data::kMaxReflectionProbes.

◆ createCamera()

static Camera3D * eve::graphics::Camera3D::createCamera ( )

inlinestatic

@ownership ECS owns the result. @lifetime Valid until ECS destroys the entity.

在文件 RenderSystem3D.h 第 87 行定义.

引用了 c.

◆ getAperture()

float eve::graphics::Camera3D::getAperture ( )

Return physical-camera aperture.

在文件 RenderSystem3D.cpp 第 251 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ getBloomIntensity()

float eve::graphics::Camera3D::getBloomIntensity ( )

Return bloom intensity.

在文件 RenderSystem3D.cpp 第 313 行定义.

◆ getBloomThreshold()

float eve::graphics::Camera3D::getBloomThreshold ( )

Return bloom threshold in linear HDR units.

在文件 RenderSystem3D.cpp 第 314 行定义.

◆ getDofFocusDistance()

float eve::graphics::Camera3D::getDofFocusDistance ( )

Return DOF focus distance.

在文件 RenderSystem3D.cpp 第 325 行定义.

◆ getDofFocusRange()

float eve::graphics::Camera3D::getDofFocusRange ( )

Return DOF focus range.

在文件 RenderSystem3D.cpp 第 327 行定义.

◆ getDofMaxBlur()

float eve::graphics::Camera3D::getDofMaxBlur ( )

Return DOF max blur in texels (0 when disabled).

在文件 RenderSystem3D.cpp 第 326 行定义.

◆ getEnvProbeCenterX()

float eve::graphics::Camera3D::getEnvProbeCenterX ( )

在文件 RenderSystem3D.cpp 第 341 行定义.

◆ getEnvProbeCenterY()

float eve::graphics::Camera3D::getEnvProbeCenterY ( )

在文件 RenderSystem3D.cpp 第 342 行定义.

◆ getEnvProbeCenterZ()

float eve::graphics::Camera3D::getEnvProbeCenterZ ( )

在文件 RenderSystem3D.cpp 第 343 行定义.

◆ getEnvProbeExtentX()

float eve::graphics::Camera3D::getEnvProbeExtentX ( )

在文件 RenderSystem3D.cpp 第 344 行定义.

◆ getEnvProbeExtentY()

float eve::graphics::Camera3D::getEnvProbeExtentY ( )

在文件 RenderSystem3D.cpp 第 345 行定义.

◆ getEnvProbeExtentZ()

float eve::graphics::Camera3D::getEnvProbeExtentZ ( )

在文件 RenderSystem3D.cpp 第 346 行定义.

◆ getExposure()

float eve::graphics::Camera3D::getExposure ( )

Return exposure compensation in photographic stops.

在文件 RenderSystem3D.cpp 第 296 行定义.

◆ getEyeX()

float eve::graphics::Camera3D::getEyeX ( )

Camera eye position (world space).

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

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ getEyeY()

float eve::graphics::Camera3D::getEyeY ( )

在文件 RenderSystem3D.cpp 第 205 行定义.

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ getEyeZ()

float eve::graphics::Camera3D::getEyeZ ( )

在文件 RenderSystem3D.cpp 第 206 行定义.

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ getFarClip()

float eve::graphics::Camera3D::getFarClip ( )

Return the far clipping distance.

在文件 RenderSystem3D.cpp 第 243 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ getFocalLength()

float eve::graphics::Camera3D::getFocalLength ( )

Return physical-camera focal length in millimetres.

在文件 RenderSystem3D.cpp 第 252 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ getFov()

float eve::graphics::Camera3D::getFov ( )

Vertical field of view in degrees.

在文件 RenderSystem3D.cpp 第 228 行定义.

◆ getLayerCullDistance()

float eve::graphics::Camera3D::getLayerCullDistance ( int layer )

Return the camera cull-distance override for one render layer.

在文件 RenderSystem3D.cpp 第 261 行定义.

引用了 EV_PARAM_CHECK , 以及 layer.

◆ getNearClip()

float eve::graphics::Camera3D::getNearClip ( )

Return the positive near clipping distance.

在文件 RenderSystem3D.cpp 第 242 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ getReflectionProbeCount()

int eve::graphics::Camera3D::getReflectionProbeCount ( )

Return the number of enabled local reflection probes.

在文件 RenderSystem3D.cpp 第 367 行定义.

引用了 count.

◆ getScreenRayDirX()

float eve::graphics::Camera3D::getScreenRayDirX ( )

在文件 RenderSystem3D.cpp 第 465 行定义.

◆ getScreenRayDirY()

float eve::graphics::Camera3D::getScreenRayDirY ( )

在文件 RenderSystem3D.cpp 第 466 行定义.

◆ getScreenRayDirZ()

float eve::graphics::Camera3D::getScreenRayDirZ ( )

在文件 RenderSystem3D.cpp 第 467 行定义.

◆ getScreenRayOriginX()

float eve::graphics::Camera3D::getScreenRayOriginX ( )

在文件 RenderSystem3D.cpp 第 462 行定义.

◆ getScreenRayOriginY()

float eve::graphics::Camera3D::getScreenRayOriginY ( )

在文件 RenderSystem3D.cpp 第 463 行定义.

◆ getScreenRayOriginZ()

float eve::graphics::Camera3D::getScreenRayOriginZ ( )

在文件 RenderSystem3D.cpp 第 464 行定义.

◆ getShadowLayerCullDistance()

float eve::graphics::Camera3D::getShadowLayerCullDistance ( int layer )

Return the shadow-caster cull-distance override for one render layer.

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

引用了 EV_PARAM_CHECK , 以及 layer.

◆ getTargetX()

float eve::graphics::Camera3D::getTargetX ( )

Look-at target (world space).

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

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ getTargetY()

float eve::graphics::Camera3D::getTargetY ( )

在文件 RenderSystem3D.cpp 第 216 行定义.

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ getTargetZ()

float eve::graphics::Camera3D::getTargetZ ( )

在文件 RenderSystem3D.cpp 第 217 行定义.

被这些函数引用 eve::camera::CameraController::setCameraRoll().

◆ hasEnvProbe()

bool eve::graphics::Camera3D::hasEnvProbe ( )

True when all three box-probe extents are positive.

在文件 RenderSystem3D.cpp 第 337 行定义.

◆ isAutoExposure()

bool eve::graphics::Camera3D::isAutoExposure ( )

Return whether automatic exposure is enabled.

在文件 RenderSystem3D.cpp 第 305 行定义.

◆ release()

void eve::graphics::Camera3D::release ( )

inlineoverride

Entity.

Release.

在文件 RenderSystem3D.h 第 35 行定义.

◆ screenToRay()

void eve::graphics::Camera3D::screenToRay	(	float	screenX,
		float	screenY,
		float	viewW,
		float	viewH
	)

Build a world-space picking ray from a screen pixel. Stores origin (camera eye) and normalized direction; read via getScreenRay*. viewW/viewH must match the drawable used for rendering.

在文件 RenderSystem3D.cpp 第 410 行定义.

引用了 eve::graphics::cameraProjectionVulkanRH_ZO(), d, dir, eye, fovRad, target, up , 以及 w.

◆ setActive()

void eve::graphics::Camera3D::setActive ( bool active )

在文件 RenderSystem3D.cpp 第 281 行定义.

引用了 active.

◆ setAmbient()

void eve::graphics::Camera3D::setAmbient	(	float	r,
		float	g,
		float	b
	)

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

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

◆ setAutoExposure()

void eve::graphics::Camera3D::setAutoExposure	(	bool	enabled,
		float	minEV = `-8.f`,
		float	maxEV = `8.f`
	)

Enable log-average automatic exposure and set its EV clamp range.

在文件 RenderSystem3D.cpp 第 298 行定义.

引用了 d , 以及 enabled.

◆ setBloom()

void eve::graphics::Camera3D::setBloom	(	float	intensity,
		float	threshold = `1.f`
	)

Configure HDR bloom. Zero intensity disables it.

在文件 RenderSystem3D.cpp 第 307 行定义.

引用了 d.

◆ setClipPlanes()

void eve::graphics::Camera3D::setClipPlanes	(	float	nearZ,
		float	farZ
	)

Set positive near/far clipping distances; far is kept beyond near.

在文件 RenderSystem3D.cpp 第 237 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ setDepthOfField()

void eve::graphics::Camera3D::setDepthOfField	(	float	focusDistance,
		float	maxBlurPx,
		float	focusRange = `8.f`
	)

Configure Gaussian depth-of-field on the final HDR resolve.

参数

focusDistance	View-space distance of the sharp plane.
maxBlurPx	Maximum blur radius in texels; <= 0 disables DOF.
focusRange	Distance from focus at which blur reaches maxBlurPx.

在文件 RenderSystem3D.cpp 第 316 行定义.

引用了 d.

◆ setEnvIntensity()

void eve::graphics::Camera3D::setEnvIntensity ( float intensity )

在文件 RenderSystem3D.cpp 第 292 行定义.

被这些函数引用 eve::graphics::ReflectionProbeCapture::requestCapture().

◆ setEnvMap()

void eve::graphics::Camera3D::setEnvMap ( Texture * cube )

Specular IBL cubemap (Graphics::newCubemap). nullptr disables IBL.

在文件 RenderSystem3D.cpp 第 290 行定义.

被这些函数引用 eve::graphics::ReflectionProbeCapture::requestCapture().

◆ setEnvProbe()

void eve::graphics::Camera3D::setEnvProbe	(	float	centerX,
		float	centerY,
		float	centerZ,
		float	extentX,
		float	extentY,
		float	extentZ
	)

Enable box-projected IBL for the camera environment cubemap.

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

◆ setExposure()

void eve::graphics::Camera3D::setExposure ( float ev )

Set exposure compensation in photographic stops. Positive values brighten.

在文件 RenderSystem3D.cpp 第 294 行定义.

◆ setEye()

void eve::graphics::Camera3D::setEye	(	float	x,
		float	y,
		float	z
	)

在文件 RenderSystem3D.cpp 第 197 行定义.

引用了 d, x, y , 以及 z.

◆ setFov()

void eve::graphics::Camera3D::setFov ( float fovYDeg )

在文件 RenderSystem3D.cpp 第 226 行定义.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ setLayerCullDistance()

void eve::graphics::Camera3D::setLayerCullDistance	(	int	layer,
		float	distance
	)

Set the camera cull distance for one render layer; zero disables the override.

在文件 RenderSystem3D.cpp 第 253 行定义.

引用了 distance, EV_PARAM_CHECK , 以及 layer.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ setOrthographic()

void eve::graphics::Camera3D::setOrthographic ( float height )

Enable an orthographic projection with the given vertical world-space span.

在文件 RenderSystem3D.cpp 第 230 行定义.

引用了 height.

◆ setPerspective()

void eve::graphics::Camera3D::setPerspective ( )

Return to perspective projection, retaining the configured field of view.

在文件 RenderSystem3D.cpp 第 235 行定义.

◆ setPhysicalLens()

void eve::graphics::Camera3D::setPhysicalLens	(	float	aperture,
		float	focalLength
	)

Set positive physical-camera aperture and focal length metadata.

在文件 RenderSystem3D.cpp 第 244 行定义.

引用了 EV_PARAM_CHECK.

被这些函数引用 eve::camera::CameraController::applyPhotoModeField().

◆ setReflectionProbe()

void eve::graphics::Camera3D::setReflectionProbe	(	int	slot,
		Texture *	cubemap,
		float	centerX,
		float	centerY,
		float	centerZ,
		float	extentX,
		float	extentY,
		float	extentZ,
		float	intensity = `1.f`,
		float	blendDistance = `1.f`,
		int	priority = `0`
	)

Configure one local reflection probe slot.

参数

slot	Slot in [0,7].
cubemap	Prefiltered cubemap; nullptr disables the slot.
blendDistance	Inward edge fade distance in world units.
priority	Higher values win when more than two probes are relevant.

在文件 RenderSystem3D.cpp 第 348 行定义.

引用了 eve::graphics::Camera3D::Data::kMaxReflectionProbes , 以及 priority.

◆ setShadowLayerCullDistance()

void eve::graphics::Camera3D::setShadowLayerCullDistance	(	int	layer,
		float	distance
	)

Set the shadow-caster cull distance for one render layer; zero disables it.

在文件 RenderSystem3D.cpp 第 267 行定义.

引用了 distance, EV_PARAM_CHECK , 以及 layer.

◆ setTarget()

void eve::graphics::Camera3D::setTarget	(	float	x,
		float	y,
		float	z
	)

在文件 RenderSystem3D.cpp 第 208 行定义.

引用了 d, x, y , 以及 z.

◆ setUp()

void eve::graphics::Camera3D::setUp	(	float	x,
		float	y,
		float	z
	)

在文件 RenderSystem3D.cpp 第 219 行定义.

引用了 d, x, y , 以及 z.

被这些函数引用 eve::camera::CameraController::setCameraRoll().

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

src/modules/graphics/RenderSystem3D.h
src/modules/graphics/RenderSystem3D.cpp

类

Public 成员函数

静态 Public 成员函数

详细描述

成员函数说明

◆ clearDepthOfField()

◆ clearEnvProbe()

◆ clearReflectionProbe()

◆ createCamera()

◆ getAperture()

◆ getBloomIntensity()

◆ getBloomThreshold()

◆ getDofFocusDistance()

◆ getDofFocusRange()

◆ getDofMaxBlur()

◆ getEnvProbeCenterX()

◆ getEnvProbeCenterY()

◆ getEnvProbeCenterZ()

◆ getEnvProbeExtentX()

◆ getEnvProbeExtentY()

◆ getEnvProbeExtentZ()

◆ getExposure()

◆ getEyeX()

◆ getEyeY()

◆ getEyeZ()

◆ getFarClip()

◆ getFocalLength()

◆ getFov()

◆ getLayerCullDistance()

◆ getNearClip()

◆ getReflectionProbeCount()

◆ getScreenRayDirX()

◆ getScreenRayDirY()

◆ getScreenRayDirZ()

◆ getScreenRayOriginX()

◆ getScreenRayOriginY()

◆ getScreenRayOriginZ()

◆ getShadowLayerCullDistance()

◆ getTargetX()

◆ getTargetY()

◆ getTargetZ()

◆ hasEnvProbe()

◆ isAutoExposure()

◆ release()

◆ screenToRay()

◆ setActive()

◆ setAmbient()

◆ setAutoExposure()

◆ setBloom()

◆ setClipPlanes()

◆ setDepthOfField()

◆ setEnvIntensity()

◆ setEnvMap()

◆ setEnvProbe()

◆ setExposure()

◆ setEye()

◆ setFov()

◆ setLayerCullDistance()

◆ setOrthographic()

◆ setPerspective()

◆ setPhysicalLens()

◆ setReflectionProbe()

◆ setShadowLayerCullDistance()

◆ setTarget()

◆ setUp()