OGLplus (0.52.0) a C++ wrapper for OpenGL

oglplus::ObjectOps< tag::DirectState, tag::Query > Class Template Reference

Class wrapping query functions with (direct state access) More...

#include </home/chochlik/devel/oglplus/include/oglplus/query.hpp>

Inheritance diagram for oglplus::ObjectOps< tag::DirectState, tag::Query >:
Collaboration diagram for oglplus::ObjectOps< tag::DirectState, tag::Query >:

Public Types

typedef QueryTarget Target
 Query execution target.
 
typedef QueryActivator Activator
 The activator class.
 

Public Member Functions

void Begin (Target target)
 Begin the query on the specified target. More...
 
void End (Target target)
 End the query on the specified target. More...
 
void BeginConditionalRender (ConditionalRenderMode mode)
 Begin conditional render on the query in the specified mode. More...
 
void Counter (Target target)
 Do a counter query on the specified target. More...
 
void Timestamp (void)
 Do a timestamp query. More...
 
bool ResultAvailable (void) const
 Returns true if the query result is available. More...
 
void Result (GLint &result) const
 Get the query result. More...
 
void Result (GLuint &result) const
 Get the query result. More...
 
void Result (GLint64 &result) const
 Get the query result. More...
 
void Result (GLuint64 &result) const
 Get the query result. More...
 
template<typename ResultType >
void WaitForResult (ResultType &result) const
 Waits for and queries the result.
 
template<typename ResultType >
QueryExecution< ResultType > Execute (Target target, ResultType &result)
 Executes this query on the specified target and gets the result. More...
 

Static Public Member Functions

static void EndConditionalRender (void)
 Ends currently active conditional render. More...
 

Detailed Description

template<>
class oglplus::ObjectOps< tag::DirectState, tag::Query >

Class wrapping query functions with (direct state access)

Note
Do not use this class directly, use Query instead.

Member Function Documentation

void oglplus::ObjectOps< tag::DirectState, tag::Query >::Begin ( Target  target)

Begin the query on the specified target.

Related OpenGL symbols:
glBeginQuery
void oglplus::ObjectOps< tag::DirectState, tag::Query >::BeginConditionalRender ( ConditionalRenderMode  mode)

Begin conditional render on the query in the specified mode.

Related OpenGL symbols:
glBeginConditionalRender
void oglplus::ObjectOps< tag::DirectState, tag::Query >::Counter ( Target  target)

Do a counter query on the specified target.

Related OpenGL symbols:
glQueryCounter
void oglplus::ObjectOps< tag::DirectState, tag::Query >::End ( Target  target)

End the query on the specified target.

Related OpenGL symbols:
glEndQuery
static void oglplus::ObjectOps< tag::DirectState, tag::Query >::EndConditionalRender ( void  )
static

Ends currently active conditional render.

Related OpenGL symbols:
glEndConditionalRender

Referenced by oglplus::ConditionalRender::Finish().

template<typename ResultType >
QueryExecution< ResultType > oglplus::ObjectOps< tag::DirectState, tag::Query >::Execute ( Target  target,
ResultType &  result 
)

Executes this query on the specified target and gets the result.

This function creates an instance of the QueryExecution class which begins a query on the specified target when it is constructed and ends this query and gets its result when it is destroyed.

void oglplus::ObjectOps< tag::DirectState, tag::Query >::Result ( GLint &  result) const

Get the query result.

Related OpenGL symbols:
glGetQueryObject GL_QUERY_RESULT
void oglplus::ObjectOps< tag::DirectState, tag::Query >::Result ( GLuint &  result) const

Get the query result.

Related OpenGL symbols:
glGetQueryObject GL_QUERY_RESULT
void oglplus::ObjectOps< tag::DirectState, tag::Query >::Result ( GLint64 &  result) const

Get the query result.

Requires OpenGL 3.3 or the GL_ARB_timer_query extension.

Related OpenGL symbols:
glGetQueryObject GL_QUERY_RESULT
void oglplus::ObjectOps< tag::DirectState, tag::Query >::Result ( GLuint64 &  result) const

Get the query result.

Requires OpenGL 3.3 or the GL_ARB_timer_query extension.

Related OpenGL symbols:
glGetQueryObject GL_QUERY_RESULT
bool oglplus::ObjectOps< tag::DirectState, tag::Query >::ResultAvailable ( void  ) const

Returns true if the query result is available.

Related OpenGL symbols:
glGetQueryObject GL_QUERY_RESULT_AVAILABLE
void oglplus::ObjectOps< tag::DirectState, tag::Query >::Timestamp ( void  )

Do a timestamp query.

Related OpenGL symbols:
glQueryCounter GL_TIMESTAMP

References oglplus::Timestamp.


The documentation for this class was generated from the following file:
  • /home/chochlik/devel/oglplus/include/oglplus/query.hpp

Copyright © 2010-2014 Matúš Chochlík, University of Žilina, Žilina, Slovakia.
<matus.chochlik -at- fri.uniza.sk>
<chochlik -at -gmail.com>
Documentation generated on Mon Sep 22 2014 by Doxygen (version 1.8.6).