 |
|
|
|
Discovers shader nodes on the filesystem. More...
#include <filesystemDiscovery.h>
Inheritance diagram for _SdrFilesystemDiscoveryPlugin:Public Types | |
| using | Filter = std::function< bool(SdrShaderNodeDiscoveryResult &)> |
| A filter for discovered nodes. | |
| Public Types inherited from SdrDiscoveryPlugin | |
| using | Context = SdrDiscoveryPluginContext |
| Public Types inherited from TfRefBase | |
| typedef void(* | UniqueChangedFuncPtr) (TfRefBase const *, bool) |
Public Member Functions | |
| SDR_API | _SdrFilesystemDiscoveryPlugin () |
| Constructor. | |
| SDR_API | _SdrFilesystemDiscoveryPlugin (Filter filter) |
| DiscoverShaderNodes() will pass each result to the given function for modification. | |
| SDR_API | ~_SdrFilesystemDiscoveryPlugin () |
| Destructor. | |
| SDR_API SdrShaderNodeDiscoveryResultVec | DiscoverShaderNodes (const Context &) override |
| Discover all of the nodes that appear within the the search paths provided and match the extensions provided. | |
| SDR_API const SdrStringVec & | GetSearchURIs () const override |
| Gets the paths that this plugin is searching for nodes in. | |
| virtual SDR_API SdrShaderNodeDiscoveryResultVec | DiscoverShaderNodes (const Context &)=0 |
| Finds and returns all nodes that the implementing plugin should be aware of. | |
| virtual SDR_API const SdrStringVec & | GetSearchURIs () const =0 |
| Gets the URIs that this plugin is searching for nodes in. | |
| Public Member Functions inherited from TfRefBase | |
| TfRefBase (TfRefBase const &) | |
| TfRefBase & | operator= (TfRefBase const &) |
| size_t | GetCurrentCount () const |
| Return the current reference count of this object. | |
| bool | IsUnique () const |
Return true if only one TfRefPtr points to this object. | |
| void | SetShouldInvokeUniqueChangedListener (bool shouldCall) |
| Public Member Functions inherited from 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 TfWeakBase | |
| TfRefPtr< Tf_Remnant > | _Register () const |
| template<class T > | |
| TfRefPtr< Tf_Remnant > | _Register (T *tempRmnt) const |
| bool | _HasRemnant () const |
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 45 of file filesystemDiscovery.h.
| using 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 50 of file filesystemDiscovery.h.
| SDR_API _SdrFilesystemDiscoveryPlugin | ( | ) |
Constructor.
| SDR_API _SdrFilesystemDiscoveryPlugin | ( | Filter | filter | ) |
DiscoverShaderNodes() will pass each result to the given function for modification.
If the function returns false then the result is discarded.
|
inline |
Destructor.
Definition at line 64 of file filesystemDiscovery.h.
|
overridevirtual |
Discover all of the nodes that appear within the the search paths provided and match the extensions provided.
Implements SdrDiscoveryPlugin.
|
inlineoverridevirtual |
Gets the paths that this plugin is searching for nodes in.
Implements SdrDiscoveryPlugin.
Definition at line 74 of file filesystemDiscovery.h.
1.9.6 