Loading...
Searching...
No Matches
rendererCreateArgsSchema.h
Go to the documentation of this file.
1//
2// Copyright 2025 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_RENDERER_CREATE_ARGS_SCHEMA_H
19#define PXR_IMAGING_HD_RENDERER_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// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
34// --(END CUSTOM CODE: Declares)--
35
36#define HD_RENDERER_CREATE_ARGS_SCHEMA_TOKENS \
37 (rendererCreateArgs) \
38 (gpuEnabled) \
39 (drivers) \
40 (hgi) \
41
42TF_DECLARE_PUBLIC_TOKENS(HdRendererCreateArgsSchemaTokens, HD_API,
43 HD_RENDERER_CREATE_ARGS_SCHEMA_TOKENS);
44
45//-----------------------------------------------------------------------------
46
47
53{
54public:
57
58 HdRendererCreateArgsSchema(HdContainerDataSourceHandle container)
59 : HdSchema(container) {}
60
66 HD_API
68 const HdContainerDataSourceHandle &fromParentContainer);
69
71
72// --(BEGIN CUSTOM CODE: Schema Methods)--
73// --(END CUSTOM CODE: Schema Methods)--
74
77
79 HD_API
80 HdBoolDataSourceHandle GetGpuEnabled() const;
81
83 HD_API
85
87
90
93 HD_API
94 static const TfToken &GetSchemaToken();
95
98 HD_API
100
102
111
113 HD_API
115
117 HD_API
120
123
131 HD_API
132 static HdContainerDataSourceHandle
134 const HdBoolDataSourceHandle &gpuEnabled,
135 const HdContainerDataSourceHandle &drivers
136 );
137
145 {
146 public:
147 HD_API
148 Builder &SetGpuEnabled(
149 const HdBoolDataSourceHandle &gpuEnabled);
150 HD_API
151 Builder &SetDrivers(
152 const HdContainerDataSourceHandle &drivers);
153
155 HD_API
156 HdContainerDataSourceHandle Build();
157
158 private:
159 HdBoolDataSourceHandle _gpuEnabled;
160 HdContainerDataSourceHandle _drivers;
161
162 };
163
165};
166
167PXR_NAMESPACE_CLOSE_SCOPE
168
169#endif
Template class for a schema backed by a container whose children have arbitrary names but an expected...
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.
Arguments to HdRendererPlugin::IsSupported and CreateRenderer.
static HD_API HdContainerDataSourceHandle BuildRetained(const HdBoolDataSourceHandle &gpuEnabled, const HdContainerDataSourceHandle &drivers)
static HD_API const HdDataSourceLocator & GetDriversLocator()
Prim-level relative data source locator to locate drivers.
HD_API HdBoolDataSourceHandle GetGpuEnabled() const
Is a GPU available.
HD_API HdSampledDataSourceContainerSchema GetDrivers() const
Drivers such as Hgi that renderer can use.
static HD_API const HdDataSourceLocator & GetGpuEnabledLocator()
Prim-level relative data source locator to locate gpuEnabled.
static HD_API const TfToken & GetSchemaToken()
Returns a token where the container representing this schema is found in a container by default.
static HD_API HdRendererCreateArgsSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Retrieves a container data source with the schema's default name token "rendererCreateArgs" from the ...
static HD_API const HdDataSourceLocator & GetDefaultLocator()
Returns an HdDataSourceLocator (relative to the prim-level data source) where the container represent...
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