HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
layerPrefetchRequest.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_USD_PCP_LAYER_PREFETCH_REQUEST_H
25 #define PXR_USD_PCP_LAYER_PREFETCH_REQUEST_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/usd/pcp/api.h"
29 #include "pxr/usd/sdf/layer.h"
30 
31 #include <set>
32 #include <utility>
33 
35 
36 class Pcp_MutedLayers;
37 
38 /// \class PcpLayerPrefetchRequest
39 ///
40 /// PcpLayerPrefetchRequest represents a request to pre-fetch and retain
41 /// a set of layers in memory. It performs the fetch as a parallel
42 /// operation using a thread pool. Fetched layers are retained by the
43 /// request to keep them alive until the client can decide what to do
44 /// with them.
45 ///
47 {
48 public:
49  /// Enqueue a request to pre-fetch of the sublayers of \a layer.
50  /// This recursively includes any nested sublayers. Arguments in \a args
51  /// will be passed to Sdf when finding or opening sublayers.
52  PCP_API
54  const SdfLayerRefPtr &layer,
56 
57  /// Run the queued requests, returning when complete.
58  PCP_API
59  void Run(const Pcp_MutedLayers& mutedLayers);
60 
61 private:
62  // The request object retains both the layer requests and
63  // the pre-fetched sublayers.
64  typedef std::pair<SdfLayerRefPtr, SdfLayer::FileFormatArguments> _Request;
65  std::set<_Request> _sublayerRequests;
66 
67  std::set<SdfLayerRefPtr> _retainedLayers;
68 };
69 
71 
72 #endif // PXR_USD_PCP_LAYER_PREFETCH_REQUEST_H
const Args & args
Definition: printf.h:628
std::map< std::string, std::string > FileFormatArguments
Definition: layer.h:119
PCP_API void RequestSublayerStack(const SdfLayerRefPtr &layer, const SdfLayer::FileFormatArguments &args)
PCP_API void Run(const Pcp_MutedLayers &mutedLayers)
Run the queued requests, returning when complete.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
GLint GLboolean GLint layer
Definition: glew.h:3601
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define PCP_API
Definition: api.h:40