@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.0/bit_doc.json

@@ -0,0 +1,404 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "bit.tobit",
+      "brief": "normalize number to the numeric range for bit operations",
+      "description": "Normalizes a number to the numeric range for bit operations and returns it. This function is usually not needed since all bit operations already normalize all of their input arguments.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "normalized number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number to normalize",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span><span class=\"p\">)</span>                <span class=\"c1\">--&gt; 4294967295 (*)</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tobit</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span><span class=\"p\">))</span>     <span class=\"c1\">--&gt; -1</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tobit</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span><span class=\"p\">))</span>    <span class=\"c1\">--&gt; 0xffffffff</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tobit</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span> <span class=\"o\">+</span> <span class=\"mi\">1</span><span class=\"p\">))</span> <span class=\"c1\">--&gt; 0</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tobit</span><span class=\"p\">(</span><span class=\"mi\">2</span><span class=\"o\">^</span><span class=\"mi\">40</span> <span class=\"o\">+</span> <span class=\"mi\">1234</span><span class=\"p\">))</span>    <span class=\"c1\">--&gt; 1234</span>\n</code></pre></div>\n\n(*) See the treatment of hex literals for an explanation why the printed numbers in the first two lines differ (if your Lua installation uses a double number type).",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.tohex",
+      "brief": "convert number to a hex string",
+      "description": "Converts its first argument to a hex string. The number of hex digits is given by the absolute value of the optional second argument. Positive numbers between 1 and 8 generate lowercase hex digits. Negative numbers generate uppercase hex digits. Only the least-significant 4*|n| bits are used. The default is to generate 8 lowercase hex digits.",
+      "returnvalues": [
+        {
+          "name": "s",
+          "doc": "hexadecimal string",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number to convert",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of hex digits to return",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">))</span>              <span class=\"c1\">--&gt; 00000001</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"o\">-</span><span class=\"mi\">1</span><span class=\"p\">))</span>             <span class=\"c1\">--&gt; ffffffff</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span><span class=\"p\">))</span>     <span class=\"c1\">--&gt; ffffffff</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"o\">-</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"o\">-</span><span class=\"mi\">8</span><span class=\"p\">))</span>         <span class=\"c1\">--&gt; FFFFFFFF</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"mh\">0x21</span><span class=\"p\">,</span> <span class=\"mi\">4</span><span class=\"p\">))</span>        <span class=\"c1\">--&gt; 0021</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">tohex</span><span class=\"p\">(</span><span class=\"mh\">0x87654321</span><span class=\"p\">,</span> <span class=\"mi\">4</span><span class=\"p\">))</span>  <span class=\"c1\">--&gt; 4321</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.bnot",
+      "brief": "bitwise not",
+      "description": "Returns the bitwise not of its argument.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise not of number x",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bnot</span><span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">))</span>            <span class=\"c1\">--&gt; -1</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bnot</span><span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">))</span>           <span class=\"c1\">--&gt; 0xffffffff</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bnot</span><span class=\"p\">(</span><span class=\"o\">-</span><span class=\"mi\">1</span><span class=\"p\">))</span>           <span class=\"c1\">--&gt; 0</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bnot</span><span class=\"p\">(</span><span class=\"mh\">0xffffffff</span><span class=\"p\">))</span>   <span class=\"c1\">--&gt; 0</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bnot</span><span class=\"p\">(</span><span class=\"mh\">0x12345678</span><span class=\"p\">))</span>  <span class=\"c1\">--&gt; 0xedcba987</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.bor",
+      "brief": "bitwise or",
+      "description": "Returns the bitwise or of all of its arguments. Note that more than two arguments are allowed.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise or of the provided arguments",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x1",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x2...",
+          "doc": "number(s)",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bor</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">2</span><span class=\"p\">,</span> <span class=\"mi\">4</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>                <span class=\"c1\">--&gt; 15</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.band",
+      "brief": "bitwise and",
+      "description": "Returns the bitwise and of all of its arguments. Note that more than two arguments are allowed.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise and of the provided arguments",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x1",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x2...",
+          "doc": "number(s)",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">band</span><span class=\"p\">(</span><span class=\"mh\">0x12345678</span><span class=\"p\">,</span> <span class=\"mh\">0xff</span><span class=\"p\">))</span>        <span class=\"c1\">--&gt; 0x00000078</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.bxor",
+      "brief": "bitwise xor",
+      "description": "Returns the bitwise xor of all of its arguments. Note that more than two arguments are allowed.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise xor of the provided arguments",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x1",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x2...",
+          "doc": "number(s)",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bxor</span><span class=\"p\">(</span><span class=\"mh\">0xa5a5f0f0</span><span class=\"p\">,</span> <span class=\"mh\">0xaa55ff00</span><span class=\"p\">))</span>  <span class=\"c1\">--&gt; 0x0ff00ff0</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.lshift",
+      "brief": "bitwise logical left-shift",
+      "description": "Returns the bitwise logical left-shift of its first argument by the number of bits given by the second argument.\nLogical shifts treat the first argument as an unsigned number and shift in 0-bits.\nOnly the lower 5 bits of the shift count are used (reduces to the range [0..31]).",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise logical left-shifted number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of bits",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">lshift</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">))</span>              <span class=\"c1\">--&gt; 1</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">lshift</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>              <span class=\"c1\">--&gt; 256</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">lshift</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">40</span><span class=\"p\">))</span>             <span class=\"c1\">--&gt; 256</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">lshift</span><span class=\"p\">(</span><span class=\"mh\">0x87654321</span><span class=\"p\">,</span> <span class=\"mi\">12</span><span class=\"p\">))</span>   <span class=\"c1\">--&gt; 0x54321000</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.rshift",
+      "brief": "bitwise logical right-shift",
+      "description": "Returns the bitwise logical right-shift of its first argument by the number of bits given by the second argument.\nLogical shifts treat the first argument as an unsigned number and shift in 0-bits.\nOnly the lower 5 bits of the shift count are used (reduces to the range [0..31]).",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise logical right-shifted number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of bits",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">rshift</span><span class=\"p\">(</span><span class=\"mi\">256</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>            <span class=\"c1\">--&gt; 1</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">rshift</span><span class=\"p\">(</span><span class=\"o\">-</span><span class=\"mi\">256</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>           <span class=\"c1\">--&gt; 16777215</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">rshift</span><span class=\"p\">(</span><span class=\"mh\">0x87654321</span><span class=\"p\">,</span> <span class=\"mi\">12</span><span class=\"p\">))</span>   <span class=\"c1\">--&gt; 0x00087654</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.arshift",
+      "brief": "bitwise arithmetic right-shift",
+      "description": "Returns the bitwise arithmetic right-shift of its first argument by the number of bits given by the second argument.\nArithmetic right-shift treats the most-significant bit as a sign bit and replicates it.\nOnly the lower 5 bits of the shift count are used (reduces to the range [0..31]).",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise arithmetic right-shifted number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of bits",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">arshift</span><span class=\"p\">(</span><span class=\"mi\">256</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>           <span class=\"c1\">--&gt; 1</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">arshift</span><span class=\"p\">(</span><span class=\"o\">-</span><span class=\"mi\">256</span><span class=\"p\">,</span> <span class=\"mi\">8</span><span class=\"p\">))</span>          <span class=\"c1\">--&gt; -1</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">arshift</span><span class=\"p\">(</span><span class=\"mh\">0x87654321</span><span class=\"p\">,</span> <span class=\"mi\">12</span><span class=\"p\">))</span>  <span class=\"c1\">--&gt; 0xfff87654</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.rol",
+      "brief": "bitwise left rotation",
+      "description": "Returns the bitwise left rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back in on the other side.\nOnly the lower 5 bits of the rotate count are used (reduces to the range [0..31]).",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise left-rotated number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of bits",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">rol</span><span class=\"p\">(</span><span class=\"mh\">0x12345678</span><span class=\"p\">,</span> <span class=\"mi\">12</span><span class=\"p\">))</span>   <span class=\"c1\">--&gt; 0x45678123</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.ror",
+      "brief": "bitwise right rotation",
+      "description": "Returns the bitwise right rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back in on the other side.\nOnly the lower 5 bits of the rotate count are used (reduces to the range [0..31]).",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise right-rotated number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "n",
+          "doc": "number of bits",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">ror</span><span class=\"p\">(</span><span class=\"mh\">0x12345678</span><span class=\"p\">,</span> <span class=\"mi\">12</span><span class=\"p\">))</span>   <span class=\"c1\">--&gt; 0x67812345</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "bit.bswap",
+      "brief": "bitwise swap",
+      "description": "Swaps the bytes of its argument and returns it. This can be used to convert little-endian 32 bit numbers to big-endian 32 bit numbers or vice versa.",
+      "returnvalues": [
+        {
+          "name": "y",
+          "doc": "bitwise swapped number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "x",
+          "doc": "number",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bswap</span><span class=\"p\">(</span><span class=\"mh\">0x12345678</span><span class=\"p\">))</span> <span class=\"c1\">--&gt; 0x78563412</span>\n<span class=\"n\">printx</span><span class=\"p\">(</span><span class=\"n\">bit</span><span class=\"p\">.</span><span class=\"n\">bswap</span><span class=\"p\">(</span><span class=\"mh\">0x78563412</span><span class=\"p\">))</span> <span class=\"c1\">--&gt; 0x12345678</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "bit",
+    "name": "BitOp",
+    "brief": "Bitwise operations API documentation",
+    "description": "[Lua BitOp](http://bitop.luajit.org/api.html) is a C extension module for Lua 5.1/5.2 which adds bitwise operations on numbers.\n\nLua BitOp is Copyright &copy; 2008-2012 Mike Pall.\nLua BitOp is free software, released under the MIT license (same license as the Lua core).\n\nLua BitOp is compatible with the built-in bitwise operations in LuaJIT 2.0 and is used\non platforms where Defold runs without LuaJIT.\n\nFor clarity the examples assume the definition of a helper function `printx()`.\nThis prints its argument as an unsigned 32 bit hexadecimal number on all platforms:\n\n```lua\nfunction printx(x)\n  print(\"0x\"..bit.tohex(x))\nend\n```",
+    "path": "engine/script/src/script_bitop.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}