Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 18:36:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MaterialCache JSDoc

Browse source
This commit is contained in:
David Rowe 2019-11-26 17:43:23 +13:00
parent 5eb6e9dadd
commit fafb3dd30b
3 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libraries/networking/src/ResourceCache.h
View file

@ -91,8 +91,8 @@ private:
class ScriptableResource : public QObject { class ScriptableResource : public QObject {
/**jsdoc /**jsdoc
* Information about a cached resource. Created by {@link AnimationCache.prefetch}, {@link ModelCache.prefetch}, * Information about a cached resource. Created by {@link AnimationCache.prefetch}, {@link MaterialCache.prefetch},
* {@link SoundCache.prefetch}, or {@link TextureCache.prefetch}. * {@link ModelCache.prefetch}, {@link SoundCache.prefetch}, or {@link TextureCache.prefetch}.
* *
* @class ResourceObject * @class ResourceObject
* *
@ -334,7 +334,7 @@ public:
* @function ResourceCache.getResourceList * @function ResourceCache.getResourceList
* @returns {string[]} The URLs of all resources in the cache. * @returns {string[]} The URLs of all resources in the cache.
* @example <caption>Report cached resources.</caption> * @example <caption>Report cached resources.</caption>
* // Replace AnimationCache with ModelCache, SoundCache, or TextureCache as appropriate. * // Replace AnimationCache with MaterialCache, ModelCache, SoundCache, or TextureCache as appropriate.
* *
* var cachedResources = AnimationCache.getResourceList(); * var cachedResources = AnimationCache.getResourceList();
* print("Cached resources: " + JSON.stringify(cachedResources)); * print("Cached resources: " + JSON.stringify(cachedResources));
@ -354,7 +354,7 @@ public:
* @param {string} url - The URL of the resource to prefetch. * @param {string} url - The URL of the resource to prefetch.
* @returns {ResourceObject} A resource object. * @returns {ResourceObject} A resource object.
* @example <caption>Prefetch a resource and wait until it has loaded.</caption> * @example <caption>Prefetch a resource and wait until it has loaded.</caption>
* // Replace AnimationCache with ModelCache, SoundCache, or TextureCache as appropriate. * // Replace AnimationCache with MaterialCache, ModelCache, SoundCache, or TextureCache as appropriate.
* // TextureCache has its own version of this function. * // TextureCache has its own version of this function.
* *
* var resourceURL = "https://s3-us-west-1.amazonaws.com/hifi-content/clement/production/animations/sitting_idle.fbx"; * var resourceURL = "https://s3-us-west-1.amazonaws.com/hifi-content/clement/production/animations/sitting_idle.fbx";

2
libraries/procedural/src/procedural/MaterialCacheScriptingInterface.h
View file

@ -24,7 +24,7 @@ class MaterialCacheScriptingInterface : public ScriptableResourceCache, public D
// Properties are copied over from ResourceCache (see ResourceCache.h for reason). // Properties are copied over from ResourceCache (see ResourceCache.h for reason).
/**jsdoc /**jsdoc
* The <code>TextureCache</code> API manages texture cache resources. * The <code>MaterialCache</code> API manages material cache resources.
* *
* @namespace MaterialCache * @namespace MaterialCache
* *

1
tools/jsdoc/plugins/hifi.js
View file

@ -57,6 +57,7 @@ exports.handlers = {
'../../libraries/physics/src', '../../libraries/physics/src',
'../../libraries/platform/src/platform/backend', '../../libraries/platform/src/platform/backend',
'../../libraries/plugins/src/plugins', '../../libraries/plugins/src/plugins',
'../../libraries/procedural/src/procedural',
'../../libraries/pointers/src', '../../libraries/pointers/src',
'../../libraries/render-utils/src', '../../libraries/render-utils/src',
'../../libraries/script-engine/src', '../../libraries/script-engine/src',