Skip to main content

Shader

The shader interface

Shader.clear()
Shader.activate_group("intro_base")

Functions​

clear​

</>
Shader.clear() → ()

Removes all active shader

add​

</>
Shader.add(
id: string,--

shader identifier

options: table--

settings

) → ()

Activates a specific shader

Options

Name Type Default Description
fade_delta number 0 fade time (s)

add_group​

</>
Shader.add_group(
group: string,--

shader group identifier

options: table--

settings

) → ()

Activates a group of shaders

Options

Name Type Default Description
fade_delta number 0 fade time (s)

remove​

</>
Shader.remove(
id: string,--

shader identifier

options: table--

settings

) → ()

Deactivates a specific shader

Options

Name Type Default Description
fade_delta number 0 fade time (s)

remove_group​

</>
Shader.remove_group(
group: string,--

shader group identifier

options: table--

settings

) → ()

Deactivates a group of shaders

Options

Name Type Default Description
fade_delta number 0 fade time (s)
Show raw api
{
    "functions": [
        {
            "name": "clear",
            "desc": "Removes all active shader",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "../../res/data/script/lib/system/shader.lua"
            }
        },
        {
            "name": "add",
            "desc": "Activates a specific shader\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| fade_delta      | number      |       0 | fade time (s)                  |",
            "params": [
                {
                    "name": "id",
                    "desc": "shader identifier",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "../../res/data/script/lib/system/shader.lua"
            }
        },
        {
            "name": "add_group",
            "desc": "Activates a group of shaders\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| fade_delta      | number      |       0 | fade time (s)                  |",
            "params": [
                {
                    "name": "group",
                    "desc": "shader group identifier",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "../../res/data/script/lib/system/shader.lua"
            }
        },
        {
            "name": "remove",
            "desc": "Deactivates a specific shader\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| fade_delta      | number      |       0 | fade time (s)                  |",
            "params": [
                {
                    "name": "id",
                    "desc": "shader identifier",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "../../res/data/script/lib/system/shader.lua"
            }
        },
        {
            "name": "remove_group",
            "desc": "Deactivates a group of shaders\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| fade_delta      | number      |       0 | fade time (s)                  |",
            "params": [
                {
                    "name": "group",
                    "desc": "shader group identifier",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "../../res/data/script/lib/system/shader.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Shader",
    "desc": "The shader interface\n\n```lua\nShader.clear()\nShader.activate_group(\"intro_base\")\n```",
    "source": {
        "line": 10,
        "path": "../../res/data/script/lib/system/shader.lua"
    }
}