Default 3D rendering material.
This provides a default material with a wide variety of rendering features and properties without the need to write shader code. See the tutorial below for details.
$DOCS_URL/tutorials/3d/spatial_material.html
Returns [code]true[/code], if the specified [enum Feature] is enabled.
Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options.
Returns the [Texture] associated with the specified [enum TextureParam].
If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [SpatialMaterial]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code].
If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options.
Sets the [Texture] to be used by the specified [enum TextureParam]. This function is called when setting members ending in [code]*_texture[/code].
- The material's base color.
- Texture to multiply by [member albedo_color]. Used for basic texturing of objects.
- The strength of the anisotropy effect. This is multiplied by [member anisotropy_flowmap]'s alpha channel if a texture is defined there and the texture contains an alpha channel.
- If [code]true[/code], anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections. [b]Note:[/b] Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken. [b]Note:[/b] Material anisotropy should not to be confused with anisotropic texture filtering. Anisotropic texture filtering can be enabled by selecting a texture in the FileSystem dock, going to the Import dock, checking the [b]Anisotropic[/b] checkbox then clicking [b]Reimport[/b]. The anisotropic filtering level can be changed by adjusting [member ProjectSettings.rendering/quality/filters/anisotropic_filter_level].
- Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion. If present, the texture's alpha channel will be used to multiply the strength of the [member anisotropy] effect. Fully opaque pixels will keep the anisotropy effect's original strength while fully transparent pixels will disable the anisotropy effect entirely. The flowmap texture's blue channel is ignored.
- If [code]true[/code], ambient occlusion is enabled. Ambient occlusion darkens areas based on the [member ao_texture].
- Amount that ambient occlusion affects lighting from lights. If [code]0[/code], ambient occlusion only affects ambient light. If [code]1[/code], ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic.
- If [code]true[/code], use [code]UV2[/code] coordinates to look up from the [member ao_texture].
- Texture that defines the amount of ambient occlusion for a given point on the object.
- Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
- If [member ProjectSettings.rendering/gles3/shaders/shader_compilation_mode] is [code]Synchronous[/code] (with or without cache), this determines how this material must behave in regards to asynchronous shader compilation. [constant ASYNC_MODE_VISIBLE] is the default and the best for most cases.
- Sets the strength of the clearcoat effect. Setting to [code]0[/code] looks the same as disabling the clearcoat effect.
- If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough. [b]Note:[/b] Clearcoat rendering is not visible if the material has [member flags_unshaded] set to [code]true[/code].
- Sets the roughness of the clearcoat pass. A higher value results in a smoother clearcoat while a lower value results in a rougher clearcoat.
- Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel.
- If [code]true[/code], the shader will read depth texture at multiple points along the view ray to determine occlusion and parrallax. This can be very performance demanding, but results in more realistic looking depth mapping.
- If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled]. [b]Note:[/b] Depth mapping is not supported if triplanar mapping is used on the same material. The value of [member depth_enabled] will be ignored if [member uv1_triplanar] is enabled.
- If [code]true[/code], direction of the binormal is flipped before using in the depth effect. This may be necessary if you have encoded your binormals in a way that is conflicting with the depth effect.
- If [code]true[/code], direction of the tangent is flipped before using in the depth effect. This may be necessary if you have encoded your tangents in a way that is conflicting with the depth effect.
- Number of layers to use when using [member depth_deep_parallax] and the view direction is perpendicular to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp.
- Number of layers to use when using [member depth_deep_parallax] and the view direction is parallel to the surface of the object. A higher number will be more performance demanding while a lower number may not look as crisp.
- Scales the depth offset effect. A higher number will create a larger depth.
- Texture used to determine depth at a given pixel. Depth is always stored in the red channel.
- Texture that specifies the color of the detail overlay.
- Specifies how the [member detail_albedo] should blend with the current [code]ALBEDO[/code]. See [enum BlendMode] for options.
- If [code]true[/code], enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on [member detail_mask]. This can be used to add variation to objects, or to blend between two different albedo/normal textures.
- Texture used to specify how the detail textures get blended with the base textures.
- Texture that specifies the per-pixel normal of the detail overlay. [b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
- Specifies whether to use [code]UV[/code] or [code]UV2[/code] for the detail layer. See [enum DetailUV] for options.
- Distance at which the object appears fully opaque. [b]Note:[/b] If [code]distance_fade_max_distance[/code] is less than [code]distance_fade_min_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
- Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible. [b]Note:[/b] If [code]distance_fade_min_distance[/code] is greater than [code]distance_fade_max_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
- Specifies which type of fade to use. Can be any of the [enum DistanceFadeMode]s.
- The emitted light's color. See [member emission_enabled].
- If [code]true[/code], the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a [GIProbe] or [BakedLightmap] is used and this object is used in baked lighting.
- The emitted light's strength. See [member emission_enabled].
- Use [code]UV2[/code] to read from the [member emission_texture].
- Sets how [member emission] interacts with [member emission_texture]. Can either add or multiply. See [enum EmissionOperator] for options.
- Texture that specifies how much surface emits light at a given point.
- Forces a conversion of the [member albedo_texture] from sRGB space to linear space.
- Enables signed distance field rendering shader.
- If [code]true[/code], the object receives no ambient light.
- If [code]true[/code], the object receives no shadow that would otherwise be cast onto it.
- If [code]true[/code], the shader will compute extra operations to make sure the normal stays correct when using a non-uniform scale. Only enable if using non-uniform scaling.
- If [code]true[/code], the object is rendered at the same size regardless of distance.
- If [code]true[/code], depth testing is disabled and the object will be drawn in render order.
- If [code]true[/code], transparency is enabled on the body. See also [member params_blend_mode].
- If [code]true[/code], the object is unaffected by lighting.
- If [code]true[/code], render point size can be changed. [b]Note:[/b] This is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size].
- If [code]true[/code], enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR.
- If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices, especially for meshes with a lower polygon count. The downside is that shading becomes much less accurate, with visible linear interpolation between vertices that are joined together. This can be compensated by ensuring meshes have a sufficient level of subdivision (but not too much, to avoid reducing performance). Some material features are also not supported when vertex shading is enabled. See also [member ProjectSettings.rendering/quality/shading/force_vertex_shading] which can globally enable vertex shading on all materials. [b]Note:[/b] By default, vertex shading is enforced on mobile platforms by [member ProjectSettings.rendering/quality/shading/force_vertex_shading]'s [code]mobile[/code] override. [b]Note:[/b] [member flags_vertex_lighting] has no effect if [member flags_unshaded] is [code]true[/code].
- If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar].
- A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between [code]0[/code] and [code]1[/code] should only be used for blending between metal and non-metal sections. To alter the amount of reflection use [member roughness].
- Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources. [b]Note:[/b] Unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness].
- Texture used to specify metallic for an object. This is multiplied by [member metallic].
- Specifies the channel of the [member metallic_texture] in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
- If [code]true[/code], normal mapping is enabled.
- The strength of the normal map's effect.
- Texture used to specify the normal at a given pixel. The [code]normal_texture[/code] only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [code]normal_texture[/code] is oriented around the surface normal provided by the [Mesh]. [b]Note:[/b] The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with [SurfaceTool], you can use [method SurfaceTool.generate_normals] and [method SurfaceTool.generate_tangents] to automatically generate normals and tangents respectively. [b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
- Threshold at which the alpha scissor will discard values.
- If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when [member params_billboard_mode] is [constant BILLBOARD_ENABLED].
- Controls how the object faces the camera. See [enum BillboardMode]. [b]Note:[/b] Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See [url=https://github.com/godotengine/godot/issues/41567]GitHub issue #41567[/url] for details.
- The material's blend mode. [b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode].
- Which side of the object is not drawn when backfaces are rendered. See [enum CullMode].
- Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member flags_transparent].
- The algorithm used for diffuse light scattering. See [enum DiffuseMode].
- If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount].
- Grows object vertices in the direction of their normals.
- Currently unimplemented in Godot.
- The point size in pixels. See [member flags_use_point_size].
- The method for rendering the specular blob. See [enum SpecularMode].
- If [code]true[/code], the shader will discard all pixels that have an alpha value less than [member params_alpha_scissor_threshold].
- The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
- If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
- The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
- Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade.
- If [code]true[/code], the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object.
- If [code]true[/code], the refraction effect is enabled. Refraction distorts transparency based on light from behind the object. When using the GLES3 backend, the material's roughness value will affect the blurriness of the refraction. Higher roughness values will make the refraction look blurrier.
- The strength of the refraction effect. Higher values result in a more distorted appearance for the refraction.
- Texture that controls the strength of the refraction per-pixel. Multiplied by [member refraction_scale].
- Specifies the channel of the [member refraction_texture] in which the refraction information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
- Sets the strength of the rim lighting effect.
- If [code]true[/code], rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object. [b]Note:[/b] Rim lighting is not visible if the material has [member flags_unshaded] set to [code]true[/code].
- Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by [member rim].
- The amount of to blend light and albedo color when rendering rim effect. If [code]0[/code] the light color is used, while [code]1[/code] means albedo color is used. An intermediate value generally works best.
- Surface reflection. A value of [code]0[/code] represents a perfect mirror while a value of [code]1[/code] completely blurs the reflection. See also [member metallic].
- Texture used to control the roughness per-pixel. Multiplied by [member roughness].
- Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
- If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges.
- The strength of the subsurface scattering effect.
- Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by [member subsurf_scatter_strength].
- The color used by the transmission effect. Represents the light passing through an object.
- If [code]true[/code], the transmission effect is enabled.
- Texture used to control the transmission effect per-pixel. Added to [member transmission].
- How much to offset the [code]UV[/code] coordinates. This amount will be added to [code]UV[/code] in the vertex function. This can be used to offset a texture.
- How much to scale the [code]UV[/code] coordinates. This is multiplied by [code]UV[/code] in the vertex function.
- If [code]true[/code], instead of using [code]UV[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
- A lower number blends the texture more softly while a higher number blends the texture more sharply.
- How much to offset the [code]UV2[/code] coordinates. This amount will be added to [code]UV2[/code] in the vertex function. This can be used to offset a texture.
- How much to scale the [code]UV2[/code] coordinates. This is multiplied by [code]UV2[/code] in the vertex function.
- If [code]true[/code], instead of using [code]UV2[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
- A lower number blends the texture more softly while a higher number blends the texture more sharply.
- If [code]true[/code], the model's vertex colors are processed as sRGB mode.
- If [code]true[/code], the vertex color is used as albedo color.
Texture specifying per-pixel color.
Texture specifying per-pixel metallic value.
Texture specifying per-pixel roughness value.
Texture specifying per-pixel emission color.
Texture specifying per-pixel normal vector.
Texture specifying per-pixel rim value.
Texture specifying per-pixel clearcoat value.
Texture specifying per-pixel flowmap direction for use with [member anisotropy].
Texture specifying per-pixel ambient occlusion value.
Texture specifying per-pixel depth.
Texture specifying per-pixel subsurface scattering.
Texture specifying per-pixel transmission color.
Texture specifying per-pixel refraction strength.
Texture specifying per-pixel detail mask blending value.
Texture specifying per-pixel detail color.
Texture specifying per-pixel detail normal.
Represents the size of the [enum TextureParam] enum.
Use [code]UV[/code] with the detail texture.
Use [code]UV2[/code] with the detail texture.
Constant for setting [member flags_transparent].
Constant for setting [member emission_enabled].
Constant for setting [member normal_enabled].
Constant for setting [member rim_enabled].
Constant for setting [member clearcoat_enabled].
Constant for setting [member anisotropy_enabled].
Constant for setting [member ao_enabled].
Constant for setting [member depth_enabled].
Constant for setting [member subsurf_scatter_enabled].
Constant for setting [member transmission_enabled].
Constant for setting [member refraction_enabled].
Constant for setting [member detail_enabled].
Represents the size of the [enum Feature] enum.
Default blend mode. The color of the object is blended over the background based on the object's alpha value.
The color of the object is added to the background.
The color of the object is subtracted from the background.
The color of the object is multiplied by the background.
Default depth draw mode. Depth is drawn only for opaque objects.
Depth draw is calculated for both opaque and transparent objects.
No depth draw.
For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn.
Default cull mode. The back of the object is culled when not visible.
The front of the object is culled when not visible.
No culling is performed.
No lighting is used on the object. Color comes directly from [code]ALBEDO[/code].
Lighting is calculated per-vertex rather than per-pixel. This can be used to increase the speed of the shader at the cost of quality.
Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
Set [code]ALBEDO[/code] to the per-vertex color specified in the mesh.
Vertex color is in sRGB space and needs to be converted to linear. Only applies in the GLES3 renderer.
Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use [code]POINT_COORD[/code] instead of [code]UV[/code].
Object is scaled by depth so that it always appears the same size on screen.
Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when [member params_billboard_mode] is [constant BILLBOARD_ENABLED].
Use triplanar texture lookup for all texture lookups that would normally use [code]UV[/code].
Use triplanar texture lookup for all texture lookups that would normally use [code]UV2[/code].
Use [code]UV2[/code] coordinates to look up from the [member ao_texture].
Use [code]UV2[/code] coordinates to look up from the [member emission_texture].
Use alpha scissor. Set by [member params_use_alpha_scissor].
Use world coordinates in the triplanar texture lookup instead of local coordinates.
Forces the shader to convert albedo from sRGB space to linear space.
Disables receiving shadows from other objects.
Disables receiving ambient light.
Ensures that normals appear correct, even with non-uniform scaling.
Enables the shadow to opacity feature.
Enables signed distance field rendering shader.
Represents the size of the [enum Flags] enum.
Default diffuse scattering algorithm.
Diffuse scattering ignores roughness.
Extends Lambert to cover more than 90 degrees when roughness increases.
Attempts to use roughness to emulate microsurfacing.
Uses a hard cut for lighting, with smoothing affected by roughness.
Default specular blob.
Older specular algorithm, included for compatibility.
Older specular algorithm, included for compatibility.
Toon blob which changes size based on roughness.
No specular blob.
Billboard mode is disabled.
The object's Z axis will always face the camera.
The object's X axis will always face the camera.
Used for particle systems when assigned to [Particles] and [CPUParticles] nodes. Enables [code]particles_anim_*[/code] properties. The [member ParticlesMaterial.anim_speed] or [member CPUParticles.anim_speed] should also be set to a positive value for the animation to play.
Used to read from the red channel of a texture.
Used to read from the green channel of a texture.
Used to read from the blue channel of a texture.
Used to read from the alpha channel of a texture.
Currently unused.
Adds the emission color to the color from the emission texture.
Multiplies the emission color by the color from the emission texture.
Do not use distance fade.
Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel.
Smoothly fades the object out based on each pixel's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
Smoothly fades the object out based on the object's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
The real conditioned shader needed on each situation will be sent for background compilation. In the meantime, a very complex shader that adapts to every situation will be used ("ubershader"). This ubershader is much slower to render, but will keep the game running without stalling to compile. Once shader compilation is done, the ubershader is replaced by the traditional optimized shader.
Anything with this material applied won't be rendered while this material's shader is being compiled. This is useful for optimization, in cases where the visuals won't suffer from having certain non-essential elements missing during the short time their shaders are being compiled.