occlusion_query.h Source File - ClanLib SDK
Description: occlusion_query.h Source File

occlusion_query.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
30
31#include <memory>
32#include "graphic_context.h"
33
34namespace clan
35{
38
39 class OcclusionQuery_Impl;
40 class GraphicContext;
41 class OcclusionQueryProvider;
42
44 class OcclusionQuery
45 {
46 public:
48 OcclusionQuery();
49
51 OcclusionQuery(GraphicContext &context);
52
53 virtual ~OcclusionQuery();
54
56 bool is_null() const { return !impl; }
57 explicit operator bool() const { return bool(impl); }
58
60 void throw_if_null() const;
61
63 int get_result();
64
66 bool is_result_ready();
67
71 OcclusionQueryProvider *get_provider() const;
72
74 void begin();
75
77 void end();
78
79 private:
80 std::shared_ptr<OcclusionQuery_Impl> impl;
81 };
82
84}
clan::GraphicContext
Interface to drawing graphics.
Definition graphic_context.h:257
clan::OcclusionQueryProvider
Occlusion query provider.
Definition occlusion_query_provider.h:40
clan::OcclusionQuery
Graphics occlusion query class.
Definition occlusion_query.h:45
clan::OcclusionQuery::is_null
bool is_null() const
Returns true if this object is invalid.
Definition occlusion_query.h:56
clan::OcclusionQuery::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::OcclusionQuery::get_result
int get_result()
Returns the result of the occlusion query.
clan::OcclusionQuery::OcclusionQuery
OcclusionQuery(GraphicContext &context)
Constructs an occlusion query object.
clan::OcclusionQuery::end
void end()
Finish occlusion query.
clan::OcclusionQuery::~OcclusionQuery
virtual ~OcclusionQuery()
clan::OcclusionQuery::OcclusionQuery
OcclusionQuery()
Constructs a null instance.
clan::OcclusionQuery::get_provider
OcclusionQueryProvider * get_provider() const
Get Provider.
clan::OcclusionQuery::is_result_ready
bool is_result_ready()
Returns true if the GPU is ready to return the result.
clan::OcclusionQuery::begin
void begin()
Start occlusion query.
clan
Definition clanapp.h:36