FrameCallback Class Reference

#include <callback.h>

Inheritance diagram for FrameCallback:

[legend]Collaboration diagram for FrameCallback:

[legend]List of all members.

---

Detailed Description

Callback interface for frame listeners Use frame callbacks to listen for frame rendering events, such as frame completion, or to be called for each light active in the frame.

Author:

Mattias Jansson (mattias@realityrift.com)

Public Types
enum	FRAMECALLBACKTYPE { PERLIGHT = 0, FRAMEEND = 1, NUMCALLBACKS = 2 }
	Callback type identifiers. More...
Public Member Functions
virtual void	FrameEvent (FRAMECALLBACKTYPE eType, void *pData)=0
bool	IsActive () const
virtual void	Activate ()
virtual void	Deactivate ()
bool	Toggle ()
Protected Attributes
bool	m_bActive

---

Member Enumeration Documentation

enum FRAMECALLBACKTYPE

Callback type identifiers. Enumeration values: PERLIGHT  Per light FRAMEEND  Frame end NUMCALLBACKS  Number of callback types

---

Member Function Documentation

virtual void FrameEvent (  FRAMECALLBACKTYPE  eType, void *  pData )  [pure virtual]

Frame callback method Parameters: eType  Callback type pData  Data pointer (type specific)

bool IsActive (   )  const [inline, inherited]

Query state of object Returns: true if active, false if not

void Activate (   )  [inline, virtual, inherited]

Activate object

void Deactivate (   )  [inline, virtual, inherited]

Deactivate object

bool Toggle (   )  [inline, inherited]

Toggle active state. This method does not need to be overloaded, it is only a wrapper to Activate and Deactivate Returns: true if activated, false if deactivated

---

Member Data Documentation

bool m_bActive [protected, inherited]

Active flag

---

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

• callback.h

---