A UsdRenderVar describes a custom data variable for a render to produce. More...

Inheritance diagram for UsdRenderVar:

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

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

virtual USDRENDER_API	~UsdRenderVar ()
	Destructor. More...

USDRENDER_API UsdAttribute	GetDataTypeAttr () const
	The type of this channel, as a USD attribute type. More...

USDRENDER_API UsdAttribute	CreateDataTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDataTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...

USDRENDER_API UsdAttribute	GetSourceNameAttr () const
	The renderer should look for an output of this name as the computed value for the RenderVar. More...

USDRENDER_API UsdAttribute	CreateSourceNameAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSourceNameAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...

USDRENDER_API UsdAttribute	GetSourceTypeAttr () const
	Indicates the type of the source. More...

USDRENDER_API UsdAttribute	CreateSourceTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSourceTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...

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

	UsdTyped (const UsdSchemaBase &schemaObj)
	Construct a UsdTyped on the prim wrapped by `schemaObj` . More...

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. More...

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

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

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

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

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

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

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

virtual USD_API	~UsdSchemaBase ()
	Destructor. More...

USD_API	operator bool () const

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

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

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

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

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

static USDRENDER_API UsdRenderVar	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at `path` is defined (according to UsdPrim::IsDefined()) on this stage. More...

Static Public Member Functions inherited from UsdTyped
static 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. More...

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

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

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

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

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

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

Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...

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

Detailed Description

A UsdRenderVar describes a custom data variable for a render to produce.

The prim describes the source of the data, which can be a shader output or an LPE (Light Path Expression), and also allows encoding of (generally renderer-specific) parameters that configure the renderer for computing the variable.

ote In the future, UsdRender may standardize RenderVar representation for well-known variables under the sourceType intrinsic, such as r, g, b, a, z, or id.

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

Definition at line 72 of file var.h.

Constructor & Destructor Documentation

UsdRenderVar ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdRenderVar on UsdPrim prim .

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

Definition at line 84 of file var.h.

UsdRenderVar ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdRenderVar on the prim held by schemaObj .

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

Definition at line 92 of file var.h.

virtual USDRENDER_API ~UsdRenderVar ( )

virtual

Destructor.

Member Function Documentation

USDRENDER_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

USDRENDER_API UsdAttribute CreateDataTypeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetDataTypeAttr(), 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.

USDRENDER_API UsdAttribute CreateSourceNameAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetSourceNameAttr(), 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.

USDRENDER_API UsdAttribute CreateSourceTypeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetSourceTypeAttr(), 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.

static USDRENDER_API UsdRenderVar Define	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDRENDER_API UsdRenderVar Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdRenderVar 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:

* UsdRenderVar(stage->GetPrimAtPath(path));

*

USDRENDER_API UsdAttribute GetDataTypeAttr ( ) const

The type of this channel, as a USD attribute type.


Declaration	`uniform token dataType = "color3f"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

static USDRENDER_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.

USDRENDER_API UsdAttribute GetSourceNameAttr ( ) const

The renderer should look for an output of this name as the computed value for the RenderVar.


Declaration	`uniform string sourceName = ""`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform

USDRENDER_API UsdAttribute GetSourceTypeAttr ( ) const

Indicates the type of the source.

"raw": The name should be passed directly to the renderer. This is the default behavior.
"primvar": This source represents the name of a primvar. Some renderers may use this to ensure that the primvar is provided; other renderers may require that a suitable material network be provided, in which case this is simply an advisory setting.
"lpe": Specifies a Light Path Expression in the OSL Light Path Expressions language as the source for this RenderVar. Some renderers may use extensions to that syntax, which will necessarily be non-portable.
"intrinsic": This setting is currently unimplemented, but represents a future namespace for UsdRender to provide portable baseline RenderVars, such as camera depth, that may have varying implementations for each renderer.


Declaration	`uniform token sourceType = "raw"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	raw, primvar, lpe, intrinsic

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also: UsdSchemaKind

Definition at line 78 of file var.h.

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

pxr/usd/usdRender/var.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation