All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
blitEncoder.h
1 //
2 // Copyright 2019 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 HGI_BLIT_ENCODER_H
25 #define HGI_BLIT_ENCODER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 struct HgiCopyResourceOp;
33 struct HgiResolveImageOp;
34 
35 
46 {
47 public:
48  HGI_API
50 
51  HGI_API
52  virtual ~HgiBlitEncoder();
53 
55  HGI_API
56  virtual void EndEncoding() = 0;
57 
59  HGI_API
60  virtual void PushDebugGroup(const char* label) = 0;
61 
63  HGI_API
64  virtual void PopDebugGroup() = 0;
65 
67  HGI_API
68  virtual void CopyTextureGpuToCpu(HgiCopyResourceOp const& copyOp) = 0;
69 
71  HGI_API
72  virtual void ResolveImage(HgiResolveImageOp const& resolveOp)= 0;
73 
74 private:
75  HgiBlitEncoder & operator=(const HgiBlitEncoder&) = delete;
76  HgiBlitEncoder(const HgiBlitEncoder&) = delete;
77 };
78 
79 
80 
81 PXR_NAMESPACE_CLOSE_SCOPE
82 
83 #endif
virtual HGI_API void PopDebugGroup()=0
Pop the lastest debug marker off encoder.
A graphics API independent abstraction of resource copy commands.
Definition: blitEncoder.h:45
Describes the properties needed to copy resource data to/from GPU/CPU.
virtual HGI_API void EndEncoding()=0
Finish recording of commands. No further commands can be recorded.
virtual HGI_API void ResolveImage(HgiResolveImageOp const &resolveOp)=0
Resolve a multi-sample texture (MSAA) so it can be read from.
Properties needed to resolve a multi-sample texture into a regular texture.
virtual HGI_API void CopyTextureGpuToCpu(HgiCopyResourceOp const &copyOp)=0
Copy a texture resource from GPU to CPU.
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker onto the encoder.