All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
textureResourceHandle.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 HDST_TEXTURE_RESOURCE_HANDLE_H
25 #define HDST_TEXTURE_RESOURCE_HANDLE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 
30 #include "pxr/imaging/hd/textureResource.h"
31 
32 #include <boost/shared_ptr.hpp>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 class HdRenderIndex;
37 class SdfPath;
38 
39 typedef boost::shared_ptr<class HdStTextureResourceHandle>
40  HdStTextureResourceHandleSharedPtr;
41 typedef boost::shared_ptr<class HdStTextureResource>
42  HdStTextureResourceSharedPtr;
43 
87 public:
88  HDST_API
90  HdStTextureResourceSharedPtr const & textureResource = nullptr);
91 
92  HDST_API
93  virtual ~HdStTextureResourceHandle();
94 
95  HDST_API
96  HdStTextureResourceSharedPtr const & GetTextureResource() const;
97 
98  HDST_API
99  void SetTextureResource(
100  HdStTextureResourceSharedPtr const & textureResource);
101 
102  HDST_API
103  static HdTextureResource::ID GetHandleKey(
104  HdRenderIndex const * renderIndex,
105  SdfPath const &textureHandleId);
106 
107  HDST_API
108  static bool IsIncompatibleTextureResource(
109  HdStTextureResourceSharedPtr const & a,
110  HdStTextureResourceSharedPtr const & b);
111 
112 private:
113  HdStTextureResourceSharedPtr _textureResource;
114 
115  HdStTextureResourceHandle(const HdStTextureResourceHandle &)
116  = delete;
117  HdStTextureResourceHandle &operator =(const HdStTextureResourceHandle &)
118  = delete;
119 };
120 
121 
122 PXR_NAMESPACE_CLOSE_SCOPE
123 
124 #endif //HDST_TEXTURE_RESOURCE_HANDLE_H
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
HdStTextureResourceHandle is an indirect handle to a GL texture resource.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287