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 <memory>
30 
32 
33 class Hgi;
34 
35 using HgiCmdsUniquePtr = std::unique_ptr<class HgiCmds>;
36 
37 
38 /// \class HgiCmds
39 ///
40 /// Graphics commands are recorded in 'cmds' objects which are later submitted
41 /// to hgi. HgiCmds is the base class for other cmds objects.
42 ///
43 class HgiCmds
44 {
45 public:
46  HGI_API
47  virtual ~HgiCmds();
48 
49 protected:
50  friend class Hgi;
51 
52  HGI_API
53  HgiCmds();
54 
55  // Submit can be called inside of Hgi::SubmitCmds to commit the
56  // command buffer to the GPU. Returns true if work was committed.
57  // The default implementation returns false.
58  HGI_API
59  virtual bool _Submit(Hgi* hgi);
60 
61 private:
62  HgiCmds & operator=(const HgiCmds&) = delete;
63  HgiCmds(const HgiCmds&) = delete;
64 };
65 
66 
68 
69 #endif
virtual HGI_API bool _Submit(Hgi *hgi)
virtual HGI_API ~HgiCmds()
std::unique_ptr< class HgiCmds > HgiCmdsUniquePtr
Definition: cmds.h:35
Definition: hgi.h:106
#define HGI_API
Definition: api.h:40
HGI_API HgiCmds()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: cmds.h:43