RslArg_v3 Class Reference

Plugin function argument (API version 3). More...

#include <RslPlugin.h>

Inherits RslArg_v2.

Inherited by RslArg.

List of all members.

Public Member Functions

virtual bool IsNormal () const =0
 Returns true if this argument is a normal (or normal array).
virtual bool IsWriteable () const =0
 Returns true if this argument is writeable.
virtual ~RslArg_v3 ()
 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
 Get the length of an array argument.
virtual unsigned int NumValues () const =0
 Get the number of values for this argument.
virtual void GetData (float **data, int *stride) const =0
 Get the raw data pointer for this argument from the given context, along with the stride, which specifies how much to increment the pointer on each iteration.

Static Public Member Functions

static unsigned int NumValues (int argc, const class RslArg **argv)
 Get the maximum number of values for the given arguments.

Detailed Description

Plugin function argument (API version 3).

For internal use only. User code should always use the most recent version, RslArg.

Constructor & Destructor Documentation

virtual RslArg_v3::~RslArg_v3 (   )  [inline, virtual]
 

Virtual destructor.

Member Function Documentation

virtual int RslArg_v2::GetArrayLength (   )  const [pure virtual, inherited]
 

Get the length of an array argument.

The result is undefined if this argument is not an array (call IsArray() first).

virtual void RslArg_v2::GetData (  float **  data,
int *  stride
)  const [pure virtual, inherited]
 

Get the raw data pointer for this argument from the given context, along with the stride, which specifies how much to increment the pointer on each iteration.

(The stride is zero if the argument is uniform.) Use with caution! Do not read or modify values for inactive points. Use RslContext::GetRunflags to determine which points are active.

virtual bool RslArg_v2::IsArray (   )  const [pure virtual, inherited]
 

Returns true if this argument is an array.

virtual bool RslArg_v2::IsColor (   )  const [pure virtual, inherited]
 

Returns true if this argument is a color (or color array).

virtual bool RslArg_v2::IsFloat (   )  const [pure virtual, inherited]
 

Returns true if this argument is a float (or float array).

virtual bool RslArg_v2::IsMatrix (   )  const [pure virtual, inherited]
 

Returns true if this argument is a matrix (or matrix array).

virtual bool RslArg_v3::IsNormal (   )  const [pure virtual]
 

Returns true if this argument is a normal (or normal array).

virtual bool RslArg_v2::IsPoint (   )  const [pure virtual, inherited]
 

Returns true if this argument is a point (or point array).

virtual bool RslArg_v2::IsString (   )  const [pure virtual, inherited]
 

Returns true if this argument is a string (or string array).

virtual bool RslArg_v2::IsVarying (   )  const [pure virtual, inherited]
 

Returns true if this argument is varying.

virtual bool RslArg_v2::IsVector (   )  const [pure virtual, inherited]
 

Returns true if this argument is a vector (or vector array).

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).

static unsigned int RslArg_v2::NumValues (  int  argc,
const class RslArg **  argv
)  [static, inherited]
 

Get the maximum number of values for the given arguments.

This method should be used to determine the number of iterations when a plugin function returns values via output arguments.

virtual unsigned int RslArg_v2::NumValues (   )  const [pure virtual, inherited]
 

Get the number of values for this argument.

Returns 1 if the argument is uniform. Otherwise it returns the number of points in the context.

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