RenderMan  26.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
RixShaderInfo Class Referenceabstract

A generic way to interrogate shaders on disk about their parameters. More...

#include <RixShaderInfo.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 RixShaderQuery * CreateQuery (void)=0
 A RixShaderQuery factory, callers are responsible for deleting the returned object when they are done with it. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixShaderInfo ()
 

Protected Attributes

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

Detailed Description

A generic way to interrogate shaders on disk about their parameters.

Applications and bridges to RenderMan can use this API to gather infomation about shaders on disk without linking to a specific shading language library. There is also a python binding to the same API.

A unique RixShaderQuery object is created each time CreateQuery is called which can then be optionaly re-used by repeatadly calling Open on different on-disk files.

This interface is only used to inspect on-disk shaders. It cannot be used to modify the rendering state or query shaders loaded in shading networks.

Member Enumeration Documentation

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

RixShaderInfo::RixShaderInfo ( )
inlineprotected

Member Function Documentation

virtual RixShaderQuery* RixShaderInfo::CreateQuery ( void  )
pure virtual

A RixShaderQuery factory, callers are responsible for deleting the returned object when they are done with it.

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

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: