HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
hgiInterop.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_HGIINTEROP_HGIINTEROP_H
25 #define PXR_IMAGING_HGIINTEROP_HGIINTEROP_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/tf/token.h"
29 #include "pxr/base/gf/vec4i.h"
32 
33 #include <memory>
34 
36 
37 class Hgi;
38 class HgiInteropMetal;
39 class HgiInteropOpenGL;
40 class HgiInteropVulkan;
41 class VtValue;
42 
43 /// \class HgiInterop
44 ///
45 /// Hydra Graphics Interface Interop.
46 ///
47 /// HgiInterop provides functionality to transfer render targets between
48 /// supported APIs as efficiently as possible.
49 ///
50 class HgiInterop final
51 {
52 public:
54  HgiInterop();
55 
57  ~HgiInterop();
58 
59  /// Composite the provided textures over the application / viewer's
60  /// framebuffer contents.
61  /// `srcHgi`:
62  /// Determines the source format/platform of the textures.
63  /// Eg. if hgi is of type HgiMetal, the textures are HgiMetalTexture.
64  /// `srcColor`: is the source color aov texture to composite to screen.
65  /// `srcDepth`: (optional) is the depth aov texture to composite to screen.
66  /// `dstApi`:
67  /// Determines what target format/platform the application is using.
68  /// E.g. If hgi==HgiMetal and dstApi==OpenGL then TransferToApp
69  /// will present the metal textures to the gl application.
70  /// `dstFramebuffer`:
71  /// The framebuffer that the source textures are presented into. This
72  /// is a VtValue that encoding a framebuffer in a dstApi specific way.
73  /// E.g., a uint32_t (aka GLuint) for framebuffer object for
74  /// dstApi==OpenGL. For backwards compatibility, the currently bound
75  /// framebuffer is used when the VtValue is empty.
76  ///
77  /// `dstRegion`:
78  /// Subrect region of the framebuffer over which to composite.
79  /// Coordinates are (left, BOTTOM, width, height) which is the same
80  /// convention as OpenGL viewport coordinates.
81  ///
82  /// Note:
83  /// To composite correctly, blending is enabled.
84  /// If `srcDepth` is provided, depth testing is enabled.
85  /// As a result, the contents of the application framebuffer matter.
86  /// In order to use the contents of `srcColor` and `srcDepth` as-is
87  /// (i.e., blit), the color attachment should be cleared to (0,0,0,0) and
88  /// the depth attachment needs to be cleared to 1.
89  ///
91  void TransferToApp(
92  Hgi *srcHgi,
93  HgiTextureHandle const &srcColor,
95  TfToken const &dstApi,
96  VtValue const &dstFramebuffer,
97  GfVec4i const &dstRegion);
98 
99 private:
100  HgiInterop & operator=(const HgiInterop&) = delete;
101  HgiInterop(const HgiInterop&) = delete;
102 
103 #if defined(PXR_METAL_SUPPORT_ENABLED)
104  std::unique_ptr<HgiInteropMetal> _metalToOpenGL;
105 #elif defined(PXR_VULKAN_SUPPORT_ENABLED)
106  std::unique_ptr<HgiInteropVulkan> _vulkanToOpenGL;
107 #else
108  std::unique_ptr<HgiInteropOpenGL> _openGLToOpenGL;
109 #endif
110 };
111 
112 
114 
115 #endif
Definition: vec4i.h:60
#define HGIINTEROP_API
Definition: api.h:40
int HgiHandle< class HgiTexture > HgiTextureHandle
Definition: token.h:87
HGIINTEROP_API void TransferToApp(Hgi *srcHgi, HgiTextureHandle const &srcColor, HgiTextureHandle const &srcDepth, TfToken const &dstApi, VtValue const &dstFramebuffer, GfVec4i const &dstRegion)
GLenum GLint GLint GLint GLint GLuint GLenum GLint GLint GLint GLint GLsizei GLsizei GLsizei srcDepth
Definition: glcorearb.h:2510
Definition: hgi.h:110
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
HGIINTEROP_API ~HgiInterop()
HGIINTEROP_API HgiInterop()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: value.h:167