]> git.cworth.org Git - vogl/blob - src/voglcommon/vogl_query_state.h
Initial vogl checkin
[vogl] / src / voglcommon / vogl_query_state.h
1 /**************************************************************************
2  *
3  * Copyright 2013-2014 RAD Game Tools and Valve Software
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  *
24  **************************************************************************/
25
26 // File: vogl_query_state.h
27 #ifndef VOGL_QUERY_STATE_H
28 #define VOGL_QUERY_STATE_H
29
30 #include "vogl_dynamic_string.h"
31 #include "vogl_json.h"
32 #include "vogl_map.h"
33
34 #include "vogl_common.h"
35 #include "vogl_general_context_state.h"
36 #include "vogl_blob_manager.h"
37
38 class vogl_query_state : public vogl_gl_object_state
39 {
40 public:
41     vogl_query_state();
42     virtual ~vogl_query_state();
43
44     virtual vogl_gl_object_state_type get_type() const
45     {
46         return cGLSTQuery;
47     }
48     virtual vogl_namespace_t get_handle_namespace() const
49     {
50         return VOGL_NAMESPACE_QUERIES;
51     }
52
53     // Target must be supplied by the caller, we can't determine it via normal GL calls.
54     virtual bool snapshot(const vogl_context_info &context_info, vogl_handle_remapper &remapper, GLuint64 handle, GLenum target);
55
56     // restore() tries to restore the previously bound query on target, but it must begin/end it to do so.
57     virtual bool restore(const vogl_context_info &context_info, vogl_handle_remapper &remapper, GLuint64 &handle) const;
58
59     virtual bool remap_handles(vogl_handle_remapper &remapper);
60
61     virtual void clear();
62
63     virtual bool serialize(json_node &node, vogl_blob_manager &blob_manager) const;
64     virtual bool deserialize(const json_node &node, const vogl_blob_manager &blob_manager);
65
66     virtual GLuint64 get_snapshot_handle() const
67     {
68         return m_snapshot_handle;
69     }
70
71     virtual bool compare_restorable_state(const vogl_gl_object_state &rhs) const;
72
73     GLenum get_target() const
74     {
75         return m_target;
76     }
77
78     int64_t get_prev_result() const
79     {
80         return m_prev_result;
81     }
82
83     virtual bool is_valid() const
84     {
85         return m_is_valid;
86     }
87
88 private:
89     GLuint m_snapshot_handle;
90
91     GLuint m_target;
92
93     int64_t m_prev_result;
94     GLenum m_get_result_status;
95
96     bool m_has_been_begun;
97
98     bool m_is_valid;
99 };
100
101 namespace vogl
102 {
103     VOGL_DEFINE_BITWISE_MOVABLE(vogl_query_state);
104 }
105
106 #endif // VOGL_QUERY_STATE_H