Loading...
Searching...
No Matches
rileyRenderTargetSchema.h
Go to the documentation of this file.
1//
2// Copyright 2023 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/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_TARGET_SCHEMA_H
36#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_TARGET_SCHEMA_H
37
39
40#include "hdPrman/api.h"
42
43#include "pxr/imaging/hd/schema.h"
44#include "pxr/imaging/hd/version.h"
45
46// --(BEGIN CUSTOM CODE: Includes)--
47// --(END CUSTOM CODE: Includes)--
48
49PXR_NAMESPACE_OPEN_SCOPE
50
51// --(BEGIN CUSTOM CODE: Declares)--
52// --(END CUSTOM CODE: Declares)--
53
54#define HD_PRMAN_RILEY_RENDER_TARGET_SCHEMA_TOKENS \
55 (rileyRenderTarget) \
56 (renderOutputs) \
57 (extent) \
58 (filterMode) \
59 (pixelVariance) \
60 (params) \
61 (importance) \
62 (weighted) \
63
64TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyRenderTargetSchemaTokens, HDPRMAN_API,
65 HD_PRMAN_RILEY_RENDER_TARGET_SCHEMA_TOKENS);
66
67//-----------------------------------------------------------------------------
68
69
70class HdPrmanRileyRenderTargetSchema : public HdSchema
71{
72public:
75
76 HdPrmanRileyRenderTargetSchema(HdContainerDataSourceHandle container)
77 : HdSchema(container) {}
78
84 HDPRMAN_API
85 static HdPrmanRileyRenderTargetSchema GetFromParent(
86 const HdContainerDataSourceHandle &fromParentContainer);
87
89
90// --(BEGIN CUSTOM CODE: Schema Methods)--
91// --(END CUSTOM CODE: Schema Methods)--
92
95
96 HDPRMAN_API
97 HdPathArrayDataSourceHandle GetRenderOutputs()
98#if HD_API_VERSION >= 66
99 const;
100#else
101 ;
102#endif
103
104
105 HDPRMAN_API
106 HdVec3iDataSourceHandle GetExtent()
107#if HD_API_VERSION >= 66
108 const;
109#else
110 ;
111#endif
112
113
114 HDPRMAN_API
115 HdTokenDataSourceHandle GetFilterMode()
116#if HD_API_VERSION >= 66
117 const;
118#else
119 ;
120#endif
121
122
123 HDPRMAN_API
124 HdFloatDataSourceHandle GetPixelVariance()
125#if HD_API_VERSION >= 66
126 const;
127#else
128 ;
129#endif
130
131
132 HDPRMAN_API
133 HdPrmanRileyParamListSchema GetParams()
134#if HD_API_VERSION >= 66
135 const;
136#else
137 ;
138#endif
139
140
142
145
148 HDPRMAN_API
149 static const TfToken &GetSchemaToken();
150
153 HDPRMAN_API
154 static const HdDataSourceLocator &GetDefaultLocator();
155
157
166
168 HDPRMAN_API
169 static const HdDataSourceLocator &GetRenderOutputsLocator();
170
172 HDPRMAN_API
173 static const HdDataSourceLocator &GetExtentLocator();
174
176 HDPRMAN_API
177 static const HdDataSourceLocator &GetFilterModeLocator();
178
180 HDPRMAN_API
181 static const HdDataSourceLocator &GetPixelVarianceLocator();
182
184 HDPRMAN_API
185 static const HdDataSourceLocator &GetParamsLocator();
187
190
198 HDPRMAN_API
199 static HdContainerDataSourceHandle
200 BuildRetained(
201 const HdPathArrayDataSourceHandle &renderOutputs,
202 const HdVec3iDataSourceHandle &extent,
203 const HdTokenDataSourceHandle &filterMode,
204 const HdFloatDataSourceHandle &pixelVariance,
205 const HdContainerDataSourceHandle &params
206 );
207
215 {
216 public:
217 HDPRMAN_API
218 Builder &SetRenderOutputs(
219 const HdPathArrayDataSourceHandle &renderOutputs);
220 HDPRMAN_API
221 Builder &SetExtent(
222 const HdVec3iDataSourceHandle &extent);
223 HDPRMAN_API
224 Builder &SetFilterMode(
225 const HdTokenDataSourceHandle &filterMode);
226 HDPRMAN_API
227 Builder &SetPixelVariance(
228 const HdFloatDataSourceHandle &pixelVariance);
229 HDPRMAN_API
230 Builder &SetParams(
231 const HdContainerDataSourceHandle &params);
232
234 HDPRMAN_API
235 HdContainerDataSourceHandle Build();
236
237 private:
238 HdPathArrayDataSourceHandle _renderOutputs;
239 HdVec3iDataSourceHandle _extent;
240 HdTokenDataSourceHandle _filterMode;
241 HdFloatDataSourceHandle _pixelVariance;
242 HdContainerDataSourceHandle _params;
243
244 };
245
252 HDPRMAN_API
253 static HdTokenDataSourceHandle BuildFilterModeDataSource(
254 const TfToken &filterMode);
255
257};
258
259PXR_NAMESPACE_CLOSE_SCOPE
260
261#endif
Represents an object that can identify the location of a data source.
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:43
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98