computeSceneIndexDiff.h File Reference

#include "pxr/pxr.h"
#include "pxr/imaging/hdsi/api.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/base/tf/declarePtrs.h"

Include dependency graph for computeSceneIndexDiff.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
using	HdsiComputeSceneIndexDiff = std::function< void(const HdSceneIndexBaseRefPtr &siA, const HdSceneIndexBaseRefPtr &siB, HdSceneIndexObserver::RemovedPrimEntries *removedEntries, HdSceneIndexObserver::AddedPrimEntries *addedEntries, HdSceneIndexObserver::RenamedPrimEntries *renamedEntries, HdSceneIndexObserver::DirtiedPrimEntries *dirtiedEntries)>

Functions
HDSI_API void	HdsiComputeSceneIndexDiffRoot (const HdSceneIndexBaseRefPtr &siA, const HdSceneIndexBaseRefPtr &siB, HdSceneIndexObserver::RemovedPrimEntries *removedEntries, HdSceneIndexObserver::AddedPrimEntries *addedEntries, HdSceneIndexObserver::RenamedPrimEntries *renamedEntries, HdSceneIndexObserver::DirtiedPrimEntries *dirtiedEntries)
HDSI_API void	HdsiComputeSceneIndexDiffDelta (const HdSceneIndexBaseRefPtr &siA, const HdSceneIndexBaseRefPtr &siB, HdSceneIndexObserver::RemovedPrimEntries *removedEntries, HdSceneIndexObserver::AddedPrimEntries *addedEntries, HdSceneIndexObserver::RenamedPrimEntries *renamedEntries, HdSceneIndexObserver::DirtiedPrimEntries *dirtiedEntries)

Typedef Documentation

using HdsiComputeSceneIndexDiff = std::function<void( const HdSceneIndexBaseRefPtr& siA, const HdSceneIndexBaseRefPtr& siB, HdSceneIndexObserver::RemovedPrimEntries* removedEntries, HdSceneIndexObserver::AddedPrimEntries* addedEntries, HdSceneIndexObserver::RenamedPrimEntries* renamedEntries, HdSceneIndexObserver::DirtiedPrimEntries* dirtiedEntries)>

This is used to compute the difference between siA and siB expressed as removedEntries, addedEntries, renamedEntries, and dirtiedEntries, being sent in that order.

Definition at line 29 of file computeSceneIndexDiff.h.

Function Documentation

HDSI_API void HdsiComputeSceneIndexDiffDelta	(	const HdSceneIndexBaseRefPtr &	siA,
		const HdSceneIndexBaseRefPtr &	siB,
		HdSceneIndexObserver::RemovedPrimEntries *	removedEntries,
		HdSceneIndexObserver::AddedPrimEntries *	addedEntries,
		HdSceneIndexObserver::RenamedPrimEntries *	renamedEntries,
		HdSceneIndexObserver::DirtiedPrimEntries *	dirtiedEntries
	)

This will walk both scene indices and try to compute a sparse delta at the prim level.

All of the pointers should be non-null.

HDSI_API void HdsiComputeSceneIndexDiffRoot	(	const HdSceneIndexBaseRefPtr &	siA,
		const HdSceneIndexBaseRefPtr &	siB,
		HdSceneIndexObserver::RemovedPrimEntries *	removedEntries,
		HdSceneIndexObserver::AddedPrimEntries *	addedEntries,
		HdSceneIndexObserver::RenamedPrimEntries *	renamedEntries,
		HdSceneIndexObserver::DirtiedPrimEntries *	dirtiedEntries
	)

This compute diff function resets the entire scene.

If siA is not null, this will remove /. If siB is not null, it will add all prims (recursively) starting with /.

All of the pointers should be non-null.