godot/doc/classes/ShaderInclude.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

18 lines
1.1 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ShaderInclude" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
2023-06-22 22:06:20 +08:00
A snippet of shader code to be included in a [Shader] with [code]#include[/code].
</brief_description>
<description>
2023-06-22 22:06:20 +08:00
A shader include file, saved with the [code].gdshaderinc[/code] extension. This class allows you to define a custom shader snippet that can be included in a [Shader] by using the preprocessor directive [code]#include[/code], followed by the file path (e.g. [code]#include "res://shader_lib.gdshaderinc"[/code]). The snippet doesn't have to be a valid shader on its own.
</description>
<tutorials>
2023-06-22 22:06:20 +08:00
<link title="Shader preprocessor">$DOCS_URL/tutorials/shaders/shader_reference/shader_preprocessor.html</link>
</tutorials>
<members>
<member name="code" type="String" setter="set_code" getter="get_code" default="&quot;&quot;">
2023-06-22 22:06:20 +08:00
Returns the code of the shader include file. The returned text is what the user has written, not the full generated code used internally.
</member>
</members>
</class>