RslPlugin.h File Reference

#include "ri.h"
#include "RixInterfaces.h"

Go to the source code of this file.

Classes
class	RslContext
	RslContext contains the grid data required to execute a shadeop. More...
class	RslArg
	An array of RslArg pointers is passed to the RSL plugin function. More...
class	RslIter< T >
	An iterator is used to access grid data. More...
class	RslArrayIter< T >
	An iterator for array arguments. More...
struct	RslFunction
	Each plugin must define an RSL function table, which requires two steps. More...
struct	RslFunctionTable
	Each plugin should define an RslFunctionTable called "RslPublicFunctions". More...
Defines
#define	RSL_PLUGIN_VERSION   2
	Plugin API version number.
#define	RSLEXPORT
	Under Windows, the plugin table must be declared with RSLEXPORT.
Typedefs
typedef unsigned int	RslRunFlag
	Most shadeops should use iterators to access data, but those that don't use runflags to determine which grid points are active.
typedef unsigned int	RslIncrType
	Iterators use an accelaration structure involving small increments.
typedef int(*	RslEntryFunc )(class RslContext *ctx, int argc, const class RslArg **argv)
	An RSL plugin function takes a context, number of arguments, and an array of arguments.
typedef RslIter< RtFloat >	RslFloatIter
	Float iterator.
typedef RslIter< RtString >	RslStringIter
	String iterator.
typedef RslIter< RtColor >	RslColorIter
	Color iterator.
typedef RslIter< RtVector >	RslVectorIter
	Vector iterator.
typedef RslIter< RtNormal >	RslNormalIter
	Normal iterator.
typedef RslIter< RtPoint >	RslPointIter
	Point iterator.
typedef RslIter< RtMatrix >	RslMatrixIter
	Matrix iterator.
typedef RslArrayIter< RtFloat >	RslFloatArrayIter
	Float array iterator.
typedef RslArrayIter< RtString >	RslStringArrayIter
	String array iterator.
typedef RslArrayIter< RtColor >	RslColorArrayIter
	Color array iterator.
typedef RslArrayIter< RtVector >	RslVectorArrayIter
	Vector array iterator.
typedef RslArrayIter< RtNormal >	RslNormalArrayIter
	Normal array iterator.
typedef RslArrayIter< RtPoint >	RslPointArrayIter
	Point array iterator.
typedef RslArrayIter< RtMatrix >	RslMatrixArrayIter
	Matrix array iterator.
typedef void(*	RslVoidFunc )(RixContext *context)
	A per-frame init/cleanup function takes an RixContext, which allows it to obtain interfaces for reporting errors, accessing global RixStorage, etc.

---

Detailed Description

---

Define Documentation

#define RSL_PLUGIN_VERSION   2

Plugin API version number.

#define RSLEXPORT

Under Windows, the plugin table must be declared with RSLEXPORT. For example: RSLEXPORT RslFunction RslPublicFunctions = ... This declaration has no effect on other platforms, so it's a good idea to always include it for portability.

---

Typedef Documentation

typedef RslArrayIter<RtColor> RslColorArrayIter

Color array iterator.

typedef RslIter<RtColor> RslColorIter

Color iterator.

typedef int(* RslEntryFunc)(class RslContext *ctx, int argc, const class RslArg **argv)

An RSL plugin function takes a context, number of arguments, and an array of arguments. A non-zero return value indicates an error.

typedef RslArrayIter<RtFloat> RslFloatArrayIter

Float array iterator.

typedef RslIter<RtFloat> RslFloatIter

Float iterator.

typedef unsigned int RslIncrType

Iterators use an accelaration structure involving small increments.

typedef RslArrayIter<RtMatrix> RslMatrixArrayIter

Matrix array iterator.

typedef RslIter<RtMatrix> RslMatrixIter

Matrix iterator.

typedef RslArrayIter<RtNormal> RslNormalArrayIter

Normal array iterator.

typedef RslIter<RtNormal> RslNormalIter

Normal iterator.

typedef RslArrayIter<RtPoint> RslPointArrayIter

Point array iterator.

typedef RslIter<RtPoint> RslPointIter

Point iterator.

typedef unsigned int RslRunFlag

Most shadeops should use iterators to access data, but those that don't use runflags to determine which grid points are active.

typedef RslArrayIter<RtString> RslStringArrayIter

String array iterator.

typedef RslIter<RtString> RslStringIter

String iterator.

typedef RslArrayIter<RtVector> RslVectorArrayIter

Vector array iterator.

typedef RslIter<RtVector> RslVectorIter

Vector iterator.

typedef void(* RslVoidFunc)(RixContext *context)

A per-frame init/cleanup function takes an RixContext, which allows it to obtain interfaces for reporting errors, accessing global RixStorage, etc.

---