class RixShaderQuery obtained from RixShaderInfo::CreateQuery().
More...
#include <RixShaderInfo.h>
class RixShaderQuery obtained from RixShaderInfo::CreateQuery().
One or more calls can be made to inspect shaders on disk.
| virtual RixShaderQuery::~RixShaderQuery |
( |
void |
) | |
|
|
inlinevirtual |
| virtual const char* RixShaderQuery::LastError |
( |
void |
) | |
|
|
pure virtual |
- Returns
- The last error encountered.
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.
| virtual int RixShaderQuery::MetaDataCount |
( |
void |
) | |
const |
|
pure virtual |
Call MetaData() first before calling this.
- Returns
- a count of metadata items.
| 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] | name | or path to shader |
| [in] | searchPath | colon separated list of directories to search for name |
- Returns
- true if there is an error which can then be retrieved by LastError().
| virtual int RixShaderQuery::ParameterCount |
( |
void |
) | |
const |
|
pure virtual |
Call Parameters() first before calling this.
- Returns
- Count of parameters.
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.
| virtual const char* RixShaderQuery::ShaderName |
( |
void |
) | |
const |
|
pure virtual |
- Returns
- the name of the shader.
| 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:
