Browse Source

Redo graphics sections;

bjorn 2 years ago
parent
commit
af5d453730

+ 39 - 51
api/init.lua

@@ -9811,10 +9811,42 @@ return {
         },
         },
         {
         {
           name = "Pass",
           name = "Pass",
-          summary = "A self-contained stream of graphics commands.",
+          summary = "A stream of graphics commands.",
           description = "TODO",
           description = "TODO",
           key = "Pass",
           key = "Pass",
           module = "lovr.graphics",
           module = "lovr.graphics",
+          sections = {
+            {
+              name = "Drawing",
+              tag = "drawing",
+              description = "TODO"
+            },
+            {
+              name = "Coordinate System",
+              tag = "transform",
+              description = "TODO"
+            },
+            {
+              name = "Render States",
+              tag = "pipeline",
+              description = "TODO"
+            },
+            {
+              name = "Shader Inputs",
+              tag = "shader-inputs",
+              description = "TODO"
+            },
+            {
+              name = "Camera",
+              tag = "camera",
+              description = "TODO"
+            },
+            {
+              name = "Compute",
+              tag = "compute",
+              description = "TODO"
+            }
+          },
           methods = {
           methods = {
             {
             {
               name = "blit",
               name = "blit",
@@ -13765,7 +13797,7 @@ return {
         },
         },
         {
         {
           name = "getBackgroundColor",
           name = "getBackgroundColor",
-          tag = "camera",
+          tag = "graphics-global",
           summary = "Get the background color.",
           summary = "Get the background color.",
           description = "TODO",
           description = "TODO",
           key = "lovr.graphics.getBackgroundColor",
           key = "lovr.graphics.getBackgroundColor",
@@ -15665,7 +15697,7 @@ return {
         },
         },
         {
         {
           name = "setBackgroundColor",
           name = "setBackgroundColor",
-          tag = "camera",
+          tag = "graphics-global",
           summary = "Set the background color.",
           summary = "Set the background color.",
           description = "TODO",
           description = "TODO",
           key = "lovr.graphics.setBackgroundColor",
           key = "lovr.graphics.setBackgroundColor",
@@ -16174,45 +16206,17 @@ return {
         }
         }
       },
       },
       sections = {
       sections = {
-        {
-          name = "Drawing",
-          tag = "drawing",
-          description = "TODO"
-        },
         {
         {
           name = "Objects",
           name = "Objects",
-          tag = "graphics-objects",
-          description = "TODO"
-        },
-        {
-          name = "Coordinate System",
-          tag = "transform",
-          description = "TODO"
-        },
-        {
-          name = "Render States",
-          tag = "pipeline",
-          description = "TODO"
-        },
-        {
-          name = "Shader Inputs",
-          tag = "shader-inputs",
-          description = "TODO"
+          tag = "graphics-objects"
         },
         },
         {
         {
-          name = "Camera",
-          tag = "camera",
-          description = "TODO"
-        },
-        {
-          name = "Compute",
-          tag = "compute",
-          description = "TODO"
+          name = "Global State",
+          tag = "graphics-global"
         },
         },
         {
         {
           name = "Work Submission",
           name = "Work Submission",
-          tag = "work-submission",
-          description = "TODO"
+          tag = "work-submission"
         },
         },
         {
         {
           name = "System Info",
           name = "System Info",
@@ -17652,22 +17656,6 @@ return {
             {
             {
               name = "eye/right",
               name = "eye/right",
               description = "The right eye."
               description = "The right eye."
-            },
-            {
-              name = "beacon/1",
-              description = "The first tracking device (i.e. lighthouse)."
-            },
-            {
-              name = "beacon/2",
-              description = "The second tracking device (i.e. lighthouse)."
-            },
-            {
-              name = "beacon/3",
-              description = "The third tracking device (i.e. lighthouse)."
-            },
-            {
-              name = "beacon/4",
-              description = "The fourth tracking device (i.e. lighthouse)."
             }
             }
           }
           }
         },
         },

+ 34 - 2
api/lovr/graphics/Pass/init.lua

@@ -1,4 +1,36 @@
 return {
 return {
-  summary = 'A self-contained stream of graphics commands.',
-  description = 'TODO'
+  summary = 'A stream of graphics commands.',
+  description = 'TODO',
+  sections = {
+    {
+      name = 'Drawing',
+      tag = 'drawing',
+      description = 'TODO'
+    },
+    {
+      name = 'Coordinate System',
+      tag = 'transform',
+      description = 'TODO'
+    },
+    {
+      name = 'Render States',
+      tag = 'pipeline',
+      description = 'TODO'
+    },
+    {
+      name = 'Shader Inputs',
+      tag = 'shader-inputs',
+      description = 'TODO'
+    },
+    {
+      name = 'Camera',
+      tag = 'camera',
+      description = 'TODO'
+    },
+    {
+      name = 'Compute',
+      tag = 'compute',
+      description = 'TODO'
+    }
+  }
 }
 }

+ 1 - 1
api/lovr/graphics/getBackgroundColor.lua

@@ -1,5 +1,5 @@
 return {
 return {
-  tag = 'camera',
+  tag = 'graphics-global',
   summary = 'Get the background color.',
   summary = 'Get the background color.',
   description = 'TODO',
   description = 'TODO',
   arguments = {},
   arguments = {},

+ 4 - 32
api/lovr/graphics/init.lua

@@ -5,45 +5,17 @@ return {
     The graphics module renders graphics and performs computation using the GPU.
     The graphics module renders graphics and performs computation using the GPU.
   ]],
   ]],
   sections = {
   sections = {
-    {
-      name = 'Drawing',
-      tag = 'drawing',
-      description = 'TODO'
-    },
     {
     {
       name = 'Objects',
       name = 'Objects',
-      tag = 'graphics-objects',
-      description = 'TODO'
-    },
-    {
-      name = 'Coordinate System',
-      tag = 'transform',
-      description = 'TODO'
-    },
-    {
-      name = 'Render States',
-      tag = 'pipeline',
-      description = 'TODO'
-    },
-    {
-      name = 'Shader Inputs',
-      tag = 'shader-inputs',
-      description = 'TODO'
-    },
-    {
-      name = 'Camera',
-      tag = 'camera',
-      description = 'TODO'
+      tag = 'graphics-objects'
     },
     },
     {
     {
-      name = 'Compute',
-      tag = 'compute',
-      description = 'TODO'
+      name = 'Global State',
+      tag = 'graphics-global'
     },
     },
     {
     {
       name = 'Work Submission',
       name = 'Work Submission',
-      tag = 'work-submission',
-      description = 'TODO'
+      tag = 'work-submission'
     },
     },
     {
     {
       name = 'System Info',
       name = 'System Info',

+ 1 - 1
api/lovr/graphics/setBackgroundColor.lua

@@ -1,5 +1,5 @@
 return {
 return {
-  tag = 'camera',
+  tag = 'graphics-global',
   summary = 'Set the background color.',
   summary = 'Set the background color.',
   description = 'TODO',
   description = 'TODO',
   arguments = {
   arguments = {