YafaRay Core  v3.2.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
background_t Class Referenceabstract

#include <background.h>

Inheritance diagram for background_t:
Inheritance graph
[legend]

Public Member Functions

virtual color_t operator() (const ray_t &ray, renderState_t &state, bool from_postprocessed=false) const =0
 get the background color for a given ray More...
 
virtual color_t eval (const ray_t &ray, bool from_postprocessed=false) const =0
 
virtual bool hasIBL ()
 
virtual bool shootsCaustic ()
 
virtual ~background_t ()
 

Detailed Description

Definition at line 14 of file background.h.

Constructor & Destructor Documentation

virtual background_t::~background_t ( )
inlinevirtual

Definition at line 26 of file background.h.

Member Function Documentation

virtual color_t background_t::eval ( const ray_t ray,
bool  from_postprocessed = false 
) const
pure virtual
virtual bool background_t::hasIBL ( )
inlinevirtual

get the light source representing background lighting.

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

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

Definition at line 24 of file background.h.

virtual color_t background_t::operator() ( const ray_t ray,
renderState_t state,
bool  from_postprocessed = false 
) const
pure virtual

get the background color for a given ray

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

virtual bool background_t::shootsCaustic ( )
inlinevirtual

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