RenderManAPI  24.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixCustomLPE Class Referenceabstract

An interface to lookup and match custom light path expressions (LPEs). More...

#include <RixInterfaces.h>

Inherits RixInterface.

Public Types

enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual int LookupLPE (char const *lpeExpr)=0
 
virtual int LookupLPEByName (char const *lpeName)=0
 
virtual bool MatchesLPE (int customLpe, RixLPEState *lpeState, RtColorRGB &thruput)=0
 
virtual void RegisterScatterCallback (RixLPECallback callbackFunc, void *userData=NULL)=0
 
virtual void InvokeScatterCallbacks (RixLPEState *lpeState, RixShadingContext const *sCtx, int sCtxIndex, RtColorRGB const &thruput, RtColorRGB const *lightTrans, bool firstContribution)=0
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixCustomLPE ()
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Detailed Description

An interface to lookup and match custom light path expressions (LPEs).

Member Enumeration Documentation

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixCustomLPE()

RixCustomLPE::RixCustomLPE ( )
inlineprotected

Member Function Documentation

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ InvokeScatterCallbacks()

virtual void RixCustomLPE::InvokeScatterCallbacks ( RixLPEState *  lpeState,
RixShadingContext const *  sCtx,
int  sCtxIndex,
RtColorRGB const &  thruput,
RtColorRGB const *  lightTrans,
bool  firstContribution 
)
pure virtual

◆ LookupLPE()

virtual int RixCustomLPE::LookupLPE ( char const *  lpeExpr)
pure virtual

◆ LookupLPEByName()

virtual int RixCustomLPE::LookupLPEByName ( char const *  lpeName)
pure virtual

◆ MatchesLPE()

virtual bool RixCustomLPE::MatchesLPE ( int  customLpe,
RixLPEState *  lpeState,
RtColorRGB &  thruput 
)
pure virtual

◆ RegisterScatterCallback()

virtual void RixCustomLPE::RegisterScatterCallback ( RixLPECallback  callbackFunc,
void *  userData = NULL 
)
pure virtual

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().

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