ClanLib  2.3.7
List of all members
CL_OcclusionQuery Class Reference

Graphics occlusion query class. More...

#include <occlusion_query.h>

Public Member Functions

Construction
 CL_OcclusionQuery ()
 Constructs a null instance. More...
 
 CL_OcclusionQuery (CL_GraphicContext &context)
 Constructs an occlusion query object. More...
 
virtual ~CL_OcclusionQuery ()
 
Attributes
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
int get_result ()
 Returns the result of the occlusion query. More...
 
bool is_result_ready ()
 Returns true if the GPU is ready to return the result. More...
 
CL_OcclusionQueryProviderget_provider () const
 Get Provider. More...
 
Operations
void begin ()
 Start occlusion query. More...
 
void end ()
 Finish occlusion query. More...
 

Detailed Description

Graphics occlusion query class.

Constructor & Destructor Documentation

CL_OcclusionQuery::CL_OcclusionQuery ( )

Constructs a null instance.

CL_OcclusionQuery::CL_OcclusionQuery ( CL_GraphicContext context)

Constructs an occlusion query object.

virtual CL_OcclusionQuery::~CL_OcclusionQuery ( )
virtual

Member Function Documentation

void CL_OcclusionQuery::begin ( )

Start occlusion query.

void CL_OcclusionQuery::end ( )

Finish occlusion query.

CL_OcclusionQueryProvider* CL_OcclusionQuery::get_provider ( ) const

Get Provider.

Returns
provider
int CL_OcclusionQuery::get_result ( )

Returns the result of the occlusion query.

bool CL_OcclusionQuery::is_null ( ) const
inline

Returns true if this object is invalid.

bool CL_OcclusionQuery::is_result_ready ( )

Returns true if the GPU is ready to return the result.

void CL_OcclusionQuery::throw_if_null ( ) const

Throw an exception if this object is invalid.


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