![]() |
|
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. More...
#include <renderDelegate.h>
Public Member Functions | |
virtual HD_API bool | SetArbitraryValue (const TfToken &key, const VtValue &value) |
Set a custom value in the render param's implementation. | |
virtual HD_API VtValue | GetArbitraryValue (const TfToken &key) const |
Retrieve a custom value identified by key from the render param's implementation. | |
virtual HD_API bool | HasArbitraryValue (const TfToken &key) const |
Check whether a valid custom value exists for the specified key in the render param's implementation. | |
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.
|
inline |
Definition at line 48 of file renderDelegate.h.
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 |
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.
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.