RslFunctionTable Struct Reference

Each plugin should define an RslFunctionTable called "RslPublicFunctions". More...

#include <RslPlugin.h>

List of all members.

Public Member Functions

 RslFunctionTable (const RslFunction *functions, RslVoidFunc init=NULL, RslVoidFunc cleanup=NULL)
 Constructor.

Public Attributes

const RslFunction * m_functions
 The function table.
const char m_version
 Plugin API version number (for internal use only).
RslVoidFunc m_initFunc
 Per-frame initialization function (possibly NULL).
RslVoidFunc m_cleanupFunc
 Per-frame cleanup function (possibly NULL).

Detailed Description

Each plugin should define an RslFunctionTable called "RslPublicFunctions".

It is constructed from an arry of RslFunction structs. In addition to specifying the array of entry functions, an optional initialization and cleanup function may be provided: 

    RSLEXPORT 
    RslFunctionTable RslPublicFunctions(myfunctions,
                                        myinit, mycleanup);
The initialization function is executed the first time any function in the pluginis called in a given frame, and the cleanup function is called at the end of the frame.

The plugin table MUST be declared with PRMANEXPORT. For example: 

       PRMANEXPORT RslFunction RslPublicFunctions = ...
RSLEXPORT was the old way of declaring this, and is still available for backwards compatability

Constructor & Destructor Documentation

RslFunctionTable::RslFunctionTable (  const RslFunction *  functions,
RslVoidFunc  init = NULL,
RslVoidFunc  cleanup = NULL
)  [inline]
 

Constructor.

Member Data Documentation

RslVoidFunc RslFunctionTable::m_cleanupFunc
 

Per-frame cleanup function (possibly NULL).

const RslFunction* RslFunctionTable::m_functions
 

The function table.

RslVoidFunc RslFunctionTable::m_initFunc
 

Per-frame initialization function (possibly NULL).

const char RslFunctionTable::m_version
 

Plugin API version number (for internal use only).

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