godot-docs/classes/class_basematerial3d.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/BaseMaterial3D.xml.

.. _class_BaseMaterial3D:

BaseMaterial3D
==============

**Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`ORMMaterial3D<class_ORMMaterial3D>`, :ref:`StandardMaterial3D<class_StandardMaterial3D>`

Default 3D rendering material.

.. rst-class:: classref-introduction-group

Description
-----------

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.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`Standard Material 3D <../tutorials/3d/standard_material_3d>`

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Color<class_Color>`                                       | :ref:`albedo_color<class_BaseMaterial3D_property_albedo_color>`                                                   | ``Color(1, 1, 1, 1)`` |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`albedo_texture<class_BaseMaterial3D_property_albedo_texture>`                                               |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>`                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`albedo_texture_msdf<class_BaseMaterial3D_property_albedo_texture_msdf>`                                     | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`alpha_antialiasing_edge<class_BaseMaterial3D_property_alpha_antialiasing_edge>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` | :ref:`alpha_antialiasing_mode<class_BaseMaterial3D_property_alpha_antialiasing_mode>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`alpha_hash_scale<class_BaseMaterial3D_property_alpha_hash_scale>`                                           |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`alpha_scissor_threshold<class_BaseMaterial3D_property_alpha_scissor_threshold>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`anisotropy<class_BaseMaterial3D_property_anisotropy>`                                                       | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`anisotropy_enabled<class_BaseMaterial3D_property_anisotropy_enabled>`                                       | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`anisotropy_flowmap<class_BaseMaterial3D_property_anisotropy_flowmap>`                                       |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`ao_enabled<class_BaseMaterial3D_property_ao_enabled>`                                                       | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`ao_light_affect<class_BaseMaterial3D_property_ao_light_affect>`                                             | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`ao_on_uv2<class_BaseMaterial3D_property_ao_on_uv2>`                                                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`ao_texture<class_BaseMaterial3D_property_ao_texture>`                                                       |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>`       | :ref:`ao_texture_channel<class_BaseMaterial3D_property_ao_texture_channel>`                                       | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Color<class_Color>`                                       | :ref:`backlight<class_BaseMaterial3D_property_backlight>`                                                         | ``Color(0, 0, 0, 1)`` |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`backlight_enabled<class_BaseMaterial3D_property_backlight_enabled>`                                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`backlight_texture<class_BaseMaterial3D_property_backlight_texture>`                                         |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`billboard_keep_scale<class_BaseMaterial3D_property_billboard_keep_scale>`                                   | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>`         | :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>`                                               | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>`                 | :ref:`blend_mode<class_BaseMaterial3D_property_blend_mode>`                                                       | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`clearcoat<class_BaseMaterial3D_property_clearcoat>`                                                         | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`clearcoat_enabled<class_BaseMaterial3D_property_clearcoat_enabled>`                                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`clearcoat_roughness<class_BaseMaterial3D_property_clearcoat_roughness>`                                     | ``0.5``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`clearcoat_texture<class_BaseMaterial3D_property_clearcoat_texture>`                                         |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`CullMode<enum_BaseMaterial3D_CullMode>`                   | :ref:`cull_mode<class_BaseMaterial3D_property_cull_mode>`                                                         | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>`         | :ref:`depth_draw_mode<class_BaseMaterial3D_property_depth_draw_mode>`                                             | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>`                                                 |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>`                 | :ref:`detail_blend_mode<class_BaseMaterial3D_property_detail_blend_mode>`                                         | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`detail_enabled<class_BaseMaterial3D_property_detail_enabled>`                                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`detail_mask<class_BaseMaterial3D_property_detail_mask>`                                                     |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`detail_normal<class_BaseMaterial3D_property_detail_normal>`                                                 |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`DetailUV<enum_BaseMaterial3D_DetailUV>`                   | :ref:`detail_uv_layer<class_BaseMaterial3D_property_detail_uv_layer>`                                             | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>`             | :ref:`diffuse_mode<class_BaseMaterial3D_property_diffuse_mode>`                                                   | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`disable_ambient_light<class_BaseMaterial3D_property_disable_ambient_light>`                                 | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`disable_receive_shadows<class_BaseMaterial3D_property_disable_receive_shadows>`                             | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`distance_fade_max_distance<class_BaseMaterial3D_property_distance_fade_max_distance>`                       | ``10.0``              |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`distance_fade_min_distance<class_BaseMaterial3D_property_distance_fade_min_distance>`                       | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>`   | :ref:`distance_fade_mode<class_BaseMaterial3D_property_distance_fade_mode>`                                       | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Color<class_Color>`                                       | :ref:`emission<class_BaseMaterial3D_property_emission>`                                                           | ``Color(0, 0, 0, 1)`` |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`emission_enabled<class_BaseMaterial3D_property_emission_enabled>`                                           | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`emission_energy_multiplier<class_BaseMaterial3D_property_emission_energy_multiplier>`                       | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`emission_intensity<class_BaseMaterial3D_property_emission_intensity>`                                       |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`emission_on_uv2<class_BaseMaterial3D_property_emission_on_uv2>`                                             | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>`   | :ref:`emission_operator<class_BaseMaterial3D_property_emission_operator>`                                         | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`emission_texture<class_BaseMaterial3D_property_emission_texture>`                                           |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`fixed_size<class_BaseMaterial3D_property_fixed_size>`                                                       | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`grow<class_BaseMaterial3D_property_grow>`                                                                   | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`grow_amount<class_BaseMaterial3D_property_grow_amount>`                                                     | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`heightmap_deep_parallax<class_BaseMaterial3D_property_heightmap_deep_parallax>`                             | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>`                                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`heightmap_flip_binormal<class_BaseMaterial3D_property_heightmap_flip_binormal>`                             | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`heightmap_flip_tangent<class_BaseMaterial3D_property_heightmap_flip_tangent>`                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`heightmap_flip_texture<class_BaseMaterial3D_property_heightmap_flip_texture>`                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`int<class_int>`                                           | :ref:`heightmap_max_layers<class_BaseMaterial3D_property_heightmap_max_layers>`                                   |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`int<class_int>`                                           | :ref:`heightmap_min_layers<class_BaseMaterial3D_property_heightmap_min_layers>`                                   |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>`                                             | ``5.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`heightmap_texture<class_BaseMaterial3D_property_heightmap_texture>`                                         |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`metallic<class_BaseMaterial3D_property_metallic>`                                                           | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`metallic_specular<class_BaseMaterial3D_property_metallic_specular>`                                         | ``0.5``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`metallic_texture<class_BaseMaterial3D_property_metallic_texture>`                                           |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>`       | :ref:`metallic_texture_channel<class_BaseMaterial3D_property_metallic_texture_channel>`                           | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`msdf_outline_size<class_BaseMaterial3D_property_msdf_outline_size>`                                         | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`msdf_pixel_range<class_BaseMaterial3D_property_msdf_pixel_range>`                                           | ``4.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`no_depth_test<class_BaseMaterial3D_property_no_depth_test>`                                                 | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`normal_enabled<class_BaseMaterial3D_property_normal_enabled>`                                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`normal_scale<class_BaseMaterial3D_property_normal_scale>`                                                   | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`normal_texture<class_BaseMaterial3D_property_normal_texture>`                                               |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`orm_texture<class_BaseMaterial3D_property_orm_texture>`                                                     |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`int<class_int>`                                           | :ref:`particles_anim_h_frames<class_BaseMaterial3D_property_particles_anim_h_frames>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`particles_anim_loop<class_BaseMaterial3D_property_particles_anim_loop>`                                     |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`int<class_int>`                                           | :ref:`particles_anim_v_frames<class_BaseMaterial3D_property_particles_anim_v_frames>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`point_size<class_BaseMaterial3D_property_point_size>`                                                       | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`proximity_fade_distance<class_BaseMaterial3D_property_proximity_fade_distance>`                             | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`proximity_fade_enabled<class_BaseMaterial3D_property_proximity_fade_enabled>`                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`refraction_enabled<class_BaseMaterial3D_property_refraction_enabled>`                                       | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`refraction_scale<class_BaseMaterial3D_property_refraction_scale>`                                           | ``0.05``              |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`refraction_texture<class_BaseMaterial3D_property_refraction_texture>`                                       |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>`       | :ref:`refraction_texture_channel<class_BaseMaterial3D_property_refraction_texture_channel>`                       | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`rim<class_BaseMaterial3D_property_rim>`                                                                     | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`rim_enabled<class_BaseMaterial3D_property_rim_enabled>`                                                     | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`rim_texture<class_BaseMaterial3D_property_rim_texture>`                                                     |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`rim_tint<class_BaseMaterial3D_property_rim_tint>`                                                           | ``0.5``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`roughness<class_BaseMaterial3D_property_roughness>`                                                         | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`roughness_texture<class_BaseMaterial3D_property_roughness_texture>`                                         |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>`       | :ref:`roughness_texture_channel<class_BaseMaterial3D_property_roughness_texture_channel>`                         | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>`             | :ref:`shading_mode<class_BaseMaterial3D_property_shading_mode>`                                                   | ``1``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`shadow_to_opacity<class_BaseMaterial3D_property_shadow_to_opacity>`                                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>`           | :ref:`specular_mode<class_BaseMaterial3D_property_specular_mode>`                                                 | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`subsurf_scatter_enabled<class_BaseMaterial3D_property_subsurf_scatter_enabled>`                             | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`subsurf_scatter_skin_mode<class_BaseMaterial3D_property_subsurf_scatter_skin_mode>`                         | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`subsurf_scatter_strength<class_BaseMaterial3D_property_subsurf_scatter_strength>`                           | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`subsurf_scatter_texture<class_BaseMaterial3D_property_subsurf_scatter_texture>`                             |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`subsurf_scatter_transmittance_boost<class_BaseMaterial3D_property_subsurf_scatter_transmittance_boost>`     | ``0.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Color<class_Color>`                                       | :ref:`subsurf_scatter_transmittance_color<class_BaseMaterial3D_property_subsurf_scatter_transmittance_color>`     | ``Color(1, 1, 1, 1)`` |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`subsurf_scatter_transmittance_depth<class_BaseMaterial3D_property_subsurf_scatter_transmittance_depth>`     | ``0.1``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`subsurf_scatter_transmittance_enabled<class_BaseMaterial3D_property_subsurf_scatter_transmittance_enabled>` | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Texture2D<class_Texture2D>`                               | :ref:`subsurf_scatter_transmittance_texture<class_BaseMaterial3D_property_subsurf_scatter_transmittance_texture>` |                       |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>`         | :ref:`texture_filter<class_BaseMaterial3D_property_texture_filter>`                                               | ``3``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`texture_repeat<class_BaseMaterial3D_property_texture_repeat>`                                               | ``true``              |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Transparency<enum_BaseMaterial3D_Transparency>`           | :ref:`transparency<class_BaseMaterial3D_property_transparency>`                                                   | ``0``                 |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`use_particle_trails<class_BaseMaterial3D_property_use_particle_trails>`                                     | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`use_point_size<class_BaseMaterial3D_property_use_point_size>`                                               | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv1_offset<class_BaseMaterial3D_property_uv1_offset>`                                                       | ``Vector3(0, 0, 0)``  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv1_scale<class_BaseMaterial3D_property_uv1_scale>`                                                         | ``Vector3(1, 1, 1)``  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`uv1_triplanar<class_BaseMaterial3D_property_uv1_triplanar>`                                                 | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`uv1_triplanar_sharpness<class_BaseMaterial3D_property_uv1_triplanar_sharpness>`                             | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`uv1_world_triplanar<class_BaseMaterial3D_property_uv1_world_triplanar>`                                     | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv2_offset<class_BaseMaterial3D_property_uv2_offset>`                                                       | ``Vector3(0, 0, 0)``  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`Vector3<class_Vector3>`                                   | :ref:`uv2_scale<class_BaseMaterial3D_property_uv2_scale>`                                                         | ``Vector3(1, 1, 1)``  |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`uv2_triplanar<class_BaseMaterial3D_property_uv2_triplanar>`                                                 | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`float<class_float>`                                       | :ref:`uv2_triplanar_sharpness<class_BaseMaterial3D_property_uv2_triplanar_sharpness>`                             | ``1.0``               |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`uv2_world_triplanar<class_BaseMaterial3D_property_uv2_world_triplanar>`                                     | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`vertex_color_is_srgb<class_BaseMaterial3D_property_vertex_color_is_srgb>`                                   | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+
   | :ref:`bool<class_bool>`                                         | :ref:`vertex_color_use_as_albedo<class_BaseMaterial3D_property_vertex_color_use_as_albedo>`                       | ``false``             |
   +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`get_feature<class_BaseMaterial3D_method_get_feature>` **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|                                            |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`           | :ref:`get_flag<class_BaseMaterial3D_method_get_flag>` **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|                                                         |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`get_texture<class_BaseMaterial3D_method_get_texture>` **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|                                    |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_feature<class_BaseMaterial3D_method_set_feature>` **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**                    |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_flag<class_BaseMaterial3D_method_set_flag>` **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**                                 |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                              | :ref:`set_texture<class_BaseMaterial3D_method_set_texture>` **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)** |
   +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_BaseMaterial3D_TextureParam:

.. rst-class:: classref-enumeration

enum **TextureParam**:

.. _class_BaseMaterial3D_constant_TEXTURE_ALBEDO:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_ALBEDO** = ``0``

Texture specifying per-pixel color.

.. _class_BaseMaterial3D_constant_TEXTURE_METALLIC:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_METALLIC** = ``1``

Texture specifying per-pixel metallic value.

.. _class_BaseMaterial3D_constant_TEXTURE_ROUGHNESS:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_ROUGHNESS** = ``2``

Texture specifying per-pixel roughness value.

.. _class_BaseMaterial3D_constant_TEXTURE_EMISSION:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_EMISSION** = ``3``

Texture specifying per-pixel emission color.

.. _class_BaseMaterial3D_constant_TEXTURE_NORMAL:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_NORMAL** = ``4``

Texture specifying per-pixel normal vector.

.. _class_BaseMaterial3D_constant_TEXTURE_RIM:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_RIM** = ``5``

Texture specifying per-pixel rim value.

.. _class_BaseMaterial3D_constant_TEXTURE_CLEARCOAT:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_CLEARCOAT** = ``6``

Texture specifying per-pixel clearcoat value.

.. _class_BaseMaterial3D_constant_TEXTURE_FLOWMAP:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_FLOWMAP** = ``7``

Texture specifying per-pixel flowmap direction for use with :ref:`anisotropy<class_BaseMaterial3D_property_anisotropy>`.

.. _class_BaseMaterial3D_constant_TEXTURE_AMBIENT_OCCLUSION:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_AMBIENT_OCCLUSION** = ``8``

Texture specifying per-pixel ambient occlusion value.

.. _class_BaseMaterial3D_constant_TEXTURE_HEIGHTMAP:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_HEIGHTMAP** = ``9``

Texture specifying per-pixel height.

.. _class_BaseMaterial3D_constant_TEXTURE_SUBSURFACE_SCATTERING:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_SUBSURFACE_SCATTERING** = ``10``

Texture specifying per-pixel subsurface scattering.

.. _class_BaseMaterial3D_constant_TEXTURE_SUBSURFACE_TRANSMITTANCE:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_SUBSURFACE_TRANSMITTANCE** = ``11``

Texture specifying per-pixel transmittance for subsurface scattering.

.. _class_BaseMaterial3D_constant_TEXTURE_BACKLIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_BACKLIGHT** = ``12``

Texture specifying per-pixel backlight color.

.. _class_BaseMaterial3D_constant_TEXTURE_REFRACTION:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_REFRACTION** = ``13``

Texture specifying per-pixel refraction strength.

.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_MASK:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_DETAIL_MASK** = ``14``

Texture specifying per-pixel detail mask blending value.

.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_ALBEDO:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_DETAIL_ALBEDO** = ``15``

Texture specifying per-pixel detail color.

.. _class_BaseMaterial3D_constant_TEXTURE_DETAIL_NORMAL:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_DETAIL_NORMAL** = ``16``

Texture specifying per-pixel detail normal.

.. _class_BaseMaterial3D_constant_TEXTURE_ORM:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_ORM** = ``17``

Texture holding ambient occlusion, roughness, and metallic.

.. _class_BaseMaterial3D_constant_TEXTURE_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` **TEXTURE_MAX** = ``18``

Represents the size of the :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_TextureFilter:

.. rst-class:: classref-enumeration

enum **TextureFilter**:

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_NEAREST** = ``0``

The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_LINEAR** = ``1``

The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``2``

The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``3``

The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for most cases as mipmaps are important to smooth out pixels that are far from the camera.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``4``

The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``5``

The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.

.. _class_BaseMaterial3D_constant_TEXTURE_FILTER_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **TEXTURE_FILTER_MAX** = ``6``

Represents the size of the :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_DetailUV:

.. rst-class:: classref-enumeration

enum **DetailUV**:

.. _class_BaseMaterial3D_constant_DETAIL_UV_1:

.. rst-class:: classref-enumeration-constant

:ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` **DETAIL_UV_1** = ``0``

Use ``UV`` with the detail texture.

.. _class_BaseMaterial3D_constant_DETAIL_UV_2:

.. rst-class:: classref-enumeration-constant

:ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` **DETAIL_UV_2** = ``1``

Use ``UV2`` with the detail texture.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_Transparency:

.. rst-class:: classref-enumeration

enum **Transparency**:

.. _class_BaseMaterial3D_constant_TRANSPARENCY_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_DISABLED** = ``0``

The material will not use transparency. This is the fastest to render.

.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_ALPHA** = ``1``

The material will use the texture's alpha values for transparency. This is the slowest to render, and disables shadow casting.

.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA_SCISSOR:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_ALPHA_SCISSOR** = ``2``

The material will cut off all values below a threshold, the rest will remain opaque. The opaque portions will be rendered in the depth prepass. This is faster to render than alpha blending, but slower than opaque rendering. This also supports casting shadows.

.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA_HASH:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_ALPHA_HASH** = ``3``

The material will cut off all values below a spatially-deterministic threshold, the rest will remain opaque. This is faster to render than alpha blending, but slower than opaque rendering. This also supports casting shadows. Alpha hashing is suited for hair rendering.

.. _class_BaseMaterial3D_constant_TRANSPARENCY_ALPHA_DEPTH_PRE_PASS:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_ALPHA_DEPTH_PRE_PASS** = ``4``

The material will use the texture's alpha value for transparency, but will discard fragments with an alpha of less than 0.99 during the depth prepass and fragments with an alpha less than 0.1 during the shadow pass. This also supports casting shadows.

.. _class_BaseMaterial3D_constant_TRANSPARENCY_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **TRANSPARENCY_MAX** = ``5``

Represents the size of the :ref:`Transparency<enum_BaseMaterial3D_Transparency>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_ShadingMode:

.. rst-class:: classref-enumeration

enum **ShadingMode**:

.. _class_BaseMaterial3D_constant_SHADING_MODE_UNSHADED:

.. rst-class:: classref-enumeration-constant

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **SHADING_MODE_UNSHADED** = ``0``

The object will not receive shadows. This is the fastest to render, but it disables all interactions with lights.

.. _class_BaseMaterial3D_constant_SHADING_MODE_PER_PIXEL:

.. rst-class:: classref-enumeration-constant

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **SHADING_MODE_PER_PIXEL** = ``1``

The object will be shaded per pixel. Useful for realistic shading effects.

.. _class_BaseMaterial3D_constant_SHADING_MODE_PER_VERTEX:

.. rst-class:: classref-enumeration-constant

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **SHADING_MODE_PER_VERTEX** = ``2``

The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality. Not implemented yet (this mode will act like :ref:`SHADING_MODE_PER_PIXEL<class_BaseMaterial3D_constant_SHADING_MODE_PER_PIXEL>`).

.. _class_BaseMaterial3D_constant_SHADING_MODE_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **SHADING_MODE_MAX** = ``3``

Represents the size of the :ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_Feature:

.. rst-class:: classref-enumeration

enum **Feature**:

.. _class_BaseMaterial3D_constant_FEATURE_EMISSION:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_EMISSION** = ``0``

Constant for setting :ref:`emission_enabled<class_BaseMaterial3D_property_emission_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_NORMAL_MAPPING:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_NORMAL_MAPPING** = ``1``

Constant for setting :ref:`normal_enabled<class_BaseMaterial3D_property_normal_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_RIM:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_RIM** = ``2``

Constant for setting :ref:`rim_enabled<class_BaseMaterial3D_property_rim_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_CLEARCOAT:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_CLEARCOAT** = ``3``

Constant for setting :ref:`clearcoat_enabled<class_BaseMaterial3D_property_clearcoat_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_ANISOTROPY:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_ANISOTROPY** = ``4``

Constant for setting :ref:`anisotropy_enabled<class_BaseMaterial3D_property_anisotropy_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_AMBIENT_OCCLUSION:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_AMBIENT_OCCLUSION** = ``5``

Constant for setting :ref:`ao_enabled<class_BaseMaterial3D_property_ao_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_HEIGHT_MAPPING:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_HEIGHT_MAPPING** = ``6``

Constant for setting :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_SUBSURFACE_SCATTERING:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_SUBSURFACE_SCATTERING** = ``7``

Constant for setting :ref:`subsurf_scatter_enabled<class_BaseMaterial3D_property_subsurf_scatter_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_SUBSURFACE_TRANSMITTANCE:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_SUBSURFACE_TRANSMITTANCE** = ``8``

Constant for setting :ref:`subsurf_scatter_transmittance_enabled<class_BaseMaterial3D_property_subsurf_scatter_transmittance_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_BACKLIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_BACKLIGHT** = ``9``

Constant for setting :ref:`backlight_enabled<class_BaseMaterial3D_property_backlight_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_REFRACTION:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_REFRACTION** = ``10``

Constant for setting :ref:`refraction_enabled<class_BaseMaterial3D_property_refraction_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_DETAIL:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_DETAIL** = ``11``

Constant for setting :ref:`detail_enabled<class_BaseMaterial3D_property_detail_enabled>`.

.. _class_BaseMaterial3D_constant_FEATURE_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Feature<enum_BaseMaterial3D_Feature>` **FEATURE_MAX** = ``12``

Represents the size of the :ref:`Feature<enum_BaseMaterial3D_Feature>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_BlendMode:

.. rst-class:: classref-enumeration

enum **BlendMode**:

.. _class_BaseMaterial3D_constant_BLEND_MODE_MIX:

.. rst-class:: classref-enumeration-constant

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **BLEND_MODE_MIX** = ``0``

Default blend mode. The color of the object is blended over the background based on the object's alpha value.

.. _class_BaseMaterial3D_constant_BLEND_MODE_ADD:

.. rst-class:: classref-enumeration-constant

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **BLEND_MODE_ADD** = ``1``

The color of the object is added to the background.

.. _class_BaseMaterial3D_constant_BLEND_MODE_SUB:

.. rst-class:: classref-enumeration-constant

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **BLEND_MODE_SUB** = ``2``

The color of the object is subtracted from the background.

.. _class_BaseMaterial3D_constant_BLEND_MODE_MUL:

.. rst-class:: classref-enumeration-constant

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **BLEND_MODE_MUL** = ``3``

The color of the object is multiplied by the background.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_AlphaAntiAliasing:

.. rst-class:: classref-enumeration

enum **AlphaAntiAliasing**:

.. _class_BaseMaterial3D_constant_ALPHA_ANTIALIASING_OFF:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` **ALPHA_ANTIALIASING_OFF** = ``0``

Disables Alpha AntiAliasing for the material.

.. _class_BaseMaterial3D_constant_ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` **ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE** = ``1``

Enables AlphaToCoverage. Alpha values in the material are passed to the AntiAliasing sample mask.

.. _class_BaseMaterial3D_constant_ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE_AND_TO_ONE:

.. rst-class:: classref-enumeration-constant

:ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` **ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE_AND_TO_ONE** = ``2``

Enables AlphaToCoverage and forces all non-zero alpha values to ``1``. Alpha values in the material are passed to the AntiAliasing sample mask.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_DepthDrawMode:

.. rst-class:: classref-enumeration

enum **DepthDrawMode**:

.. _class_BaseMaterial3D_constant_DEPTH_DRAW_OPAQUE_ONLY:

.. rst-class:: classref-enumeration-constant

:ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` **DEPTH_DRAW_OPAQUE_ONLY** = ``0``

Default depth draw mode. Depth is drawn only for opaque objects during the opaque prepass (if any) and during the opaque pass.

.. _class_BaseMaterial3D_constant_DEPTH_DRAW_ALWAYS:

.. rst-class:: classref-enumeration-constant

:ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` **DEPTH_DRAW_ALWAYS** = ``1``

Objects will write to depth during the opaque and the transparent passes. Transparent objects that are close to the camera may obscure other transparent objects behind them.

\ **Note:** This does not influence whether transparent objects are included in the depth prepass or not. For that, see :ref:`Transparency<enum_BaseMaterial3D_Transparency>`.

.. _class_BaseMaterial3D_constant_DEPTH_DRAW_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` **DEPTH_DRAW_DISABLED** = ``2``

Objects will not write their depth to the depth buffer, even during the depth prepass (if enabled).

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_CullMode:

.. rst-class:: classref-enumeration

enum **CullMode**:

.. _class_BaseMaterial3D_constant_CULL_BACK:

.. rst-class:: classref-enumeration-constant

:ref:`CullMode<enum_BaseMaterial3D_CullMode>` **CULL_BACK** = ``0``

Default cull mode. The back of the object is culled when not visible. Back face triangles will be culled when facing the camera. This results in only the front side of triangles being drawn. For closed-surface meshes, this means that only the exterior of the mesh will be visible.

.. _class_BaseMaterial3D_constant_CULL_FRONT:

.. rst-class:: classref-enumeration-constant

:ref:`CullMode<enum_BaseMaterial3D_CullMode>` **CULL_FRONT** = ``1``

Front face triangles will be culled when facing the camera. This results in only the back side of triangles being drawn. For closed-surface meshes, this means that the interior of the mesh will be drawn instead of the exterior.

.. _class_BaseMaterial3D_constant_CULL_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`CullMode<enum_BaseMaterial3D_CullMode>` **CULL_DISABLED** = ``2``

No face culling is performed; both the front face and back face will be visible.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_Flags:

.. rst-class:: classref-enumeration

enum **Flags**:

.. _class_BaseMaterial3D_constant_FLAG_DISABLE_DEPTH_TEST:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_DISABLE_DEPTH_TEST** = ``0``

Disables the depth test, so this object is drawn on top of all others drawn before it. This puts the object in the transparent draw pass where it is sorted based on distance to camera. Objects drawn after it in the draw order may cover it. This also disables writing to depth.

.. _class_BaseMaterial3D_constant_FLAG_ALBEDO_FROM_VERTEX_COLOR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_ALBEDO_FROM_VERTEX_COLOR** = ``1``

Set ``ALBEDO`` to the per-vertex color specified in the mesh.

.. _class_BaseMaterial3D_constant_FLAG_SRGB_VERTEX_COLOR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_SRGB_VERTEX_COLOR** = ``2``

Vertex colors are considered to be stored in sRGB color space and are converted to linear color space during rendering. See also :ref:`vertex_color_is_srgb<class_BaseMaterial3D_property_vertex_color_is_srgb>`.

\ **Note:** Only effective when using the Forward+ and Mobile rendering methods.

.. _class_BaseMaterial3D_constant_FLAG_USE_POINT_SIZE:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_POINT_SIZE** = ``3``

Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use ``POINT_COORD`` instead of ``UV``.

.. _class_BaseMaterial3D_constant_FLAG_FIXED_SIZE:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_FIXED_SIZE** = ``4``

Object is scaled by depth so that it always appears the same size on screen.

.. _class_BaseMaterial3D_constant_FLAG_BILLBOARD_KEEP_SCALE:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_BILLBOARD_KEEP_SCALE** = ``5``

Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>` is :ref:`BILLBOARD_ENABLED<class_BaseMaterial3D_constant_BILLBOARD_ENABLED>`.

.. _class_BaseMaterial3D_constant_FLAG_UV1_USE_TRIPLANAR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_UV1_USE_TRIPLANAR** = ``6``

Use triplanar texture lookup for all texture lookups that would normally use ``UV``.

.. _class_BaseMaterial3D_constant_FLAG_UV2_USE_TRIPLANAR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_UV2_USE_TRIPLANAR** = ``7``

Use triplanar texture lookup for all texture lookups that would normally use ``UV2``.

.. _class_BaseMaterial3D_constant_FLAG_UV1_USE_WORLD_TRIPLANAR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_UV1_USE_WORLD_TRIPLANAR** = ``8``

Use triplanar texture lookup for all texture lookups that would normally use ``UV``.

.. _class_BaseMaterial3D_constant_FLAG_UV2_USE_WORLD_TRIPLANAR:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_UV2_USE_WORLD_TRIPLANAR** = ``9``

Use triplanar texture lookup for all texture lookups that would normally use ``UV2``.

.. _class_BaseMaterial3D_constant_FLAG_AO_ON_UV2:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_AO_ON_UV2** = ``10``

Use ``UV2`` coordinates to look up from the :ref:`ao_texture<class_BaseMaterial3D_property_ao_texture>`.

.. _class_BaseMaterial3D_constant_FLAG_EMISSION_ON_UV2:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_EMISSION_ON_UV2** = ``11``

Use ``UV2`` coordinates to look up from the :ref:`emission_texture<class_BaseMaterial3D_property_emission_texture>`.

.. _class_BaseMaterial3D_constant_FLAG_ALBEDO_TEXTURE_FORCE_SRGB:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = ``12``

Forces the shader to convert albedo from sRGB space to linear space. See also :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>`.

.. _class_BaseMaterial3D_constant_FLAG_DONT_RECEIVE_SHADOWS:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_DONT_RECEIVE_SHADOWS** = ``13``

Disables receiving shadows from other objects.

.. _class_BaseMaterial3D_constant_FLAG_DISABLE_AMBIENT_LIGHT:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_DISABLE_AMBIENT_LIGHT** = ``14``

Disables receiving ambient light.

.. _class_BaseMaterial3D_constant_FLAG_USE_SHADOW_TO_OPACITY:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_SHADOW_TO_OPACITY** = ``15``

Enables the shadow to opacity feature.

.. _class_BaseMaterial3D_constant_FLAG_USE_TEXTURE_REPEAT:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_USE_TEXTURE_REPEAT** = ``16``

Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.

.. _class_BaseMaterial3D_constant_FLAG_INVERT_HEIGHTMAP:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_INVERT_HEIGHTMAP** = ``17``

Invert values read from a depth texture to convert them to height values (heightmap).

.. _class_BaseMaterial3D_constant_FLAG_SUBSURFACE_MODE_SKIN:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_SUBSURFACE_MODE_SKIN** = ``18``

Enables the skin mode for subsurface scattering which is used to improve the look of subsurface scattering when used for human skin.

.. _class_BaseMaterial3D_constant_FLAG_PARTICLE_TRAILS_MODE:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_PARTICLE_TRAILS_MODE** = ``19``

Enables parts of the shader required for :ref:`GPUParticles3D<class_GPUParticles3D>` trails to function. This also requires using a mesh with appropriate skinning, such as :ref:`RibbonTrailMesh<class_RibbonTrailMesh>` or :ref:`TubeTrailMesh<class_TubeTrailMesh>`. Enabling this feature outside of materials used in :ref:`GPUParticles3D<class_GPUParticles3D>` meshes will break material rendering.

.. _class_BaseMaterial3D_constant_FLAG_ALBEDO_TEXTURE_MSDF:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_ALBEDO_TEXTURE_MSDF** = ``20``

Enables multichannel signed distance field rendering shader.

.. _class_BaseMaterial3D_constant_FLAG_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`Flags<enum_BaseMaterial3D_Flags>` **FLAG_MAX** = ``21``

Represents the size of the :ref:`Flags<enum_BaseMaterial3D_Flags>` enum.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_DiffuseMode:

.. rst-class:: classref-enumeration

enum **DiffuseMode**:

.. _class_BaseMaterial3D_constant_DIFFUSE_BURLEY:

.. rst-class:: classref-enumeration-constant

:ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **DIFFUSE_BURLEY** = ``0``

Default diffuse scattering algorithm.

.. _class_BaseMaterial3D_constant_DIFFUSE_LAMBERT:

.. rst-class:: classref-enumeration-constant

:ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **DIFFUSE_LAMBERT** = ``1``

Diffuse scattering ignores roughness.

.. _class_BaseMaterial3D_constant_DIFFUSE_LAMBERT_WRAP:

.. rst-class:: classref-enumeration-constant

:ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **DIFFUSE_LAMBERT_WRAP** = ``2``

Extends Lambert to cover more than 90 degrees when roughness increases.

.. _class_BaseMaterial3D_constant_DIFFUSE_TOON:

.. rst-class:: classref-enumeration-constant

:ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **DIFFUSE_TOON** = ``3``

Uses a hard cut for lighting, with smoothing affected by roughness.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_SpecularMode:

.. rst-class:: classref-enumeration

enum **SpecularMode**:

.. _class_BaseMaterial3D_constant_SPECULAR_SCHLICK_GGX:

.. rst-class:: classref-enumeration-constant

:ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` **SPECULAR_SCHLICK_GGX** = ``0``

Default specular blob.

.. _class_BaseMaterial3D_constant_SPECULAR_TOON:

.. rst-class:: classref-enumeration-constant

:ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` **SPECULAR_TOON** = ``1``

Toon blob which changes size based on roughness.

.. _class_BaseMaterial3D_constant_SPECULAR_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` **SPECULAR_DISABLED** = ``2``

No specular blob. This is slightly faster to render than other specular modes.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_BillboardMode:

.. rst-class:: classref-enumeration

enum **BillboardMode**:

.. _class_BaseMaterial3D_constant_BILLBOARD_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **BILLBOARD_DISABLED** = ``0``

Billboard mode is disabled.

.. _class_BaseMaterial3D_constant_BILLBOARD_ENABLED:

.. rst-class:: classref-enumeration-constant

:ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **BILLBOARD_ENABLED** = ``1``

The object's Z axis will always face the camera.

.. _class_BaseMaterial3D_constant_BILLBOARD_FIXED_Y:

.. rst-class:: classref-enumeration-constant

:ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **BILLBOARD_FIXED_Y** = ``2``

The object's X axis will always face the camera.

.. _class_BaseMaterial3D_constant_BILLBOARD_PARTICLES:

.. rst-class:: classref-enumeration-constant

:ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **BILLBOARD_PARTICLES** = ``3``

Used for particle systems when assigned to :ref:`GPUParticles3D<class_GPUParticles3D>` and :ref:`CPUParticles3D<class_CPUParticles3D>` nodes. Enables ``particles_anim_*`` properties.

The :ref:`ParticleProcessMaterial.anim_speed_min<class_ParticleProcessMaterial_property_anim_speed_min>` or :ref:`CPUParticles3D.anim_speed_min<class_CPUParticles3D_property_anim_speed_min>` should also be set to a value bigger than zero for the animation to play.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_TextureChannel:

.. rst-class:: classref-enumeration

enum **TextureChannel**:

.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_RED:

.. rst-class:: classref-enumeration-constant

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **TEXTURE_CHANNEL_RED** = ``0``

Used to read from the red channel of a texture.

.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_GREEN:

.. rst-class:: classref-enumeration-constant

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **TEXTURE_CHANNEL_GREEN** = ``1``

Used to read from the green channel of a texture.

.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_BLUE:

.. rst-class:: classref-enumeration-constant

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **TEXTURE_CHANNEL_BLUE** = ``2``

Used to read from the blue channel of a texture.

.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_ALPHA:

.. rst-class:: classref-enumeration-constant

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **TEXTURE_CHANNEL_ALPHA** = ``3``

Used to read from the alpha channel of a texture.

.. _class_BaseMaterial3D_constant_TEXTURE_CHANNEL_GRAYSCALE:

.. rst-class:: classref-enumeration-constant

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **TEXTURE_CHANNEL_GRAYSCALE** = ``4``

Used to read from the linear (non-perceptual) average of the red, green and blue channels of a texture.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_EmissionOperator:

.. rst-class:: classref-enumeration

enum **EmissionOperator**:

.. _class_BaseMaterial3D_constant_EMISSION_OP_ADD:

.. rst-class:: classref-enumeration-constant

:ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` **EMISSION_OP_ADD** = ``0``

Adds the emission color to the color from the emission texture.

.. _class_BaseMaterial3D_constant_EMISSION_OP_MULTIPLY:

.. rst-class:: classref-enumeration-constant

:ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` **EMISSION_OP_MULTIPLY** = ``1``

Multiplies the emission color by the color from the emission texture.

.. rst-class:: classref-item-separator

----

.. _enum_BaseMaterial3D_DistanceFadeMode:

.. rst-class:: classref-enumeration

enum **DistanceFadeMode**:

.. _class_BaseMaterial3D_constant_DISTANCE_FADE_DISABLED:

.. rst-class:: classref-enumeration-constant

:ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **DISTANCE_FADE_DISABLED** = ``0``

Do not use distance fade.

.. _class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_ALPHA:

.. rst-class:: classref-enumeration-constant

:ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **DISTANCE_FADE_PIXEL_ALPHA** = ``1``

Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel.

.. _class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_DITHER:

.. rst-class:: classref-enumeration-constant

:ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **DISTANCE_FADE_PIXEL_DITHER** = ``2``

Smoothly fades the object out based on each pixel's distance from the camera using a dithering approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware, this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA<class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_ALPHA>`.

.. _class_BaseMaterial3D_constant_DISTANCE_FADE_OBJECT_DITHER:

.. rst-class:: classref-enumeration-constant

:ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **DISTANCE_FADE_OBJECT_DITHER** = ``3``

Smoothly fades the object out based on the object's distance from the camera using a dithering approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware, this can be faster than :ref:`DISTANCE_FADE_PIXEL_ALPHA<class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_ALPHA>` and :ref:`DISTANCE_FADE_PIXEL_DITHER<class_BaseMaterial3D_constant_DISTANCE_FADE_PIXEL_DITHER>`.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_BaseMaterial3D_property_albedo_color:

.. rst-class:: classref-property

:ref:`Color<class_Color>` **albedo_color** = ``Color(1, 1, 1, 1)``

.. rst-class:: classref-property-setget

- void **set_albedo** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_albedo** **(** **)**

The material's base color.

\ **Note:** If :ref:`detail_enabled<class_BaseMaterial3D_property_detail_enabled>` is ``true`` and a :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` texture is specified, :ref:`albedo_color<class_BaseMaterial3D_property_albedo_color>` will *not* modulate the detail texture. This can be used to color partial areas of a material by not specifying an albedo texture and using a transparent :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` texture instead.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_albedo_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **albedo_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture to multiply by :ref:`albedo_color<class_BaseMaterial3D_property_albedo_color>`. Used for basic texturing of objects.

If the texture appears unexpectedly too dark or too bright, check :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_albedo_texture_force_srgb:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **albedo_texture_force_srgb** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, forces a conversion of the :ref:`albedo_texture<class_BaseMaterial3D_property_albedo_texture>` from sRGB color space to linear color space. See also :ref:`vertex_color_is_srgb<class_BaseMaterial3D_property_vertex_color_is_srgb>`.

This should only be enabled when needed (typically when using a :ref:`ViewportTexture<class_ViewportTexture>` as :ref:`albedo_texture<class_BaseMaterial3D_property_albedo_texture>`). If :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>` is ``true`` when it shouldn't be, the texture will appear to be too dark. If :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>` is ``false`` when it shouldn't be, the texture will appear to be too bright.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_albedo_texture_msdf:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **albedo_texture_msdf** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

Enables multichannel signed distance field rendering shader. Use :ref:`msdf_pixel_range<class_BaseMaterial3D_property_msdf_pixel_range>` and :ref:`msdf_outline_size<class_BaseMaterial3D_property_msdf_outline_size>` to configure MSDF parameters.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_alpha_antialiasing_edge:

.. rst-class:: classref-property

:ref:`float<class_float>` **alpha_antialiasing_edge**

.. rst-class:: classref-property-setget

- void **set_alpha_antialiasing_edge** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_alpha_antialiasing_edge** **(** **)**

Threshold at which antialiasing will be applied on the alpha channel.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_alpha_antialiasing_mode:

.. rst-class:: classref-property

:ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` **alpha_antialiasing_mode**

.. rst-class:: classref-property-setget

- void **set_alpha_antialiasing** **(** :ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` value **)**
- :ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>` **get_alpha_antialiasing** **(** **)**

The type of alpha antialiasing to apply. See :ref:`AlphaAntiAliasing<enum_BaseMaterial3D_AlphaAntiAliasing>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_alpha_hash_scale:

.. rst-class:: classref-property

:ref:`float<class_float>` **alpha_hash_scale**

.. rst-class:: classref-property-setget

- void **set_alpha_hash_scale** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_alpha_hash_scale** **(** **)**

The hashing scale for Alpha Hash. Recommended values between ``0`` and ``2``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_alpha_scissor_threshold:

.. rst-class:: classref-property

:ref:`float<class_float>` **alpha_scissor_threshold**

.. rst-class:: classref-property-setget

- void **set_alpha_scissor_threshold** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_alpha_scissor_threshold** **(** **)**

Threshold at which the alpha scissor will discard values. Higher values will result in more pixels being discarded. If the material becomes too opaque at a distance, try increasing :ref:`alpha_scissor_threshold<class_BaseMaterial3D_property_alpha_scissor_threshold>`. If the material disappears at a distance, try decreasing :ref:`alpha_scissor_threshold<class_BaseMaterial3D_property_alpha_scissor_threshold>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_anisotropy:

.. rst-class:: classref-property

:ref:`float<class_float>` **anisotropy** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_anisotropy** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_anisotropy** **(** **)**

The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_flowmap<class_BaseMaterial3D_property_anisotropy_flowmap>`'s alpha channel if a texture is defined there and the texture contains an alpha channel.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_anisotropy_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **anisotropy_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, 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.

\ **Note:** Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken.

\ **Note:** Material anisotropy should not to be confused with anisotropic texture filtering, which can be enabled by setting :ref:`texture_filter<class_BaseMaterial3D_property_texture_filter>` to :ref:`TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC<class_BaseMaterial3D_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_anisotropy_flowmap:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **anisotropy_flowmap**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

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 :ref:`anisotropy<class_BaseMaterial3D_property_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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_ao_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **ao_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, ambient occlusion is enabled. Ambient occlusion darkens areas based on the :ref:`ao_texture<class_BaseMaterial3D_property_ao_texture>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_ao_light_affect:

.. rst-class:: classref-property

:ref:`float<class_float>` **ao_light_affect** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_ao_light_affect** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_ao_light_affect** **(** **)**

Amount that ambient occlusion affects lighting from lights. If ``0``, ambient occlusion only affects ambient light. If ``1``, 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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_ao_on_uv2:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **ao_on_uv2** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, use ``UV2`` coordinates to look up from the :ref:`ao_texture<class_BaseMaterial3D_property_ao_texture>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_ao_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **ao_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture that defines the amount of ambient occlusion for a given point on the object.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_ao_texture_channel:

.. rst-class:: classref-property

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **ao_texture_channel** = ``0``

.. rst-class:: classref-property-setget

- void **set_ao_texture_channel** **(** :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` value **)**
- :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **get_ao_texture_channel** **(** **)**

Specifies the channel of the :ref:`ao_texture<class_BaseMaterial3D_property_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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_backlight:

.. rst-class:: classref-property

:ref:`Color<class_Color>` **backlight** = ``Color(0, 0, 0, 1)``

.. rst-class:: classref-property-setget

- void **set_backlight** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_backlight** **(** **)**

The color used by the backlight effect. Represents the light passing through an object.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_backlight_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **backlight_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, the backlight effect is enabled. See also :ref:`subsurf_scatter_transmittance_enabled<class_BaseMaterial3D_property_subsurf_scatter_transmittance_enabled>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_backlight_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **backlight_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to control the backlight effect per-pixel. Added to :ref:`backlight<class_BaseMaterial3D_property_backlight>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_billboard_keep_scale:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **billboard_keep_scale** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>` is not :ref:`BILLBOARD_DISABLED<class_BaseMaterial3D_constant_BILLBOARD_DISABLED>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_billboard_mode:

.. rst-class:: classref-property

:ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **billboard_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_billboard_mode** **(** :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` value **)**
- :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>` **get_billboard_mode** **(** **)**

Controls how the object faces the camera. See :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>`.

\ **Note:** 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 `GitHub issue #41567 <https://github.com/godotengine/godot/issues/41567>`__ for details.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_blend_mode:

.. rst-class:: classref-property

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **blend_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_blend_mode** **(** :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` value **)**
- :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **get_blend_mode** **(** **)**

The material's blend mode.

\ **Note:** Values other than ``Mix`` force the object into the transparent pipeline. See :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_clearcoat:

.. rst-class:: classref-property

:ref:`float<class_float>` **clearcoat** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_clearcoat** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_clearcoat** **(** **)**

Sets the strength of the clearcoat effect. Setting to ``0`` looks the same as disabling the clearcoat effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_clearcoat_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **clearcoat_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, 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.

\ **Note:** Clearcoat rendering is not visible if the material's :ref:`shading_mode<class_BaseMaterial3D_property_shading_mode>` is :ref:`SHADING_MODE_UNSHADED<class_BaseMaterial3D_constant_SHADING_MODE_UNSHADED>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_clearcoat_roughness:

.. rst-class:: classref-property

:ref:`float<class_float>` **clearcoat_roughness** = ``0.5``

.. rst-class:: classref-property-setget

- void **set_clearcoat_roughness** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_clearcoat_roughness** **(** **)**

Sets the roughness of the clearcoat pass. A higher value results in a rougher clearcoat while a lower value results in a smoother clearcoat.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_clearcoat_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **clearcoat_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_cull_mode:

.. rst-class:: classref-property

:ref:`CullMode<enum_BaseMaterial3D_CullMode>` **cull_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_cull_mode** **(** :ref:`CullMode<enum_BaseMaterial3D_CullMode>` value **)**
- :ref:`CullMode<enum_BaseMaterial3D_CullMode>` **get_cull_mode** **(** **)**

Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera. See :ref:`CullMode<enum_BaseMaterial3D_CullMode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_depth_draw_mode:

.. rst-class:: classref-property

:ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` **depth_draw_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_depth_draw_mode** **(** :ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` value **)**
- :ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>` **get_depth_draw_mode** **(** **)**

Determines when depth rendering takes place. See :ref:`DepthDrawMode<enum_BaseMaterial3D_DepthDrawMode>`. See also :ref:`transparency<class_BaseMaterial3D_property_transparency>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_albedo:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **detail_albedo**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture that specifies the color of the detail overlay. :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>`'s alpha channel is used as a mask, even when the material is opaque. To use a dedicated texture as a mask, see :ref:`detail_mask<class_BaseMaterial3D_property_detail_mask>`.

\ **Note:** :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` is *not* modulated by :ref:`albedo_color<class_BaseMaterial3D_property_albedo_color>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_blend_mode:

.. rst-class:: classref-property

:ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **detail_blend_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_detail_blend_mode** **(** :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` value **)**
- :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` **get_detail_blend_mode** **(** **)**

Specifies how the :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` should blend with the current ``ALBEDO``. See :ref:`BlendMode<enum_BaseMaterial3D_BlendMode>` for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **detail_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on :ref:`detail_mask<class_BaseMaterial3D_property_detail_mask>` and :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>`'s alpha channel. This can be used to add variation to objects, or to blend between two different albedo/normal textures.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_mask:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **detail_mask**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to specify how the detail textures get blended with the base textures. :ref:`detail_mask<class_BaseMaterial3D_property_detail_mask>` can be used together with :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>`'s alpha channel (if any).

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_normal:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **detail_normal**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture that specifies the per-pixel normal of the detail overlay. The :ref:`detail_normal<class_BaseMaterial3D_property_detail_normal>` texture only uses the red and green channels; the blue and alpha channels are ignored. The normal read from :ref:`detail_normal<class_BaseMaterial3D_property_detail_normal>` is oriented around the surface normal provided by the :ref:`Mesh<class_Mesh>`.

\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_detail_uv_layer:

.. rst-class:: classref-property

:ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` **detail_uv_layer** = ``0``

.. rst-class:: classref-property-setget

- void **set_detail_uv** **(** :ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` value **)**
- :ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` **get_detail_uv** **(** **)**

Specifies whether to use ``UV`` or ``UV2`` for the detail layer. See :ref:`DetailUV<enum_BaseMaterial3D_DetailUV>` for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_diffuse_mode:

.. rst-class:: classref-property

:ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **diffuse_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_diffuse_mode** **(** :ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` value **)**
- :ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>` **get_diffuse_mode** **(** **)**

The algorithm used for diffuse light scattering. See :ref:`DiffuseMode<enum_BaseMaterial3D_DiffuseMode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_disable_ambient_light:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **disable_ambient_light** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, the object receives no ambient light.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_disable_receive_shadows:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **disable_receive_shadows** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, the object receives no shadow that would otherwise be cast onto it.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_distance_fade_max_distance:

.. rst-class:: classref-property

:ref:`float<class_float>` **distance_fade_max_distance** = ``10.0``

.. rst-class:: classref-property-setget

- void **set_distance_fade_max_distance** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_distance_fade_max_distance** **(** **)**

Distance at which the object appears fully opaque.

\ **Note:** If ``distance_fade_max_distance`` is less than ``distance_fade_min_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_distance_fade_min_distance:

.. rst-class:: classref-property

:ref:`float<class_float>` **distance_fade_min_distance** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_distance_fade_min_distance** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_distance_fade_min_distance** **(** **)**

Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible.

\ **Note:** If ``distance_fade_min_distance`` is greater than ``distance_fade_max_distance``, the behavior will be reversed. The object will start to fade away at ``distance_fade_max_distance`` and will fully disappear once it reaches ``distance_fade_min_distance``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_distance_fade_mode:

.. rst-class:: classref-property

:ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **distance_fade_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_distance_fade** **(** :ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` value **)**
- :ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>` **get_distance_fade** **(** **)**

Specifies which type of fade to use. Can be any of the :ref:`DistanceFadeMode<enum_BaseMaterial3D_DistanceFadeMode>`\ s.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission:

.. rst-class:: classref-property

:ref:`Color<class_Color>` **emission** = ``Color(0, 0, 0, 1)``

.. rst-class:: classref-property-setget

- void **set_emission** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_emission** **(** **)**

The emitted light's color. See :ref:`emission_enabled<class_BaseMaterial3D_property_emission_enabled>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **emission_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a :ref:`VoxelGI<class_VoxelGI>`, SDFGI, or :ref:`LightmapGI<class_LightmapGI>` is used and this object is used in baked lighting.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_energy_multiplier:

.. rst-class:: classref-property

:ref:`float<class_float>` **emission_energy_multiplier** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_emission_energy_multiplier** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_emission_energy_multiplier** **(** **)**

Multiplier for emitted light. See :ref:`emission_enabled<class_BaseMaterial3D_property_emission_enabled>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_intensity:

.. rst-class:: classref-property

:ref:`float<class_float>` **emission_intensity**

.. rst-class:: classref-property-setget

- void **set_emission_intensity** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_emission_intensity** **(** **)**

Luminance of emitted light, measured in nits (candela per square meter). Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units<class_ProjectSettings_property_rendering/lights_and_shadows/use_physical_light_units>` is enabled. The default is roughly equivalent to an indoor lightbulb.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_on_uv2:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **emission_on_uv2** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

Use ``UV2`` to read from the :ref:`emission_texture<class_BaseMaterial3D_property_emission_texture>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_operator:

.. rst-class:: classref-property

:ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` **emission_operator** = ``0``

.. rst-class:: classref-property-setget

- void **set_emission_operator** **(** :ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` value **)**
- :ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` **get_emission_operator** **(** **)**

Sets how :ref:`emission<class_BaseMaterial3D_property_emission>` interacts with :ref:`emission_texture<class_BaseMaterial3D_property_emission_texture>`. Can either add or multiply. See :ref:`EmissionOperator<enum_BaseMaterial3D_EmissionOperator>` for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_emission_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **emission_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture that specifies how much surface emits light at a given point.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_fixed_size:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **fixed_size** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, the object is rendered at the same size regardless of distance.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_grow:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **grow** = ``false``

.. rst-class:: classref-property-setget

- void **set_grow_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_grow_enabled** **(** **)**

If ``true``, enables the vertex grow setting. This can be used to create mesh-based outlines using a second material pass and its :ref:`cull_mode<class_BaseMaterial3D_property_cull_mode>` set to :ref:`CULL_FRONT<class_BaseMaterial3D_constant_CULL_FRONT>`. See also :ref:`grow_amount<class_BaseMaterial3D_property_grow_amount>`.

\ **Note:** Vertex growth cannot create new vertices, which means that visible gaps may occur in sharp corners. This can be alleviated by designing the mesh to use smooth normals exclusively using `face weighted normals <https://wiki.polycount.com/wiki/Face_weighted_normals>`__ in the 3D authoring software. In this case, grow will be able to join every outline together, just like in the original mesh.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_grow_amount:

.. rst-class:: classref-property

:ref:`float<class_float>` **grow_amount** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_grow** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_grow** **(** **)**

Grows object vertices in the direction of their normals. Only effective if :ref:`grow<class_BaseMaterial3D_property_grow>` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_deep_parallax:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **heightmap_deep_parallax** = ``false``

.. rst-class:: classref-property-setget

- void **set_heightmap_deep_parallax** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_heightmap_deep_parallax_enabled** **(** **)**

If ``true``, uses parallax occlusion mapping to represent depth in the material instead of simple offset mapping (see :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>`). This results in a more convincing depth effect, but is much more expensive on the GPU. Only enable this on materials where it makes a significant visual difference.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **heightmap_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, height mapping is enabled (also called "parallax mapping" or "depth mapping"). See also :ref:`normal_enabled<class_BaseMaterial3D_property_normal_enabled>`. Height mapping is a demanding feature on the GPU, so it should only be used on materials where it makes a significant visual difference.

\ **Note:** Height mapping is not supported if triplanar mapping is used on the same material. The value of :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>` will be ignored if :ref:`uv1_triplanar<class_BaseMaterial3D_property_uv1_triplanar>` is enabled.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_flip_binormal:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **heightmap_flip_binormal** = ``false``

.. rst-class:: classref-property-setget

- void **set_heightmap_deep_parallax_flip_binormal** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_heightmap_deep_parallax_flip_binormal** **(** **)**

If ``true``, flips the mesh's binormal vectors when interpreting the height map. If the heightmap effect looks strange when the camera moves (even with a reasonable :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>`), try setting this to ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_flip_tangent:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **heightmap_flip_tangent** = ``false``

.. rst-class:: classref-property-setget

- void **set_heightmap_deep_parallax_flip_tangent** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_heightmap_deep_parallax_flip_tangent** **(** **)**

If ``true``, flips the mesh's tangent vectors when interpreting the height map. If the heightmap effect looks strange when the camera moves (even with a reasonable :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>`), try setting this to ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_flip_texture:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **heightmap_flip_texture** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, interprets the height map texture as a depth map, with brighter values appearing to be "lower" in altitude compared to darker values.

This can be enabled for compatibility with some materials authored for Godot 3.x. This is not necessary if the Invert import option was used to invert the depth map in Godot 3.x, in which case :ref:`heightmap_flip_texture<class_BaseMaterial3D_property_heightmap_flip_texture>` should remain ``false``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_max_layers:

.. rst-class:: classref-property

:ref:`int<class_int>` **heightmap_max_layers**

.. rst-class:: classref-property-setget

- void **set_heightmap_deep_parallax_max_layers** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_heightmap_deep_parallax_max_layers** **(** **)**

The number of layers to use for parallax occlusion mapping when the camera is up close to the material. Higher values result in a more convincing depth effect, especially in materials that have steep height changes. Higher values have a significant cost on the GPU, so it should only be increased on materials where it makes a significant visual difference.

\ **Note:** Only effective if :ref:`heightmap_deep_parallax<class_BaseMaterial3D_property_heightmap_deep_parallax>` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_min_layers:

.. rst-class:: classref-property

:ref:`int<class_int>` **heightmap_min_layers**

.. rst-class:: classref-property-setget

- void **set_heightmap_deep_parallax_min_layers** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_heightmap_deep_parallax_min_layers** **(** **)**

The number of layers to use for parallax occlusion mapping when the camera is far away from the material. Higher values result in a more convincing depth effect, especially in materials that have steep height changes. Higher values have a significant cost on the GPU, so it should only be increased on materials where it makes a significant visual difference.

\ **Note:** Only effective if :ref:`heightmap_deep_parallax<class_BaseMaterial3D_property_heightmap_deep_parallax>` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_scale:

.. rst-class:: classref-property

:ref:`float<class_float>` **heightmap_scale** = ``5.0``

.. rst-class:: classref-property-setget

- void **set_heightmap_scale** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_heightmap_scale** **(** **)**

The heightmap scale to use for the parallax effect (see :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>`). The default value is tuned so that the highest point (value = 255) appears to be 5 cm higher than the lowest point (value = 0). Higher values result in a deeper appearance, but may result in artifacts appearing when looking at the material from oblique angles, especially when the camera moves. Negative values can be used to invert the parallax effect, but this is different from inverting the texture using :ref:`heightmap_flip_texture<class_BaseMaterial3D_property_heightmap_flip_texture>` as the material will also appear to be "closer" to the camera. In most cases, :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>` should be kept to a positive value.

\ **Note:** If the height map effect looks strange regardless of this value, try adjusting :ref:`heightmap_flip_binormal<class_BaseMaterial3D_property_heightmap_flip_binormal>` and :ref:`heightmap_flip_tangent<class_BaseMaterial3D_property_heightmap_flip_tangent>`. See also :ref:`heightmap_texture<class_BaseMaterial3D_property_heightmap_texture>` for recommendations on authoring heightmap textures, as the way the heightmap texture is authored affects how :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>` behaves.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_heightmap_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **heightmap_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

The texture to use as a height map. See also :ref:`heightmap_enabled<class_BaseMaterial3D_property_heightmap_enabled>`.

For best results, the texture should be normalized (with :ref:`heightmap_scale<class_BaseMaterial3D_property_heightmap_scale>` reduced to compensate). In `GIMP <https://gimp.org>`__, this can be done using **Colors > Auto > Equalize**. If the texture only uses a small part of its available range, the parallax effect may look strange, especially when the camera moves.

\ **Note:** To reduce memory usage and improve loading times, you may be able to use a lower-resolution heightmap texture as most heightmaps are only comprised of low-frequency data.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_metallic:

.. rst-class:: classref-property

:ref:`float<class_float>` **metallic** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_metallic** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_metallic** **(** **)**

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 ``0`` and ``1`` should only be used for blending between metal and non-metal sections. To alter the amount of reflection use :ref:`roughness<class_BaseMaterial3D_property_roughness>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_metallic_specular:

.. rst-class:: classref-property

:ref:`float<class_float>` **metallic_specular** = ``0.5``

.. rst-class:: classref-property-setget

- void **set_specular** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_specular** **(** **)**

Adjusts the strength of specular reflections. Specular reflections are composed of scene reflections and the specular lobe which is the bright spot that is reflected from light sources. When set to ``0.0``, no specular reflections will be visible. This differs from the :ref:`SPECULAR_DISABLED<class_BaseMaterial3D_constant_SPECULAR_DISABLED>` :ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` as :ref:`SPECULAR_DISABLED<class_BaseMaterial3D_constant_SPECULAR_DISABLED>` only applies to the specular lobe from the light source.

\ **Note:** Unlike :ref:`metallic<class_BaseMaterial3D_property_metallic>`, this is not energy-conserving, so it should be left at ``0.5`` in most cases. See also :ref:`roughness<class_BaseMaterial3D_property_roughness>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_metallic_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **metallic_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to specify metallic for an object. This is multiplied by :ref:`metallic<class_BaseMaterial3D_property_metallic>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_metallic_texture_channel:

.. rst-class:: classref-property

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **metallic_texture_channel** = ``0``

.. rst-class:: classref-property-setget

- void **set_metallic_texture_channel** **(** :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` value **)**
- :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **get_metallic_texture_channel** **(** **)**

Specifies the channel of the :ref:`metallic_texture<class_BaseMaterial3D_property_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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_msdf_outline_size:

.. rst-class:: classref-property

:ref:`float<class_float>` **msdf_outline_size** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_msdf_outline_size** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_msdf_outline_size** **(** **)**

The width of the shape outine.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_msdf_pixel_range:

.. rst-class:: classref-property

:ref:`float<class_float>` **msdf_pixel_range** = ``4.0``

.. rst-class:: classref-property-setget

- void **set_msdf_pixel_range** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_msdf_pixel_range** **(** **)**

The width of the range around the shape between the minimum and maximum representable signed distance.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_no_depth_test:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **no_depth_test** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, depth testing is disabled and the object will be drawn in render order.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_normal_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **normal_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, normal mapping is enabled. This has a slight performance cost, especially on mobile GPUs.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_normal_scale:

.. rst-class:: classref-property

:ref:`float<class_float>` **normal_scale** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_normal_scale** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_normal_scale** **(** **)**

The strength of the normal map's effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_normal_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **normal_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to specify the normal at a given pixel. The :ref:`normal_texture<class_BaseMaterial3D_property_normal_texture>` only uses the red and green channels; the blue and alpha channels are ignored. The normal read from :ref:`normal_texture<class_BaseMaterial3D_property_normal_texture>` is oriented around the surface normal provided by the :ref:`Mesh<class_Mesh>`.

\ **Note:** 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 :ref:`SurfaceTool<class_SurfaceTool>`, you can use :ref:`SurfaceTool.generate_normals<class_SurfaceTool_method_generate_normals>` and :ref:`SurfaceTool.generate_tangents<class_SurfaceTool_method_generate_tangents>` to automatically generate normals and tangents respectively.

\ **Note:** Godot expects the normal map to use X+, Y+, and Z+ coordinates. See `this page <http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates>`__ for a comparison of normal map coordinates expected by popular engines.

\ **Note:** If :ref:`detail_enabled<class_BaseMaterial3D_property_detail_enabled>` is ``true``, the :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` texture is drawn *below* the :ref:`normal_texture<class_BaseMaterial3D_property_normal_texture>`. To display a normal map *above* the :ref:`detail_albedo<class_BaseMaterial3D_property_detail_albedo>` texture, use :ref:`detail_normal<class_BaseMaterial3D_property_detail_normal>` instead.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_orm_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **orm_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

The Occlusion/Roughness/Metallic texture to use. This is a more efficient replacement of :ref:`ao_texture<class_BaseMaterial3D_property_ao_texture>`, :ref:`roughness_texture<class_BaseMaterial3D_property_roughness_texture>` and :ref:`metallic_texture<class_BaseMaterial3D_property_metallic_texture>` in :ref:`ORMMaterial3D<class_ORMMaterial3D>`. Ambient occlusion is stored in the red channel. Roughness map is stored in the green channel. Metallic map is stored in the blue channel. The alpha channel is ignored.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_particles_anim_h_frames:

.. rst-class:: classref-property

:ref:`int<class_int>` **particles_anim_h_frames**

.. rst-class:: classref-property-setget

- void **set_particles_anim_h_frames** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_particles_anim_h_frames** **(** **)**

The number of horizontal frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`. See :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_particles_anim_loop:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **particles_anim_loop**

.. rst-class:: classref-property-setget

- void **set_particles_anim_loop** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **get_particles_anim_loop** **(** **)**

If ``true``, particle animations are looped. Only enabled when using :ref:`BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`. See :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_particles_anim_v_frames:

.. rst-class:: classref-property

:ref:`int<class_int>` **particles_anim_v_frames**

.. rst-class:: classref-property-setget

- void **set_particles_anim_v_frames** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_particles_anim_v_frames** **(** **)**

The number of vertical frames in the particle sprite sheet. Only enabled when using :ref:`BILLBOARD_PARTICLES<class_BaseMaterial3D_constant_BILLBOARD_PARTICLES>`. See :ref:`billboard_mode<class_BaseMaterial3D_property_billboard_mode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_point_size:

.. rst-class:: classref-property

:ref:`float<class_float>` **point_size** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_point_size** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_point_size** **(** **)**

The point size in pixels. See :ref:`use_point_size<class_BaseMaterial3D_property_use_point_size>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_proximity_fade_distance:

.. rst-class:: classref-property

:ref:`float<class_float>` **proximity_fade_distance** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_proximity_fade_distance** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_proximity_fade_distance** **(** **)**

Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_proximity_fade_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **proximity_fade_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_proximity_fade_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_proximity_fade_enabled** **(** **)**

If ``true``, the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_refraction_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **refraction_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_refraction_scale:

.. rst-class:: classref-property

:ref:`float<class_float>` **refraction_scale** = ``0.05``

.. rst-class:: classref-property-setget

- void **set_refraction** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_refraction** **(** **)**

The strength of the refraction effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_refraction_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **refraction_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture that controls the strength of the refraction per-pixel. Multiplied by :ref:`refraction_scale<class_BaseMaterial3D_property_refraction_scale>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_refraction_texture_channel:

.. rst-class:: classref-property

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **refraction_texture_channel** = ``0``

.. rst-class:: classref-property-setget

- void **set_refraction_texture_channel** **(** :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` value **)**
- :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **get_refraction_texture_channel** **(** **)**

Specifies the channel of the :ref:`refraction_texture<class_BaseMaterial3D_property_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 refraction in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_rim:

.. rst-class:: classref-property

:ref:`float<class_float>` **rim** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_rim** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_rim** **(** **)**

Sets the strength of the rim lighting effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_rim_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **rim_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object.

\ **Note:** Rim lighting is not visible if the material's :ref:`shading_mode<class_BaseMaterial3D_property_shading_mode>` is :ref:`SHADING_MODE_UNSHADED<class_BaseMaterial3D_constant_SHADING_MODE_UNSHADED>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_rim_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **rim_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by :ref:`rim<class_BaseMaterial3D_property_rim>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_rim_tint:

.. rst-class:: classref-property

:ref:`float<class_float>` **rim_tint** = ``0.5``

.. rst-class:: classref-property-setget

- void **set_rim_tint** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_rim_tint** **(** **)**

The amount of to blend light and albedo color when rendering rim effect. If ``0`` the light color is used, while ``1`` means albedo color is used. An intermediate value generally works best.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_roughness:

.. rst-class:: classref-property

:ref:`float<class_float>` **roughness** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_roughness** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_roughness** **(** **)**

Surface reflection. A value of ``0`` represents a perfect mirror while a value of ``1`` completely blurs the reflection. See also :ref:`metallic<class_BaseMaterial3D_property_metallic>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_roughness_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **roughness_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to control the roughness per-pixel. Multiplied by :ref:`roughness<class_BaseMaterial3D_property_roughness>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_roughness_texture_channel:

.. rst-class:: classref-property

:ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **roughness_texture_channel** = ``0``

.. rst-class:: classref-property-setget

- void **set_roughness_texture_channel** **(** :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` value **)**
- :ref:`TextureChannel<enum_BaseMaterial3D_TextureChannel>` **get_roughness_texture_channel** **(** **)**

Specifies the channel of the :ref:`roughness_texture<class_BaseMaterial3D_property_roughness_texture>` in which the roughness 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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_shading_mode:

.. rst-class:: classref-property

:ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **shading_mode** = ``1``

.. rst-class:: classref-property-setget

- void **set_shading_mode** **(** :ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` value **)**
- :ref:`ShadingMode<enum_BaseMaterial3D_ShadingMode>` **get_shading_mode** **(** **)**

Sets whether the shading takes place, per-pixel, per-vertex or unshaded. Per-vertex lighting is faster, making it the best choice for mobile applications, however it looks considerably worse than per-pixel. Unshaded rendering is the fastest, but disables all interactions with lights.

\ **Note:** Setting the shading mode vertex shading currently has no effect, as vertex shading is not implemented yet.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_shadow_to_opacity:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **shadow_to_opacity** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, 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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_specular_mode:

.. rst-class:: classref-property

:ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` **specular_mode** = ``0``

.. rst-class:: classref-property-setget

- void **set_specular_mode** **(** :ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` value **)**
- :ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>` **get_specular_mode** **(** **)**

The method for rendering the specular blob. See :ref:`SpecularMode<enum_BaseMaterial3D_SpecularMode>`.

\ **Note:** :ref:`specular_mode<class_BaseMaterial3D_property_specular_mode>` only applies to the specular blob. It does not affect specular reflections from the sky, screen-space reflections, :ref:`VoxelGI<class_VoxelGI>`, SDFGI or :ref:`ReflectionProbe<class_ReflectionProbe>`\ s. To disable reflections from these sources as well, set :ref:`metallic_specular<class_BaseMaterial3D_property_metallic_specular>` to ``0.0`` instead.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **subsurf_scatter_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. Subsurface scattering quality is controlled by :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_quality<class_ProjectSettings_property_rendering/environment/subsurface_scattering/subsurface_scattering_quality>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_skin_mode:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **subsurf_scatter_skin_mode** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, subsurface scattering will use a special mode optimized for the color and density of human skin, such as boosting the intensity of the red channel in subsurface scattering.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_strength:

.. rst-class:: classref-property

:ref:`float<class_float>` **subsurf_scatter_strength** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_subsurface_scattering_strength** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_subsurface_scattering_strength** **(** **)**

The strength of the subsurface scattering effect. The depth of the effect is also controlled by :ref:`ProjectSettings.rendering/environment/subsurface_scattering/subsurface_scattering_scale<class_ProjectSettings_property_rendering/environment/subsurface_scattering/subsurface_scattering_scale>`, which is set globally.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **subsurf_scatter_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by :ref:`subsurf_scatter_strength<class_BaseMaterial3D_property_subsurf_scatter_strength>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_transmittance_boost:

.. rst-class:: classref-property

:ref:`float<class_float>` **subsurf_scatter_transmittance_boost** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_transmittance_boost** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_transmittance_boost** **(** **)**

The intensity of the subsurface scattering transmittance effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_transmittance_color:

.. rst-class:: classref-property

:ref:`Color<class_Color>` **subsurf_scatter_transmittance_color** = ``Color(1, 1, 1, 1)``

.. rst-class:: classref-property-setget

- void **set_transmittance_color** **(** :ref:`Color<class_Color>` value **)**
- :ref:`Color<class_Color>` **get_transmittance_color** **(** **)**

The color to multiply the subsurface scattering transmittance effect with. Ignored if :ref:`subsurf_scatter_skin_mode<class_BaseMaterial3D_property_subsurf_scatter_skin_mode>` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_transmittance_depth:

.. rst-class:: classref-property

:ref:`float<class_float>` **subsurf_scatter_transmittance_depth** = ``0.1``

.. rst-class:: classref-property-setget

- void **set_transmittance_depth** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_transmittance_depth** **(** **)**

The depth of the subsurface scattering transmittance effect.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_transmittance_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **subsurf_scatter_transmittance_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

If ``true``, enables subsurface scattering transmittance. Only effective if :ref:`subsurf_scatter_enabled<class_BaseMaterial3D_property_subsurf_scatter_enabled>` is ``true``. See also :ref:`backlight_enabled<class_BaseMaterial3D_property_backlight_enabled>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_subsurf_scatter_transmittance_texture:

.. rst-class:: classref-property

:ref:`Texture2D<class_Texture2D>` **subsurf_scatter_transmittance_texture**

.. rst-class:: classref-property-setget

- void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**
- :ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

The texture to use for multiplying the intensity of the subsurface scattering transmitteance intensity. See also :ref:`subsurf_scatter_texture<class_BaseMaterial3D_property_subsurf_scatter_texture>`. Ignored if :ref:`subsurf_scatter_skin_mode<class_BaseMaterial3D_property_subsurf_scatter_skin_mode>` is ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_texture_filter:

.. rst-class:: classref-property

:ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **texture_filter** = ``3``

.. rst-class:: classref-property-setget

- void **set_texture_filter** **(** :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` value **)**
- :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` **get_texture_filter** **(** **)**

Filter flags for the texture. See :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` for options.

\ **Note:** :ref:`heightmap_texture<class_BaseMaterial3D_property_heightmap_texture>` is always sampled with linear filtering, even if nearest-neighbor filtering is selected here. This is to ensure the heightmap effect looks as intended. If you need sharper height transitions between pixels, resize the heightmap texture in an image editor with nearest-neighbor filtering.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_texture_repeat:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **texture_repeat** = ``true``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

Repeat flags for the texture. See :ref:`TextureFilter<enum_BaseMaterial3D_TextureFilter>` for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_transparency:

.. rst-class:: classref-property

:ref:`Transparency<enum_BaseMaterial3D_Transparency>` **transparency** = ``0``

.. rst-class:: classref-property-setget

- void **set_transparency** **(** :ref:`Transparency<enum_BaseMaterial3D_Transparency>` value **)**
- :ref:`Transparency<enum_BaseMaterial3D_Transparency>` **get_transparency** **(** **)**

The material's transparency mode. Some transparency modes will disable shadow casting. Any transparency mode other than :ref:`TRANSPARENCY_DISABLED<class_BaseMaterial3D_constant_TRANSPARENCY_DISABLED>` has a greater performance impact compared to opaque rendering. See also :ref:`blend_mode<class_BaseMaterial3D_property_blend_mode>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_use_particle_trails:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **use_particle_trails** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, enables parts of the shader required for :ref:`GPUParticles3D<class_GPUParticles3D>` trails to function. This also requires using a mesh with appropriate skinning, such as :ref:`RibbonTrailMesh<class_RibbonTrailMesh>` or :ref:`TubeTrailMesh<class_TubeTrailMesh>`. Enabling this feature outside of materials used in :ref:`GPUParticles3D<class_GPUParticles3D>` meshes will break material rendering.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_use_point_size:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **use_point_size** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, render point size can be changed.

\ **Note:** This is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`point_size<class_BaseMaterial3D_property_point_size>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv1_offset:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **uv1_offset** = ``Vector3(0, 0, 0)``

.. rst-class:: classref-property-setget

- void **set_uv1_offset** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_uv1_offset** **(** **)**

How much to offset the ``UV`` coordinates. This amount will be added to ``UV`` in the vertex function. This can be used to offset a texture. The Z component is used when :ref:`uv1_triplanar<class_BaseMaterial3D_property_uv1_triplanar>` is enabled, but it is not used anywhere else.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv1_scale:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **uv1_scale** = ``Vector3(1, 1, 1)``

.. rst-class:: classref-property-setget

- void **set_uv1_scale** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_uv1_scale** **(** **)**

How much to scale the ``UV`` coordinates. This is multiplied by ``UV`` in the vertex function. The Z component is used when :ref:`uv1_triplanar<class_BaseMaterial3D_property_uv1_triplanar>` is enabled, but it is not used anywhere else.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv1_triplanar:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **uv1_triplanar** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, instead of using ``UV`` 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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv1_triplanar_sharpness:

.. rst-class:: classref-property

:ref:`float<class_float>` **uv1_triplanar_sharpness** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_uv1_triplanar_blend_sharpness** **(** **)**

A lower number blends the texture more softly while a higher number blends the texture more sharply.

\ **Note:** :ref:`uv1_triplanar_sharpness<class_BaseMaterial3D_property_uv1_triplanar_sharpness>` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv1_world_triplanar:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **uv1_world_triplanar** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, triplanar mapping for ``UV`` is calculated in world space rather than object local space. See also :ref:`uv1_triplanar<class_BaseMaterial3D_property_uv1_triplanar>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv2_offset:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **uv2_offset** = ``Vector3(0, 0, 0)``

.. rst-class:: classref-property-setget

- void **set_uv2_offset** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_uv2_offset** **(** **)**

How much to offset the ``UV2`` coordinates. This amount will be added to ``UV2`` in the vertex function. This can be used to offset a texture. The Z component is used when :ref:`uv2_triplanar<class_BaseMaterial3D_property_uv2_triplanar>` is enabled, but it is not used anywhere else.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv2_scale:

.. rst-class:: classref-property

:ref:`Vector3<class_Vector3>` **uv2_scale** = ``Vector3(1, 1, 1)``

.. rst-class:: classref-property-setget

- void **set_uv2_scale** **(** :ref:`Vector3<class_Vector3>` value **)**
- :ref:`Vector3<class_Vector3>` **get_uv2_scale** **(** **)**

How much to scale the ``UV2`` coordinates. This is multiplied by ``UV2`` in the vertex function. The Z component is used when :ref:`uv2_triplanar<class_BaseMaterial3D_property_uv2_triplanar>` is enabled, but it is not used anywhere else.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv2_triplanar:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **uv2_triplanar** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, instead of using ``UV2`` 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.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv2_triplanar_sharpness:

.. rst-class:: classref-property

:ref:`float<class_float>` **uv2_triplanar_sharpness** = ``1.0``

.. rst-class:: classref-property-setget

- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_uv2_triplanar_blend_sharpness** **(** **)**

A lower number blends the texture more softly while a higher number blends the texture more sharply.

\ **Note:** :ref:`uv2_triplanar_sharpness<class_BaseMaterial3D_property_uv2_triplanar_sharpness>` is clamped between ``0.0`` and ``150.0`` (inclusive) as values outside that range can look broken depending on the mesh.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_uv2_world_triplanar:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **uv2_world_triplanar** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, triplanar mapping for ``UV2`` is calculated in world space rather than object local space. See also :ref:`uv2_triplanar<class_BaseMaterial3D_property_uv2_triplanar>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_vertex_color_is_srgb:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **vertex_color_is_srgb** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, vertex colors are considered to be stored in sRGB color space and are converted to linear color space during rendering. If ``false``, vertex colors are considered to be stored in linear color space and are rendered as-is. See also :ref:`albedo_texture_force_srgb<class_BaseMaterial3D_property_albedo_texture_force_srgb>`.

\ **Note:** Only effective when using the Forward+ and Mobile rendering methods, not Compatibility.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_property_vertex_color_use_as_albedo:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **vertex_color_use_as_albedo** = ``false``

.. rst-class:: classref-property-setget

- void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

If ``true``, the vertex color is used as albedo color.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_BaseMaterial3D_method_get_feature:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature **)** |const|

Returns ``true``, if the specified :ref:`Feature<enum_BaseMaterial3D_Feature>` is enabled.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_method_get_flag:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **get_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag **)** |const|

Returns ``true``, if the specified flag is enabled. See :ref:`Flags<enum_BaseMaterial3D_Flags>` enumerator for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_method_get_texture:

.. rst-class:: classref-method

:ref:`Texture2D<class_Texture2D>` **get_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param **)** |const|

Returns the :ref:`Texture2D<class_Texture2D>` associated with the specified :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>`.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_method_set_feature:

.. rst-class:: classref-method

void **set_feature** **(** :ref:`Feature<enum_BaseMaterial3D_Feature>` feature, :ref:`bool<class_bool>` enable **)**

If ``true``, enables the specified :ref:`Feature<enum_BaseMaterial3D_Feature>`. Many features that are available in **BaseMaterial3D**\ 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 ``true``.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_method_set_flag:

.. rst-class:: classref-method

void **set_flag** **(** :ref:`Flags<enum_BaseMaterial3D_Flags>` flag, :ref:`bool<class_bool>` enable **)**

If ``true``, 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 ``true``. See :ref:`Flags<enum_BaseMaterial3D_Flags>` enumerator for options.

.. rst-class:: classref-item-separator

----

.. _class_BaseMaterial3D_method_set_texture:

.. rst-class:: classref-method

void **set_texture** **(** :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` param, :ref:`Texture2D<class_Texture2D>` texture **)**

Sets the texture for the slot specified by ``param``. See :ref:`TextureParam<enum_BaseMaterial3D_TextureParam>` for available slots.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`