Browse Source

Travis CI: API documentation update at 2016-04-19 09:54:00 UTC.
[ci package]

Commit: https://github.com/urho3d/Urho3D/commit/57389d42c2bf87cd1397959da5b9b6fe847c87ac

Message: Minor documentation edit.

urho3d-travis-ci 9 years ago
parent
commit
03f355ca96
4 changed files with 162 additions and 30 deletions
  1. 46 5
      Docs/AngelScriptAPI.h
  2. 68 20
      Docs/LuaScriptAPI.dox
  3. 47 4
      Docs/ScriptAPI.dox
  4. 1 1
      Source/Urho3D/.soversion

+ 46 - 5
Docs/AngelScriptAPI.h

@@ -5055,7 +5055,7 @@ void SendEvent(const String&, VariantMap& = VariantMap ( ));
 bool SetDrawRange(PrimitiveType, uint, uint, bool = true);
 bool SetDrawRange(PrimitiveType, uint, uint, uint, uint, bool = true);
 void SetIndexBuffer(IndexBuffer);
-bool SetVertexBuffer(uint, VertexBuffer, uint = MASK_DEFAULT);
+bool SetVertexBuffer(uint, VertexBuffer);
 
 // Properties:
 /* readonly */
@@ -5082,8 +5082,6 @@ Array<VertexBuffer> vertexBuffers;
 /* readonly */
 uint vertexCount;
 /* readonly */
-Array<uint> vertexElementMasks;
-/* readonly */
 uint vertexStart;
 /* readonly */
 int weakRefs;
@@ -12859,12 +12857,17 @@ uint size;
 class VertexBuffer
 {
 // Methods:
-VectorBuffer GetData();
+VectorBuffer GetData() const;
+uint GetElementOffset(VertexElementSemantic, uint8 = 0) const;
+uint GetElementOffset(VertexElementType, VertexElementSemantic, uint8 = 0) const;
+bool HasElement(VertexElementSemantic, uint8 = 0) const;
+bool HasElement(VertexElementType, VertexElementSemantic, uint8 = 0) const;
 bool HasSubscribedToEvent(Object, const String&);
 bool HasSubscribedToEvent(const String&);
 void SendEvent(const String&, VariantMap& = VariantMap ( ));
 bool SetData(VectorBuffer&);
 bool SetDataRange(VectorBuffer&, uint, uint, bool = false);
+void SetSize(uint, Array<VertexElement>, bool = false);
 void SetSize(uint, uint, bool = false);
 
 // Properties:
@@ -12875,6 +12878,8 @@ bool dynamic;
 /* readonly */
 uint elementMask;
 /* readonly */
+Array<VertexElement> elements;
+/* readonly */
 int refs;
 bool shadowed;
 /* readonly */
@@ -12889,6 +12894,17 @@ uint vertexSize;
 int weakRefs;
 };
 
+class VertexElement
+{
+
+// Properties:
+uint8 index;
+uint offset;
+bool perInstance;
+VertexElementSemantic semantic;
+VertexElementType type;
+};
+
 class View3D
 {
 // Methods:
@@ -14147,6 +14163,32 @@ VAR_DOUBLE,
 VAR_STRINGVECTOR,
 };
 
+enum VertexElementSemantic
+{
+SEM_POSITION,
+SEM_NORMAL,
+SEM_BINORMAL,
+SEM_TANGENT,
+SEM_TEXCOORD,
+SEM_COLOR,
+SEM_BLENDWEIGHTS,
+SEM_BLENDINDICES,
+SEM_OBJECTINDEX,
+MAX_VERTEX_ELEMENT_SEMANTICS,
+};
+
+enum VertexElementType
+{
+TYPE_INT,
+TYPE_FLOAT,
+TYPE_VECTOR2,
+TYPE_VECTOR3,
+TYPE_VECTOR4,
+TYPE_UBYTE4,
+TYPE_UBYTE4_NORM,
+MAX_VERTEX_ELEMENT_TYPES,
+};
+
 enum VerticalAlignment
 {
 VA_TOP,
@@ -14494,7 +14536,6 @@ uint MASK_BLENDWEIGHTS;
 uint MASK_COLOR;
 uint MASK_CUBETEXCOORD1;
 uint MASK_CUBETEXCOORD2;
-uint MASK_DEFAULT;
 uint MASK_INSTANCEMATRIX1;
 uint MASK_INSTANCEMATRIX2;
 uint MASK_INSTANCEMATRIX3;

+ 68 - 20
Docs/LuaScriptAPI.dox

@@ -208,6 +208,7 @@ namespace Urho3D
 <a href="#Class_Vector4"><b>Vector4</b></a>
 <a href="#Class_VectorBuffer"><b>VectorBuffer</b></a>
 <a href="#Class_VertexBuffer"><b>VertexBuffer</b></a>
+<a href="#Class_VertexElement"><b>VertexElement</b></a>
 <a href="#Class_View3D"><b>View3D</b></a>
 <a href="#Class_Viewport"><b>Viewport</b></a>
 <a href="#Class_Window"><b>Window</b></a>
@@ -2453,14 +2454,13 @@ Methods:
 - Geometry* new()
 - void delete()
 - bool SetNumVertexBuffers(unsigned num)
-- bool SetVertexBuffer(unsigned index, VertexBuffer* buffer, unsigned elementMask = MASK_DEFAULT)
+- bool SetVertexBuffer(unsigned index, VertexBuffer* buffer)
 - void SetIndexBuffer(IndexBuffer* buffer)
 - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, bool getUsedVertexRange = true)
 - bool SetDrawRange(PrimitiveType type, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, bool checkIllegal = true)
 - void SetLodDistance(float distance)
 - unsigned GetNumVertexBuffers() const
 - VertexBuffer* GetVertexBuffer(unsigned index) const
-- unsigned GetVertexElementMask(unsigned index) const
 - IndexBuffer* GetIndexBuffer() const
 - PrimitiveType GetPrimitiveType() const
 - unsigned GetIndexStart() const
@@ -6982,6 +6982,7 @@ Methods:
 - VertexBuffer* new()
 - void delete()
 - void SetShadowed(bool enable)
+- bool SetSize(unsigned vertexCount, const PODVector<VertexElement>& elements, bool dynamic = false)
 - bool SetSize(unsigned vertexCount, unsigned elementMask, bool dynamic = false)
 - bool SetData(VectorBuffer& data)
 - bool SetDataRange(VectorBuffer& data, unsigned start, unsigned count, bool discard = false)
@@ -6990,6 +6991,11 @@ Methods:
 - bool IsDynamic() const
 - unsigned GetVertexCount() const
 - unsigned GetVertexSize() const
+- const PODVector<VertexElement>& GetElements() const
+- bool HasElement(VertexElementSemantic semantic, char index = 0) const
+- bool HasElement(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
+- unsigned GetElementOffset(VertexElementSemantic semantic, char index = 0) const
+- unsigned GetElementOffset(VertexElementType type, VertexElementSemantic semantic, char index = 0) const
 - unsigned GetElementMask() const
 
 Properties:
@@ -7000,6 +7006,25 @@ Properties:
 - unsigned vertexSize (readonly)
 - unsigned elementMask (readonly)
 
+<a name="Class_VertexElement"></a>
+### VertexElement
+
+
+Methods:
+
+- VertexElement() (GC)
+- VertexElement* new()
+- VertexElement(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false) (GC)
+- VertexElement* new(VertexElementType type, VertexElementSemantic semantic, char index = 0, bool perInstance = false)
+
+Properties:
+
+- VertexElementType type
+- VertexElementSemantic semantic
+- char index
+- bool perInstance
+- unsigned offset
+
 <a name="Class_View3D"></a>
 ### View3D : Window
 
@@ -7512,6 +7537,24 @@ Properties:
 - int LM_HORIZONTAL
 - int LM_VERTICAL
 
+### LegacyVertexElement
+
+- int ELEMENT_POSITION
+- int ELEMENT_NORMAL
+- int ELEMENT_COLOR
+- int ELEMENT_TEXCOORD1
+- int ELEMENT_TEXCOORD2
+- int ELEMENT_CUBETEXCOORD1
+- int ELEMENT_CUBETEXCOORD2
+- int ELEMENT_TANGENT
+- int ELEMENT_BLENDWEIGHTS
+- int ELEMENT_BLENDINDICES
+- int ELEMENT_INSTANCEMATRIX1
+- int ELEMENT_INSTANCEMATRIX2
+- int ELEMENT_INSTANCEMATRIX3
+- int ELEMENT_OBJECTINDEX
+- int MAX_LEGACY_VERTEX_ELEMENTS
+
 ### LightType
 
 - int LIGHT_DIRECTIONAL
@@ -7757,23 +7800,29 @@ Properties:
 - int VAR_STRINGVECTOR
 - int MAX_VAR_TYPES
 
-### VertexElement
-
-- int ELEMENT_POSITION
-- int ELEMENT_NORMAL
-- int ELEMENT_COLOR
-- int ELEMENT_TEXCOORD1
-- int ELEMENT_TEXCOORD2
-- int ELEMENT_CUBETEXCOORD1
-- int ELEMENT_CUBETEXCOORD2
-- int ELEMENT_TANGENT
-- int ELEMENT_BLENDWEIGHTS
-- int ELEMENT_BLENDINDICES
-- int ELEMENT_INSTANCEMATRIX1
-- int ELEMENT_INSTANCEMATRIX2
-- int ELEMENT_INSTANCEMATRIX3
-- int ELEMENT_OBJECTINDEX
-- int MAX_VERTEX_ELEMENTS
+### VertexElementSemantic
+
+- int SEM_POSITION
+- int SEM_NORMAL
+- int SEM_BINORMAL
+- int SEM_TANGENT
+- int SEM_TEXCOORD
+- int SEM_COLOR
+- int SEM_BLENDWEIGHTS
+- int SEM_BLENDINDICES
+- int SEM_OBJECTINDEX
+- int MAX_VERTEX_ELEMENT_SEMANTICS
+
+### VertexElementType
+
+- int TYPE_INT
+- int TYPE_FLOAT
+- int TYPE_VECTOR2
+- int TYPE_VECTOR3
+- int TYPE_VECTOR4
+- int TYPE_UBYTE4
+- int TYPE_UBYTE4_NORM
+- int MAX_VERTEX_ELEMENT_TYPES
 
 ### VerticalAlignment
 
@@ -8126,7 +8175,6 @@ Properties:
 - unsigned MASK_COLOR
 - unsigned MASK_CUBETEXCOORD1
 - unsigned MASK_CUBETEXCOORD2
-- unsigned MASK_DEFAULT
 - unsigned MASK_INSTANCEMATRIX1
 - unsigned MASK_INSTANCEMATRIX2
 - unsigned MASK_INSTANCEMATRIX3

+ 47 - 4
Docs/ScriptAPI.dox

@@ -2461,6 +2461,7 @@ namespace Urho3D
 <a href="#Class_Vector4"><b>Vector4</b></a>
 <a href="#Class_VectorBuffer"><b>VectorBuffer</b></a>
 <a href="#Class_VertexBuffer"><b>VertexBuffer</b></a>
+<a href="#Class_VertexElement"><b>VertexElement</b></a>
 <a href="#Class_View3D"><b>View3D</b></a>
 <a href="#Class_Viewport"><b>Viewport</b></a>
 <a href="#Class_WeakHandle"><b>WeakHandle</b></a>
@@ -6928,7 +6929,7 @@ Methods:
 - bool SetDrawRange(PrimitiveType, uint, uint, bool = true)
 - bool SetDrawRange(PrimitiveType, uint, uint, uint, uint, bool = true)
 - void SetIndexBuffer(IndexBuffer@)
-- bool SetVertexBuffer(uint, VertexBuffer@, uint = MASK_DEFAULT)
+- bool SetVertexBuffer(uint, VertexBuffer@)
 
 Properties:
 
@@ -6945,7 +6946,6 @@ Properties:
 - String typeName // readonly
 - VertexBuffer@[] vertexBuffers // readonly
 - uint vertexCount // readonly
-- uint[] vertexElementMasks // readonly
 - uint vertexStart // readonly
 - int weakRefs // readonly
 
@@ -13782,12 +13782,17 @@ Properties:
 
 Methods:
 
-- VectorBuffer GetData()
+- VectorBuffer GetData() const
+- uint GetElementOffset(VertexElementSemantic, uint8 = 0) const
+- uint GetElementOffset(VertexElementType, VertexElementSemantic, uint8 = 0) const
+- bool HasElement(VertexElementSemantic, uint8 = 0) const
+- bool HasElement(VertexElementType, VertexElementSemantic, uint8 = 0) const
 - bool HasSubscribedToEvent(Object@, const String&)
 - bool HasSubscribedToEvent(const String&)
 - void SendEvent(const String&, VariantMap& = VariantMap ( ))
 - bool SetData(VectorBuffer&)
 - bool SetDataRange(VectorBuffer&, uint, uint, bool = false)
+- void SetSize(uint, VertexElement[]@, bool = false)
 - void SetSize(uint, uint, bool = false)
 
 Properties:
@@ -13795,6 +13800,7 @@ Properties:
 - String category // readonly
 - bool dynamic // readonly
 - uint elementMask // readonly
+- VertexElement[]@ elements // readonly
 - int refs // readonly
 - bool shadowed
 - StringHash type // readonly
@@ -13803,6 +13809,18 @@ Properties:
 - uint vertexSize // readonly
 - int weakRefs // readonly
 
+<a name="Class_VertexElement"></a>
+
+### VertexElement
+
+Properties:
+
+- uint8 index
+- uint offset
+- bool perInstance
+- VertexElementSemantic semantic
+- VertexElementType type
+
 <a name="Class_View3D"></a>
 
 ### View3D
@@ -14981,6 +14999,32 @@ Properties:
 - VAR_STRINGVECTOR
 
 
+### VertexElementSemantic
+
+- SEM_POSITION
+- SEM_NORMAL
+- SEM_BINORMAL
+- SEM_TANGENT
+- SEM_TEXCOORD
+- SEM_COLOR
+- SEM_BLENDWEIGHTS
+- SEM_BLENDINDICES
+- SEM_OBJECTINDEX
+- MAX_VERTEX_ELEMENT_SEMANTICS
+
+
+### VertexElementType
+
+- TYPE_INT
+- TYPE_FLOAT
+- TYPE_VECTOR2
+- TYPE_VECTOR3
+- TYPE_VECTOR4
+- TYPE_UBYTE4
+- TYPE_UBYTE4_NORM
+- MAX_VERTEX_ELEMENT_TYPES
+
+
 ### VerticalAlignment
 
 - VA_TOP
@@ -15325,7 +15369,6 @@ Properties:
 - uint MASK_COLOR
 - uint MASK_CUBETEXCOORD1
 - uint MASK_CUBETEXCOORD2
-- uint MASK_DEFAULT
 - uint MASK_INSTANCEMATRIX1
 - uint MASK_INSTANCEMATRIX2
 - uint MASK_INSTANCEMATRIX3

+ 1 - 1
Source/Urho3D/.soversion

@@ -1 +1 @@
-0.0.212
+0.0.213