occlusion_query.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_display.h"
33 #include <memory>
34 #include "graphic_context.h"
35 
36 namespace clan
37 {
40 
41 class OcclusionQuery_Impl;
42 class GraphicContext;
43 class OcclusionQueryProvider;
44 
46 class CL_API_DISPLAY OcclusionQuery
47 {
50 
51 public:
54 
57 
58  virtual ~OcclusionQuery();
59 
63 
64 public:
66  bool is_null() const { return !impl; }
67 
69  void throw_if_null() const;
70 
72  int get_result();
73 
75  bool is_result_ready();
76 
80  OcclusionQueryProvider *get_provider() const;
81 
85 
86 public:
88  void begin();
89 
91  void end();
92 
96 
97 private:
98  std::shared_ptr<OcclusionQuery_Impl> impl;
100 };
101 
102 }
103 
Graphics occlusion query class.
Definition: occlusion_query.h:46
Occlusion query provider.
Definition: occlusion_query_provider.h:41
Interface to drawing graphics.
Definition: graphic_context.h:257
bool is_null() const
Returns true if this object is invalid.
Definition: occlusion_query.h:66