Browse Source

Section descriptions/tags;

bjorn 3 years ago
parent
commit
7dfd9ab171
3 changed files with 17 additions and 5 deletions
  1. 6 3
      api/init.lua
  2. 1 0
      api/lovr/graphics/compileShader.lua
  3. 10 2
      api/lovr/graphics/init.lua

+ 6 - 3
api/init.lua

@@ -7215,7 +7215,7 @@ return {
       name = "graphics",
       tag = "modules",
       summary = "Renders graphics using the GPU.",
-      description = "The graphics module renders graphics and performs computation using the GPU.",
+      description = "The graphics module renders graphics and performs computation using the GPU.\n\nMost of the graphics functions are on the `Pass` object.",
       key = "lovr.graphics",
       objects = {
         {
@@ -13764,6 +13764,7 @@ return {
       functions = {
         {
           name = "compileShader",
+          tag = "graphics-objects",
           summary = "Compile a Shader.",
           description = "TODO",
           key = "lovr.graphics.compileShader",
@@ -16218,11 +16219,13 @@ return {
         },
         {
           name = "Work Submission",
-          tag = "work-submission"
+          tag = "work-submission",
+          description = "The only way to get the GPU to do anything is to submit `Pass` objects to it.  LÖVR submits the default pass automatically at the end of `lovr.draw`, but work can also be submitted manually."
         },
         {
           name = "System Info",
-          tag = "graphics-misc"
+          tag = "graphics-misc",
+          description = "Information about the GPU hardware and the features it supports."
         }
       }
     },

+ 1 - 0
api/lovr/graphics/compileShader.lua

@@ -1,4 +1,5 @@
 return {
+  tag = 'graphics-objects',
   summary = 'Compile a Shader.',
   description = 'TODO',
   arguments = {

+ 10 - 2
api/lovr/graphics/init.lua

@@ -3,6 +3,8 @@ return {
   summary = 'Renders graphics using the GPU.',
   description = [[
     The graphics module renders graphics and performs computation using the GPU.
+
+    Most of the graphics functions are on the `Pass` object.
   ]],
   sections = {
     {
@@ -15,11 +17,17 @@ return {
     },
     {
       name = 'Work Submission',
-      tag = 'work-submission'
+      tag = 'work-submission',
+      description = [[
+        The only way to get the GPU to do anything is to submit `Pass` objects to it.  LÖVR submits
+        the default pass automatically at the end of `lovr.draw`, but work can also be submitted
+        manually.
+      ]]
     },
     {
       name = 'System Info',
-      tag = 'graphics-misc'
+      tag = 'graphics-misc',
+      description = 'Information about the GPU hardware and the features it supports.'
     }
   }
 }