Browse Source

Buffer sections;

bjorn 1 year ago
parent
commit
2e99ca8240

+ 17 - 0
api/init.lua

@@ -3908,6 +3908,7 @@ return {
             },
             },
             {
             {
               name = "getPointer",
               name = "getPointer",
+              tag = "buffer-transfer",
               summary = "Get a raw pointer to the Blob's data.",
               summary = "Get a raw pointer to the Blob's data.",
               description = "Returns a raw pointer to the Blob's data.  This can be used to interface with other C libraries using the LuaJIT FFI.  Use this only if you know what you're doing!",
               description = "Returns a raw pointer to the Blob's data.  This can be used to interface with other C libraries using the LuaJIT FFI.  Use this only if you know what you're doing!",
               key = "Blob:getPointer",
               key = "Blob:getPointer",
@@ -12838,6 +12839,7 @@ return {
           methods = {
           methods = {
             {
             {
               name = "clear",
               name = "clear",
+              tag = "buffer-transfer",
               summary = "Clear data in the Buffer.",
               summary = "Clear data in the Buffer.",
               description = "Clears a range of data in the Buffer to a value.",
               description = "Clears a range of data in the Buffer to a value.",
               key = "Buffer:clear",
               key = "Buffer:clear",
@@ -12873,6 +12875,7 @@ return {
             },
             },
             {
             {
               name = "getFormat",
               name = "getFormat",
+              tag = "buffer-metadata",
               summary = "Get the format of the Buffer.",
               summary = "Get the format of the Buffer.",
               description = "Returns the format the Buffer was created with.",
               description = "Returns the format the Buffer was created with.",
               key = "Buffer:getFormat",
               key = "Buffer:getFormat",
@@ -12929,6 +12932,7 @@ return {
             },
             },
             {
             {
               name = "getLength",
               name = "getLength",
+              tag = "buffer-metadata",
               summary = "Get the length of the Buffer.",
               summary = "Get the length of the Buffer.",
               description = "Returns the length of the Buffer, or `nil` if the Buffer was not created with a format.",
               description = "Returns the length of the Buffer, or `nil` if the Buffer was not created with a format.",
               key = "Buffer:getLength",
               key = "Buffer:getLength",
@@ -12975,6 +12979,7 @@ return {
             },
             },
             {
             {
               name = "getSize",
               name = "getSize",
+              tag = "buffer-metadata",
               summary = "Get the size of the Buffer, in bytes.",
               summary = "Get the size of the Buffer, in bytes.",
               description = "Returns the size of the Buffer in VRAM, in bytes.  This is the same as `length * stride`.\n\nThe size of the Buffer can't change after it's created.",
               description = "Returns the size of the Buffer in VRAM, in bytes.  This is the same as `length * stride`.\n\nThe size of the Buffer can't change after it's created.",
               key = "Buffer:getSize",
               key = "Buffer:getSize",
@@ -12998,6 +13003,7 @@ return {
             },
             },
             {
             {
               name = "getStride",
               name = "getStride",
+              tag = "buffer-metadata",
               summary = "Get the stride of the Buffer, in bytes.",
               summary = "Get the stride of the Buffer, in bytes.",
               description = "Returns the distance between each item in the Buffer, in bytes, or `nil` if the Buffer was not created with a format.",
               description = "Returns the distance between each item in the Buffer, in bytes, or `nil` if the Buffer was not created with a format.",
               key = "Buffer:getStride",
               key = "Buffer:getStride",
@@ -13044,6 +13050,7 @@ return {
             },
             },
             {
             {
               name = "setData",
               name = "setData",
+              tag = "buffer-transfer",
               summary = "Change the data in the Buffer.",
               summary = "Change the data in the Buffer.",
               description = "Changes data in a temporary Buffer using a table or a Blob.  Permanent buffers can be changed using `Pass:copy`.",
               description = "Changes data in a temporary Buffer using a table or a Blob.  Permanent buffers can be changed using `Pass:copy`.",
               key = "Buffer:setData",
               key = "Buffer:setData",
@@ -13113,6 +13120,16 @@ return {
                 }
                 }
               }
               }
             }
             }
+          },
+          sections = {
+            {
+              name = "Metadata",
+              tag = "buffer-metadata"
+            },
+            {
+              name = "Transfers",
+              tag = "buffer-transfer"
+            }
           }
           }
         },
         },
         {
         {

+ 1 - 0
api/lovr/data/Blob/getPointer.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-transfer',
   summary = 'Get a raw pointer to the Blob\'s data.',
   summary = 'Get a raw pointer to the Blob\'s data.',
   description = [[
   description = [[
     Returns a raw pointer to the Blob's data.  This can be used to interface with other C libraries
     Returns a raw pointer to the Blob's data.  This can be used to interface with other C libraries

+ 1 - 0
api/lovr/graphics/Buffer/clear.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-transfer',
   summary = 'Clear data in the Buffer.',
   summary = 'Clear data in the Buffer.',
   description = 'Clears a range of data in the Buffer to a value.',
   description = 'Clears a range of data in the Buffer to a value.',
   arguments = {
   arguments = {

+ 1 - 0
api/lovr/graphics/Buffer/getFormat.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-metadata',
   summary = 'Get the format of the Buffer.',
   summary = 'Get the format of the Buffer.',
   description = 'Returns the format the Buffer was created with.',
   description = 'Returns the format the Buffer was created with.',
   arguments = {},
   arguments = {},

+ 1 - 0
api/lovr/graphics/Buffer/getLength.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-metadata',
   summary = 'Get the length of the Buffer.',
   summary = 'Get the length of the Buffer.',
   description = [[
   description = [[
     Returns the length of the Buffer, or `nil` if the Buffer was not created with a format.
     Returns the length of the Buffer, or `nil` if the Buffer was not created with a format.

+ 1 - 0
api/lovr/graphics/Buffer/getSize.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-metadata',
   summary = 'Get the size of the Buffer, in bytes.',
   summary = 'Get the size of the Buffer, in bytes.',
   description = [[
   description = [[
     Returns the size of the Buffer in VRAM, in bytes.  This is the same as `length * stride`.
     Returns the size of the Buffer in VRAM, in bytes.  This is the same as `length * stride`.

+ 1 - 0
api/lovr/graphics/Buffer/getStride.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-metadata',
   summary = 'Get the stride of the Buffer, in bytes.',
   summary = 'Get the stride of the Buffer, in bytes.',
   description = [[
   description = [[
     Returns the distance between each item in the Buffer, in bytes, or `nil` if the Buffer was not
     Returns the distance between each item in the Buffer, in bytes, or `nil` if the Buffer was not

+ 10 - 0
api/lovr/graphics/Buffer/init.lua

@@ -48,5 +48,15 @@ return {
   constructors = {
   constructors = {
     'lovr.graphics.newBuffer',
     'lovr.graphics.newBuffer',
     'lovr.graphics.getBuffer'
     'lovr.graphics.getBuffer'
+  },
+  sections = {
+    {
+      name = 'Metadata',
+      tag = 'buffer-metadata'
+    },
+    {
+      name = 'Transfers',
+      tag = 'buffer-transfer'
+    }
   }
   }
 }
 }

+ 1 - 0
api/lovr/graphics/Buffer/setData.lua

@@ -1,4 +1,5 @@
 return {
 return {
+  tag = 'buffer-transfer',
   summary = 'Change the data in the Buffer.',
   summary = 'Change the data in the Buffer.',
   description = [[
   description = [[
     Changes data in a temporary Buffer using a table or a Blob.  Permanent buffers can be changed
     Changes data in a temporary Buffer using a table or a Blob.  Permanent buffers can be changed