BSDF implementation of a BSDF model. More...

#include <bsdf.h>

Inherits bsdf_base< get_config< BSDFMODEL > >, and BSDFMODEL.

Public Member Functions
	BBM_BASETYPES (BSDFMODEL)

	BBM_IMPORT_CONFIG (BSDFMODEL)

	bsdf (const BSDFMODEL &model)
	Construct directly from a BSDF model.

virtual Spectrum	eval (const Vec3d &in, const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const override final
	Virtual passthrough of eval function.

virtual BsdfSample	sample (const Vec3d &out, const Vec2d &xi, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const override final
	Virtual passthrough of sample function.

virtual Value	pdf (const Vec3d &in, const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const override final
	Virtual passthrough of the pdf function.

virtual Spectrum	reflectance (const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const override final
	Virtual passthrough of the hemispherical reflectance function.

virtual std::string	toString (void) const override final
	Pipe toString to BSDFMODEL.

Parameter Enumeration
virtual bbm::vector< Value & >	parameter_values (bsdf_attr flags=bsdf_attr::All) override final

virtual bbm::vector< const Value & >	parameter_values (bsdf_attr flags=bsdf_attr::All) const override final

virtual bbm::vector< Value >	parameter_default_values (bsdf_attr flags=bsdf_attr::All) const override final

virtual bbm::vector< Value >	parameter_lower_bound (bsdf_attr flags=bsdf_attr::All) const override final

virtual bbm::vector< Value >	parameter_upper_bound (bsdf_attr flags=bsdf_attr::All) const override final

Public Member Functions inherited from bsdf_base< get_config< BSDFMODEL > >
	BBM_IMPORT_CONFIG (get_config< BSDFMODEL >)

virtual	~bsdf_base (void)
	empty virtual destructor

virtual Spectrum	eval (const Vec3d &in, const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const=0
	Evaluate the BSDF given an in and out direction.

virtual BsdfSample	sample (const Vec3d &out, const Vec2d &xi, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const=0
	Samples the BSDF given an out direction and 2 random variables.

virtual Value	pdf (const Vec3d &in, const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const=0
	The pdf of the in-out direction combination.

virtual Spectrum	reflectance (const Vec3d &out, BsdfFlag component=bsdf_flag::All, unit_t unit=unit_t::Radiance, Mask mask=true) const=0
	the (approximate) hemispherical reflectance of the BSDF

virtual std::string	toString (void) const=0
	Fancy print the BSDF to a string.

Static Public Member Functions
static bsdf	fromString (const std::string &str)
	construct the bsdf from a string

Public Attributes
	BBM_BSDF_FORWARD

Public Attributes inherited from bsdf_base< get_config< BSDFMODEL > >
	BBM_BSDF_FORWARD

Static Public Attributes
static constexpr string_literal	name = "Bsdf"

Static Public Attributes inherited from bsdf_base< get_config< BSDFMODEL > >
static constexpr string_literal	name

Detailed Description

template<typename BSDFMODEL>
requires concepts::bsdfmodel<BSDFMODEL>
class bbm::bsdf< BSDFMODEL >

BSDF implementation of a BSDF model.

Template Parameters

BSDFMODEL = the BSDF model to transform into a BSDF

Constructor & Destructor Documentation

◆ bsdf()

bsdf ( const BSDFMODEL & model )

inline

Construct directly from a BSDF model.

Member Function Documentation

◆ BBM_BASETYPES()

BBM_BASETYPES ( BSDFMODEL )

◆ BBM_IMPORT_CONFIG()

BBM_IMPORT_CONFIG ( BSDFMODEL )

◆ eval()

virtual Spectrum eval	(	const Vec3d &	in,
		const Vec3d &	out,
		BsdfFlag	component = `bsdf_flag::All`,
		unit_t	unit = `unit_t::Radiance`,
		Mask	mask = `true`
	)		const

inlinefinaloverridevirtual

Virtual passthrough of eval function.

Parameters

in	= incoming direction
out	= exitant direction
component	= which reflectance component to eval
unit	= unit of computation
mask	= mask to enable/disable lanes

Returns: the resulting Spectrum of the evaluation.

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ fromString()

static bsdf fromString ( const std::string & str )

inlinestatic

construct the bsdf from a string

◆ parameter_default_values()

virtual bbm::vector< Value > parameter_default_values ( bsdf_attr flags = bsdf_attr::All ) const

inlinefinaloverridevirtual

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ parameter_lower_bound()

virtual bbm::vector< Value > parameter_lower_bound ( bsdf_attr flags = bsdf_attr::All ) const

inlinefinaloverridevirtual

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ parameter_upper_bound()

virtual bbm::vector< Value > parameter_upper_bound ( bsdf_attr flags = bsdf_attr::All ) const

inlinefinaloverridevirtual

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ parameter_values() [1/2]

virtual bbm::vector< const Value & > parameter_values ( bsdf_attr flags = bsdf_attr::All ) const

inlinefinaloverridevirtual

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ parameter_values() [2/2]

virtual bbm::vector< Value & > parameter_values ( bsdf_attr flags = bsdf_attr::All )

inlinefinaloverridevirtual

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ pdf()

virtual Value pdf	(	const Vec3d &	in,
		const Vec3d &	out,
		BsdfFlag	component = `bsdf_flag::All`,
		unit_t	unit = `unit_t::Radiance`,
		Mask	mask = `true`
	)		const

inlinefinaloverridevirtual

Virtual passthrough of the pdf function.

Parameters

in	= the incoming sampled direction
out	= the exitant (given) direction
component	= which reflectance component was sampled
unit	= unit of computation
mask	= mask to enable/disable lanes

Returns: the pdf of samling the in-out direction conbination.

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ reflectance()

virtual Spectrum reflectance	(	const Vec3d &	out,
		BsdfFlag	component = `bsdf_flag::All`,
		unit_t	unit = `unit_t::Radiance`,
		Mask	mask = `true`
	)		const

inlinefinaloverridevirtual

Virtual passthrough of the hemispherical reflectance function.

Parameters

out	= the outgoing direction
component	= which reflectance component to eval
unit	= unit of computation
mask	= mask to enable/disable lanes

Returns: the approximate hemispherical reflectance (Spectrum) of the BSDF

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ sample()

virtual BsdfSample sample	(	const Vec3d &	out,
		const Vec2d &	xi,
		BsdfFlag	component = `bsdf_flag::All`,
		unit_t	unit = `unit_t::Radiance`,
		Mask	mask = `true`
	)		const

inlinefinaloverridevirtual

Virtual passthrough of sample function.

Parameters

out	= the outgoing direction
xi	= two random variables stored in a Vec2d used to sample
component	= which reflectance component to sample
unit	= unit of computation
mask	= mask to enable/disable lanes

Returns: a BsdfSample that contains the sampled direction and the corresponding pdf.

Implements bsdf_base< get_config< BSDFMODEL > >.

◆ toString()

virtual std::string toString ( void ) const

inlinefinaloverridevirtual

Pipe toString to BSDFMODEL.

Implements bsdf_base< get_config< BSDFMODEL > >.

Member Data Documentation

◆ BBM_BSDF_FORWARD

BBM_BSDF_FORWARD

◆ name

constexpr string_literal name = "Bsdf"

staticconstexpr

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

include/bbm/bsdf.h

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ bsdf()

Member Function Documentation

◆ BBM_BASETYPES()

◆ BBM_IMPORT_CONFIG()

◆ eval()

◆ fromString()

◆ parameter_default_values()

◆ parameter_lower_bound()

◆ parameter_upper_bound()

◆ parameter_values() [1/2]

◆ parameter_values() [2/2]

◆ pdf()

◆ reflectance()

◆ sample()

◆ toString()

Member Data Documentation

◆ BBM_BSDF_FORWARD

◆ name