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

opengl_context_description.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** Magnus Norddahl
27*/
28
29#pragma once
30
31#include <memory>
32
33namespace clan
34{
37
38 class OpenGLContextDescription_Impl;
39
41 class OpenGLContextDescription
42 {
43 public:
45 OpenGLContextDescription();
46
50 virtual ~OpenGLContextDescription();
51
53 int get_version_major() const;
54
56 int get_version_minor() const;
57
59 bool get_allow_lower_versions() const;
60
62 bool get_debug() const;
63
65 bool get_forward_compatible() const;
66
68 bool get_core_profile() const;
69
71 bool get_compatibility_profile() const;
72
74 int get_layer_plane() const;
75
83 void set_version(int major, int minor, bool allow_lower_versions);
84
92 void set_debug(bool enable);
93
102 void set_forward_compatible(bool enable);
103
109 void set_core_profile(bool enable);
110
116 void set_compatibility_profile(bool enable);
117
123 void set_layer_plane(int value);
124
125 private:
126 std::shared_ptr<OpenGLContextDescription_Impl> impl;
127 };
128
130}
clan::OpenGLContextDescription
OpenGL context specific settings.
Definition opengl_context_description.h:42
clan::OpenGLContextDescription::get_forward_compatible
bool get_forward_compatible() const
Returns true if the forward compatible flag is set.
clan::OpenGLContextDescription::get_compatibility_profile
bool get_compatibility_profile() const
Returns true if the compatibility profile flag is set.
clan::OpenGLContextDescription::set_version
void set_version(int major, int minor, bool allow_lower_versions)
Select the OpenGL version number.
clan::OpenGLContextDescription::~OpenGLContextDescription
virtual ~OpenGLContextDescription()
Constructs a OpenGLContextDescription.
clan::OpenGLContextDescription::set_layer_plane
void set_layer_plane(int value)
Sets the layer plane value.
clan::OpenGLContextDescription::set_core_profile
void set_core_profile(bool enable)
Sets the core profile flag.
clan::OpenGLContextDescription::get_core_profile
bool get_core_profile() const
Returns true if the core profile flag is set.
clan::OpenGLContextDescription::get_allow_lower_versions
bool get_allow_lower_versions() const
Returns true if allowed lower versions than the selected version.
clan::OpenGLContextDescription::set_compatibility_profile
void set_compatibility_profile(bool enable)
Sets the compatibility profile flag.
clan::OpenGLContextDescription::OpenGLContextDescription
OpenGLContextDescription()
Constructs a window description with default values.
clan::OpenGLContextDescription::get_version_minor
int get_version_minor() const
Returns selected minor version number.
clan::OpenGLContextDescription::get_layer_plane
int get_layer_plane() const
Returns the layer plane value.
clan::OpenGLContextDescription::get_version_major
int get_version_major() const
Returns selected major version number.
clan::OpenGLContextDescription::set_debug
void set_debug(bool enable)
Sets the debug flag.
clan::OpenGLContextDescription::get_debug
bool get_debug() const
Returns true if the debug flag is set.
clan::OpenGLContextDescription::set_forward_compatible
void set_forward_compatible(bool enable)
Sets the forward compatible flag.
clan
Definition clanapp.h:36