Browse Source

Update Shader:send table;

bjorn 5 years ago
parent
commit
af11b5dcbb
2 changed files with 31 additions and 23 deletions
  1. 1 1
      api/init.lua
  2. 30 22
      api/lovr/graphics/Shader/send.lua

+ 1 - 1
api/init.lua

@@ -11931,7 +11931,7 @@ return {
                 "ShaderBlock:sendBlock",
                 "Shader:sendBlock"
               },
-              notes = "The shader does not need to be active to update its uniforms.\n\nThe following type combinations are supported:\n\n<table>\n  <thead>\n    <tr>\n      <td>Uniform type</td>\n      <td>LÖVR type</td>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td><code>float</code></td>\n      <td><code>number</code></td>\n    </tr>\n    <tr>\n      <td><code>int</code></td>\n      <td><code>number</code></td>\n    </tr>\n    <tr>\n      <td><code>vec2</code></td>\n      <td><code>{ x, y }</code></td>\n    </tr>\n    <tr>\n      <td><code>vec3</code></td>\n      <td><code>{ x, y, z }</code> or <code>vec3</code></td>\n    </tr>\n    <tr>\n      <td><code>vec4</code></td>\n      <td><code>{ x, y, z, w }</code></td>\n    </tr>\n    <tr>\n      <td><code>ivec2</code></td>\n      <td><code>{ x, y }</code></td>\n    </tr>\n    <tr>\n      <td><code>mat2</code></td>\n      <td>{ x, y, ... }</td>\n    </tr>\n    <tr>\n      <td><code>mat3</code></td>\n      <td><code>{ x, y, z, ... }</code></td>\n    </tr>\n    <tr>\n      <td><code>mat4</code></td>\n      <td><code>{ x, y, z, w, ... }</code> or <code>mat4</code></td>\n    </tr>\n    <tr>\n      <td><code>sampler</code></td>\n      <td><code>Texture</code></td>\n    </tr>\n    <tr>\n      <td><code>image</code></td>\n      <td><code>Texture</code></td>\n    </tr>\n  </tbody> </table>\n\nUniform arrays can be wrapped in tables or passed as multiple arguments.\n\nTextures must match the type of sampler or image they are being sent to.\n\nThe following sampler (and image) types are currently supported:\n\n- `sampler2D`\n- `sampler3D`\n- `samplerCube`\n- `sampler2DArray`\n\nAn error is thrown if the uniform does not exist or is not used in the shader.  The `Shader:hasUniform` function can be used to check if a uniform variable exists.\n\n`Blob`s can be used to pass arbitrary binary data to Shader variables.",
+              notes = "The shader does not need to be active to update its uniforms.\n\nThe following type combinations are supported:\n\n<table>\n  <thead>\n    <tr>\n      <td>Uniform type</td>\n      <td>LÖVR type</td>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>float</td>\n      <td>number</td>\n    </tr>\n    <tr>\n      <td>int</td>\n      <td>number</td>\n    </tr>\n    <tr>\n      <td>vec2</td>\n      <td>{ x, y }</td>\n    </tr>\n    <tr>\n      <td>vec3</td>\n      <td>{ x, y, z } or vec3</td>\n    </tr>\n    <tr>\n      <td>vec4</td>\n      <td>{ x, y, z, w }</td>\n    </tr>\n    <tr>\n      <td>ivec2</td>\n      <td>{ x, y }</td>\n    </tr>\n    <tr>\n      <td>ivec3</td>\n      <td>{ x, y, z }</td>\n    </tr>\n    <tr>\n      <td>ivec4</td>\n      <td>{ x, y, z, w }</td>\n    </tr>\n    <tr>\n      <td>mat2</td>\n      <td>{ x, ... }</td>\n    </tr>\n    <tr>\n      <td>mat3</td>\n      <td>{ x, ... }</td>\n    </tr>\n    <tr>\n      <td>mat4</td>\n      <td>{ x, ... } or mat4</td>\n    </tr>\n    <tr>\n      <td>sampler</td>\n      <td>Texture</td>\n    </tr>\n    <tr>\n      <td>image</td>\n      <td>Texture</td>\n    </tr>\n  </tbody> </table>\n\nUniform arrays can be wrapped in tables or passed as multiple arguments.\n\nTextures must match the type of sampler or image they are being sent to.\n\nThe following sampler (and image) types are currently supported:\n\n- `sampler2D`\n- `sampler3D`\n- `samplerCube`\n- `sampler2DArray`\n\nAn error is thrown if the uniform does not exist or is not used in the shader.  The `Shader:hasUniform` function can be used to check if a uniform variable exists.\n\n`Blob`s can be used to pass arbitrary binary data to Shader variables.",
               variants = {
                 {
                   arguments = {

+ 30 - 22
api/lovr/graphics/Shader/send.lua

@@ -28,48 +28,56 @@ return {
       </thead>
       <tbody>
         <tr>
-          <td><code>float</code></td>
-          <td><code>number</code></td>
+          <td>float</td>
+          <td>number</td>
         </tr>
         <tr>
-          <td><code>int</code></td>
-          <td><code>number</code></td>
+          <td>int</td>
+          <td>number</td>
         </tr>
         <tr>
-          <td><code>vec2</code></td>
-          <td><code>{ x, y }</code></td>
+          <td>vec2</td>
+          <td>{ x, y }</td>
         </tr>
         <tr>
-          <td><code>vec3</code></td>
-          <td><code>{ x, y, z }</code> or <code>vec3</code></td>
+          <td>vec3</td>
+          <td>{ x, y, z } or vec3</td>
         </tr>
         <tr>
-          <td><code>vec4</code></td>
-          <td><code>{ x, y, z, w }</code></td>
+          <td>vec4</td>
+          <td>{ x, y, z, w }</td>
         </tr>
         <tr>
-          <td><code>ivec2</code></td>
-          <td><code>{ x, y }</code></td>
+          <td>ivec2</td>
+          <td>{ x, y }</td>
         </tr>
         <tr>
-          <td><code>mat2</code></td>
-          <td>{ x, y, ... }</td>
+          <td>ivec3</td>
+          <td>{ x, y, z }</td>
         </tr>
         <tr>
-          <td><code>mat3</code></td>
-          <td><code>{ x, y, z, ... }</code></td>
+          <td>ivec4</td>
+          <td>{ x, y, z, w }</td>
         </tr>
         <tr>
-          <td><code>mat4</code></td>
-          <td><code>{ x, y, z, w, ... }</code> or <code>mat4</code></td>
+          <td>mat2</td>
+          <td>{ x, ... }</td>
         </tr>
         <tr>
-          <td><code>sampler</code></td>
-          <td><code>Texture</code></td>
+          <td>mat3</td>
+          <td>{ x, ... }</td>
         </tr>
         <tr>
-          <td><code>image</code></td>
-          <td><code>Texture</code></td>
+          <td>mat4</td>
+          <td>{ x, ... } or mat4</td>
+        </tr>
+        <tr>
+          <td>sampler</td>
+          <td>Texture</td>
+        </tr>
+        <tr>
+          <td>image</td>
+          <td>Texture</td>
         </tr>
       </tbody>
     </table>