Browse Source

Add a few more viewport notes;

bjorn 1 year ago
parent
commit
9ffe2efbe0
2 changed files with 6 additions and 6 deletions
  1. 3 3
      api/init.lua
  2. 3 3
      api/lovr/graphics/Pass/setViewport.lua

+ 3 - 3
api/init.lua

@@ -20450,7 +20450,7 @@ return {
                     {
                       name = "w",
                       type = "number",
-                      description = "The width of the viewport."
+                      description = "The width of the viewport.  Must be positive."
                     },
                     {
                       name = "h",
@@ -20460,13 +20460,13 @@ return {
                     {
                       name = "dmin",
                       type = "number",
-                      description = "The min component of the depth range.",
+                      description = "The min component of the depth range, between 0 and 1.",
                       default = "0.0"
                     },
                     {
                       name = "dmax",
                       type = "number",
-                      description = "The max component of the depth range.",
+                      description = "The max component of the depth range, between 0 and 1.",
                       default = "1.0"
                     }
                   },

+ 3 - 3
api/lovr/graphics/Pass/setViewport.lua

@@ -17,7 +17,7 @@ return {
     },
     w = {
       type = 'number',
-      description = 'The width of the viewport.',
+      description = 'The width of the viewport.  Must be positive.',
     },
     h = {
       type = 'number',
@@ -26,12 +26,12 @@ return {
     dmin = {
       type = 'number',
       default = '0.0',
-      description = 'The min component of the depth range.'
+      description = 'The min component of the depth range, between 0 and 1.'
     },
     dmax = {
       type = 'number',
       default = '1.0',
-      description = 'The max component of the depth range.'
+      description = 'The max component of the depth range, between 0 and 1.'
     }
   },
   returns = {},