RenderManAPI  24.0
RixLPEInfo Class Referenceabstract

An interface to find out information related to 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 GetLpeIdByName (bool discrete, bool specular, bool reflect, bool user, unsigned char lobeId, char const *name) const =0
 GetLpeIdByName returns the integer lobe index given the lobe name and booleans indicating whether it is a discrete/specular/reflect lobe. More...
 
virtual int GetNumPotentialDiffuseLobes () const =0
 Return the maximum potential number of diffuse and specular lobe indices. More...
 
virtual int GetNumPotentialSpecularLobes () const =0
 
virtual int GetNumPotentialUserLobes () const =0
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixLPEInfo ()
 

Protected Attributes

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

Detailed Description

An interface to find out information related to 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

◆ RixLPEInfo()

RixLPEInfo::RixLPEInfo ( )
inlineprotected

Member Function Documentation

◆ GetLpeIdByName()

virtual int RixLPEInfo::GetLpeIdByName ( bool  discrete,
bool  specular,
bool  reflect,
bool  user,
unsigned char  lobeId,
char const *  name 
) const
pure virtual

GetLpeIdByName returns the integer lobe index given the lobe name and booleans indicating whether it is a discrete/specular/reflect lobe.

◆ GetNumPotentialDiffuseLobes()

virtual int RixLPEInfo::GetNumPotentialDiffuseLobes ( ) const
pure virtual

Return the maximum potential number of diffuse and specular lobe indices.

◆ GetNumPotentialSpecularLobes()

virtual int RixLPEInfo::GetNumPotentialSpecularLobes ( ) const
pure virtual

◆ GetNumPotentialUserLobes()

virtual int RixLPEInfo::GetNumPotentialUserLobes ( ) const
pure virtual

◆ 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.

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: