All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
texture.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_TEXTURE_H
25 #define HGI_TEXTURE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/gf/vec3i.h"
29 #include "pxr/imaging/hgi/api.h"
30 #include "pxr/imaging/hgi/enums.h"
31 #include "pxr/imaging/hgi/types.h"
32 
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 struct HgiTextureDesc;
37 
38 
48 class HgiTexture {
49 public:
50  HGI_API
51  HgiTexture(HgiTextureDesc const& desc);
52 
53  HGI_API
54  virtual ~HgiTexture();
55 
56 private:
57  HgiTexture() = delete;
58  HgiTexture & operator=(const HgiTexture&) = delete;
59  HgiTexture(const HgiTexture&) = delete;
60 };
61 
63 
64 
65 
83  : usage(HgiTextureUsageBitsColorTarget)
84  , format(HgiFormatInvalid)
85  , dimensions(0)
86  , sampleCount(HgiSampleCount1)
87  {}
88 
89  HgiTextureUsage usage;
90  HgiFormat format;
91  GfVec3i dimensions;
92  HgiSampleCount sampleCount;
93 };
94 
95 HGI_API
96 bool operator==(
97  const HgiTextureDesc& lhs,
98  const HgiTextureDesc& rhs);
99 
100 HGI_API
101 inline bool operator!=(
102  const HgiTextureDesc& lhs,
103  const HgiTextureDesc& rhs);
104 
105 
106 PXR_NAMESPACE_CLOSE_SCOPE
107 
108 #endif
AR_API bool operator!=(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
AR_API bool operator==(const ArAssetInfo &lhs, const ArAssetInfo &rhs)
Describes the properties needed to create a GPU texture.
Definition: texture.h:81
Basic type for a vector of 3 int components.
Definition: vec3i.h:61
Represents a graphics platform independent GPU texture resource.
Definition: texture.h:48