Browse Source

Make clear more clear;

bjorn 7 years ago
parent
commit
4f4cb7f56b
2 changed files with 5 additions and 0 deletions
  1. 1 0
      api/init.lua
  2. 4 0
      api/lovr/graphics/clear.lua

+ 1 - 0
api/init.lua

@@ -6742,6 +6742,7 @@ return {
           notes = "The two variants of this function can be mixed and matched, meaning you can use booleans for some of the values and numeric values for others.",
           variants = {
             {
+              description = "Clears the color, depth, and stencil to their default values.  Color will be cleared to the current background color, depth will be cleared to 1.0, and stencil will be cleared to 0.",
               arguments = {
                 {
                   name = "color",

+ 4 - 0
api/lovr/graphics/clear.lua

@@ -52,6 +52,10 @@ return {
   returns = {},
   variants = {
     {
+      description = [[
+        Clears the color, depth, and stencil to their default values.  Color will be cleared to the
+        current background color, depth will be cleared to 1.0, and stencil will be cleared to 0.
+      ]],
       arguments = { 'color', 'depth', 'stencil' },
       returns = {}
     },