HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
device.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 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 PXR_IMAGING_HGIGL_DEVICE_H
25 #define PXR_IMAGING_HGIGL_DEVICE_H
26 
27 #include "pxr/pxr.h"
29 #include "pxr/imaging/hgiGL/api.h"
31 #include "pxr/imaging/hgiGL/hgi.h"
32 
33 #include <fstream>
34 #include <ostream>
35 
37 
38 class HgiGraphicsCmdDesc;
39 
40 /// \class HgiGLDevice
41 ///
42 /// OpenGL implementation of GPU device.
43 /// Note: HgiGL does not concern itself with GL context management.
44 /// See notes in hgiGL/hgi.h
45 ///
46 class HgiGLDevice final {
47 public:
48  HGIGL_API
49  HgiGLDevice();
50 
51  HGIGL_API
52  ~HgiGLDevice();
53 
54  /// Execute the provided functions / ops. This will emit the GL calls.
55  HGIGL_API
56  void SubmitOps(HgiGLOpsVector const& ops);
57 
58  /// Sets the active arena to use when submitting commands. This is used
59  /// for management of resources tied to a GL context such as FBOs.
60  /// The default arena is used if a valid handle isn't provided.
61  HGIGL_API
62  void SetCurrentArena(HgiGLContextArenaHandle const& arenaHandle);
63 
64  /// Returns a framebuffer object id that is managed by the active arena.
65  HGIGL_API
66  uint32_t AcquireFramebuffer(
67  HgiGraphicsCmdsDesc const& desc,
68  bool resolved = false);
69 
70  /// Garbage collect resources in the active arena.
71  HGIGL_API
72  void GarbageCollect();
73 
74 private:
75  HgiGLContextArena const * _GetArena() const;
76  HgiGLContextArena * _GetArena();
77 
78  HgiGLDevice & operator=(const HgiGLDevice&) = delete;
79  HgiGLDevice(const HgiGLDevice&) = delete;
80 
81  friend std::ofstream& operator<<(
82  std::ofstream& out,
83  const HgiGLDevice& dev);
84 
85  // The default arena is used in the absence of a user provided arena.
86  HgiGLContextArena _defaultArena;
87  HgiGLContextArena *_activeArena;
88 };
89 
90 
92 
93 #endif
HGIGL_API void SubmitOps(HgiGLOpsVector const &ops)
Execute the provided functions / ops. This will emit the GL calls.
std::ofstream ofstream
Definition: filesystem.h:58
friend std::ofstream & operator<<(std::ofstream &out, const HgiGLDevice &dev)
HGIGL_API HgiGLDevice()
HGIGL_API uint32_t AcquireFramebuffer(HgiGraphicsCmdsDesc const &desc, bool resolved=false)
Returns a framebuffer object id that is managed by the active arena.
#define HGIGL_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
HGIGL_API ~HgiGLDevice()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::vector< HgiGLOpsFn > HgiGLOpsVector
Definition: hgi.h:43
HGIGL_API void GarbageCollect()
Garbage collect resources in the active arena.
HGIGL_API void SetCurrentArena(HgiGLContextArenaHandle const &arenaHandle)