Loading...
Searching...
No Matches
rileyDisplaySchema.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_DISPLAY_SCHEMA_H
36#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_DISPLAY_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_DISPLAY_SCHEMA_TOKENS \
55 (rileyDisplay) \
56 (renderTarget) \
57 (name) \
58 (driver) \
59 (renderOutputs) \
60 (driverParams) \
61
62TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyDisplaySchemaTokens, HDPRMAN_API,
63 HD_PRMAN_RILEY_DISPLAY_SCHEMA_TOKENS);
64
65//-----------------------------------------------------------------------------
66
67
68class HdPrmanRileyDisplaySchema : public HdSchema
69{
70public:
73
74 HdPrmanRileyDisplaySchema(HdContainerDataSourceHandle container)
75 : HdSchema(container) {}
76
82 HDPRMAN_API
83 static HdPrmanRileyDisplaySchema GetFromParent(
84 const HdContainerDataSourceHandle &fromParentContainer);
85
87
88// --(BEGIN CUSTOM CODE: Schema Methods)--
89// --(END CUSTOM CODE: Schema Methods)--
90
93
94 HDPRMAN_API
95 HdPathDataSourceHandle GetRenderTarget()
96#if HD_API_VERSION >= 66
97 const;
98#else
99 ;
100#endif
101
102
103 HDPRMAN_API
104 HdTokenDataSourceHandle GetName()
105#if HD_API_VERSION >= 66
106 const;
107#else
108 ;
109#endif
110
111
112 HDPRMAN_API
113 HdTokenDataSourceHandle GetDriver()
114#if HD_API_VERSION >= 66
115 const;
116#else
117 ;
118#endif
119
120
121 HDPRMAN_API
122 HdPathArrayDataSourceHandle GetRenderOutputs()
123#if HD_API_VERSION >= 66
124 const;
125#else
126 ;
127#endif
128
129
130 HDPRMAN_API
131 HdPrmanRileyParamListSchema GetDriverParams()
132#if HD_API_VERSION >= 66
133 const;
134#else
135 ;
136#endif
137
138
140
143
146 HDPRMAN_API
147 static const TfToken &GetSchemaToken();
148
151 HDPRMAN_API
152 static const HdDataSourceLocator &GetDefaultLocator();
153
155
164
166 HDPRMAN_API
167 static const HdDataSourceLocator &GetRenderTargetLocator();
168
170 HDPRMAN_API
171 static const HdDataSourceLocator &GetNameLocator();
172
174 HDPRMAN_API
175 static const HdDataSourceLocator &GetDriverLocator();
176
178 HDPRMAN_API
179 static const HdDataSourceLocator &GetRenderOutputsLocator();
180
182 HDPRMAN_API
183 static const HdDataSourceLocator &GetDriverParamsLocator();
185
188
196 HDPRMAN_API
197 static HdContainerDataSourceHandle
198 BuildRetained(
199 const HdPathDataSourceHandle &renderTarget,
200 const HdTokenDataSourceHandle &name,
201 const HdTokenDataSourceHandle &driver,
202 const HdPathArrayDataSourceHandle &renderOutputs,
203 const HdContainerDataSourceHandle &driverParams
204 );
205
213 {
214 public:
215 HDPRMAN_API
216 Builder &SetRenderTarget(
217 const HdPathDataSourceHandle &renderTarget);
218 HDPRMAN_API
219 Builder &SetName(
220 const HdTokenDataSourceHandle &name);
221 HDPRMAN_API
222 Builder &SetDriver(
223 const HdTokenDataSourceHandle &driver);
224 HDPRMAN_API
225 Builder &SetRenderOutputs(
226 const HdPathArrayDataSourceHandle &renderOutputs);
227 HDPRMAN_API
228 Builder &SetDriverParams(
229 const HdContainerDataSourceHandle &driverParams);
230
232 HDPRMAN_API
233 HdContainerDataSourceHandle Build();
234
235 private:
236 HdPathDataSourceHandle _renderTarget;
237 HdTokenDataSourceHandle _name;
238 HdTokenDataSourceHandle _driver;
239 HdPathArrayDataSourceHandle _renderOutputs;
240 HdContainerDataSourceHandle _driverParams;
241
242 };
243
245};
246
247PXR_NAMESPACE_CLOSE_SCOPE
248
249#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