@defold-typescript/types 0.5.1 → 0.5.3

package/generated/resource.d.ts

@@ -59,69 +59,69 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the atlas. Supported entries:
-  -
-  `texture`
-  string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
-  -
-  `animations`
-  table a list of the animations in the atlas. Supports the following fields:
-  -
-  `id`
-  string the id of the animation, used in e.g sprite.play_animation
-  -
-  `width`
-  number the width of the animation
-  -
-  `height`
-  number the height of the animation
-  -
-  `frame_start`
-  number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
-  -
-  `frame_end`
-  number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
-  -
-  `playback`
-  constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
-  -
-  `fps`
-  number optional fps of the animation, the default value is 30
-  -
-  `flip_vertical`
-  boolean optional flip the animation vertically, the default value is false
-  -
-  `flip_horizontal`
-  boolean optional flip the animation horizontally, the default value is false
-  -
-  `geometries`
-  table A list of the geometries that should map to the texture data. Supports the following fields:
-  -
-  `id`
-  string The name of the geometry. Used when matching animations between multiple atlases
-  -
-  `width`
-  number The width of the image the sprite geometry represents
-  -
-  `height`
-  number The height of the image the sprite geometry represents
-  -
-  `pivot_x`
-  number The pivot x value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
-  -
-  `pivot_y`
-  number The pivot y value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
-  -
-  `rotated`
-  boolean Whether the image is rotated 90 degrees counter-clockwise in the atlas. This affects UV coordinate generation for proper rendering. Default is false.
-  -
-  `vertices`
-  table a list of the vertices in image space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
-  -
-  `uvs`
-  table a list of the uv coordinates in image space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}.
-  -
-  `indices`
-  table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
+     * -
+     * `texture`
+     * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
+     * -
+     * `animations`
+     * table a list of the animations in the atlas. Supports the following fields:
+     * -
+     * `id`
+     * string the id of the animation, used in e.g sprite.play_animation
+     * -
+     * `width`
+     * number the width of the animation
+     * -
+     * `height`
+     * number the height of the animation
+     * -
+     * `frame_start`
+     * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
+     * -
+     * `frame_end`
+     * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
+     * -
+     * `playback`
+     * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
+     * -
+     * `fps`
+     * number optional fps of the animation, the default value is 30
+     * -
+     * `flip_vertical`
+     * boolean optional flip the animation vertically, the default value is false
+     * -
+     * `flip_horizontal`
+     * boolean optional flip the animation horizontally, the default value is false
+     * -
+     * `geometries`
+     * table A list of the geometries that should map to the texture data. Supports the following fields:
+     * -
+     * `id`
+     * string The name of the geometry. Used when matching animations between multiple atlases
+     * -
+     * `width`
+     * number The width of the image the sprite geometry represents
+     * -
+     * `height`
+     * number The height of the image the sprite geometry represents
+     * -
+     * `pivot_x`
+     * number The pivot x value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
+     * -
+     * `pivot_y`
+     * number The pivot y value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
+     * -
+     * `rotated`
+     * boolean Whether the image is rotated 90 degrees counter-clockwise in the atlas. This affects UV coordinate generation for proper rendering. Default is false.
+     * -
+     * `vertices`
+     * table a list of the vertices in image space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
+     * -
+     * `uvs`
+     * table a list of the uv coordinates in image space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}.
+     * -
+     * `indices`
+     * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @returns Returns the atlas resource path
      * @example
      * ```lua
@@ -194,12 +194,12 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the buffer. Supported entries:
-  -
-  `buffer`
-  buffer the buffer to bind to this resource
-  -
-  `transfer_ownership`
-  boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default true)
+     * -
+     * `buffer`
+     * buffer the buffer to bind to this resource
+     * -
+     * `transfer_ownership`
+     * boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default true)
      * @returns Returns the buffer resource path
      * @example
      * ```lua
@@ -254,12 +254,12 @@ declare global {
      *
      * @param path - the path to the resource. Must not already exist.
      * @param options - A table containing parameters for the text. Supported entries:
-  `data`
-  string The raw data of the file. May be partial, but must include the header of the file
-  `filesize`
-  number If the file is partial, it must also specify the full size of the complete file.
-  `partial`
-  boolean Is the data not representing the full file, but just the initial chunk?
+     * `data`
+     * string The raw data of the file. May be partial, but must include the header of the file
+     * `filesize`
+     * number If the file is partial, it must also specify the full size of the complete file.
+     * `partial`
+     * boolean Is the data not representing the full file, but just the initial chunk?
      * @returns the resulting path hash to the resource
      * @example
      * ```lua
@@ -283,70 +283,70 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the texture. Supported entries:
-  `type`
-  number The texture type. Supported values:
-  - `graphics.TEXTURE_TYPE_2D`
-  - `graphics.TEXTURE_TYPE_IMAGE_2D`
-  - `graphics.TEXTURE_TYPE_3D`
-  - `graphics.TEXTURE_TYPE_IMAGE_3D`
-  - `graphics.TEXTURE_TYPE_CUBE_MAP`
-  `width`
-  number The width of the texture (in pixels). Must be larger than 0.
-  `height`
-  number The width of the texture (in pixels). Must be larger than 0.
-  `depth`
-  number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
-  `format`
-  number The texture format, note that some of these formats might not be supported by the running device. Supported values:
-  - `graphics.TEXTURE_FORMAT_LUMINANCE`
-  - `graphics.TEXTURE_FORMAT_RGB`
-  - `graphics.TEXTURE_FORMAT_RGBA`
-  These constants might not be available on the device:
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_ETC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
-  - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
-  - `graphics.TEXTURE_FORMAT_RGB_BC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC3`
-  - `graphics.TEXTURE_FORMAT_R_BC4`
-  - `graphics.TEXTURE_FORMAT_RG_BC5`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC7`
-  - `graphics.TEXTURE_FORMAT_RGB16F`
-  - `graphics.TEXTURE_FORMAT_RGB32F`
-  - `graphics.TEXTURE_FORMAT_RGBA16F`
-  - `graphics.TEXTURE_FORMAT_RGBA32F`
-  - `graphics.TEXTURE_FORMAT_R16F`
-  - `graphics.TEXTURE_FORMAT_RG16F`
-  - `graphics.TEXTURE_FORMAT_R32F`
-  - `graphics.TEXTURE_FORMAT_RG32F`
-  You can test if the device supports these values by checking if a specific enum is nil or not:
-  `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
-  -- it is safe to use this format
-  end
-  `
-  `flags`
-  number Texture creation flags that can be used to dictate how the texture is created. The default value is graphics.TEXTURE_USAGE_FLAG_SAMPLE, which means that the texture can be sampled from a shader.
-  These flags may or may not be supported on the running device and/or the underlying graphics API and is simply used internally as a 'hint' when creating the texture. There is no guarantee that any of these will have any effect. Supported values:
-  - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
-  - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
-  - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
-  `max_mipmaps`
-  number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
-  `compression_type`
-  number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
-  Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
-  - `COMPRESSION_TYPE_DEFAULT`
-  - `COMPRESSION_TYPE_BASIS_UASTC`
+     * `type`
+     * number The texture type. Supported values:
+     * - `graphics.TEXTURE_TYPE_2D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     * - `graphics.TEXTURE_TYPE_3D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     * `width`
+     * number The width of the texture (in pixels). Must be larger than 0.
+     * `height`
+     * number The width of the texture (in pixels). Must be larger than 0.
+     * `depth`
+     * number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
+     * `format`
+     * number The texture format, note that some of these formats might not be supported by the running device. Supported values:
+     * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     * - `graphics.TEXTURE_FORMAT_RGB`
+     * - `graphics.TEXTURE_FORMAT_RGBA`
+     * These constants might not be available on the device:
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_ETC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
+     * - `graphics.TEXTURE_FORMAT_RGB_BC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC3`
+     * - `graphics.TEXTURE_FORMAT_R_BC4`
+     * - `graphics.TEXTURE_FORMAT_RG_BC5`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC7`
+     * - `graphics.TEXTURE_FORMAT_RGB16F`
+     * - `graphics.TEXTURE_FORMAT_RGB32F`
+     * - `graphics.TEXTURE_FORMAT_RGBA16F`
+     * - `graphics.TEXTURE_FORMAT_RGBA32F`
+     * - `graphics.TEXTURE_FORMAT_R16F`
+     * - `graphics.TEXTURE_FORMAT_RG16F`
+     * - `graphics.TEXTURE_FORMAT_R32F`
+     * - `graphics.TEXTURE_FORMAT_RG32F`
+     * You can test if the device supports these values by checking if a specific enum is nil or not:
+     * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
+     * -- it is safe to use this format
+     * end
+     * `
+     * `flags`
+     * number Texture creation flags that can be used to dictate how the texture is created. The default value is graphics.TEXTURE_USAGE_FLAG_SAMPLE, which means that the texture can be sampled from a shader.
+     * These flags may or may not be supported on the running device and/or the underlying graphics API and is simply used internally as a 'hint' when creating the texture. There is no guarantee that any of these will have any effect. Supported values:
+     * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+     * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+     * - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+     * `max_mipmaps`
+     * number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
+     * `compression_type`
+     * number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
+     * Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     * - `COMPRESSION_TYPE_DEFAULT`
+     * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - optional buffer of precreated pixel data
      * @returns The path to the resource.
-  3D Textures are currently only supported on OpenGL and Vulkan adapters. To check if your device supports 3D textures, use:
-  ```lua
-  if graphics.TEXTURE_TYPE_3D ~= nil then
-  -- Device and graphics adapter support 3D textures
-  end
+     * 3D Textures are currently only supported on OpenGL and Vulkan adapters. To check if your device supports 3D textures, use:
+     * ```lua
+     * if graphics.TEXTURE_TYPE_3D ~= nil then
+     * -- Device and graphics adapter support 3D textures
+     * end
      * @example
      * ```lua
      * How to create an 128x128 RGBA texture resource and assign it to a model
@@ -436,62 +436,62 @@ declare global {
      *
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the texture. Supported entries:
-  `type`
-  number The texture type. Supported values:
-  - `graphics.TEXTURE_TYPE_2D`
-  - `graphics.TEXTURE_TYPE_IMAGE_2D`
-  - `graphics.TEXTURE_TYPE_3D`
-  - `graphics.TEXTURE_TYPE_IMAGE_3D`
-  - `graphics.TEXTURE_TYPE_CUBE_MAP`
-  `width`
-  number The width of the texture (in pixels). Must be larger than 0.
-  `height`
-  number The width of the texture (in pixels). Must be larger than 0.
-  `depth`
-  number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
-  `format`
-  number The texture format, note that some of these formats might not be supported by the running device. Supported values:
-  - `graphics.TEXTURE_FORMAT_LUMINANCE`
-  - `graphics.TEXTURE_FORMAT_RGB`
-  - `graphics.TEXTURE_FORMAT_RGBA`
-  These constants might not be available on the device:
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_ETC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
-  - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
-  - `graphics.TEXTURE_FORMAT_RGB_BC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC3`
-  - `graphics.TEXTURE_FORMAT_R_BC4`
-  - `graphics.TEXTURE_FORMAT_RG_BC5`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC7`
-  - `graphics.TEXTURE_FORMAT_RGB16F`
-  - `graphics.TEXTURE_FORMAT_RGB32F`
-  - `graphics.TEXTURE_FORMAT_RGBA16F`
-  - `graphics.TEXTURE_FORMAT_RGBA32F`
-  - `graphics.TEXTURE_FORMAT_R16F`
-  - `graphics.TEXTURE_FORMAT_RG16F`
-  - `graphics.TEXTURE_FORMAT_R32F`
-  - `graphics.TEXTURE_FORMAT_RG32F`
-  You can test if the device supports these values by checking if a specific enum is nil or not:
-  `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
-  -- it is safe to use this format
-  end
-  `
-  `flags`
-  number Texture creation flags that can be used to dictate how the texture is created. Supported values:
-  - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
-  - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
-  - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
-  `max_mipmaps`
-  number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
-  `compression_type`
-  number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
-  Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
-  - `COMPRESSION_TYPE_DEFAULT`
-  - `COMPRESSION_TYPE_BASIS_UASTC`
+     * `type`
+     * number The texture type. Supported values:
+     * - `graphics.TEXTURE_TYPE_2D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     * - `graphics.TEXTURE_TYPE_3D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     * `width`
+     * number The width of the texture (in pixels). Must be larger than 0.
+     * `height`
+     * number The width of the texture (in pixels). Must be larger than 0.
+     * `depth`
+     * number The depth of the texture (in pixels). Must be larger than 0. Only used when `type` is `graphics.TEXTURE_TYPE_3D` or `graphics.TEXTURE_TYPE_IMAGE_3D`.
+     * `format`
+     * number The texture format, note that some of these formats might not be supported by the running device. Supported values:
+     * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     * - `graphics.TEXTURE_FORMAT_RGB`
+     * - `graphics.TEXTURE_FORMAT_RGBA`
+     * These constants might not be available on the device:
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_ETC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
+     * - `graphics.TEXTURE_FORMAT_RGB_BC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC3`
+     * - `graphics.TEXTURE_FORMAT_R_BC4`
+     * - `graphics.TEXTURE_FORMAT_RG_BC5`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC7`
+     * - `graphics.TEXTURE_FORMAT_RGB16F`
+     * - `graphics.TEXTURE_FORMAT_RGB32F`
+     * - `graphics.TEXTURE_FORMAT_RGBA16F`
+     * - `graphics.TEXTURE_FORMAT_RGBA32F`
+     * - `graphics.TEXTURE_FORMAT_R16F`
+     * - `graphics.TEXTURE_FORMAT_RG16F`
+     * - `graphics.TEXTURE_FORMAT_R32F`
+     * - `graphics.TEXTURE_FORMAT_RG32F`
+     * You can test if the device supports these values by checking if a specific enum is nil or not:
+     * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
+     * -- it is safe to use this format
+     * end
+     * `
+     * `flags`
+     * number Texture creation flags that can be used to dictate how the texture is created. Supported values:
+     * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+     * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+     * - `graphics.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+     * `max_mipmaps`
+     * number optional max number of mipmaps. Defaults to zero, i.e no mipmap support
+     * `compression_type`
+     * number optional specify the compression type for the data in the buffer object that holds the texture data. Will only be used when a compressed buffer has been passed into the function.
+     * Creating an empty texture with no buffer data is not supported as a core feature. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     * - `COMPRESSION_TYPE_DEFAULT`
+     * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - optional buffer of precreated pixel data
      * @param callback - callback function when texture is created (self, request_id, resource)
      * @example
@@ -597,12 +597,12 @@ declare global {
      *
      * @param path - The path to the atlas resource
      * @returns A table with the following entries:
-  - texture
-  - geometries
-  - animations
-  Each animation entry also contains a `frames` table with indices into
-  `geometries`, preserving the frame-to-geometry mapping used by the atlas.
-  See resource.set_atlas for a detailed description of each field
+     * - texture
+     * - geometries
+     * - animations
+     * Each animation entry also contains a `frames` table with indices into
+     * `geometries`, preserving the frame-to-geometry mapping used by the atlas.
+     * See resource.set_atlas for a detailed description of each field
      */
     function get_atlas(path: Hash | string): { texture: string | Hash; animations: { id: string; width: number; height: number; frame_start: number; frame_end: number; playback: Opaque<"constant">; fps: number; flip_vertical: boolean; flip_horizontal: boolean }[]; geometries: Record<string | number, unknown> };
     /**
@@ -631,35 +631,35 @@ declare global {
      *
      * @param path - The path to the resource or a render target handle
      * @returns A table containing info about the render target:
-  `handle`
-  number the opaque handle to the texture resource
-  'attachments'
-  table a table of attachments, where each attachment contains the following entries:
-  `width`
-  number width of the texture
-  `height`
-  number height of the texture
-  `depth`
-  number depth of the texture (i.e 1 for a 2D texture and 6 for a cube map)
-  `mipmaps`
-  number number of mipmaps of the texture
-  `type`
-  number The texture type. Supported values:
-  - `graphics.TEXTURE_TYPE_2D`
-  - `graphics.TEXTURE_TYPE_CUBE_MAP`
-  - `graphics.TEXTURE_TYPE_2D_ARRAY`
-  `buffer_type`
-  number The attachment buffer type. Supported values:
-  - `resource.BUFFER_TYPE_COLOR0`
-  - `resource.BUFFER_TYPE_COLOR1`
-  - `resource.BUFFER_TYPE_COLOR2`
-  - `resource.BUFFER_TYPE_COLOR3`
-  - `resource.BUFFER_TYPE_DEPTH`
-  -
-  `resource.BUFFER_TYPE_STENCIL`
-  -
-  `texture`
-  hash The hashed path to the attachment texture resource. This field is only available if the render target passed in is a resource.
+     * `handle`
+     * number the opaque handle to the texture resource
+     * 'attachments'
+     * table a table of attachments, where each attachment contains the following entries:
+     * `width`
+     * number width of the texture
+     * `height`
+     * number height of the texture
+     * `depth`
+     * number depth of the texture (i.e 1 for a 2D texture and 6 for a cube map)
+     * `mipmaps`
+     * number number of mipmaps of the texture
+     * `type`
+     * number The texture type. Supported values:
+     * - `graphics.TEXTURE_TYPE_2D`
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     * - `graphics.TEXTURE_TYPE_2D_ARRAY`
+     * `buffer_type`
+     * number The attachment buffer type. Supported values:
+     * - `resource.BUFFER_TYPE_COLOR0`
+     * - `resource.BUFFER_TYPE_COLOR1`
+     * - `resource.BUFFER_TYPE_COLOR2`
+     * - `resource.BUFFER_TYPE_COLOR3`
+     * - `resource.BUFFER_TYPE_DEPTH`
+     * -
+     * `resource.BUFFER_TYPE_STENCIL`
+     * -
+     * `texture`
+     * hash The hashed path to the attachment texture resource. This field is only available if the render target passed in is a resource.
      * @example
      * ```lua
      * Get the metadata from a render target resource
@@ -689,19 +689,19 @@ declare global {
      * @param url - the font to get the (unscaled) metrics from
      * @param text - text to measure
      * @param options - A table containing parameters for the text. Supported entries:
-  `width`
-  number The width of the text field. Not used if `line_break` is false.
-  `leading`
-  number The leading (default 1.0)
-  `tracking`
-  number The tracking (default 0.0)
-  `line_break`
-  boolean If the calculation should consider line breaks (default false)
+     * `width`
+     * number The width of the text field. Not used if `line_break` is false.
+     * `leading`
+     * number The leading (default 1.0)
+     * `tracking`
+     * number The tracking (default 0.0)
+     * `line_break`
+     * boolean If the calculation should consider line breaks (default false)
      * @returns a table with the following fields:
-  - width
-  - height
-  - max_ascent
-  - max_descent
+     * - width
+     * - height
+     * - max_ascent
+     * - max_descent
      * @example
      * ```lua
      * function init(self)
@@ -717,28 +717,28 @@ declare global {
      *
      * @param path - The path to the resource or a texture handle
      * @returns A table containing info about the texture:
-  `handle`
-  number the opaque handle to the texture resource
-  `width`
-  number width of the texture
-  `height`
-  number height of the texture
-  `depth`
-  number depth of the texture (i.e 1 for a 2D texture, 6 for a cube map, the actual depth of a 3D texture)
-  `page_count`
-  number number of pages of the texture array. For 2D texture value is 1. For cube map - 6
-  `mipmaps`
-  number number of mipmaps of the texture
-  `flags`
-  number usage hints of the texture.
-  `type`
-  number The texture type. Supported values:
-  - `graphics.TEXTURE_TYPE_2D`
-  - `graphics.TEXTURE_TYPE_2D_ARRAY`
-  - `graphics.TEXTURE_TYPE_IMAGE_2D`
-  - `graphics.TEXTURE_TYPE_3D`
-  - `graphics.TEXTURE_TYPE_IMAGE_3D`
-  - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     * `handle`
+     * number the opaque handle to the texture resource
+     * `width`
+     * number width of the texture
+     * `height`
+     * number height of the texture
+     * `depth`
+     * number depth of the texture (i.e 1 for a 2D texture, 6 for a cube map, the actual depth of a 3D texture)
+     * `page_count`
+     * number number of pages of the texture array. For 2D texture value is 1. For cube map - 6
+     * `mipmaps`
+     * number number of mipmaps of the texture
+     * `flags`
+     * number usage hints of the texture.
+     * `type`
+     * number The texture type. Supported values:
+     * - `graphics.TEXTURE_TYPE_2D`
+     * - `graphics.TEXTURE_TYPE_2D_ARRAY`
+     * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     * - `graphics.TEXTURE_TYPE_3D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
      * @example
      * ```lua
      * Create a new texture and get the metadata from it
@@ -876,51 +876,51 @@ declare global {
      *
      * @param path - The path to the atlas resource
      * @param table - A table containing info about the atlas. Supported entries:
-  -
-  `texture`
-  string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
-  -
-  `animations`
-  table a list of the animations in the atlas. Supports the following fields:
-  -
-  `id`
-  string the id of the animation, used in e.g sprite.play_animation
-  -
-  `width`
-  number the width of the animation
-  -
-  `height`
-  number the height of the animation
-  -
-  `frame_start`
-  number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
-  -
-  `frame_end`
-  number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
-  -
-  `playback`
-  constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
-  -
-  `fps`
-  number optional fps of the animation, the default value is 30
-  -
-  `flip_vertical`
-  boolean optional flip the animation vertically, the default value is false
-  -
-  `flip_horizontal`
-  boolean optional flip the animation horizontally, the default value is false
-  -
-  `geometries`
-  table A list of the geometries that should map to the texture data. Supports the following fields:
-  -
-  `vertices`
-  table a list of the vertices in texture space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
-  -
-  `uvs`
-  table a list of the uv coordinates in texture space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}
-  -
-  `indices`
-  table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
+     * -
+     * `texture`
+     * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
+     * -
+     * `animations`
+     * table a list of the animations in the atlas. Supports the following fields:
+     * -
+     * `id`
+     * string the id of the animation, used in e.g sprite.play_animation
+     * -
+     * `width`
+     * number the width of the animation
+     * -
+     * `height`
+     * number the height of the animation
+     * -
+     * `frame_start`
+     * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
+     * -
+     * `frame_end`
+     * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
+     * -
+     * `playback`
+     * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
+     * -
+     * `fps`
+     * number optional fps of the animation, the default value is 30
+     * -
+     * `flip_vertical`
+     * boolean optional flip the animation vertically, the default value is false
+     * -
+     * `flip_horizontal`
+     * boolean optional flip the animation horizontally, the default value is false
+     * -
+     * `geometries`
+     * table A list of the geometries that should map to the texture data. Supports the following fields:
+     * -
+     * `vertices`
+     * table a list of the vertices in texture space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
+     * -
+     * `uvs`
+     * table a list of the uv coordinates in texture space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}
+     * -
+     * `indices`
+     * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @example
      * ```lua
      * Add a new animation to an existing atlas
@@ -987,9 +987,9 @@ declare global {
      * @param path - The path to the resource
      * @param buffer - The resource buffer
      * @param table - A table containing info about how to set the buffer. Supported entries:
-  -
-  `transfer_ownership`
-  boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default false)
+     * -
+     * `transfer_ownership`
+     * boolean optional flag to determine wether or not the resource should take over ownership of the buffer object (default false)
      * @example
      * ```lua
      * How to set the data from a buffer
@@ -1038,69 +1038,69 @@ declare global {
      *
      * @param path - The path to the resource
      * @param table - A table containing info about the texture. Supported entries:
-  `type`
-  number The texture type. Supported values:
-  - `graphics.TEXTURE_TYPE_2D`
-  - `graphics.TEXTURE_TYPE_IMAGE_2D`
-  - `graphics.TEXTURE_TYPE_3D`
-  - `graphics.TEXTURE_TYPE_IMAGE_3D`
-  - `graphics.TEXTURE_TYPE_CUBE_MAP`
-  `width`
-  number The width of the texture (in pixels)
-  `height`
-  number The width of the texture (in pixels)
-  `format`
-  number The texture format, note that some of these formats are platform specific. Supported values:
-  - `graphics.TEXTURE_FORMAT_LUMINANCE`
-  - `graphics.TEXTURE_FORMAT_RGB`
-  - `graphics.TEXTURE_FORMAT_RGBA`
-  These constants might not be available on the device:
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
-  - `graphics.TEXTURE_FORMAT_RGB_ETC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
-  - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
-  - `graphics.TEXTURE_FORMAT_RGB_BC1`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC3`
-  - `graphics.TEXTURE_FORMAT_R_BC4`
-  - `graphics.TEXTURE_FORMAT_RG_BC5`
-  - `graphics.TEXTURE_FORMAT_RGBA_BC7`
-  - `graphics.TEXTURE_FORMAT_RGB16F`
-  - `graphics.TEXTURE_FORMAT_RGB32F`
-  - `graphics.TEXTURE_FORMAT_RGBA16F`
-  - `graphics.TEXTURE_FORMAT_RGBA32F`
-  - `graphics.TEXTURE_FORMAT_R16F`
-  - `graphics.TEXTURE_FORMAT_RG16F`
-  - `graphics.TEXTURE_FORMAT_R32F`
-  - `graphics.TEXTURE_FORMAT_RG32F`
-  You can test if the device supports these values by checking if a specific enum is nil or not:
-  `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
-  -- it is safe to use this format
-  end
-  `
-  `x`
-  number optional x offset of the texture (in pixels)
-  `y`
-  number optional y offset of the texture (in pixels)
-  `z`
-  number optional z offset of the texture (in pixels). Only applies to 3D textures
-  `page`
-  number optional slice of the array texture. Only applies to 2D texture arrays. Zero-based
-  `mipmap`
-  number optional mipmap to upload the data to
-  `compression_type`
-  number optional specify the compression type for the data in the buffer object that holds the texture data. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
-  - `COMPRESSION_TYPE_DEFAULT`
-  - `COMPRESSION_TYPE_BASIS_UASTC`
+     * `type`
+     * number The texture type. Supported values:
+     * - `graphics.TEXTURE_TYPE_2D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_2D`
+     * - `graphics.TEXTURE_TYPE_3D`
+     * - `graphics.TEXTURE_TYPE_IMAGE_3D`
+     * - `graphics.TEXTURE_TYPE_CUBE_MAP`
+     * `width`
+     * number The width of the texture (in pixels)
+     * `height`
+     * number The width of the texture (in pixels)
+     * `format`
+     * number The texture format, note that some of these formats are platform specific. Supported values:
+     * - `graphics.TEXTURE_FORMAT_LUMINANCE`
+     * - `graphics.TEXTURE_FORMAT_RGB`
+     * - `graphics.TEXTURE_FORMAT_RGBA`
+     * These constants might not be available on the device:
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_2BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_PVRTC_4BPPV1`
+     * - `graphics.TEXTURE_FORMAT_RGB_ETC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ETC2`
+     * - `graphics.TEXTURE_FORMAT_RGBA_ASTC_4X4`
+     * - `graphics.TEXTURE_FORMAT_RGB_BC1`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC3`
+     * - `graphics.TEXTURE_FORMAT_R_BC4`
+     * - `graphics.TEXTURE_FORMAT_RG_BC5`
+     * - `graphics.TEXTURE_FORMAT_RGBA_BC7`
+     * - `graphics.TEXTURE_FORMAT_RGB16F`
+     * - `graphics.TEXTURE_FORMAT_RGB32F`
+     * - `graphics.TEXTURE_FORMAT_RGBA16F`
+     * - `graphics.TEXTURE_FORMAT_RGBA32F`
+     * - `graphics.TEXTURE_FORMAT_R16F`
+     * - `graphics.TEXTURE_FORMAT_RG16F`
+     * - `graphics.TEXTURE_FORMAT_R32F`
+     * - `graphics.TEXTURE_FORMAT_RG32F`
+     * You can test if the device supports these values by checking if a specific enum is nil or not:
+     * `if graphics.TEXTURE_FORMAT_RGBA16F ~= nil then
+     * -- it is safe to use this format
+     * end
+     * `
+     * `x`
+     * number optional x offset of the texture (in pixels)
+     * `y`
+     * number optional y offset of the texture (in pixels)
+     * `z`
+     * number optional z offset of the texture (in pixels). Only applies to 3D textures
+     * `page`
+     * number optional slice of the array texture. Only applies to 2D texture arrays. Zero-based
+     * `mipmap`
+     * number optional mipmap to upload the data to
+     * `compression_type`
+     * number optional specify the compression type for the data in the buffer object that holds the texture data. Defaults to graphics.COMPRESSION_TYPE_DEFAULT, i.e no compression. Supported values:
+     * - `COMPRESSION_TYPE_DEFAULT`
+     * - `COMPRESSION_TYPE_BASIS_UASTC`
      * @param buffer - The buffer of precreated pixel data
-  To update a cube map texture you need to pass in six times the amount of data via the buffer, since a cube map has six sides!
-  3D Textures are currently only supported on OpenGL and Vulkan adapters. To check if your device supports 3D textures, use:
-  ```lua
-  if graphics.TEXTURE_TYPE_3D ~= nil then
-  -- Device and graphics adapter support 3D textures
-  end
+     * To update a cube map texture you need to pass in six times the amount of data via the buffer, since a cube map has six sides!
+     * 3D Textures are currently only supported on OpenGL and Vulkan adapters. To check if your device supports 3D textures, use:
+     * ```lua
+     * if graphics.TEXTURE_TYPE_3D ~= nil then
+     * -- Device and graphics adapter support 3D textures
+     * end
      * @example
      * ```lua
      * How to set all pixels of an atlas