RslArg_v2 Class Reference

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

#include <RslPlugin.h>

Inherited by RslArg_v3.

List of all members.

Public Member Functions

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

Friends

class RslIter
class RslArrayIter

Detailed Description

Plugin function argument (API version 2).

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

Constructor & Destructor Documentation

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

Virtual destructor.

Member Function Documentation

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

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]
 

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]
 

Returns true if this argument is an array.

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

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

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

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

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

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

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

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

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

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

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

Returns true if this argument is varying.

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

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

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

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]
 

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.

Friends And Related Function Documentation

friend class RslArrayIter [friend]
 

Reimplemented in RslArg.

friend class RslIter [friend]
 

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