HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
materialSchema.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 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 /* ************************************************************************** */
27 /* ** This file is generated by a script. Do not edit directly. Edit ** */
28 /* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29 /* ************************************************************************** */
30 
31 #ifndef PXR_IMAGING_HD_MATERIAL_SCHEMA_H
32 #define PXR_IMAGING_HD_MATERIAL_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDMATERIAL_SCHEMA_TOKENS \
43  (material) \
44  ((universalRenderContext, "")) \
45 
46 TF_DECLARE_PUBLIC_TOKENS(HdMaterialSchemaTokens, HD_API,
48 
49 //-----------------------------------------------------------------------------
50 
51 class HdMaterialSchema : public HdSchema
52 {
53 public:
54  HdMaterialSchema(HdContainerDataSourceHandle container)
55  : HdSchema(container) {}
56 
57  HD_API
58  static HdContainerDataSourceHandle
60  size_t count,
61  TfToken *names,
62  HdDataSourceBaseHandle *values);
63 
64  HdContainerDataSourceHandle GetMaterialNetwork();
65  HdContainerDataSourceHandle GetMaterialNetwork(TfToken const &context);
66 
67 
68  /// Retrieves a container data source with the schema's default name token
69  /// "material" from the parent container and constructs a
70  /// HdMaterialSchema instance.
71  /// Because the requested container data source may not exist, the result
72  /// should be checked with IsDefined() or a bool comparison before use.
73  HD_API
75  const HdContainerDataSourceHandle &fromParentContainer);
76 
77  /// Returns a token where the container representing this schema is found in
78  /// a container by default.
79  HD_API
80  static const TfToken &GetSchemaToken();
81 
82  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
83  /// where the container representing this schema is found by default.
84  HD_API
85  static const HdDataSourceLocator &GetDefaultLocator();
86 
87 };
88 
90 
91 #endif
HdMaterialSchema(HdContainerDataSourceHandle container)
#define HD_API
Definition: api.h:40
static HD_API HdMaterialSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
Definition: token.h:87
TF_DECLARE_PUBLIC_TOKENS(HdMaterialSchemaTokens, HD_API, HDMATERIAL_SCHEMA_TOKENS)
static HD_API const TfToken & GetSchemaToken()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1602
#define HDMATERIAL_SCHEMA_TOKENS
static HD_API HdContainerDataSourceHandle BuildRetained(size_t count, TfToken *names, HdDataSourceBaseHandle *values)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static HD_API const HdDataSourceLocator & GetDefaultLocator()
GLint GLsizei count
Definition: glcorearb.h:405
HdContainerDataSourceHandle GetMaterialNetwork()