Outdated documentation

This documentation page refers to Godot 4.3, and may be outdated or incorrect.
Additionally, this engine version is no longer supported.

Check this page in the stable branch for the latest additions and corrections.

ShaderInclude

Inherits: Resource < RefCounted < Object

A snippet of shader code to be included in a Shader with #include.

Description

A shader include file, saved with the .gdshaderinc extension. This class allows you to define a custom shader snippet that can be included in a Shader by using the preprocessor directive #include, followed by the file path (e.g. #include "res://shader_lib.gdshaderinc"). The snippet doesn't have to be a valid shader on its own.

Tutorials

Shader preprocessor

Properties

String

code

""

Property Descriptions

String code = "" 🔗

void set_code(value: String)
String get_code()

Returns the code of the shader include file. The returned text is what the user has written, not the full generated code used internally.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.