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 
39 /// \class HgiGlDevice
40 ///
41 /// OpenGL implementation of GPU device.
42 /// Note that there is only one global opengl context / device.
43 ///
44 class HgiGLDevice final {
45 public:
46  HGIGL_API
47  HgiGLDevice();
48 
49  HGIGL_API
50  ~HgiGLDevice();
51 
52  /// Get a framebuffer that matches the descriptor.
53  /// Do not hold onto the framebuffer Id. Instead re-acquire it every frame.
54  /// Framebuffer are internally managed in a framebuffer cache.
55  ///
56  /// When the cmds descriptor has resolved textures, two framebuffers are
57  /// created for the MSAA and for the resolved textures. The bool flag can
58  /// be used to access the respective ones.
59  HGIGL_API
60  uint32_t AcquireFramebuffer(
61  HgiGraphicsCmdsDesc const& desc,
62  bool resolved = false);
63 
64  /// Execute the provided functions / ops. This will emit the GL calls.
65  HGIGL_API
66  void SubmitOps(HgiGLOpsVector const& ops);
67 
68 private:
69  HgiGLDevice & operator=(const HgiGLDevice&) = delete;
70  HgiGLDevice(const HgiGLDevice&) = delete;
71 
72  friend std::ofstream& operator<<(
73  std::ofstream& out,
74  const HgiGLDevice& dev);
75 
76  HgiGLFramebufferCache _framebufferCache;
77 };
78 
79 
81 
82 #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:57
friend std::ofstream & operator<<(std::ofstream &out, const HgiGLDevice &dev)
HGIGL_API HgiGLDevice()
HGIGL_API uint32_t AcquireFramebuffer(HgiGraphicsCmdsDesc const &desc, bool resolved=false)
#define HGIGL_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
HGIGL_API ~HgiGLDevice()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::vector< HgiGLOpsFn > HgiGLOpsVector
Definition: hgi.h:41