RslArg_v5 Class Reference
RslArg_v5 Class Referenceabstract
#include <RslPlugin.h>
Inheritance diagram for RslArg_v5:
Public Member Functions | |
| virtual bool | IsStruct () const =0 |
| Returns true if this argument is a struct (or struct array). | |
| virtual const char * | GetName () const =0 |
| virtual bool | IsResizable () const =0 |
| Returns true if this argument is a resizable array. | |
| virtual class RslResizer * | GetResizer () const =0 |
| Get resizer for this argument (returns NULL if not resizable). | |
| virtual | ~RslArg_v5 () |
| Virtual destructor. | |
 Public Member Functions inherited from RslArg_v3 | |
| virtual bool | IsNormal () const =0 |
| Returns true if this argument is a normal (or normal array). | |
| virtual bool | IsWriteable () const =0 |
| virtual | ~RslArg_v3 () |
| Virtual destructor. | |
| Public Member Functions inherited from RslArg_v2 | |
| virtual | ~RslArg_v2 () |
| Virtual destructor. | |
| virtual bool | IsFloat () const =0 |
| Returns true if this argument is a float (or float array). | |
| virtual bool | IsPoint () const =0 |
| Returns true if this argument is a point (or point array). | |
| virtual bool | IsVector () const =0 |
| Returns true if this argument is a vector (or vector array). | |
| virtual bool | IsColor () const =0 |
| Returns true if this argument is a color (or color array). | |
| virtual bool | IsString () const =0 |
| Returns true if this argument is a string (or string array). | |
| virtual bool | IsMatrix () const =0 |
| Returns true if this argument is a matrix (or matrix array). | |
| virtual bool | IsArray () const =0 |
| Returns true if this argument is an array. | |
| virtual bool | IsVarying () const =0 |
| Returns true if this argument is varying. | |
| virtual int | GetArrayLength () const =0 |
| virtual unsigned int | NumValues () const =0 |
| virtual void | GetData (float **data, int *stride) const =0 |
Friends | |
| class | RslStruct |
| class | RslStructArray |
| template<typename T > | |
| class | RslArrayIter |
Additional Inherited Members | |
| Static Public Member Functions inherited from RslArg_v2 | |
| static unsigned int | NumValues (int argc, const class RslArg **argv) |
Detailed Description
Plugin function argument (API version 5). For internal use only. User code should always use the most recent version, RslArg.
Member Function Documentation
|
pure virtual |
Get the name of this argument, which is not guaranteed to be sensible. Useful for error messages and struct member handling.
The documentation for this class was generated from the following file: