Function Index Class Index

Finish_Picture Class Reference

#include <hic_wrap.h>

List of all members.

Public Member Functions

 Finish_Picture (HC_KEY key, const char *name, void *data=0)
virtual void finish_picture (HIC_Rendition const *nr, bool swap_buffers)
const char * GetName ()
virtual ~Finish_Picture ()

Protected Member Functions

void * GetData ()

Detailed Description

The Finish_Picture 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 finish_picture. 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

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

Constructs a Finish_Picture 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 Finish_Picture::~Finish_Picture ( ) [virtual]

Deletes the callback object.


Member Function Documentation

virtual void Finish_Picture::finish_picture ( HIC_Rendition const *  nr,
bool  swap_buffers 
) [inline, virtual]

The function you implement for your callback.

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

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

const char* Finish_Picture::GetName ( )

Returns the name of the callback.


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