RslArg_v3 Class Reference

RslArg_v3 Class Referenceabstract

#include <RslPlugin.h>

Inheritance diagram for RslArg_v3:
RslArg_v2 RslArg_v5 RslArg_v6 RslArg_v7 RslArg

Public Member Functions

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
 

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 3). For internal use only. User code should always use the most recent version, RslArg.

Member Function Documentation

virtual bool RslArg_v3::IsWriteable ( ) const
pure virtual

Returns true if this argument is writeable. This is useful in varargs plugin functions to verify that output arguments are valid. An argument is writeable if it's a local variable, a shader output parameter, or a global variable (e.g. P, N).


The documentation for this class was generated from the following file: