Provides Hydra-specific properties for UsdRenderPass. More...

#include <renderPassAPI.h>

Inheritance diagram for UsdHydraRenderPassAPI:

Public Member Functions
	UsdHydraRenderPassAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdHydraRenderPassAPI on UsdPrim `prim` .

	UsdHydraRenderPassAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdHydraRenderPassAPI on the prim held by `schemaObj` .

virtual USDHYDRA_API	~UsdHydraRenderPassAPI ()
	Destructor.

USDHYDRA_API UsdAttribute	GetHydraRendererNameAttr () const
	The name of the Hydra renderer to use if the user does not otherwise specify one to the application.

USDHYDRA_API UsdAttribute	CreateHydraRendererNameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetHydraRendererNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDHYDRA_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 classes.

static USDHYDRA_API UsdHydraRenderPassAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdHydraRenderPassAPI holding the prim adhering to this schema at `path` on `stage`.

static USDHYDRA_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`.

static USDHYDRA_API UsdHydraRenderPassAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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 classes.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDHYDRA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

Detailed Description

Provides Hydra-specific properties for UsdRenderPass.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdHydraTokens. So to set an attribute to the value "rightHanded", use UsdHydraTokens->rightHanded as the value.

Definition at line 45 of file renderPassAPI.h.

Constructor & Destructor Documentation

◆ UsdHydraRenderPassAPI() [1/2]

UsdHydraRenderPassAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdHydraRenderPassAPI on UsdPrim prim .

Equivalent to UsdHydraRenderPassAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 57 of file renderPassAPI.h.

◆ UsdHydraRenderPassAPI() [2/2]

UsdHydraRenderPassAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdHydraRenderPassAPI on the prim held by schemaObj .

Should be preferred over UsdHydraRenderPassAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 65 of file renderPassAPI.h.

◆ ~UsdHydraRenderPassAPI()

virtual USDHYDRA_API ~UsdHydraRenderPassAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDHYDRA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDHYDRA_API UsdHydraRenderPassAPI Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "HydraRenderPassAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid UsdHydraRenderPassAPI object is returned upon success. An invalid (or empty) UsdHydraRenderPassAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CanApply()

static USDHYDRA_API bool CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = nullptr )

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CreateHydraRendererNameAttr()

USDHYDRA_API UsdAttribute CreateHydraRendererNameAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

See GetHydraRendererNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

◆ Get()

static USDHYDRA_API UsdHydraRenderPassAPI Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path )

static

Return a UsdHydraRenderPassAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdHydraRenderPassAPI(stage->GetPrimAtPath(path));

UsdHydraRenderPassAPI::UsdHydraRenderPassAPI

UsdHydraRenderPassAPI(const UsdPrim &prim=UsdPrim())

Construct a UsdHydraRenderPassAPI on UsdPrim prim .

Definition renderPassAPI.h:57

◆ GetHydraRendererNameAttr()

USDHYDRA_API UsdAttribute GetHydraRendererNameAttr ( ) const

The name of the Hydra renderer to use if the user does not otherwise specify one to the application.

Applications typically allow the user to specify a session renderer to use, such as by the –renderer argument to usdrecord; this attribute provides a way to specify renderer selection in a USD-based pipeline.


Declaration	`uniform token hydra:rendererName`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

◆ GetSchemaAttributeNames()

static USDHYDRA_API const TfTokenVector & GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 143 of file renderPassAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 51 of file renderPassAPI.h.

The documentation for this class was generated from the following file:

pxr/usd/usdHydra/renderPassAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdHydraRenderPassAPI() [1/2]

◆ UsdHydraRenderPassAPI() [2/2]

◆ ~UsdHydraRenderPassAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ CreateHydraRendererNameAttr()

◆ Get()

◆ GetHydraRendererNameAttr()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind