Loading...
Searching...
No Matches
rileyRenderOutputSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
8
9/* ************************************************************************** */
10/* ** ** */
11/* ** This file is generated by a script. ** */
12/* ** ** */
13/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14/* ** Edit hdSchemaDefs.py instead to make changes. ** */
15/* ** ** */
16/* ************************************************************************** */
17
18#ifndef EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_H
19#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_H
20
22
23#include "hdPrman/api.h"
25
26#include "pxr/imaging/hd/schema.h"
27#include "pxr/imaging/hd/version.h"
28
29// --(BEGIN CUSTOM CODE: Includes)--
30// --(END CUSTOM CODE: Includes)--
31
32PXR_NAMESPACE_OPEN_SCOPE
33
34// --(BEGIN CUSTOM CODE: Declares)--
35// --(END CUSTOM CODE: Declares)--
36
37#define HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_TOKENS \
38 (rileyRenderOutput) \
39 (name) \
40 (type) \
41 (source) \
42 (accumulationRule) \
43 (filter) \
44 (filterSize) \
45 (relativePixelVariance) \
46 (params) \
47 ((float_, "float")) \
48 (integer) \
49 (color) \
50 (vector) \
51
52TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyRenderOutputSchemaTokens, HDPRMAN_API,
53 HD_PRMAN_RILEY_RENDER_OUTPUT_SCHEMA_TOKENS);
54
55//-----------------------------------------------------------------------------
56
57
58class HdPrmanRileyRenderOutputSchema : public HdSchema
59{
60public:
63
64 HdPrmanRileyRenderOutputSchema(HdContainerDataSourceHandle container)
65 : HdSchema(container) {}
66
72 HDPRMAN_API
73 static HdPrmanRileyRenderOutputSchema GetFromParent(
74 const HdContainerDataSourceHandle &fromParentContainer);
75
77
78// --(BEGIN CUSTOM CODE: Schema Methods)--
79// --(END CUSTOM CODE: Schema Methods)--
80
83
84 HDPRMAN_API
85 HdTokenDataSourceHandle GetName()
86#if HD_API_VERSION >= 66
87 const;
88#else
89 ;
90#endif
91
92
93 HDPRMAN_API
94 HdTokenDataSourceHandle GetType()
95#if HD_API_VERSION >= 66
96 const;
97#else
98 ;
99#endif
100
101
102 HDPRMAN_API
103 HdTokenDataSourceHandle GetSource()
104#if HD_API_VERSION >= 66
105 const;
106#else
107 ;
108#endif
109
110
111 HDPRMAN_API
112 HdTokenDataSourceHandle GetAccumulationRule()
113#if HD_API_VERSION >= 66
114 const;
115#else
116 ;
117#endif
118
119
120 HDPRMAN_API
121 HdTokenDataSourceHandle GetFilter()
122#if HD_API_VERSION >= 66
123 const;
124#else
125 ;
126#endif
127
128
129 HDPRMAN_API
130 HdVec2fDataSourceHandle GetFilterSize()
131#if HD_API_VERSION >= 66
132 const;
133#else
134 ;
135#endif
136
137
138 HDPRMAN_API
139 HdFloatDataSourceHandle GetRelativePixelVariance()
140#if HD_API_VERSION >= 66
141 const;
142#else
143 ;
144#endif
145
146
147 HDPRMAN_API
149#if HD_API_VERSION >= 66
150 const;
151#else
152 ;
153#endif
154
155
157
160
163 HDPRMAN_API
164 static const TfToken &GetSchemaToken();
165
168 HDPRMAN_API
169 static const HdDataSourceLocator &GetDefaultLocator();
170
172
181
183 HDPRMAN_API
184 static const HdDataSourceLocator &GetNameLocator();
185
187 HDPRMAN_API
188 static const HdDataSourceLocator &GetTypeLocator();
189
191 HDPRMAN_API
192 static const HdDataSourceLocator &GetSourceLocator();
193
195 HDPRMAN_API
196 static const HdDataSourceLocator &GetAccumulationRuleLocator();
197
199 HDPRMAN_API
200 static const HdDataSourceLocator &GetFilterLocator();
201
203 HDPRMAN_API
204 static const HdDataSourceLocator &GetFilterSizeLocator();
205
207 HDPRMAN_API
208 static const HdDataSourceLocator &GetRelativePixelVarianceLocator();
209
211 HDPRMAN_API
212 static const HdDataSourceLocator &GetParamsLocator();
214
217
225 HDPRMAN_API
226 static HdContainerDataSourceHandle
227 BuildRetained(
228 const HdTokenDataSourceHandle &name,
229 const HdTokenDataSourceHandle &type,
230 const HdTokenDataSourceHandle &source,
231 const HdTokenDataSourceHandle &accumulationRule,
232 const HdTokenDataSourceHandle &filter,
233 const HdVec2fDataSourceHandle &filterSize,
234 const HdFloatDataSourceHandle &relativePixelVariance,
235 const HdContainerDataSourceHandle &params
236 );
237
245 {
246 public:
247 HDPRMAN_API
248 Builder &SetName(
249 const HdTokenDataSourceHandle &name);
250 HDPRMAN_API
251 Builder &SetType(
252 const HdTokenDataSourceHandle &type);
253 HDPRMAN_API
254 Builder &SetSource(
255 const HdTokenDataSourceHandle &source);
256 HDPRMAN_API
257 Builder &SetAccumulationRule(
258 const HdTokenDataSourceHandle &accumulationRule);
259 HDPRMAN_API
260 Builder &SetFilter(
261 const HdTokenDataSourceHandle &filter);
262 HDPRMAN_API
263 Builder &SetFilterSize(
264 const HdVec2fDataSourceHandle &filterSize);
265 HDPRMAN_API
266 Builder &SetRelativePixelVariance(
267 const HdFloatDataSourceHandle &relativePixelVariance);
268 HDPRMAN_API
269 Builder &SetParams(
270 const HdContainerDataSourceHandle &params);
271
273 HDPRMAN_API
274 HdContainerDataSourceHandle Build();
275
276 private:
277 HdTokenDataSourceHandle _name;
278 HdTokenDataSourceHandle _type;
279 HdTokenDataSourceHandle _source;
280 HdTokenDataSourceHandle _accumulationRule;
281 HdTokenDataSourceHandle _filter;
282 HdVec2fDataSourceHandle _filterSize;
283 HdFloatDataSourceHandle _relativePixelVariance;
284 HdContainerDataSourceHandle _params;
285
286 };
287
296 HDPRMAN_API
297 static HdTokenDataSourceHandle BuildTypeDataSource(
298 const TfToken &type);
299
301};
302
303PXR_NAMESPACE_CLOSE_SCOPE
304
305#endif
Represents an object that can identify the location of a data source.
Schema to describe RtParamList.
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HDPRMAN_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:92