All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
immediateCommandBuffer.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_IMMEDIATE_COMMAND_BUFFER_H
25 #define HGI_IMMEDIATE_COMMAND_BUFFER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
29 #include <memory>
30 
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
35 
36 typedef std::unique_ptr<class HgiGraphicsEncoder> HgiGraphicsEncoderUniquePtr;
37 typedef std::unique_ptr<class HgiBlitEncoder> HgiBlitEncoderUniquePtr;
38 
39 
52 {
53 public:
54  HGI_API
56 
57  HGI_API
58  virtual ~HgiImmediateCommandBuffer();
59 
63  HGI_API
64  virtual HgiGraphicsEncoderUniquePtr CreateGraphicsEncoder(
65  HgiGraphicsEncoderDesc const& desc) = 0;
66 
70  HGI_API
71  virtual HgiBlitEncoderUniquePtr CreateBlitEncoder() = 0;
72 
73 private:
74  HgiImmediateCommandBuffer & operator=
75  (const HgiImmediateCommandBuffer&) = delete;
76  HgiImmediateCommandBuffer(const HgiImmediateCommandBuffer&) = delete;
77 };
78 
79 
80 
81 PXR_NAMESPACE_CLOSE_SCOPE
82 
83 #endif
virtual HGI_API HgiBlitEncoderUniquePtr CreateBlitEncoder()=0
Returns a blit encoder for temporary use that is ready to execute resource copy commands.
The encoders created from this command buffer are assumed to execute the commands immediately in the ...
virtual HGI_API HgiGraphicsEncoderUniquePtr CreateGraphicsEncoder(HgiGraphicsEncoderDesc const &desc)=0
Returns a graphics encoder for temporary use that is ready to execute draw commands.
Describes the properties to begin a HgiGraphicsEncoder.