usdrt::UsdRenderDenoisePass

Defined in usdrt/scenegraph/usd/usdRender/denoisePass.h

Functions

usdrt::UsdRenderDenoisePass::Define: Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdRenderDenoisePass::UsdRenderDenoisePass: Construct a UsdRenderDenoisePass on the prim held by schemaObj . Should be preferred over UsdRenderDenoisePass (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::UsdRenderDenoisePass::UsdRenderDenoisePass: Construct a UsdRenderDenoisePass on UsdPrim prim . Equivalent to UsdRenderDenoisePass::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdRenderDenoisePass::operator bool: Boolean operator.
usdrt::UsdRenderDenoisePass::~UsdRenderDenoisePass: Destructor.

Variables

usdrt::UsdRenderDenoisePass::schemaType: Compile time constant representing what kind of schema this class is.

class UsdRenderDenoisePass : public usdrt::UsdTyped 

A RenderDenoisePass generates renders via a denoising process. This may be the same renderer that a pipeline uses for UsdRender, or may be a separate one. Notably, a RenderDenoisePass requires another Pass to be present for it to operate. The denoising process itself is not generative, and requires images inputs to operate.

As denoising integration varies so widely across pipelines, all implementation details are left to pipeline-specific prims that inherit from RenderDenoisePass.

Public Functions

inline explicit UsdRenderDenoisePass(const UsdPrim &prim = UsdPrim()): Construct a UsdRenderDenoisePass on UsdPrim prim. Equivalent to UsdRenderDenoisePass::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdRenderDenoisePass(const UsdSchemaBase &schemaObj): Construct a UsdRenderDenoisePass on the prim held by schemaObj . Should be preferred over UsdRenderDenoisePass(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdRenderDenoisePass(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is an instance of this schema using IsA, and false otherwise.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline UsdRenderDenoisePass Define(const UsdStageRefPtr &stage, const SdfPath &path): Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped 

Compile time constant representing what kind of schema this class is.