HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
layerHints.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_USD_SDF_LAYER_HINTS_H
25 #define PXR_USD_SDF_LAYER_HINTS_H
26 
27 #include "pxr/pxr.h"
28 
30 
31 /// Contains hints about layer contents that may be used to accelerate certain
32 /// composition operations.
34 {
35 public:
36  /// Default constructed hints provide the most conservative set of values
37  /// such that consumers of the hints will act correctly if not optimally.
38  SdfLayerHints() = default;
39 
40  /// Construct hints with specific values. Using this constructor requires
41  /// that all hint fields be specified.
43  : mightHaveRelocates(mightHaveRelocates)
44  {}
45 
46  /// If this field is false, the layer does not contain relocates. If
47  /// true, relocates may be present but are not guaranteed to exist.
48  bool mightHaveRelocates = true;
49 };
50 
52 
53 #endif
SdfLayerHints(bool mightHaveRelocates)
Definition: layerHints.h:42
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
bool mightHaveRelocates
Definition: layerHints.h:48
SdfLayerHints()=default