Преглед изворни кода

Travis CI: API documentation update at 2014-07-25 14:57:16 UTC.
[ci package]

urho3d-travis-ci пре 11 година
родитељ
комит
1b36be0115
3 измењених фајлова са 69 додато и 19 уклоњено
  1. 19 5
      Docs/AngelScriptAPI.h
  2. 26 9
      Docs/LuaScriptAPI.dox
  3. 24 5
      Docs/ScriptAPI.dox

+ 19 - 5
Docs/AngelScriptAPI.h

@@ -7020,6 +7020,7 @@ class ResourceCache
 bool AddManualResource(Resource);
 void AddPackageFile(PackageFile, uint = M_MAX_UNSIGNED);
 bool AddResourceDir(const String&, uint = M_MAX_UNSIGNED);
+bool BackgroundLoadResource(const String&, const String&, bool = true);
 bool Exists(const String&) const;
 File GetFile(const String&);
 String GetPreferredResourceDir(const String&) const;
@@ -7045,10 +7046,13 @@ bool autoReloadResources;
 StringHash baseType;
 /* readonly */
 String category;
+int finishBackgroundResourcesMs;
 Array<uint> memoryBudget;
 /* readonly */
 Array<uint> memoryUse;
 /* readonly */
+uint numBackgroundLoadResources;
+/* readonly */
 Array<PackageFile> packageFiles;
 /* readonly */
 int refs;
@@ -7309,8 +7313,8 @@ Node InstantiateXML(XMLFile, const Vector3&, const Quaternion&, CreateMode = REP
 Node InstantiateXML(const XMLElement&, const Vector3&, const Quaternion&, CreateMode = REPLICATED);
 bool Load(File, bool = false);
 bool Load(VectorBuffer&, bool = false);
-bool LoadAsync(File);
-bool LoadAsyncXML(File);
+bool LoadAsync(File, LoadMode = LOAD_SCENE_AND_RESOURCES);
+bool LoadAsyncXML(File, LoadMode = LOAD_SCENE_AND_RESOURCES);
 bool LoadXML(File);
 bool LoadXML(VectorBuffer&);
 bool LoadXML(const XMLElement&, bool = false);
@@ -7379,7 +7383,10 @@ void Yaw(float, TransformSpace = TS_LOCAL);
 // Properties:
 bool animationEnabled;
 /* readonly */
+LoadMode asyncLoadMode;
+/* readonly */
 bool asyncLoading;
+int asyncLoadingMs;
 /* readonly */
 float asyncProgress;
 /* readonly */
@@ -9846,11 +9853,11 @@ class Texture2D
 // Methods:
 void ClearDataLost();
 bool Load(File);
-bool Load(Image, bool = false);
 bool Load(VectorBuffer&);
 bool Save(File) const;
 bool Save(VectorBuffer&) const;
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetData(Image, bool = false);
 void SetNumLevels(uint);
 bool SetSize(int, int, uint, TextureUsage = TEXTURE_STATIC);
 
@@ -9905,11 +9912,11 @@ class Texture3D
 // Methods:
 void ClearDataLost();
 bool Load(File);
-bool Load(Image, bool = false);
 bool Load(VectorBuffer&);
 bool Save(File) const;
 bool Save(VectorBuffer&) const;
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetData(Image, bool = false);
 void SetNumLevels(uint);
 bool SetSize(int, int, uint, TextureUsage = TEXTURE_STATIC);
 
@@ -9963,12 +9970,12 @@ class TextureCube
 {
 // Methods:
 void ClearDataLost();
-bool Load(CubeMapFace, Image, bool = false);
 bool Load(File);
 bool Load(VectorBuffer&);
 bool Save(File) const;
 bool Save(VectorBuffer&) const;
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
+bool SetData(CubeMapFace, Image, bool = false);
 void SetNumLevels(uint);
 bool SetSize(int, uint, TextureUsage = TEXTURE_STATIC);
 
@@ -11542,6 +11549,13 @@ LIGHT_SPOT,
 LIGHT_POINT,
 };
 
+enum LoadMode
+{
+LOAD_RESOURCES_ONLY,
+LOAD_SCENE,
+LOAD_SCENE_AND_RESOURCES,
+};
+
 enum LoopMode2D
 {
 LM_DEFAULT,

+ 26 - 9
Docs/LuaScriptAPI.dox

@@ -3982,8 +3982,11 @@ Methods:
 - void SetAutoReloadResources(bool enable)
 - void SetReturnFailedResources(bool enable)
 - void SetSearchPackagesFirst(bool value)
+- void SetFinishBackgroundResourcesMs(int ms)
 - File* GetFile(const String name)
-- Resource* GetResource(const String type, const String name, bool SendEventOnFailure = true)
+- Resource* GetResource(const String type, const String name, bool sendEventOnFailure = true)
+- bool BackgroundLoadResource(const String type, const String name, bool sendEventOnFailure = true)
+- unsigned GetNumBackgroundLoadResources() const
 - bool Exists(const String name) const
 - unsigned GetMemoryBudget(StringHash type) const
 - unsigned GetMemoryUse(StringHash type) const
@@ -3992,6 +3995,7 @@ Methods:
 - bool GetAutoReloadResources() const
 - bool GetReturnFailedResources() const
 - bool GetSearchPackagesFirst() const
+- int GetFinishBackgroundResourcesMs() const
 - String GetPreferredResourceDir(const String path) const
 - String SanitateResourceName(const String name) const
 - String SanitateResourceDirName(const String name) const
@@ -3999,9 +4003,11 @@ Methods:
 Properties:
 
 - unsigned totalMemoryUse (readonly)
-- bool autoReloadResources (readonly)
-- bool returnFailedResources (readonly)
-- bool searchPackagesFirst (readonly)
+- bool autoReloadResources
+- bool returnFailedResources
+- bool searchPackagesFirst
+- unsigned numBackgroundLoadResources (readonly)
+- int finishBackgroundResourcesMs
 
 ### ResourceRef
 
@@ -4215,10 +4221,10 @@ Methods:
 - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
 - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
 - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
-- bool LoadAsync(File* file)
-- bool LoadAsyncXML(File* file)
-- bool LoadAsync(const String fileName)
-- bool LoadAsyncXML(const String fileName)
+- bool LoadAsync(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
+- bool LoadAsyncXML(File* file, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
+- bool LoadAsync(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
+- bool LoadAsyncXML(const String fileName, LoadMode mode = LOAD_SCENE_AND_RESOURCES)
 - void StopAsyncLoading()
 - void Clear(bool clearReplicated = true, bool clearLocal = true)
 - void SetUpdateEnabled(bool enable)
@@ -4226,16 +4232,19 @@ Methods:
 - void SetElapsedTime(float time)
 - void SetSmoothingConstant(float constant)
 - void SetSnapThreshold(float threshold)
+- void SetAsyncLoadingMs(int ms)
 - Node* GetNode(unsigned id) const
 - bool IsUpdateEnabled() const
 - bool IsAsyncLoading() const
 - float GetAsyncProgress() const
+- LoadMode GetAsyncLoadMode() const
 - const String GetFileName() const
 - unsigned GetChecksum() const
 - float GetTimeScale() const
 - float GetElapsedTime() const
 - float GetSmoothingConstant() const
 - float GetSnapThreshold() const
+- int GetAsyncLoadingMs() const
 - const String GetVarName(StringHash hash) const
 - void Update(float timeStep)
 - void BeginThreadedUpdate()
@@ -4261,12 +4270,14 @@ Properties:
 - bool updateEnabled
 - bool asyncLoading (readonly)
 - float asyncProgress (readonly)
+- LoadMode asyncLoadMode (readonly)
 - const String fileName
 - unsigned checksum (readonly)
 - float timeScale
 - float elapsedTime
 - float smoothingConstant
 - float snapThreshold
+- int asyncLoadingMs
 - bool threadedUpdate (readonly)
 - String varNamesAttr
 
@@ -5087,7 +5098,7 @@ Methods:
 - Texture2D* new()
 - void delete()
 - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
-- bool Load(Image* image, bool useAlpha = false)
+- bool SetData(Image* image, bool useAlpha = false)
 - RenderSurface* GetRenderSurface() const
 
 Properties:
@@ -6319,6 +6330,12 @@ Properties:
 - int LIGHT_SPOT
 - int LIGHT_POINT
 
+### LoadMode
+
+- int LOAD_RESOURCES_ONLY
+- int LOAD_SCENE
+- int LOAD_SCENE_AND_RESOURCES
+
 ### LockState
 
 - int LOCK_NONE

+ 24 - 5
Docs/ScriptAPI.dox

@@ -329,6 +329,11 @@ namespace Urho3D
 ### UnknownResourceType
 - %ResourceType : StringHash
 
+### ResourceBackgroundLoaded
+- %ResourceName : String
+- %Success : bool
+- %Resource : Resource pointer
+
 ## %Scene events
 
 ### SceneUpdate
@@ -364,6 +369,8 @@ namespace Urho3D
 - %Progress : float
 - %LoadedNodes : int
 - %TotalNodes : int
+- %LoadedResources : int
+- %TotalResources : int
 
 ### AsyncLoadFinished
 - %Scene : Scene pointer
@@ -7915,6 +7922,7 @@ Methods:
 - bool AddManualResource(Resource@)
 - void AddPackageFile(PackageFile@, uint = M_MAX_UNSIGNED)
 - bool AddResourceDir(const String&, uint = M_MAX_UNSIGNED)
+- bool BackgroundLoadResource(const String&, const String&, bool = true)
 - bool Exists(const String&) const
 - File@ GetFile(const String&)
 - String GetPreferredResourceDir(const String&) const
@@ -7939,8 +7947,10 @@ Properties:
 - bool autoReloadResources
 - StringHash baseType // readonly
 - String category // readonly
+- int finishBackgroundResourcesMs
 - uint[] memoryBudget
 - uint[] memoryUse // readonly
+- uint numBackgroundLoadResources // readonly
 - PackageFile@[]@ packageFiles // readonly
 - int refs // readonly
 - String[]@ resourceDirs // readonly
@@ -8171,8 +8181,8 @@ Methods:
 - Node@ InstantiateXML(const XMLElement&, const Vector3&, const Quaternion&, CreateMode = REPLICATED)
 - bool Load(File@, bool = false)
 - bool Load(VectorBuffer&, bool = false)
-- bool LoadAsync(File@)
-- bool LoadAsyncXML(File@)
+- bool LoadAsync(File@, LoadMode = LOAD_SCENE_AND_RESOURCES)
+- bool LoadAsyncXML(File@, LoadMode = LOAD_SCENE_AND_RESOURCES)
 - bool LoadXML(File@)
 - bool LoadXML(VectorBuffer&)
 - bool LoadXML(const XMLElement&, bool = false)
@@ -8241,7 +8251,9 @@ Methods:
 Properties:
 
 - bool animationEnabled
+- LoadMode asyncLoadMode // readonly
 - bool asyncLoading // readonly
+- int asyncLoadingMs
 - float asyncProgress // readonly
 - Variant[] attributeDefaults // readonly
 - AttributeInfo[] attributeInfos // readonly
@@ -10310,11 +10322,11 @@ Methods:
 
 - void ClearDataLost()
 - bool Load(File@)
-- bool Load(Image@, bool = false)
 - bool Load(VectorBuffer&)
 - bool Save(File@) const
 - bool Save(VectorBuffer&) const
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetData(Image@, bool = false)
 - void SetNumLevels(uint)
 - bool SetSize(int, int, uint, TextureUsage = TEXTURE_STATIC)
 
@@ -10353,11 +10365,11 @@ Methods:
 
 - void ClearDataLost()
 - bool Load(File@)
-- bool Load(Image@, bool = false)
 - bool Load(VectorBuffer&)
 - bool Save(File@) const
 - bool Save(VectorBuffer&) const
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetData(Image@, bool = false)
 - void SetNumLevels(uint)
 - bool SetSize(int, int, uint, TextureUsage = TEXTURE_STATIC)
 
@@ -10395,12 +10407,12 @@ Properties:
 Methods:
 
 - void ClearDataLost()
-- bool Load(CubeMapFace, Image@, bool = false)
 - bool Load(File@)
 - bool Load(VectorBuffer&)
 - bool Save(File@) const
 - bool Save(VectorBuffer&) const
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
+- bool SetData(CubeMapFace, Image@, bool = false)
 - void SetNumLevels(uint)
 - bool SetSize(int, uint, TextureUsage = TEXTURE_STATIC)
 
@@ -11796,6 +11808,13 @@ Properties:
 - LIGHT_POINT
 
 
+### LoadMode
+
+- LOAD_RESOURCES_ONLY
+- LOAD_SCENE
+- LOAD_SCENE_AND_RESOURCES
+
+
 ### LoopMode2D
 
 - LM_DEFAULT