@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.0/material_doc.json

@@ -0,0 +1,238 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "material.get_vertex_attributes",
+      "brief": "gets vertex attributes from a material",
+      "description": "Returns a table of all the vertex attributes in the material. This function will return all the vertex attributes\nthat are used in the vertex shader of the material.",
+      "returnvalues": [
+        {
+          "name": "table",
+          "doc": "A table of tables, where each entry contains info about the vertex attributes:\n<dl>\n<dt><code>name</code></dt>\n<dd><span class=\"type\">hash</span> the hashed name of the vertex attribute</dd>\n<dt><code>value</code></dt>\n<dd><span class=\"type\">vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table</span> the value of the vertex attribute. Matrix attributes that do not map to <code>vmath.matrix4</code> are returned as a table of numbers.</dd>\n<dt><code>normalize</code></dt>\n<dd><span class=\"type\">boolean</span> whether the value is normalized when passed into the shader</dd>\n<dt><code>data_type</code></dt>\n<dd><span class=\"type\">number</span> the data type of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.DATA_TYPE_BYTE</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_BYTE</code></li>\n<li><code>graphics.DATA_TYPE_SHORT</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_SHORT</code></li>\n<li><code>graphics.DATA_TYPE_INT</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_INT</code></li>\n<li><code>graphics.DATA_TYPE_FLOAT</code></li>\n</ul>\n<dl>\n<dt><code>coordinate_space</code></dt>\n<dd><span class=\"type\">number</span> the coordinate space of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.COORDINATE_SPACE_WORLD</code></li>\n<li><code>graphics.COORDINATE_SPACE_LOCAL</code></li>\n</ul>\n<dl>\n<dt><code>semantic_type</code></dt>\n<dd><span class=\"type\">number</span> the semantic type of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.SEMANTIC_TYPE_NONE</code></li>\n<li><code>graphics.SEMANTIC_TYPE_POSITION</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TEXCOORD</code></li>\n<li><code>graphics.SEMANTIC_TYPE_PAGE_INDEX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_COLOR</code></li>\n<li><code>graphics.SEMANTIC_TYPE_NORMAL</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TANGENT</code></li>\n<li><code>graphics.SEMANTIC_TYPE_WORLD_MATRIX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_NORMAL_MATRIX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_BONE_WEIGHTS</code></li>\n<li><code>graphics.SEMANTIC_TYPE_BONE_INDICES</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TEXTURE_TRANSFORM_2D</code></li>\n</ul>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Get the vertex attributes from a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"kd\">local</span> <span class=\"n\">vertex_attributes</span> <span class=\"o\">=</span> <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">get_vertex_attributes</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.get_samplers",
+      "brief": "gets texture samplers from a material",
+      "description": "Returns a table of all the texture samplers in the material. This function will return all the texture samplers\nthat are used in both the vertex and the fragment shaders.",
+      "returnvalues": [
+        {
+          "name": "table",
+          "doc": "A table of tables, where each entry contains info about the texture samplers:\n<dl>\n<dt><code>name</code></dt>\n<dd><span class=\"type\">hash</span> the hashed name of the texture sampler</dd>\n<dt><code>u_wrap</code></dt>\n<dd><span class=\"type\">number</span> the u wrap mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_BORDER</code></li>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_EDGE</code></li>\n<li><code>graphics.TEXTURE_WRAP_MIRRORED_REPEAT</code></li>\n<li><code>graphics.TEXTURE_WRAP_REPEAT</code></li>\n</ul>\n<dl>\n<dt><code>v_wrap</code></dt>\n<dd><span class=\"type\">number</span> the v wrap mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_BORDER</code></li>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_EDGE</code></li>\n<li><code>graphics.TEXTURE_WRAP_MIRRORED_REPEAT</code></li>\n<li><code>graphics.TEXTURE_WRAP_REPEAT</code></li>\n</ul>\n<dl>\n<dt><code>min_filter</code></dt>\n<dd><span class=\"type\">number</span> the min filter mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_FILTER_DEFAULT</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR</code></li>\n</ul>\n<dl>\n<dt><code>mag_filter</code></dt>\n<dd><span class=\"type\">number</span> the mag filter mode of the texture sampler</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_FILTER_DEFAULT</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR</code></li>\n</ul>\n<dl>\n<dt><code>max_anisotropy</code></dt>\n<dd><span class=\"type\">number</span> the max anisotropy of the texture sampler</dd>\n</dl>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Get the texture samplers from a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"kd\">local</span> <span class=\"n\">samplers</span> <span class=\"o\">=</span> <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">get_samplers</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.get_constants",
+      "brief": "gets shader constants from a material",
+      "description": "Returns a table of all the shader constants in the material. This function will return all the shader constants\nthat are used in both the vertex and the fragment shaders.",
+      "returnvalues": [
+        {
+          "name": "table",
+          "doc": "A table of tables, where each entry contains info about the shader constants:\n<dl>\n<dt><code>name</code></dt>\n<dd><span class=\"type\">hash</span> the hashed name of the constant</dd>\n<dt><code>type</code></dt>\n<dd><span class=\"type\">number</span> the type of the constant. Supported values:</dd>\n</dl>\n<ul>\n<li><code>material.CONSTANT_TYPE_USER</code></li>\n<li><code>material.CONSTANT_TYPE_USER_MATRIX4</code></li>\n<li><code>material.CONSTANT_TYPE_VIEWPROJ</code></li>\n<li><code>material.CONSTANT_TYPE_WORLD</code></li>\n<li><code>material.CONSTANT_TYPE_TEXTURE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEW</code></li>\n<li><code>material.CONSTANT_TYPE_PROJECTION</code></li>\n<li><code>material.CONSTANT_TYPE_NORMAL</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEW</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEWPROJ</code></li>\n<li><code>material.CONSTANT_TYPE_TIME</code></li>\n<li><code>material.CONSTANT_TYPE_WORLD_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEW_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_PROJECTION_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEWPROJ_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEW_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE</code></li>\n</ul>\n<dl>\n<dt><code>value</code></dt>\n<dd><span class=\"type\">vmath.vector4 | vmath.matrix4</span> the value(s) of the constant. If the constant is an array, the value will be a table of vmath.vector4 or vmath.matrix4 if the type is <code>material.CONSTANT_TYPE_USER_MATRIX4</code>.</dd>\n</dl>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Get the shader constants from a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"kd\">local</span> <span class=\"n\">constants</span> <span class=\"o\">=</span> <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">get_constants</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.get_textures",
+      "brief": "gets textures associated with a material",
+      "description": "Returns a table of all the textures from the material.",
+      "returnvalues": [
+        {
+          "name": "table",
+          "doc": "A table of tables, where each entry contains info about the material textures:\n<dl>\n<dt><code>path</code></dt>\n<dd><span class=\"type\">hash</span> the resource path of the texture. Only available if the texture is a resource.</dd>\n<dt><code>handle</code></dt>\n<dd><span class=\"type\">hash</span> the runtime handle of the texture.</dd>\n<dt><code>width</code></dt>\n<dd><span class=\"type\">number</span> the width of the texture</dd>\n<dt><code>height</code></dt>\n<dd><span class=\"type\">number</span> the height of the texture</dd>\n<dt><code>depth</code></dt>\n<dd><span class=\"type\">number</span> the depth of the texture. Corresponds to the number of layers in an array texture.</dd>\n<dt><code>mipmaps</code></dt>\n<dd><span class=\"type\">number</span> the number of mipmaps in the texture</dd>\n<dt><code>type</code></dt>\n<dd><span class=\"type\">number</span> the type of the texture. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_TYPE_2D</code></li>\n<li><code>graphics.TEXTURE_TYPE_2D_ARRAY</code></li>\n<li><code>graphics.TEXTURE_TYPE_CUBE_MAP</code></li>\n<li><code>graphics.TEXTURE_TYPE_IMAGE_2D</code></li>\n<li><code>graphics.TEXTURE_TYPE_3D</code></li>\n<li><code>graphics.TEXTURE_TYPE_IMAGE_3D</code></li>\n</ul>\n<dl>\n<dt><code>flags</code></dt>\n<dd><span class=\"type\">number</span> the flags of the texture. This field is a bit mask of these supported flags:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_USAGE_FLAG_SAMPLE</code></li>\n<li><code>graphics.TEXTURE_USAGE_FLAG_MEMORYLESS</code></li>\n<li><code>graphics.TEXTURE_USAGE_FLAG_STORAGE</code></li>\n<li><code>graphics.TEXTURE_USAGE_FLAG_INPUT</code></li>\n<li><code>graphics.TEXTURE_USAGE_FLAG_COLOR</code></li>\n</ul>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Get the textures from a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"kd\">local</span> <span class=\"n\">textures</span> <span class=\"o\">=</span> <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">get_textures</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.set_vertex_attributes",
+      "brief": "sets vertex attributes in a material",
+      "description": "Sets vertex attributes in a material, if the vertex attributes exist.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "attributes",
+          "doc": "A table keyed by vertex attribute name with args tables as values. Partial updates are supported. Supported entries:\n<dl>\n<dt><code>value</code></dt>\n<dd><span class=\"type\">vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table</span> the value of the vertex attribute. Use a table of numbers for matrix attributes that do not map to <code>vmath.matrix4</code>.</dd>\n<dt><code>normalize</code></dt>\n<dd><span class=\"type\">boolean</span> whether the value is normalized when passed into the shader</dd>\n<dt><code>data_type</code></dt>\n<dd><span class=\"type\">number</span> the data type of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.DATA_TYPE_BYTE</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_BYTE</code></li>\n<li><code>graphics.DATA_TYPE_SHORT</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_SHORT</code></li>\n<li><code>graphics.DATA_TYPE_INT</code></li>\n<li><code>graphics.DATA_TYPE_UNSIGNED_INT</code></li>\n<li><code>graphics.DATA_TYPE_FLOAT</code></li>\n</ul>\n<dl>\n<dt><code>coordinate_space</code></dt>\n<dd><span class=\"type\">number</span> the coordinate space of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.COORDINATE_SPACE_DEFAULT</code></li>\n<li><code>graphics.COORDINATE_SPACE_WORLD</code></li>\n<li><code>graphics.COORDINATE_SPACE_LOCAL</code></li>\n</ul>\n<dl>\n<dt><code>semantic_type</code></dt>\n<dd><span class=\"type\">number</span> the semantic type of the vertex attribute. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.SEMANTIC_TYPE_NONE</code></li>\n<li><code>graphics.SEMANTIC_TYPE_POSITION</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TEXCOORD</code></li>\n<li><code>graphics.SEMANTIC_TYPE_PAGE_INDEX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_COLOR</code></li>\n<li><code>graphics.SEMANTIC_TYPE_NORMAL</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TANGENT</code></li>\n<li><code>graphics.SEMANTIC_TYPE_WORLD_MATRIX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_NORMAL_MATRIX</code></li>\n<li><code>graphics.SEMANTIC_TYPE_BONE_WEIGHTS</code></li>\n<li><code>graphics.SEMANTIC_TYPE_BONE_INDICES</code></li>\n<li><code>graphics.SEMANTIC_TYPE_TEXTURE_TRANSFORM_2D</code></li>\n</ul>",
+          "types": ["table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Configures a vertex attribute in a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">set_vertex_attributes</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">,</span> <span class=\"p\">{</span>\n        <span class=\"n\">tint_attribute</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">value</span> <span class=\"o\">=</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">vec4</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">1</span><span class=\"p\">),</span> <span class=\"n\">semantic_type</span> <span class=\"o\">=</span> <span class=\"n\">graphics</span><span class=\"p\">.</span><span class=\"n\">SEMANTIC_TYPE_COLOR</span> <span class=\"p\">},</span>\n        <span class=\"n\">weights</span>        <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">value</span> <span class=\"o\">=</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">vec4</span><span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">),</span> <span class=\"n\">semantic_type</span> <span class=\"o\">=</span> <span class=\"n\">graphics</span><span class=\"p\">.</span><span class=\"n\">SEMANTIC_TYPE_NONE</span> <span class=\"p\">}</span>\n    <span class=\"p\">})</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.set_samplers",
+      "brief": "sets texture samplers in a material",
+      "description": "Sets texture samplers in a material, if the samplers exist. Use this function to change the settings of texture samplers.\nTo set actual textures that should be bound to the samplers, use the <code>material.set_textures</code> function instead.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "samplers",
+          "doc": "A table keyed by sampler name with args tables as values. Partial updates are supported. Supported entries:\n<dl>\n<dt><code>u_wrap</code></dt>\n<dd><span class=\"type\">number</span> the u wrap mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_BORDER</code></li>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_EDGE</code></li>\n<li><code>graphics.TEXTURE_WRAP_MIRRORED_REPEAT</code></li>\n<li><code>graphics.TEXTURE_WRAP_REPEAT</code></li>\n</ul>\n<dl>\n<dt><code>v_wrap</code></dt>\n<dd><span class=\"type\">number</span> the v wrap mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_BORDER</code></li>\n<li><code>graphics.TEXTURE_WRAP_CLAMP_TO_EDGE</code></li>\n<li><code>graphics.TEXTURE_WRAP_MIRRORED_REPEAT</code></li>\n<li><code>graphics.TEXTURE_WRAP_REPEAT</code></li>\n</ul>\n<dl>\n<dt><code>min_filter</code></dt>\n<dd><span class=\"type\">number</span> the min filter mode of the texture sampler. Supported values:</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_FILTER_DEFAULT</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR</code></li>\n</ul>\n<dl>\n<dt><code>mag_filter</code></dt>\n<dd><span class=\"type\">number</span> the mag filter mode of the texture sampler</dd>\n</dl>\n<ul>\n<li><code>graphics.TEXTURE_FILTER_DEFAULT</code></li>\n<li><code>graphics.TEXTURE_FILTER_NEAREST</code></li>\n<li><code>graphics.TEXTURE_FILTER_LINEAR</code></li>\n</ul>\n<dl>\n<dt><code>max_anisotropy</code></dt>\n<dd><span class=\"type\">number</span> the max anisotropy of the texture sampler</dd>\n</dl>",
+          "types": ["table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Configures a sampler in a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">set_samplers</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">,</span> <span class=\"p\">{</span>\n        <span class=\"n\">texture_sampler</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">u_wrap</span> <span class=\"o\">=</span> <span class=\"n\">graphics</span><span class=\"p\">.</span><span class=\"n\">TEXTURE_WRAP_REPEAT</span><span class=\"p\">,</span> <span class=\"n\">v_wrap</span> <span class=\"o\">=</span> <span class=\"n\">graphics</span><span class=\"p\">.</span><span class=\"n\">TEXTURE_WRAP_MIRRORED_REPEAT</span> <span class=\"p\">}</span>\n    <span class=\"p\">})</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.set_constants",
+      "brief": "sets shader constants in a material",
+      "description": "Sets shader constants in a material, if the constants exist.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "constants",
+          "doc": "A table keyed by constant name with args tables as values. Constants can be partially updated. Supported entries:\n<dl>\n<dt><code>type</code></dt>\n<dd><span class=\"type\">number</span> the type of the constant. Supported values:</dd>\n</dl>\n<ul>\n<li><code>material.CONSTANT_TYPE_USER</code></li>\n<li><code>material.CONSTANT_TYPE_USER_MATRIX4</code></li>\n<li><code>material.CONSTANT_TYPE_VIEWPROJ</code></li>\n<li><code>material.CONSTANT_TYPE_WORLD</code></li>\n<li><code>material.CONSTANT_TYPE_TEXTURE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEW</code></li>\n<li><code>material.CONSTANT_TYPE_PROJECTION</code></li>\n<li><code>material.CONSTANT_TYPE_NORMAL</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEW</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEWPROJ</code></li>\n<li><code>material.CONSTANT_TYPE_TIME</code></li>\n<li><code>material.CONSTANT_TYPE_WORLD_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEW_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_PROJECTION_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_VIEWPROJ_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEW_INVERSE</code></li>\n<li><code>material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE</code></li>\n</ul>\n<dl>\n<dt><code>value</code></dt>\n<dd><span class=\"type\">vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table</span> the value(s) of the constant. If the shader constant is an array, the amount of values to update depends on how many values that are passed in the 'value' field.</dd>\n</dl>",
+          "types": ["table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Set a shader constant in a material specified as a resource property\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">update</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"c1\">-- update the &#39;tint&#39; constant</span>\n    <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">set_constants</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">,</span> <span class=\"p\">{</span>\n        <span class=\"n\">tint</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">value</span> <span class=\"o\">=</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">vector4</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">,</span> <span class=\"mi\">1</span><span class=\"p\">)</span> <span class=\"p\">}</span>\n    <span class=\"p\">})</span>\n    <span class=\"c1\">-- change the type of the &#39;view_proj&#39; constant to CONSTANT_TYPE_USER_MATRIX4 so the renderer can set our custom data</span>\n    <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">set_constants</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">,</span> <span class=\"p\">{</span>\n        <span class=\"n\">view_proj</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"n\">value</span> <span class=\"o\">=</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_view_proj</span><span class=\"p\">,</span> <span class=\"nb\">type</span> <span class=\"o\">=</span> <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">CONSTANT_TYPE_USER_MATRIX4</span> <span class=\"p\">}</span>\n    <span class=\"p\">})</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "material.set_textures",
+      "brief": "sets textures in a material",
+      "description": "Sets textures in a material, if the samplers exist.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "The path to the resource",
+          "types": ["hash", "string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "textures",
+          "doc": "A table keyed by sampler name with texture resources as values.",
+          "types": ["table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Set a texture in a material from a resource\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_material&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">material</span><span class=\"p\">())</span>\n<span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_texture&quot;</span><span class=\"p\">,</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">texture</span><span class=\"p\">())</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"n\">material</span><span class=\"p\">.</span><span class=\"n\">set_textures</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_material</span><span class=\"p\">,</span> <span class=\"p\">{</span>\n        <span class=\"n\">my_texture</span> <span class=\"o\">=</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_texture</span>\n    <span class=\"p\">})</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "material",
+    "name": "Material",
+    "brief": "Material API documentation",
+    "description": "Functions for interacting with materials.",
+    "path": "engine/gamesys/src/gamesys/scripts/script_material.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}