HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
GR_Light Class Referenceabstract

Base class for all light types. More...

#include <GR_Light.h>

+ Inheritance diagram for GR_Light:

Public Types

enum  LightType {
  AMBIENT, DISTANT, POINT, ENVIRONMENT,
  AREA
}
 

Public Member Functions

LightType type () const
 
bool isHeadlight () const
 
void setHeadlight (bool e)
 
bool isEnabled () const
 
void setEnabled (bool e)
 
void setLightID (exint id)
 
bool initSceneSetForRender (RV_Render *r, RV_ShaderProgram *shader, UT_UniquePtr< RV_ShaderBlock > &scene_block, UT_UniquePtr< RV_ShaderVariableSet > &scene_set)
 
bool initLightSetForRender (RV_Render *r, RV_ShaderProgramBase *shader)
 
bool bindSets (RV_Render *r, RV_ShaderProgramBase *shader)
 
virtual bool initBlocks (RV_Render *r, const GR_CommonDispOption &opts)=0
 
virtual unsigned setupShadowRenders (RE_RenderContext, GR_RenderMode &out_render_mode, bool scene_changed, unsigned shadowmap_size, const GR_DistantShadowMapParms &)=0
 
virtual RV_ShaderProgram * getShader (bool shadows, bool per_sample, bool is_antialiased)=0
 
virtual void startShadowRender (RE_RenderContext rc, unsigned shadowmap_index)
 
virtual void finishShadowRender (RE_RenderContext)
 
virtual void finishShadowRenders (RE_RenderContext)
 
virtual bool hasShadowMap ()=0
 
virtual void attachShadowMap (RE_RenderContext)
 
void setLightLink (const UT_StringHolder &link)
 
const UT_StringHolder & lightLink () const
 
void setShadowMask (const UT_StringHolder &mask)
 
const UT_StringHolder & shadowMask () const
 
- Public Member Functions inherited from GR_SceneItem
const UT_StringHolder & name () const
 
exint id () const
 
int64 getVersion () const
 
void setVersion (int64 v)
 
void incref ()
 
void decref ()
 
void setName (const UT_StringHolder &name)
 
void setID (int id)
 

Static Public Member Functions

static RV_ShaderProgram * getAmbientOcclusionShader ()
 
static bool initShaders (RV_Instance *inst)
 
static void cleanupShaders ()
 

Protected Types

enum  { GLOBAL_SET = 0, LIGHT_SET = 1 }
 

Protected Member Functions

 GR_Light (const UT_StringHolder &name, LightType type)
 
 ~GR_Light () override
 
 UT_NON_COPYABLE (GR_Light)
 
bool privInitBlocks (RV_Render *r, void *light_block, int light_size, void *shadow_block, int shadow_size)
 
void privBindTexture (RV_Render *r, const UT_StringHolder &map_name, int rel_op_id, RV_TextureRef &map_id, const UT_StringHolder &sampler_name, const GR_CommonDispOption &opts, RV_TextureParms *tex_parms=nullptr, bool is_cube=false)
 
void initTexParms (RV_Render *r, const GR_CommonDispOption &opts, RV_TextureParms &parms) const
 
- Protected Member Functions inherited from GR_SceneItem
 GR_SceneItem (const UT_StringHolder &name, int id)
 
virtual ~GR_SceneItem ()
 
 UT_NON_COPYABLE (GR_SceneItem)
 

Static Protected Member Functions

static RV_ShaderProgram * privGetShader (exint tags)
 

Protected Attributes

bool myDirtyFlag
 
bool myShadowDirtyFlag
 
bool mySetBound
 

Detailed Description

Base class for all light types.

Definition at line 40 of file GR_Light.h.

Member Enumeration Documentation

anonymous enum
protected
Enumerator
GLOBAL_SET 
LIGHT_SET 

Definition at line 127 of file GR_Light.h.

enum GR_Light::LightType
Enumerator
AMBIENT 
DISTANT 
POINT 
ENVIRONMENT 
AREA 

Definition at line 43 of file GR_Light.h.

Constructor & Destructor Documentation

GR_Light::GR_Light ( const UT_StringHolder &  name,
LightType  type 
)
protected
GR_Light::~GR_Light ( )
overrideprotected

Member Function Documentation

virtual void GR_Light::attachShadowMap ( RE_RenderContext  )
inlinevirtual

Reimplemented in GR_AreaLight.

Definition at line 88 of file GR_Light.h.

bool GR_Light::bindSets ( RV_Render *  r,
RV_ShaderProgramBase *  shader 
)
static void GR_Light::cleanupShaders ( )
static
virtual void GR_Light::finishShadowRender ( RE_RenderContext  )
inlinevirtual

Reimplemented in GR_AreaLight.

Definition at line 85 of file GR_Light.h.

virtual void GR_Light::finishShadowRenders ( RE_RenderContext  )
inlinevirtual

Reimplemented in GR_AreaLight.

Definition at line 86 of file GR_Light.h.

static RV_ShaderProgram* GR_Light::getAmbientOcclusionShader ( )
static
virtual RV_ShaderProgram* GR_Light::getShader ( bool  shadows,
bool  per_sample,
bool  is_antialiased 
)
pure virtual

Implemented in GR_AreaLight, GR_EnvLight, GR_AmbientLight, GR_PointLight, and GR_DistantLight.

virtual bool GR_Light::hasShadowMap ( )
pure virtual

Implemented in GR_AreaLight, and GR_AmbientLight.

virtual bool GR_Light::initBlocks ( RV_Render *  r,
const GR_CommonDispOption &  opts 
)
pure virtual

Implemented in GR_AreaLight, GR_EnvLight, GR_AmbientLight, GR_PointLight, and GR_DistantLight.

bool GR_Light::initLightSetForRender ( RV_Render *  r,
RV_ShaderProgramBase *  shader 
)
bool GR_Light::initSceneSetForRender ( RV_Render *  r,
RV_ShaderProgram *  shader,
UT_UniquePtr< RV_ShaderBlock > &  scene_block,
UT_UniquePtr< RV_ShaderVariableSet > &  scene_set 
)
static bool GR_Light::initShaders ( RV_Instance *  inst)
static
void GR_Light::initTexParms ( RV_Render *  r,
const GR_CommonDispOption &  opts,
RV_TextureParms &  parms 
) const
protected
bool GR_Light::isEnabled ( ) const
inline

Definition at line 57 of file GR_Light.h.

bool GR_Light::isHeadlight ( ) const
inline

Definition at line 54 of file GR_Light.h.

const UT_StringHolder& GR_Light::lightLink ( ) const
inline

Definition at line 94 of file GR_Light.h.

void GR_Light::privBindTexture ( RV_Render *  r,
const UT_StringHolder &  map_name,
int  rel_op_id,
RV_TextureRef &  map_id,
const UT_StringHolder &  sampler_name,
const GR_CommonDispOption &  opts,
RV_TextureParms *  tex_parms = nullptr,
bool  is_cube = false 
)
protected
static RV_ShaderProgram* GR_Light::privGetShader ( exint  tags)
staticprotected
bool GR_Light::privInitBlocks ( RV_Render *  r,
void *  light_block,
int  light_size,
void *  shadow_block,
int  shadow_size 
)
protected
void GR_Light::setEnabled ( bool  e)
inline

Definition at line 58 of file GR_Light.h.

void GR_Light::setHeadlight ( bool  e)
inline

Definition at line 55 of file GR_Light.h.

void GR_Light::setLightID ( exint  id)
inline

Definition at line 60 of file GR_Light.h.

void GR_Light::setLightLink ( const UT_StringHolder &  link)
inline

Definition at line 93 of file GR_Light.h.

void GR_Light::setShadowMask ( const UT_StringHolder &  mask)
inline

Definition at line 95 of file GR_Light.h.

virtual unsigned GR_Light::setupShadowRenders ( RE_RenderContext  ,
GR_RenderMode &  out_render_mode,
bool  scene_changed,
unsigned  shadowmap_size,
const GR_DistantShadowMapParms &   
)
pure virtual

Implemented in GR_AreaLight, and GR_AmbientLight.

const UT_StringHolder& GR_Light::shadowMask ( ) const
inline

Definition at line 96 of file GR_Light.h.

virtual void GR_Light::startShadowRender ( RE_RenderContext  rc,
unsigned  shadowmap_index 
)
inlinevirtual

Reimplemented in GR_AreaLight.

Definition at line 83 of file GR_Light.h.

LightType GR_Light::type ( ) const
inline

Definition at line 52 of file GR_Light.h.

GR_Light::UT_NON_COPYABLE ( GR_Light  )
protected

Member Data Documentation

bool GR_Light::myDirtyFlag
protected

Definition at line 123 of file GR_Light.h.

bool GR_Light::mySetBound
protected

Definition at line 125 of file GR_Light.h.

bool GR_Light::myShadowDirtyFlag
protected

Definition at line 124 of file GR_Light.h.

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