opengl_window_description.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 ** Magnus Norddahl
27 */
28
29
30 #pragma once
31
32 #include <memory>
33
34 namespace clan
35 {
38
39 class OpenGLWindowDescription_Impl;
40
51 class OpenGLWindowDescription
52 {
55 public:
57 OpenGLWindowDescription();
58
62 virtual ~OpenGLWindowDescription();
63
67 public:
69 int get_version_major() const;
70
72 int get_version_minor() const;
73
75 bool get_allow_lower_versions() const;
76
78 bool get_debug() const;
79
81 bool get_forward_compatible() const;
82
84 bool get_core_profile() const;
85
87 bool get_compatibility_profile() const;
88
90 int get_layer_plane() const;
91
95 public:
103 void set_version(int major, int minor, bool allow_lower_versions);
104
112 void set_debug(bool enable);
113
122 void set_forward_compatible(bool enable);
123
129 void set_core_profile(bool enable);
130
136 void set_compatibility_profile(bool enable);
137
143 void set_layer_plane(int value);
144
148 private:
149 std::shared_ptr<OpenGLWindowDescription_Impl> impl;
151 };
152
153 }
154
clan
Definition: clanapp.h:35
clan::OpenGLWindowDescription::get_core_profile
bool get_core_profile() const
Returns true if the core profile flag is set.
clan::OpenGLWindowDescription::set_version
void set_version(int major, int minor, bool allow_lower_versions)
Select the OpenGL version number.
clan::OpenGLWindowDescription::set_core_profile
void set_core_profile(bool enable)
Sets the core profile flag.
clan::OpenGLWindowDescription::~OpenGLWindowDescription
virtual ~OpenGLWindowDescription()
Constructs a OpenGLWindowDescription.
clan::OpenGLWindowDescription::get_version_minor
int get_version_minor() const
Returns selected minor version number.
clan::OpenGLWindowDescription::set_debug
void set_debug(bool enable)
Sets the debug flag.
clan::OpenGLWindowDescription::get_forward_compatible
bool get_forward_compatible() const
Returns true if the forward compatible flag is set.
clan::OpenGLWindowDescription::get_layer_plane
int get_layer_plane() const
Returns the layer plane value.
clan::OpenGLWindowDescription::set_compatibility_profile
void set_compatibility_profile(bool enable)
Sets the compatibility profile flag.
clan::OpenGLWindowDescription::OpenGLWindowDescription
OpenGLWindowDescription()
Constructs a window description with default values.
clan::OpenGLWindowDescription::set_layer_plane
void set_layer_plane(int value)
Sets the layer plane value.
clan::OpenGLWindowDescription::get_allow_lower_versions
bool get_allow_lower_versions() const
Returns true if allowed lower versions than the selected version.
clan::OpenGLWindowDescription::get_compatibility_profile
bool get_compatibility_profile() const
Returns true if the compatibility profile flag is set.
clan::OpenGLWindowDescription::get_version_major
int get_version_major() const
Returns selected major version number.
clan::OpenGLWindowDescription::set_forward_compatible
void set_forward_compatible(bool enable)
Sets the forward compatible flag.
clan::OpenGLWindowDescription
OpenGL specific display window description.
Definition: opengl_window_description.h:51
clan::OpenGLWindowDescription::get_debug
bool get_debug() const
Returns true if the debug flag is set.