occlusion_query.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Harry Storbacka
27 */
28
29
30 #pragma once
31
32 #include <memory>
33 #include "graphic_context.h"
34
35 namespace clan
36 {
39
40 class OcclusionQuery_Impl;
41 class GraphicContext;
42 class OcclusionQueryProvider;
43
45 class OcclusionQuery
46 {
49
50 public:
52 OcclusionQuery();
53
55 OcclusionQuery(GraphicContext &context);
56
57 virtual ~OcclusionQuery();
58
62
63 public:
65 bool is_null() const { return !impl; }
66
68 void throw_if_null() const;
69
71 int get_result();
72
74 bool is_result_ready();
75
79 OcclusionQueryProvider *get_provider() const;
80
84
85 public:
87 void begin();
88
90 void end();
91
95
96 private:
97 std::shared_ptr<OcclusionQuery_Impl> impl;
99 };
100
101 }
102
clan
Definition: clanapp.h:35
clan::OcclusionQuery::get_result
int get_result()
Returns the result of the occlusion query.
clan::OcclusionQuery
Graphics occlusion query class.
Definition: occlusion_query.h:45
clan::OcclusionQuery::OcclusionQuery
OcclusionQuery()
Constructs a null instance.
clan::OcclusionQuery::begin
void begin()
Start occlusion query.
clan::OcclusionQueryProvider
Occlusion query provider.
Definition: occlusion_query_provider.h:40
clan::OcclusionQuery::end
void end()
Finish occlusion query.
clan::OcclusionQuery::get_provider
OcclusionQueryProvider * get_provider() const
Get Provider.
clan::GraphicContext
Interface to drawing graphics.
Definition: graphic_context.h:257
clan::OcclusionQuery::is_result_ready
bool is_result_ready()
Returns true if the GPU is ready to return the result.
clan::OcclusionQuery::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: occlusion_query.h:65
clan::OcclusionQuery::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::OcclusionQuery::~OcclusionQuery
virtual ~OcclusionQuery()