Loading...
Searching...
No Matches
denoisePass.h
Go to the documentation of this file.
1//
2// Copyright 2016 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#ifndef USDRENDER_GENERATED_DENOISEPASS_H
25#define USDRENDER_GENERATED_DENOISEPASS_H
26
28
29#include "pxr/pxr.h"
30#include "pxr/usd/usdRender/api.h"
31#include "pxr/usd/usd/typed.h"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
34
35#include "pxr/base/vt/value.h"
36
37#include "pxr/base/gf/vec3d.h"
38#include "pxr/base/gf/vec3f.h"
40
41#include "pxr/base/tf/token.h"
42#include "pxr/base/tf/type.h"
43
44PXR_NAMESPACE_OPEN_SCOPE
45
46class SdfAssetPath;
47
48// -------------------------------------------------------------------------- //
49// RENDERDENOISEPASS //
50// -------------------------------------------------------------------------- //
51
66{
67public:
71 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
72
77 explicit UsdRenderDenoisePass(const UsdPrim& prim=UsdPrim())
78 : UsdTyped(prim)
79 {
80 }
81
85 explicit UsdRenderDenoisePass(const UsdSchemaBase& schemaObj)
86 : UsdTyped(schemaObj)
87 {
88 }
89
91 USDRENDER_API
93
97 USDRENDER_API
98 static const TfTokenVector &
99 GetSchemaAttributeNames(bool includeInherited=true);
100
110 USDRENDER_API
112 Get(const UsdStagePtr &stage, const SdfPath &path);
113
136 USDRENDER_API
138 Define(const UsdStagePtr &stage, const SdfPath &path);
139
140protected:
144 USDRENDER_API
146
147private:
148 // needs to invoke _GetStaticTfType.
149 friend class UsdSchemaRegistry;
150 USDRENDER_API
151 static const TfType &_GetStaticTfType();
152
153 static bool _IsTypedSchema();
154
155 // override SchemaBase virtuals.
156 USDRENDER_API
157 const TfType &_GetTfType() const override;
158
159public:
160 // ===================================================================== //
161 // Feel free to add custom code below this line, it will be preserved by
162 // the code generator.
163 //
164 // Just remember to:
165 // - Close the class declaration with };
166 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
167 // - Close the include guard with #endif
168 // ===================================================================== //
169 // --(BEGIN CUSTOM CODE)--
170};
171
172PXR_NAMESPACE_CLOSE_SCOPE
173
174#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
TfType represents a dynamic runtime type.
Definition: type.h:65
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
A RenderDenoisePass generates renders via a denoising process.
Definition: denoisePass.h:66
static USDRENDER_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: denoisePass.h:71
UsdRenderDenoisePass(const UsdPrim &prim=UsdPrim())
Construct a UsdRenderDenoisePass on UsdPrim prim .
Definition: denoisePass.h:77
static USDRENDER_API UsdRenderDenoisePass Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
static USDRENDER_API UsdRenderDenoisePass Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRenderDenoisePass holding the prim adhering to this schema at path on stage.
USDRENDER_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
virtual USDRENDER_API ~UsdRenderDenoisePass()
Destructor.
UsdRenderDenoisePass(const UsdSchemaBase &schemaObj)
Construct a UsdRenderDenoisePass on the prim held by schemaObj .
Definition: denoisePass.h:85
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Definition: typed.h:62
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457