RenderManAPI  24.0
RixEventCallbacks Class Referenceabstract

#include <RixEventCallbacks.h>

Inherits RixInterface.

Public Types

enum  Event { k_Scene, k_Render, k_Progress, k_Iteration }
 
typedef void(* Callback) (Event event, void const *eventData, void *clientData)
 
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 bool RegisterCallback (Event event, Callback cb, void *clientData)=0
 Register an event callback returns true on success. More...
 
virtual bool UnregisterCallback (Event event, Callback cb, void *clientData)=0
 Un-register an event callback returns true on success. More...
 
virtual int GetVersion () const
 Get the version number of this interface. More...
 

Protected Member Functions

 RixEventCallbacks ()
 

Protected Attributes

int m_version
 Version number of this interface. More...
 

Member Typedef Documentation

◆ Callback

typedef void(* RixEventCallbacks::Callback) (Event event, void const *eventData, void *clientData)

Member Enumeration Documentation

◆ Event

Enumerator
k_Scene 
k_Render 

data is integer, 1=create, 0=destroy

k_Progress 

data is integer, 1=begin, 0=end

k_Iteration 

data is integer range 0 to 100

◆ Type

enum RixInterface::Type
inherited
Enumerator
k_Float 
k_Integer 
k_StringV 
k_Color 
k_Normal 
k_Vector 
k_Point 
k_HPoint 
k_MPoint 
k_Matrix 

Constructor & Destructor Documentation

◆ RixEventCallbacks()

RixEventCallbacks::RixEventCallbacks ( )
inlineprotected

Member Function Documentation

◆ GetVersion()

virtual int RixInterface::GetVersion ( ) const
inlinevirtualinherited

Get the version number of this interface.

Different interfaces might have different version numbers in a given release.

References RixInterface::m_version.

◆ RegisterCallback()

virtual bool RixEventCallbacks::RegisterCallback ( Event  event,
Callback  cb,
void *  clientData 
)
pure virtual

Register an event callback returns true on success.

◆ UnregisterCallback()

virtual bool RixEventCallbacks::UnregisterCallback ( Event  event,
Callback  cb,
void *  clientData 
)
pure virtual

Un-register an event callback returns true on success.

Member Data Documentation

◆ m_version

int RixInterface::m_version
protectedinherited

Version number of this interface.

Referenced by RixInterface::GetVersion().


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