_SdrFilesystemDiscoveryPlugin Class Reference

#include <filesystemDiscovery.h>

Inheritance diagram for _SdrFilesystemDiscoveryPlugin:

Public Types
using	Filter = std::function< bool(SdrShaderNodeDiscoveryResult &)>
Public Types inherited from SdrDiscoveryPlugin
using	Context = SdrDiscoveryPluginContext
Public Types inherited from NdrDiscoveryPlugin
using	Context = NdrDiscoveryPluginContext
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Public Member Functions
SDR_API	_SdrFilesystemDiscoveryPlugin ()
	Constructor. More...
SDR_API	_SdrFilesystemDiscoveryPlugin (Filter filter)
SDR_API	~_SdrFilesystemDiscoveryPlugin ()
	Destructor. More...
SDR_API SdrShaderNodeDiscoveryResultVec	DiscoverShaderNodes (const Context &) override
SDR_API const SdrStringVec &	GetSearchURIs () const override
	Gets the paths that this plugin is searching for nodes in. More...
Public Member Functions inherited from SdrDiscoveryPlugin
SDR_API	SdrDiscoveryPlugin ()
virtual SDR_API	~SdrDiscoveryPlugin ()
SDR_API NdrNodeDiscoveryResultVec	DiscoverNodes (const NdrDiscoveryPluginContext &) overridefinal
Public Member Functions inherited from NdrDiscoveryPlugin
NDR_API	NdrDiscoveryPlugin ()
virtual NDR_API	~NdrDiscoveryPlugin ()
Public Member Functions inherited from TfRefBase
	TfRefBase ()
	TfRefBase (TfRefBase const &)
TfRefBase &	operator= (TfRefBase const &)
size_t	GetCurrentCount () const
	Return the current reference count of this object. More...
bool	IsUnique () const
	Return true if only one TfRefPtr points to this object. More...
void	SetShouldInvokeUniqueChangedListener (bool shouldCall)
Public Member Functions inherited from TfWeakBase
	TfWeakBase ()
	TfWeakBase (const TfWeakBase &)
const TfWeakBase &	__GetTfWeakBase__ () const
const TfWeakBase &	operator= (const TfWeakBase &)
void	EnableNotification2 () const
TF_API void const *	GetUniqueIdentifier () const

Additional Inherited Members
Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)
Protected Member Functions inherited from TfRefBase
virtual TF_API	~TfRefBase ()
Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()
TfRefPtr< Tf_Remnant >	_Register () const
template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const
bool	_HasRemnant () const

Detailed Description

Discovers shader nodes on the filesystem. The provided search paths are walked to find files that have certain extensions. If a file with a matching extension is found, it is turned into a SdrShaderNodeDiscoveryResult and will be parsed into a node when its information is accessed.

Parameters for this plugin are specified via environment variables (which must be set before the library is loaded):

PXR_SDR_FS_PLUGIN_SEARCH_PATHS - The paths that should be searched, recursively, for files that represent nodes. Paths should be separated by either a ':' or a ';' depending on your platform (it should mimic the PATH env var on your platform). See ARCH_PATH_LIST_SEP.

PXR_SDR_FS_PLUGIN_ALLOWED_EXTS - The extensions on files that define nodes. Do not include the leading ".". Extensions should be separated by a colon.

PXR_SDR_FS_PLUGIN_FOLLOW_SYMLINKS - Whether symlinks should be followed while walking the search paths. Set to "true" (case sensitive) if they should be followed.

Definition at line 50 of file filesystemDiscovery.h.

Member Typedef Documentation

using _SdrFilesystemDiscoveryPlugin::Filter = std::function<bool(SdrShaderNodeDiscoveryResult&)>

A filter for discovered nodes. If the function returns false then the discovered node is discarded. Otherwise the function can modify the discovery result.

Definition at line 55 of file filesystemDiscovery.h.

Constructor & Destructor Documentation

SDR_API _SdrFilesystemDiscoveryPlugin::_SdrFilesystemDiscoveryPlugin

(

)

Constructor.

SDR_API _SdrFilesystemDiscoveryPlugin::_SdrFilesystemDiscoveryPlugin

(

Filter

filter

)

DiscoverNodes() will pass each result to the given function for modification. If the function returns false then the result is discarded.

SDR_API _SdrFilesystemDiscoveryPlugin::~_SdrFilesystemDiscoveryPlugin ( )

inline

Destructor.

Definition at line 69 of file filesystemDiscovery.h.

Member Function Documentation

SDR_API SdrShaderNodeDiscoveryResultVec _SdrFilesystemDiscoveryPlugin::DiscoverShaderNodes ( const Context &  )

overridevirtual

Discover all of the nodes that appear within the the search paths provided and match the extensions provided.

Implements SdrDiscoveryPlugin.

SDR_API const SdrStringVec& _SdrFilesystemDiscoveryPlugin::GetSearchURIs ( ) const

inlineoverridevirtual

Gets the paths that this plugin is searching for nodes in.

Implements NdrDiscoveryPlugin.

Definition at line 79 of file filesystemDiscovery.h.

---

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

• pxr/usd/sdr/filesystemDiscovery.h