renderSettingsSchema.h
1 //
2 // Copyright 2022 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 //
25 
26 /* ************************************************************************** */
27 /* ** This file is generated by a script. Do not edit directly. Edit ** */
28 /* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29 /* ************************************************************************** */
30 
31 #ifndef PXR_IMAGING_HD_RENDER_SETTINGS_SCHEMA_H
32 #define PXR_IMAGING_HD_RENDER_SETTINGS_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDRENDERSETTINGS_SCHEMA_TOKENS \
43  (renderSettings) \
44  (sampleFilters) \
45  (displayFilters) \
46 
47 TF_DECLARE_PUBLIC_TOKENS(HdRenderSettingsSchemaTokens, HD_API,
48  HDRENDERSETTINGS_SCHEMA_TOKENS);
49 
50 //-----------------------------------------------------------------------------
51 
52 class HdRenderSettingsSchema : public HdSchema
53 {
54 public:
55  HdRenderSettingsSchema(HdContainerDataSourceHandle container)
56  : HdSchema(container) {}
57 
58  //ACCESSORS
59 
60  HD_API
61  HdPathArrayDataSourceHandle GetSampleFilters();
62  HD_API
63  HdPathArrayDataSourceHandle GetDisplayFilters();
64 
65  // RETRIEVING AND CONSTRUCTING
66 
72  HD_API
73  static HdContainerDataSourceHandle
74  BuildRetained(
75  const HdPathArrayDataSourceHandle &sampleFilters,
76  const HdPathArrayDataSourceHandle &displayFilters
77  );
78 
85  class Builder
86  {
87  public:
88  HD_API
89  Builder &SetSampleFilters(
90  const HdPathArrayDataSourceHandle &sampleFilters);
91  HD_API
92  Builder &SetDisplayFilters(
93  const HdPathArrayDataSourceHandle &displayFilters);
94 
96  HD_API
97  HdContainerDataSourceHandle Build();
98 
99  private:
100  HdPathArrayDataSourceHandle _sampleFilters;
101  HdPathArrayDataSourceHandle _displayFilters;
102  };
103 
109  HD_API
110  static HdRenderSettingsSchema GetFromParent(
111  const HdContainerDataSourceHandle &fromParentContainer);
112 
115  HD_API
116  static const HdDataSourceLocator &GetDefaultLocator();
117 
118 };
119 
120 PXR_NAMESPACE_CLOSE_SCOPE
121 
122 #endif
Represents an object that can identify the location of a data source.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:42