HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cmds.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_HGI_CMDS_H
25 #define PXR_IMAGING_HGI_CMDS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
29 #include "pxr/imaging/hgi/enums.h"
30 #include <memory>
31 
33 
34 class Hgi;
35 
36 using HgiCmdsUniquePtr = std::unique_ptr<class HgiCmds>;
37 
38 
39 /// \class HgiCmds
40 ///
41 /// Graphics commands are recorded in 'cmds' objects which are later submitted
42 /// to hgi. HgiCmds is the base class for other cmds objects.
43 ///
44 class HgiCmds
45 {
46 public:
47  HGI_API
48  virtual ~HgiCmds();
49 
50  /// Returns true if the HgiCmds object has been submitted to GPU.
51  HGI_API
52  bool IsSubmitted() const;
53 
54 protected:
55  friend class Hgi;
56 
57  HGI_API
58  HgiCmds();
59 
60  // Submit can be called inside of Hgi::SubmitCmds to commit the
61  // command buffer to the GPU. Returns true if work was committed.
62  // The default implementation returns false.
63  HGI_API
64  virtual bool _Submit(Hgi* hgi, HgiSubmitWaitType wait);
65 
66  // Flags the HgiCmds object as 'submitted' to GPU.
67  HGI_API
68  void _SetSubmitted();
69 
70 private:
71  HgiCmds & operator=(const HgiCmds&) = delete;
72  HgiCmds(const HgiCmds&) = delete;
73 
74  bool _submitted;
75 };
76 
77 
79 
80 #endif
HgiSubmitWaitType
Definition: enums.h:516
virtual HGI_API ~HgiCmds()
std::unique_ptr< class HgiCmds > HgiCmdsUniquePtr
Definition: cmds.h:36
virtual HGI_API bool _Submit(Hgi *hgi, HgiSubmitWaitType wait)
*tasks wait()
Definition: hgi.h:106
#define HGI_API
Definition: api.h:40
HGI_API HgiCmds()
HGI_API bool IsSubmitted() const
Returns true if the HgiCmds object has been submitted to GPU.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HGI_API void _SetSubmitted()
Definition: cmds.h:44