All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
glContextRegistry.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef GLF_GLCONTEXTREGISTRY_H
25 #define GLF_GLCONTEXTREGISTRY_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/imaging/glf/glContext.h"
31 #include "pxr/base/tf/singleton.h"
32 #include <boost/noncopyable.hpp>
33 #include <boost/optional.hpp>
34 #include <boost/ptr_container/ptr_vector.hpp>
35 #include <boost/scoped_ptr.hpp>
36 #include <boost/shared_ptr.hpp>
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 
41 struct GlfGLContextRegistry_Data;
42 
43 typedef boost::shared_ptr<class GlfGLContext> GlfGLContextSharedPtr;
44 
49 class GlfGLContextRegistry : boost::noncopyable {
50 public:
51  static GlfGLContextRegistry& GetInstance()
52  {
54  }
55 
57  bool IsInitialized() const;
58 
62 
64  GlfGLContextSharedPtr GetShared();
65 
67  GlfGLContextSharedPtr GetCurrent();
68 
70  void DidMakeCurrent(const GlfGLContextSharedPtr& context);
71 
73  void Remove(const GlfGLContext* context);
74 
75 private:
78 
79  friend class TfSingleton<GlfGLContextRegistry>;
80 
81 private:
82  boost::ptr_vector<GlfGLContextRegistrationInterface> _interfaces;
83  boost::optional<GlfGLContextSharedPtr> _shared;
84  boost::scoped_ptr<GlfGLContextRegistry_Data> _data;
85 };
86 
87 
88 PXR_NAMESPACE_CLOSE_SCOPE
89 
90 #endif // GLF_GLCONTEXTREGISTRY_H
bool IsInitialized() const
Returns whether the registry has any registered interfaces.
Manage a single instance of an object (see.
Definition: singleton.h:122
Registry of GlfGLContexts.
void Add(GlfGLContextRegistrationInterface *)
Add a registration object to the registry.
Provides window system independent access to GL contexts.
Definition: glContext.h:52
static T & GetInstance()
Return a reference to an object of type T, creating it if necessary.
Definition: singleton.h:137
void DidMakeCurrent(const GlfGLContextSharedPtr &context)
Registers this context. It must be current.
GlfGLContextSharedPtr GetShared()
Returns the shared context, if any.
void Remove(const GlfGLContext *context)
Removes the context.
GlfGLContextSharedPtr GetCurrent()
Returns the context that matches the raw context, if any.
Interface for registering a GlfGLContext system.
Definition: glContext.h:252