bjorn 3 years ago
parent
commit
c1467ab749

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'work-submission',
   summary = 'Begin a pass of graphics work.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'work-submission',
   summary = 'Finish a pass.',
   description = 'TODO',
   arguments = {},

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

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

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'camera',
   summary = 'Get the field of view.',
   description = 'Returns the projection for a single view.',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'camera',
   summary = 'Get the camera pose.',
   description = 'Get the pose of a single view.',
   arguments = {

+ 23 - 1
api/lovr/graphics/init.lua

@@ -3,5 +3,27 @@ return {
   summary = 'Renders graphics using the GPU.',
   description = [[
     The graphics module renders graphics and performs computation using the GPU.
-  ]]
+  ]],
+  sections = {
+    {
+      name = 'Camera',
+      tag = 'camera',
+      description = 'TODO'
+    },
+    {
+      name = 'Transform',
+      tag = 'transform',
+      description = 'TODO'
+    },
+    {
+      name = 'Work Submission',
+      tag = 'work-submission',
+      description = 'TODO'
+    },
+    {
+      name = 'Miscellaneous',
+      tag = 'graphics-misc',
+      description = 'Hardware info and statistics.'
+    }
+  }
 }

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Reset the transform to the origin.',
   description = 'TODO',
   arguments = {},

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Restore original state from a stack.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'work-submission',
   summary = 'Start recording graphics work.',
   description = 'TODO',
   arguments = {},

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Push state onto a stack.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Rotate the coordinate system.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Scale the coordinate system.',
   description = 'TODO',
   arguments = {

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

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

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

@@ -1,5 +1,5 @@
 return {
-  tag = 'graphicsState',
+  tag = 'camera',
   summary = 'Set the field of view.',
   description = [[
     Sets the projection for a single view.  4 field of view angles can be used, similar to the field

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'camera',
   summary = 'Set the scissor.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'camera',
   summary = 'Set the camera pose.',
   description = [[
     Sets the pose for a single view.  Objects rendered in this view will appear as though the camera

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'camera',
   summary = 'Set the viewport.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'work-submission',
   summary = 'Submit recorded graphics work to the GPU.',
   description = 'TODO',
   arguments = {},

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Apply a general transform to the coordinate system.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'transform',
   summary = 'Translate the coordinate system.',
   description = 'TODO',
   arguments = {

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

@@ -1,4 +1,5 @@
 return {
+  tag = 'work-submission',
   summary = 'Wait for the GPU to finish all submitted work.',
   description = 'TODO',
   arguments = {},