Loading...
Searching...
No Matches
rileyDisplaySchema.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_DISPLAY_SCHEMA_H
19#define EXT_RMANPKG_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_DISPLAY_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_DISPLAY_SCHEMA_TOKENS \
38 (rileyDisplay) \
39 (renderTarget) \
40 (name) \
41 (driver) \
42 (renderOutputs) \
43 (driverParams) \
44
45TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyDisplaySchemaTokens, HDPRMAN_API,
46 HD_PRMAN_RILEY_DISPLAY_SCHEMA_TOKENS);
47
48//-----------------------------------------------------------------------------
49
50
51class HdPrmanRileyDisplaySchema : public HdSchema
52{
53public:
56
57 HdPrmanRileyDisplaySchema(HdContainerDataSourceHandle container)
58 : HdSchema(container) {}
59
65 HDPRMAN_API
66 static HdPrmanRileyDisplaySchema GetFromParent(
67 const HdContainerDataSourceHandle &fromParentContainer);
68
70
71// --(BEGIN CUSTOM CODE: Schema Methods)--
72// --(END CUSTOM CODE: Schema Methods)--
73
76
77 HDPRMAN_API
78 HdPathDataSourceHandle GetRenderTarget()
79#if HD_API_VERSION >= 66
80 const;
81#else
82 ;
83#endif
84
85
86 HDPRMAN_API
87 HdTokenDataSourceHandle GetName()
88#if HD_API_VERSION >= 66
89 const;
90#else
91 ;
92#endif
93
94
95 HDPRMAN_API
96 HdTokenDataSourceHandle GetDriver()
97#if HD_API_VERSION >= 66
98 const;
99#else
100 ;
101#endif
102
103
104 HDPRMAN_API
105 HdPathArrayDataSourceHandle GetRenderOutputs()
106#if HD_API_VERSION >= 66
107 const;
108#else
109 ;
110#endif
111
112
113 HDPRMAN_API
114 HdPrmanRileyParamListSchema GetDriverParams()
115#if HD_API_VERSION >= 66
116 const;
117#else
118 ;
119#endif
120
121
123
126
129 HDPRMAN_API
130 static const TfToken &GetSchemaToken();
131
134 HDPRMAN_API
135 static const HdDataSourceLocator &GetDefaultLocator();
136
138
147
149 HDPRMAN_API
150 static const HdDataSourceLocator &GetRenderTargetLocator();
151
153 HDPRMAN_API
154 static const HdDataSourceLocator &GetNameLocator();
155
157 HDPRMAN_API
158 static const HdDataSourceLocator &GetDriverLocator();
159
161 HDPRMAN_API
162 static const HdDataSourceLocator &GetRenderOutputsLocator();
163
165 HDPRMAN_API
166 static const HdDataSourceLocator &GetDriverParamsLocator();
168
171
179 HDPRMAN_API
180 static HdContainerDataSourceHandle
181 BuildRetained(
182 const HdPathDataSourceHandle &renderTarget,
183 const HdTokenDataSourceHandle &name,
184 const HdTokenDataSourceHandle &driver,
185 const HdPathArrayDataSourceHandle &renderOutputs,
186 const HdContainerDataSourceHandle &driverParams
187 );
188
196 {
197 public:
198 HDPRMAN_API
199 Builder &SetRenderTarget(
200 const HdPathDataSourceHandle &renderTarget);
201 HDPRMAN_API
202 Builder &SetName(
203 const HdTokenDataSourceHandle &name);
204 HDPRMAN_API
205 Builder &SetDriver(
206 const HdTokenDataSourceHandle &driver);
207 HDPRMAN_API
208 Builder &SetRenderOutputs(
209 const HdPathArrayDataSourceHandle &renderOutputs);
210 HDPRMAN_API
211 Builder &SetDriverParams(
212 const HdContainerDataSourceHandle &driverParams);
213
215 HDPRMAN_API
216 HdContainerDataSourceHandle Build();
217
218 private:
219 HdPathDataSourceHandle _renderTarget;
220 HdTokenDataSourceHandle _name;
221 HdTokenDataSourceHandle _driver;
222 HdPathArrayDataSourceHandle _renderOutputs;
223 HdContainerDataSourceHandle _driverParams;
224
225 };
226
228};
229
230PXR_NAMESPACE_CLOSE_SCOPE
231
232#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 to describe RtParamList.
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