RenderMan API  23.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
RixDspy Class Referenceabstract

#include <RixDspy.h>

Inheritance diagram for RixDspy:
RixInterface

Public Types

typedef void(* ServerListener) (RixDspyServer const &server, void *clientData)
 Callback type. More...
 
- Public Types inherited from RixInterface
enum  Type {
  k_Float, k_Integer, k_StringV, k_Color,
  k_Normal, k_Vector, k_Point, k_HPoint,
  k_MPoint, k_Matrix
}
 

Public Member Functions

virtual RixDspyServer * CreateServer (const char *in, const char *out)=0
 Return a pointer to new server object. More...
 
virtual RixDspyServer * CreateServer (const char *in, const char *out, ServerListener listener, void *clientData)=0
 Return a pointer to new server object with a listener callable. More...
 
virtual void ProcessCallbacks ()=0
 Process outstanding callback requests (display, exception) More...
 
virtual void SetDeliveryMode (RixDeliveryMode mode)=0
 
virtual PtDspyError FindStringInParamList (const char *string, char **result, int paramCount, const UserParameter *parameters)=0
 Equivalent to DspyFindStringInParamList. More...
 
virtual PtDspyError FindIntInParamList (const char *string, int *result, int paramCount, const UserParameter *parameters)=0
 Equivalent to DspyFindIntInParamList. More...
 
virtual PtDspyError FindIntsInParamList (const char *string, int *resultCount, int *result, int paramCount, const UserParameter *parameters)=0
 Equivalent to DspyFindIntsInParamList. More...
 
virtual PtDspyError FindFloatInParamList (const char *string, float *result, int paramCount, const UserParameter *parameters)=0
 Equivalent to DspyFindFloatInParamList. More...
 
virtual PtDspyError FindFloatsInParamList (const char *string, int *resultCount, float *result, int paramCount, const UserParameter *parameters)=0
 Equivalent to DspyFindFloatsInParamList. More...
 
virtual PtDspyError RegisterDriverTable (const char *name, const PtDspyDriverFunctionTable *pTable)=0
 Equivalent to DspyRegisterDriverTable. More...
 
virtual PtDspyError ReorderFormatting (int formatCount, PtDspyDevFormat *format, int outFormatCount, const PtDspyDevFormat *outFormat)=0
 
virtual unsigned int ByteCountForType (PtDspyUnsigned32 type)=0
 For a given pixel type return how wide in bytes that is. More...
 
- Public Member Functions inherited from RixInterface
virtual int GetVersion () const
 

Protected Member Functions

 RixDspy ()
 
virtual ~RixDspy ()
 
- Protected Member Functions inherited from RixInterface
 RixInterface (int version)
 Interfaces should not be constructed by users. More...
 
virtual ~RixInterface ()
 Interfaces should not be deleted by users. More...
 

Additional Inherited Members

- Protected Attributes inherited from RixInterface
int m_version
 Version number of this interface. More...
 

Detailed Description

Definition at line 131 of file RixDspy.h.

Member Typedef Documentation

◆ ServerListener

typedef void(* RixDspy::ServerListener) (RixDspyServer const &server, void *clientData)

Callback type.

Definition at line 136 of file RixDspy.h.

Constructor & Destructor Documentation

◆ RixDspy()

RixDspy::RixDspy ( )
inlineprotected

Definition at line 222 of file RixDspy.h.

◆ ~RixDspy()

virtual RixDspy::~RixDspy ( )
inlineprotectedvirtual

Definition at line 223 of file RixDspy.h.

Member Function Documentation

◆ ByteCountForType()

virtual unsigned int RixDspy::ByteCountForType ( PtDspyUnsigned32  type)
pure virtual

For a given pixel type return how wide in bytes that is.

◆ CreateServer() [1/2]

virtual RixDspyServer* RixDspy::CreateServer ( const char *  in,
const char *  out 
)
pure virtual

Return a pointer to new server object.

RixDspyServer methods --------------------------------------------——

◆ CreateServer() [2/2]

virtual RixDspyServer* RixDspy::CreateServer ( const char *  in,
const char *  out,
ServerListener  listener,
void *  clientData 
)
pure virtual

Return a pointer to new server object with a listener callable.

◆ FindFloatInParamList()

virtual PtDspyError RixDspy::FindFloatInParamList ( const char *  string,
float *  result,
int  paramCount,
const UserParameter *  parameters 
)
pure virtual

Equivalent to DspyFindFloatInParamList.

◆ FindFloatsInParamList()

virtual PtDspyError RixDspy::FindFloatsInParamList ( const char *  string,
int *  resultCount,
float *  result,
int  paramCount,
const UserParameter *  parameters 
)
pure virtual

Equivalent to DspyFindFloatsInParamList.

◆ FindIntInParamList()

virtual PtDspyError RixDspy::FindIntInParamList ( const char *  string,
int *  result,
int  paramCount,
const UserParameter *  parameters 
)
pure virtual

Equivalent to DspyFindIntInParamList.

◆ FindIntsInParamList()

virtual PtDspyError RixDspy::FindIntsInParamList ( const char *  string,
int *  resultCount,
int *  result,
int  paramCount,
const UserParameter *  parameters 
)
pure virtual

Equivalent to DspyFindIntsInParamList.

◆ FindStringInParamList()

virtual PtDspyError RixDspy::FindStringInParamList ( const char *  string,
char **  result,
int  paramCount,
const UserParameter *  parameters 
)
pure virtual

Equivalent to DspyFindStringInParamList.

RixDspy methods --------------------------------------------------——

◆ ProcessCallbacks()

virtual void RixDspy::ProcessCallbacks ( )
pure virtual

Process outstanding callback requests (display, exception)

◆ RegisterDriverTable()

virtual PtDspyError RixDspy::RegisterDriverTable ( const char *  name,
const PtDspyDriverFunctionTable *  pTable 
)
pure virtual

Equivalent to DspyRegisterDriverTable.

◆ ReorderFormatting()

virtual PtDspyError RixDspy::ReorderFormatting ( int  formatCount,
PtDspyDevFormat *  format,
int  outFormatCount,
const PtDspyDevFormat *  outFormat 
)
pure virtual

◆ SetDeliveryMode()

virtual void RixDspy::SetDeliveryMode ( RixDeliveryMode  mode)
pure virtual

Sets how dspy server messages are processed, if RixQueued then the client also needs to call our ProcessCallbacks periodically to

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