Function Index Class Index

Exit_Update Class Reference

#include <hic_wrap.h>

List of all members.

Public Member Functions

 Exit_Update (HC_KEY key, const char *name, void *data=0)
virtual void exit_update (HIC_Rendition const *nr)
const char * GetName ()
virtual ~Exit_Update ()

Protected Member Functions

void * GetData ()

Detailed Description

The Exit_Update class is a base class used to define and set a callback at the "finish picture" callback point during the HOOPS update cycle. To use this class, derive your own child class from it and implement the method Exit_Update. For more information on how to define and set callbacks as a C++/C/Java Developer, please see the HOOPS/3dGS Programming Guide.


Constructor & Destructor Documentation

Exit_Update::Exit_Update ( HC_KEY  key,
const char *  name,
void *  data = 0 
)

Constructs a Exit_Update Callback object.

Parameters:
keyKey to the segment on which the callback is set.
nameThe name of the callback.
dataOptional pointer to user data that can then be accessed from the callback.
virtual Exit_Update::~Exit_Update ( ) [virtual]

Deletes the callback object.


Member Function Documentation

virtual void Exit_Update::exit_update ( HIC_Rendition const *  nr) [inline, virtual]

The function you implement for your callback.

Parameters:
nrA pointer to a const HIC_Rendition
swap_buffersA bool variable
void* Exit_Update::GetData ( ) [protected]

Returns the pointer to the user data that may have been provided when the callback was created.

const char* Exit_Update::GetName ( )

Returns the name of the callback.


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