eve::graphics::FogVolume类 参考

Analytic local participating-media volume injected into atmospheric fog. 更多...

#include <FogVolume.h>

Public 类型
enum class	Shape { sphere , box , cylinder }
	Shape public API. 更多...

Public 成员函数
void	setShape (const std::string &shape)
	Set shape using "sphere", "box" or "cylinder"; unknown selects box.
Shape	getShape () const
std::string	getShapeName () const
void	setPosition (float x, float y, float z)
	Set world-space center.
const glm::vec3 &	getPosition () const
void	setSize (float x, float y, float z)
	Set full world-space dimensions; values are clamped positive.
const glm::vec3 &	getSize () const
void	setExtinction (float extinction)
	Signed extinction; negative values carve fog but total density is clamped.
float	getExtinction () const
void	setAlbedo (float r, float g, float b)
	Single-scattering albedo, clamped to [0,1].
const glm::vec3 &	getAlbedo () const
void	setEmissive (float r, float g, float b)
	Unlit radiance emitted per unit density.
const glm::vec3 &	getEmissive () const
void	setAnisotropy (float anisotropy)
	HG anisotropy in [-0.99,0.99].
float	getAnisotropy () const
void	setEdgeFalloff (float falloff)
	Fraction of normalized radius used for a smooth edge, in [0,1].
float	getEdgeFalloff () const
void	setNoise (float amount, float scale, int seed)
	Configure deterministic world-space density variation.
float	getNoiseAmount () const
	Density-noise blend amount in [0,1].
float	getNoiseScale () const
	World-space density-noise frequency.
int	getNoiseSeed () const
	Stable density-noise seed.
float	sampleExtinction (const glm::vec3 &worldPosition) const
	Normalized analytic density at a world position, including signed extinction.

详细描述

Analytic local participating-media volume injected into atmospheric fog.

在文件 FogVolume.h 第 12 行定义.

成员枚举类型说明

Shape

enum class eve::graphics::FogVolume::Shape

strong

Shape public API.

枚举值
sphere
box
cylinder

在文件 FogVolume.h 第 15 行定义.

成员函数说明

getAlbedo()

const glm::vec3 & eve::graphics::FogVolume::getAlbedo ( ) const

inline

在文件 FogVolume.h 第 34 行定义.

getAnisotropy()

float eve::graphics::FogVolume::getAnisotropy ( ) const

inline

在文件 FogVolume.h 第 40 行定义.

getEdgeFalloff()

float eve::graphics::FogVolume::getEdgeFalloff ( ) const

inline

在文件 FogVolume.h 第 43 行定义.

getEmissive()

const glm::vec3 & eve::graphics::FogVolume::getEmissive ( ) const

inline

在文件 FogVolume.h 第 37 行定义.

getExtinction()

float eve::graphics::FogVolume::getExtinction ( ) const

inline

在文件 FogVolume.h 第 31 行定义.

getNoiseAmount()

float eve::graphics::FogVolume::getNoiseAmount ( ) const

inline

Density-noise blend amount in [0,1].

在文件 FogVolume.h 第 52 行定义.

getNoiseScale()

float eve::graphics::FogVolume::getNoiseScale ( ) const

inline

World-space density-noise frequency.

在文件 FogVolume.h 第 54 行定义.

getNoiseSeed()

int eve::graphics::FogVolume::getNoiseSeed ( ) const

inline

Stable density-noise seed.

在文件 FogVolume.h 第 56 行定义.

getPosition()

const glm::vec3 & eve::graphics::FogVolume::getPosition ( ) const

inline

在文件 FogVolume.h 第 24 行定义.

getShape()

Shape eve::graphics::FogVolume::getShape ( ) const

inline

在文件 FogVolume.h 第 19 行定义.

getShapeName()

std::string eve::graphics::FogVolume::getShapeName

(

)

const

在文件 FogVolume.cpp 第 50 行定义.

引用了 cylinder , 以及 sphere.

getSize()

const glm::vec3 & eve::graphics::FogVolume::getSize ( ) const

inline

在文件 FogVolume.h 第 27 行定义.

sampleExtinction()

float eve::graphics::FogVolume::sampleExtinction

(

const glm::vec3 &

worldPosition

)

const

Normalized analytic density at a world position, including signed extinction.

在文件 FogVolume.cpp 第 82 行定义.

引用了 cylinder, p, radius , 以及 sphere.

setAlbedo()

void eve::graphics::FogVolume::setAlbedo	(	float	r,
		float	g,
		float	b
	)

Single-scattering albedo, clamped to [0,1].

在文件 FogVolume.cpp 第 60 行定义.

引用了 b, g , 以及 r.

setAnisotropy()

void eve::graphics::FogVolume::setAnisotropy

(

float

anisotropy

)

HG anisotropy in [-0.99,0.99].

在文件 FogVolume.cpp 第 68 行定义.

setEdgeFalloff()

void eve::graphics::FogVolume::setEdgeFalloff

(

float

falloff

)

Fraction of normalized radius used for a smooth edge, in [0,1].

在文件 FogVolume.cpp 第 72 行定义.

setEmissive()

void eve::graphics::FogVolume::setEmissive	(	float	r,
		float	g,
		float	b
	)

Unlit radiance emitted per unit density.

在文件 FogVolume.cpp 第 64 行定义.

引用了 b, g , 以及 r.

setExtinction()

void eve::graphics::FogVolume::setExtinction ( float  extinction )

inline

Signed extinction; negative values carve fog but total density is clamped.

在文件 FogVolume.h 第 30 行定义.

引用了 extinction.

setNoise()

void eve::graphics::FogVolume::setNoise	(	float	amount,
		float	scale,
		int	seed
	)

Configure deterministic world-space density variation.

参数

amount	Blend from uniform density at 0 to full noise at 1.
scale	World-space noise frequency; values are clamped positive.
seed	Stable integer variation seed.

在文件 FogVolume.cpp 第 76 行定义.

引用了 scale , 以及 seed.

setPosition()

void eve::graphics::FogVolume::setPosition ( float  x, float  y, float  z  )

inline

Set world-space center.

在文件 FogVolume.h 第 23 行定义.

引用了 x, y , 以及 z.

setShape()

void eve::graphics::FogVolume::setShape

(

const std::string &

shape

)

Set shape using "sphere", "box" or "cylinder"; unknown selects box.

在文件 FogVolume.cpp 第 41 行定义.

引用了 box, cylinder, shape , 以及 sphere.

setSize()

void eve::graphics::FogVolume::setSize	(	float	x,
		float	y,
		float	z
	)

Set full world-space dimensions; values are clamped positive.

在文件 FogVolume.cpp 第 56 行定义.

引用了 x, y , 以及 z.

---

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

• src/modules/graphics/FogVolume.h
• src/modules/graphics/FogVolume.cpp