Inheritance diagram for iOcclusionQuery:

Detailed Description

Occlusion query object.

Public Member Functions
virtual tBool	Begin ()=0
	Begin the query. More...

virtual tBool	End ()=0
	End the query. More...

virtual eOcclusionQueryStatus	GetStatus (tBool abWait)=0
	Get the status of the query. More...

virtual tU32	GetResult () const =0
	Get the result of the query. More...

Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...

virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...

virtual tI32	Release ()=0
	Release a reference of the object. More...

virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...

virtual void	Invalidate ()=0
	Invalidate the object. More...

virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...

virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...

virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...

virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual tBool Begin ( )

pure virtual

Begin the query.

virtual tBool End ( )

pure virtual

End the query.

virtual eOcclusionQueryStatus GetStatus ( tBool abWait )

pure virtual

Get the status of the query.

Parameters

abWait if eTrue the function will wait until the query is successful or fails.

virtual tU32 GetResult ( ) const

pure virtual

Get the result of the query.

Returns: the number of pixels drawn between begin/end. eInvalidHandle if the result is not yet available. {Property}