Browse Source

Add note about stencil test default;

bjorn 6 years ago
parent
commit
47214173d2
3 changed files with 12 additions and 4 deletions
  1. 2 2
      api/init.lua
  2. 5 1
      api/lovr/graphics/getStencilTest.lua
  3. 5 1
      api/lovr/graphics/setStencilTest.lua

+ 2 - 2
api/init.lua

@@ -6937,7 +6937,7 @@ return {
           related = {
           related = {
             "lovr.graphics.stencil"
             "lovr.graphics.stencil"
           },
           },
-          notes = "Stencil values are between 0 and 255."
+          notes = "Stencil values are between 0 and 255.\n\nBy default, the stencil test is disabled."
         },
         },
         {
         {
           name = "getWidth",
           name = "getWidth",
@@ -9009,7 +9009,7 @@ return {
           description = "Sets the stencil test.  The stencil test lets you mask out pixels that meet certain criteria, based on the contents of the stencil buffer.  The stencil buffer can be modified using `lovr.graphics.stencil`.  After rendering to the stencil buffer, the stencil test can be set to control how subsequent drawing functions are masked by the stencil buffer.",
           description = "Sets the stencil test.  The stencil test lets you mask out pixels that meet certain criteria, based on the contents of the stencil buffer.  The stencil buffer can be modified using `lovr.graphics.stencil`.  After rendering to the stencil buffer, the stencil test can be set to control how subsequent drawing functions are masked by the stencil buffer.",
           key = "lovr.graphics.setStencilTest",
           key = "lovr.graphics.setStencilTest",
           module = "lovr.graphics",
           module = "lovr.graphics",
-          notes = "Stencil values are between 0 and 255.",
+          notes = "Stencil values are between 0 and 255.\n\nBy default, the stencil test is disabled.",
           variants = {
           variants = {
             {
             {
               arguments = {
               arguments = {

+ 5 - 1
api/lovr/graphics/getStencilTest.lua

@@ -25,7 +25,11 @@ return {
       ]]
       ]]
     }
     }
   },
   },
-  notes = 'Stencil values are between 0 and 255.',
+  notes = [[
+    Stencil values are between 0 and 255.
+
+    By default, the stencil test is disabled.
+  ]],
   related = {
   related = {
     'lovr.graphics.stencil'
     'lovr.graphics.stencil'
   }
   }

+ 5 - 1
api/lovr/graphics/setStencilTest.lua

@@ -32,7 +32,11 @@ return {
       returns = {}
       returns = {}
     }
     }
   },
   },
-  notes = 'Stencil values are between 0 and 255.',
+  notes = [[
+    Stencil values are between 0 and 255.
+
+    By default, the stencil test is disabled.
+  ]],
   related = {
   related = {
     'lovr.graphics.stencil'
     'lovr.graphics.stencil'
   }
   }