SFML - Simple and Fast Multimedia Library

SFML 2.5.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

Context.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2018 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages 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 freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#ifndef SFML_CONTEXT_HPP
26#define SFML_CONTEXT_HPP
27
29// Headers
31#include <SFML/Window/Export.hpp>
32#include <SFML/Window/GlResource.hpp>
33#include <SFML/Window/ContextSettings.hpp>
34#include <SFML/System/NonCopyable.hpp>
35
36
37namespace sf
38{
39namespace priv
40{
41 class GlContext;
42}
43
44typedef void (*GlFunctionPointer)();
45
50 class SFML_WINDOW_API Context : GlResource, NonCopyable
51{
52public:
53
60 Context();
61
68 ~Context();
69
78 bool setActive(bool active);
79
90 const ContextSettings& getSettings() const;
91
100 static bool isExtensionAvailable(const char* name);
101
110 static GlFunctionPointer getFunction(const char* name);
111
122 static const Context* getActiveContext();
123
133 static Uint64 getActiveContextId();
134
146 Context(const ContextSettings& settings, unsigned int width, unsigned int height);
147
148private:
149
151 // Member data
153 priv::GlContext* m_context;
154};
155
156} // namespace sf
157
158
159#endif // SFML_CONTEXT_HPP
160
sf::Context
Class holding a valid drawing context.
Definition: Context.hpp:51
sf::Context::setActive
bool setActive(bool active)
Activate or deactivate explicitly the context.
sf::Context::isExtensionAvailable
static bool isExtensionAvailable(const char *name)
Check whether a given OpenGL extension is available.
sf::Context::Context
Context(const ContextSettings &settings, unsigned int width, unsigned int height)
Construct a in-memory context.
sf::Context::getActiveContext
static const Context * getActiveContext()
Get the currently active context.
sf::Context::getSettings
const ContextSettings & getSettings() const
Get the settings of the context.
sf::Context::getActiveContextId
static Uint64 getActiveContextId()
Get the currently active context's ID.
sf::Context::~Context
~Context()
Destructor.
sf::Context::getFunction
static GlFunctionPointer getFunction(const char *name)
Get the address of an OpenGL function.
sf::Context::Context
Context()
Default constructor.
sf::GlResource
Base class for classes that require an OpenGL context.
Definition: GlResource.hpp:47
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition: NonCopyable.hpp:42
sf::ContextSettings
Structure defining the settings of the OpenGL context attached to a window.
Definition: ContextSettings.hpp:38