HdEngine Class Reference

The application-facing entry point top-level entry point for accessing Hydra. More...

#include <engine.h>

Public Member Functions
HD_API void	Execute (HdRenderIndex *index, HdTaskSharedPtrVector *tasks)
	Execute tasks.
HD_API void	Execute (HdRenderIndex *index, const SdfPathVector &taskPaths)
HD_API bool	AreTasksConverged (HdRenderIndex *index, const SdfPathVector &taskPaths)
Task Context
External interface to set data/state in the task context passed to each task in the render graph
HD_API void	SetTaskContextData (const TfToken &id, const VtValue &data)
	Adds or updates the value associated with the token.
HD_API bool	GetTaskContextData (const TfToken &id, VtValue *data) const
	If found, will return the value from the task context data associated with the token.
HD_API void	RemoveTaskContextData (const TfToken &id)
	Removes the specified token.
HD_API void	ClearTaskContextData ()
	Removes all keys.

Detailed Description

The application-facing entry point top-level entry point for accessing Hydra.

Typically the application would only create one of these.

Definition at line 31 of file engine.h.

Member Function Documentation

ClearTaskContextData()

HD_API void ClearTaskContextData

(

)

Removes all keys.

Execute()

HD_API void Execute	(	HdRenderIndex *	index,
		HdTaskSharedPtrVector *	tasks
	)

Execute tasks.

GetTaskContextData()

HD_API bool GetTaskContextData	(	const TfToken &	id,
		VtValue *	data
	)		const

If found, will return the value from the task context data associated with the token.

Returns false if the data could not be found.

RemoveTaskContextData()

HD_API void RemoveTaskContextData

(

const TfToken &

id

)

Removes the specified token.

SetTaskContextData()

HD_API void SetTaskContextData	(	const TfToken &	id,
		const VtValue &	data
	)

Adds or updates the value associated with the token.

Only one is supported for each token.

---

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

• pxr/imaging/hd/engine.h