background_t Class Reference

#include <background.h>

Inheritance diagram for background_t:

[legend]

List of all members.

Public Member Functions
virtual color_t	operator() (const ray_t &ray, renderState_t &state, bool filtered=false) const =0
	get the background color for a given ray
virtual color_t	eval (const ray_t &ray, bool filtered=false) const =0
virtual light_t *	getLight () const
virtual	~background_t ()

---

Detailed Description

Definition at line 14 of file background.h.

---

Constructor & Destructor Documentation

virtual background_t::~background_t

(

)

[inline, virtual]

Definition at line 25 of file background.h.

---

Member Function Documentation

virtual color_t background_t::eval	(	const ray_t &	ray,
		bool	filtered = false
	)			const [pure virtual]

Implemented in darkSkyBackground_t, gradientBackground_t, sunskyBackground_t, textureBackground_t, and constBackground_t.

virtual light_t* background_t::getLight

(

)

const [inline, virtual]

get the light source representing background lighting.

Returns:

the light source that reproduces background lighting, or NULL if background shall only be sampled from BSDFs

Reimplemented in darkSkyBackground_t, gradientBackground_t, sunskyBackground_t, textureBackground_t, and constBackground_t.

Definition at line 24 of file background.h.

virtual color_t background_t::operator()	(	const ray_t &	ray,
		renderState_t &	state,
		bool	filtered = false
	)			const [pure virtual]

get the background color for a given ray

Implemented in darkSkyBackground_t, gradientBackground_t, sunskyBackground_t, textureBackground_t, and constBackground_t.

---

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

• include/core_api/background.h