All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
hgi.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_HGI_H
25 #define HGI_HGI_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
29 #include "pxr/imaging/hgi/texture.h"
30 #include "pxr/imaging/hgi/types.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
35 
56 class Hgi
57 {
58 public:
59  HGI_API
60  Hgi();
61 
62  HGI_API
63  virtual ~Hgi();
64 
65  //
66  // Command Buffers
67  //
68 
70  HGI_API
72 
73  //
74  // Resource API
75  //
76 
78  HGI_API
79  virtual HgiTextureHandle CreateTexture(HgiTextureDesc const & desc) = 0;
80 
82  HGI_API
83  virtual void DestroyTexture(HgiTextureHandle* texHandle) = 0;
84 
85 private:
86  Hgi & operator=(const Hgi&) = delete;
87  Hgi(const Hgi&) = delete;
88 };
89 
90 PXR_NAMESPACE_CLOSE_SCOPE
91 
92 #endif
The encoders created from this command buffer are assumed to execute the commands immediately in the ...
Describes the properties needed to create a GPU texture.
Definition: texture.h:81
virtual HGI_API HgiTextureHandle CreateTexture(HgiTextureDesc const &desc)=0
Create a texture in rendering backend.
Represents a graphics platform independent GPU texture resource.
Definition: texture.h:48
Hydra Graphics Interface.
Definition: hgi.h:56
virtual HGI_API void DestroyTexture(HgiTextureHandle *texHandle)=0
Destroy a texture in rendering backend.
virtual HGI_API HgiImmediateCommandBuffer & GetImmediateCommandBuffer()=0
Returns the immediate command buffer.