All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
renderPassSchema.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 PXR_IMAGING_HD_RENDER_PASS_SCHEMA_H
19#define PXR_IMAGING_HD_RENDER_PASS_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
24#include "pxr/imaging/hd/schemaTypeDefs.h"
25
26#include "pxr/imaging/hd/schema.h"
27
28// --(BEGIN CUSTOM CODE: Includes)--
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
34// --(END CUSTOM CODE: Declares)--
35
36#define HD_RENDER_PASS_SCHEMA_TOKENS \
37 (renderPass) \
38 (passType) \
39 (renderSource) \
40
41TF_DECLARE_PUBLIC_TOKENS(HdRenderPassSchemaTokens, HD_API,
42 HD_RENDER_PASS_SCHEMA_TOKENS);
43
44//-----------------------------------------------------------------------------
45
46
47class HdRenderPassSchema : public HdSchema
48{
49public:
52
53 HdRenderPassSchema(HdContainerDataSourceHandle container)
54 : HdSchema(container) {}
55
61 HD_API
62 static HdRenderPassSchema GetFromParent(
63 const HdContainerDataSourceHandle &fromParentContainer);
64
66
67// --(BEGIN CUSTOM CODE: Schema Methods)--
68// --(END CUSTOM CODE: Schema Methods)--
69
72
73 HD_API
74 HdTokenDataSourceHandle GetPassType() const;
75
76 HD_API
77 HdPathDataSourceHandle GetRenderSource() const;
78
80
83
86 HD_API
87 static const TfToken &GetSchemaToken();
88
91 HD_API
92 static const HdDataSourceLocator &GetDefaultLocator();
93
95
104
106 HD_API
107 static const HdDataSourceLocator &GetPassTypeLocator();
108
110 HD_API
111 static const HdDataSourceLocator &GetRenderSourceLocator();
113
116
124 HD_API
125 static HdContainerDataSourceHandle
126 BuildRetained(
127 const HdTokenDataSourceHandle &passType,
128 const HdPathDataSourceHandle &renderSource
129 );
130
138 {
139 public:
140 HD_API
141 Builder &SetPassType(
142 const HdTokenDataSourceHandle &passType);
143 HD_API
144 Builder &SetRenderSource(
145 const HdPathDataSourceHandle &renderSource);
146
148 HD_API
149 HdContainerDataSourceHandle Build();
150
151 private:
152 HdTokenDataSourceHandle _passType;
153 HdPathDataSourceHandle _renderSource;
154
155 };
156
158};
159
160PXR_NAMESPACE_CLOSE_SCOPE
161
162#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...
HD_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:81