Loading...
Searching...
No Matches
sceneIndexCreateArgsSchema.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_SCENE_INDEX_CREATE_ARGS_SCHEMA_H
19#define PXR_IMAGING_HD_SCENE_INDEX_CREATE_ARGS_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// #include "pxr/imaging/hd/renderDelegateInfo.h"
30// --(END CUSTOM CODE: Includes)--
31
32PXR_NAMESPACE_OPEN_SCOPE
33
34// --(BEGIN CUSTOM CODE: Declares)--
35struct HdRenderDelegateInfo;
37using HdRenderDelegateInfoDataSourceHandle = HdRenderDelegateInfoDataSource::Handle;
38// --(END CUSTOM CODE: Declares)--
39
40#define HD_SCENE_INDEX_CREATE_ARGS_SCHEMA_TOKENS \
41 (motionBlurSupport) \
42 (cameraMotionBlurSupport) \
43 (legacyRenderDelegateInfo) \
44 (renderSettingDescriptors) \
45 (excludedPurposesHint) \
46
47TF_DECLARE_PUBLIC_TOKENS(HdSceneIndexCreateArgsSchemaTokens, HD_API,
48 HD_SCENE_INDEX_CREATE_ARGS_SCHEMA_TOKENS);
49
50//-----------------------------------------------------------------------------
51
52
70{
71public:
74
75 HdSceneIndexCreateArgsSchema(HdContainerDataSourceHandle container)
76 : HdSchema(container) {}
77
79
80// --(BEGIN CUSTOM CODE: Schema Methods)--
81// --(END CUSTOM CODE: Schema Methods)--
82
85
90 HD_API
91 HdBoolDataSourceHandle GetMotionBlurSupport() const;
92
97 HD_API
98 HdBoolDataSourceHandle GetCameraMotionBlurSupport() const;
99
105 HD_API
106 HdRenderDelegateInfoDataSourceHandle GetLegacyRenderDelegateInfo() const;
107
109 HD_API
111
115 HD_API
116 HdTokenArrayDataSourceHandle GetExcludedPurposesHint() const;
117
119
122
130 HD_API
131 static HdContainerDataSourceHandle
133 const HdBoolDataSourceHandle &motionBlurSupport,
134 const HdBoolDataSourceHandle &cameraMotionBlurSupport,
135 const HdRenderDelegateInfoDataSourceHandle &legacyRenderDelegateInfo,
136 const HdContainerDataSourceHandle &renderSettingDescriptors,
137 const HdTokenArrayDataSourceHandle &excludedPurposesHint
138 );
139
146 class Builder
147 {
148 public:
149 HD_API
150 Builder &SetMotionBlurSupport(
151 const HdBoolDataSourceHandle &motionBlurSupport);
152 HD_API
153 Builder &SetCameraMotionBlurSupport(
154 const HdBoolDataSourceHandle &cameraMotionBlurSupport);
155 HD_API
156 Builder &SetLegacyRenderDelegateInfo(
157 const HdRenderDelegateInfoDataSourceHandle &legacyRenderDelegateInfo);
158 HD_API
159 Builder &SetRenderSettingDescriptors(
160 const HdContainerDataSourceHandle &renderSettingDescriptors);
161 HD_API
162 Builder &SetExcludedPurposesHint(
163 const HdTokenArrayDataSourceHandle &excludedPurposesHint);
164
166 HD_API
167 HdContainerDataSourceHandle Build();
168
169 private:
170 HdBoolDataSourceHandle _motionBlurSupport;
171 HdBoolDataSourceHandle _cameraMotionBlurSupport;
172 HdRenderDelegateInfoDataSourceHandle _legacyRenderDelegateInfo;
173 HdContainerDataSourceHandle _renderSettingDescriptors;
174 HdTokenArrayDataSourceHandle _excludedPurposesHint;
175
176 };
177
179};
180
181PXR_NAMESPACE_CLOSE_SCOPE
182
183#endif
Template class for a schema backed by a container whose children have arbitrary names but an expected...
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 for the container data source returned by HdRendererPlugin::GetSceneIndexCreateArgs.
static HD_API HdContainerDataSourceHandle BuildRetained(const HdBoolDataSourceHandle &motionBlurSupport, const HdBoolDataSourceHandle &cameraMotionBlurSupport, const HdRenderDelegateInfoDataSourceHandle &legacyRenderDelegateInfo, const HdContainerDataSourceHandle &renderSettingDescriptors, const HdTokenArrayDataSourceHandle &excludedPurposesHint)
HD_API HdRenderSettingDescriptorContainerSchema GetRenderSettingDescriptors() const
Render settings advertised by rendererer.
HD_API HdRenderDelegateInfoDataSourceHandle GetLegacyRenderDelegateInfo() const
Used for HdRenderIndexAdapterSceneIndex.
HD_API HdBoolDataSourceHandle GetMotionBlurSupport() const
Does consumer (most likely HdRenderer) of scene indices need samples for motion blur?...
HD_API HdBoolDataSourceHandle GetCameraMotionBlurSupport() const
Does consumer (most likely HdRenderer) of scene indices need samples for motion blur for cameras?...
HD_API HdTokenArrayDataSourceHandle GetExcludedPurposesHint() const
Hint listing prim purposes (e.g.
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition schema.h:26
A datasource representing a concretely-typed sampled value.
Definition dataSource.h:248
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.