RenderManAPI  24.0
Public Member Functions | List of all members
RixShaderQuery Class Referenceabstract

class RixShaderQuery obtained from RixShaderInfo::CreateQuery(). More...

#include <RixShaderInfo.h>

Public Member Functions

virtual ~RixShaderQuery (void)
 
virtual bool Open (const char *name, const char *searchPath)=0
 loads the metadata of a shader from disk. More...
 
virtual const char * LastError (void)=0
 
virtual int ParameterCount (void) const =0
 Call Parameters() first before calling this. More...
 
virtual const RixShaderParameter *const * Parameters (void) const =0
 The formal parameter list of a shader. More...
 
virtual int MetaDataCount (void) const =0
 Call MetaData() first before calling this. More...
 
virtual const RixShaderParameter *const * MetaData (void) const =0
 Shaders have meta data each represented by parameter object. More...
 
virtual const char * ShaderName (void) const =0
 
virtual const char * ShaderType (void) const =0
 

Detailed Description

class RixShaderQuery obtained from RixShaderInfo::CreateQuery().

One or more calls can be made to inspect shaders on disk.

Constructor & Destructor Documentation

◆ ~RixShaderQuery()

virtual RixShaderQuery::~RixShaderQuery ( void  )
inlinevirtual

Member Function Documentation

◆ LastError()

virtual const char* RixShaderQuery::LastError ( void  )
pure virtual
Returns
The last error encountered.

◆ MetaData()

virtual const RixShaderParameter* const* RixShaderQuery::MetaData ( void  ) const
pure virtual

Shaders have meta data each represented by parameter object.

Parameters are valid after a succesful call to Open() (it returned false) and remain valid until the next call to Open() or this object is deleted.

Returns
array of parameter pointers.

◆ MetaDataCount()

virtual int RixShaderQuery::MetaDataCount ( void  ) const
pure virtual

Call MetaData() first before calling this.

Returns
a count of metadata items.

◆ Open()

virtual bool RixShaderQuery::Open ( const char *  name,
const char *  searchPath 
)
pure virtual

loads the metadata of a shader from disk.

Any previous pointers retrieved from Paramters() are invalidated on a call to Open() regardless of whether Open() succeeds. You must call Parameters() for each time you call Open() as the pointer may change.

Parameters
[in]nameor path to shader
[in]searchPathcolon separated list of directories to search for name
Returns
true if there is an error which can then be retrieved by LastError().

◆ ParameterCount()

virtual int RixShaderQuery::ParameterCount ( void  ) const
pure virtual

Call Parameters() first before calling this.

Returns
Count of parameters.

◆ Parameters()

virtual const RixShaderParameter* const* RixShaderQuery::Parameters ( void  ) const
pure virtual

The formal parameter list of a shader.

Parameters() can be called after a succesful call to Open() (it returned false) The pointer remains valid until the next call to Open() or this query object is deleted.

Returns
array of parameter pointers.

◆ ShaderName()

virtual const char* RixShaderQuery::ShaderName ( void  ) const
pure virtual
Returns
the name of the shader.

◆ ShaderType()

virtual const char* RixShaderQuery::ShaderType ( void  ) const
pure virtual
Returns
the type name of the shader.
The documentation for this class was generated from the following file: