HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdRenderParam Class Reference

#include <renderDelegate.h>

+ Inheritance diagram for HdRenderParam:

Public Member Functions

 HdRenderParam ()
 
virtual HD_API ~HdRenderParam ()
 
virtual HD_API bool SetArbitraryValue (const TfToken &key, const VtValue &value)
 
virtual HD_API VtValue GetArbitraryValue (const TfToken &key) const
 
virtual HD_API bool HasArbitraryValue (const TfToken &key) const
 

Detailed Description

The HdRenderParam is an opaque (to core Hydra) handle, to an object that is obtained from the render delegate and passed to each prim during Sync processing.

Definition at line 45 of file renderDelegate.h.

Constructor & Destructor Documentation

HdRenderParam::HdRenderParam ( )
inline

Definition at line 48 of file renderDelegate.h.

virtual HD_API HdRenderParam::~HdRenderParam ( )
virtual

Member Function Documentation

virtual HD_API VtValue HdRenderParam::GetArbitraryValue ( const TfToken key) const
virtual

Retrieve a custom value identified by key from the render param's implementation. The value could have been set via SetArbitraryValue() or provided internally by the render param. Return an empty VtValue if no value is associated with the key. This can either be used to retrieve arbitrary values by the render delegate or by Hydra client code. Since this method can be called by client code, it must be thread-safe.

virtual HD_API bool HdRenderParam::HasArbitraryValue ( const TfToken key) const
virtual

Check whether a valid custom value exists for the specified key in the render param's implementation. Returns true if the value exists, false otherwise. Since this method can be called by client code, it must be thread-safe.

virtual HD_API bool HdRenderParam::SetArbitraryValue ( const TfToken key,
const VtValue value 
)
virtual

Set a custom value in the render param's implementation. The key identifies the value, while value holds the data to set. Return true if the value was successfully set, false if the operation is not supported for the specified key or value. Since this method can be called by client code, it must be thread-safe.


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