ggx< CONF, Symmetry, SampleVisible, NAME > Class Template Reference

The GGX Microfacet distribution. More...

#include <ggx.h>

Public Member Functions
	BBM_IMPORT_CONFIG (CONF)
Value	eval (const Vec3d &halfway, Mask mask=true) const
	Evaluate the NDF.
Vec3d	sample (const Vec3d &view, const Vec2d &xi, Mask mask=true) const
	Sample the NDF.
Value	pdf (const Vec3d &view, const Vec3d &m, Mask mask=true) const
	PDF of sampling the NDF.
Value	G1 (const Vec3d &v, const Vec3d &m, Mask mask=true) const
	Monodirectional shadowing and masking term.
	BBM_DEFAULT_CONSTRUCTOR (ggx)
	Default constructor.

Static Public Attributes
static constexpr string_literal	name = NAME

Class Attributes
specular_roughness< symmetry_t< Symmetry, Value > >	roughness
	BBM_ATTRIBUTES (roughness)

Detailed Description

template<typename CONF, symmetry_v Symmetry = symmetry_v::Isotropic, bool SampleVisible = true, string_literal NAME = "GGX">
requires concepts::config<CONF>
class bbm::ndf::ggx< CONF, Symmetry, SampleVisible, NAME >

The GGX Microfacet distribution.

Template Parameters

CONF	= bbm configuration \tpatam Symmetry = symmetry_v::Isotropic or symmetry_v::Anisotropic (Default = symmetry_v::Isotropic)
SampleVisible	= sample visible normal distribution (Default = true)
NAME	= ndf name (default = GGX)

Implements: concepts::ndf

Member Function Documentation

BBM_ATTRIBUTES()

BBM_ATTRIBUTES

(

roughness

)

BBM_DEFAULT_CONSTRUCTOR()

BBM_DEFAULT_CONSTRUCTOR ( ggx< CONF, Symmetry, SampleVisible, NAME >  )

inline

Default constructor.

BBM_IMPORT_CONFIG()

BBM_IMPORT_CONFIG

(

CONF

)

eval()

Value eval ( const Vec3d &  halfway, Mask  mask = true  ) const

inline

Evaluate the NDF.

Parameters

halfway	= vector to eval the NDF for
mask	= enable/disbale lanes [default = true]

Returns

the resulting evaluation of the NDF

G1()

Value G1 ( const Vec3d &  v, const Vec3d &  m, Mask  mask = true  ) const

inline

Monodirectional shadowing and masking term.

Parameters

v	= incident/outgoing vector
m	= microfacet normal
mask	= enable/disable lanes

Returns

the monodirectional shadowing and masking attentuation factor

pdf()

Value pdf ( const Vec3d &  view, const Vec3d &  m, Mask  mask = true  ) const

inline

PDF of sampling the NDF.

Parameters

view	= view direction (ignored)
m	= sampled microfacet normal
mask	= enable/disable lanes [default = true]

Returns

the PDF of sampling 'm' using the sample method.

sample()

Vec3d sample ( const Vec3d &  view, const Vec2d &  xi, Mask  mask = true  ) const

inline

Sample the NDF.

Parameters

view	= view direction
xi	= 2D uniform random variables in [0..1] range
Mask	= enable/disbale lanes

Returns

A sampled microfacet normal.

Member Data Documentation

name

constexpr string_literal name = NAME

staticconstexpr

roughness

specular_roughness<symmetry_t<Symmetry,Value> > roughness

---

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

• include/ndf/ggx.h