godot-docs/classes/class_spatialmaterial.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the SpatialMaterial.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_SpatialMaterial:

SpatialMaterial
===============

**Inherits:** :ref:`Material<class_material>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------



Member Variables
----------------

  .. _class_SpatialMaterial_albedo_color:

- :ref:`Color<class_color>` **albedo_color**

  .. _class_SpatialMaterial_albedo_texture:

- :ref:`Texture<class_texture>` **albedo_texture**

  .. _class_SpatialMaterial_anisotropy:

- :ref:`float<class_float>` **anisotropy**

  .. _class_SpatialMaterial_anisotropy_enabled:

- :ref:`bool<class_bool>` **anisotropy_enabled**

  .. _class_SpatialMaterial_anisotropy_flowmap:

- :ref:`Texture<class_texture>` **anisotropy_flowmap**

  .. _class_SpatialMaterial_ao_enabled:

- :ref:`bool<class_bool>` **ao_enabled**

  .. _class_SpatialMaterial_ao_light_affect:

- :ref:`float<class_float>` **ao_light_affect**

  .. _class_SpatialMaterial_ao_on_uv2:

- :ref:`bool<class_bool>` **ao_on_uv2**

  .. _class_SpatialMaterial_ao_texture:

- :ref:`Texture<class_texture>` **ao_texture**

  .. _class_SpatialMaterial_ao_texture_channel:

- :ref:`TextureChannel<enum_spatialmaterial_texturechannel>` **ao_texture_channel**

  .. _class_SpatialMaterial_clearcoat:

- :ref:`float<class_float>` **clearcoat**

  .. _class_SpatialMaterial_clearcoat_enabled:

- :ref:`bool<class_bool>` **clearcoat_enabled**

  .. _class_SpatialMaterial_clearcoat_gloss:

- :ref:`float<class_float>` **clearcoat_gloss**

  .. _class_SpatialMaterial_clearcoat_texture:

- :ref:`Texture<class_texture>` **clearcoat_texture**

  .. _class_SpatialMaterial_depth_deep_parallax:

- :ref:`bool<class_bool>` **depth_deep_parallax**

  .. _class_SpatialMaterial_depth_enabled:

- :ref:`bool<class_bool>` **depth_enabled**

  .. _class_SpatialMaterial_depth_max_layers:

- :ref:`int<class_int>` **depth_max_layers**

  .. _class_SpatialMaterial_depth_min_layers:

- :ref:`int<class_int>` **depth_min_layers**

  .. _class_SpatialMaterial_depth_scale:

- :ref:`float<class_float>` **depth_scale**

  .. _class_SpatialMaterial_depth_texture:

- :ref:`Texture<class_texture>` **depth_texture**

  .. _class_SpatialMaterial_detail_albedo:

- :ref:`Texture<class_texture>` **detail_albedo**

  .. _class_SpatialMaterial_detail_blend_mode:

- :ref:`BlendMode<enum_spatialmaterial_blendmode>` **detail_blend_mode**

  .. _class_SpatialMaterial_detail_enabled:

- :ref:`bool<class_bool>` **detail_enabled**

  .. _class_SpatialMaterial_detail_mask:

- :ref:`Texture<class_texture>` **detail_mask**

  .. _class_SpatialMaterial_detail_normal:

- :ref:`Texture<class_texture>` **detail_normal**

  .. _class_SpatialMaterial_detail_uv_layer:

- :ref:`DetailUV<enum_spatialmaterial_detailuv>` **detail_uv_layer**

  .. _class_SpatialMaterial_distance_fade_enable:

- :ref:`bool<class_bool>` **distance_fade_enable**

  .. _class_SpatialMaterial_distance_fade_max_distance:

- :ref:`float<class_float>` **distance_fade_max_distance**

  .. _class_SpatialMaterial_distance_fade_min_distance:

- :ref:`float<class_float>` **distance_fade_min_distance**

  .. _class_SpatialMaterial_emission:

- :ref:`Color<class_color>` **emission**

  .. _class_SpatialMaterial_emission_enabled:

- :ref:`bool<class_bool>` **emission_enabled**

  .. _class_SpatialMaterial_emission_energy:

- :ref:`float<class_float>` **emission_energy**

  .. _class_SpatialMaterial_emission_on_uv2:

- :ref:`bool<class_bool>` **emission_on_uv2**

  .. _class_SpatialMaterial_emission_operator:

- :ref:`EmissionOperator<enum_spatialmaterial_emissionoperator>` **emission_operator**

  .. _class_SpatialMaterial_emission_texture:

- :ref:`Texture<class_texture>` **emission_texture**

  .. _class_SpatialMaterial_flags_albedo_tex_force_srgb:

- :ref:`bool<class_bool>` **flags_albedo_tex_force_srgb**

  .. _class_SpatialMaterial_flags_fixed_size:

- :ref:`bool<class_bool>` **flags_fixed_size**

  .. _class_SpatialMaterial_flags_no_depth_test:

- :ref:`bool<class_bool>` **flags_no_depth_test**

  .. _class_SpatialMaterial_flags_transparent:

- :ref:`bool<class_bool>` **flags_transparent**

  .. _class_SpatialMaterial_flags_unshaded:

- :ref:`bool<class_bool>` **flags_unshaded**

  .. _class_SpatialMaterial_flags_use_point_size:

- :ref:`bool<class_bool>` **flags_use_point_size**

  .. _class_SpatialMaterial_flags_vertex_lighting:

- :ref:`bool<class_bool>` **flags_vertex_lighting**

  .. _class_SpatialMaterial_flags_world_triplanar:

- :ref:`bool<class_bool>` **flags_world_triplanar**

  .. _class_SpatialMaterial_metallic:

- :ref:`float<class_float>` **metallic**

  .. _class_SpatialMaterial_metallic_specular:

- :ref:`float<class_float>` **metallic_specular**

  .. _class_SpatialMaterial_metallic_texture:

- :ref:`Texture<class_texture>` **metallic_texture**

  .. _class_SpatialMaterial_metallic_texture_channel:

- :ref:`TextureChannel<enum_spatialmaterial_texturechannel>` **metallic_texture_channel**

  .. _class_SpatialMaterial_normal_enabled:

- :ref:`bool<class_bool>` **normal_enabled**

  .. _class_SpatialMaterial_normal_scale:

- :ref:`float<class_float>` **normal_scale**

  .. _class_SpatialMaterial_normal_texture:

- :ref:`Texture<class_texture>` **normal_texture**

  .. _class_SpatialMaterial_params_alpha_scissor_threshold:

- :ref:`float<class_float>` **params_alpha_scissor_threshold**

  .. _class_SpatialMaterial_params_billboard_mode:

- :ref:`BillboardMode<enum_spatialmaterial_billboardmode>` **params_billboard_mode**

  .. _class_SpatialMaterial_params_blend_mode:

- :ref:`BlendMode<enum_spatialmaterial_blendmode>` **params_blend_mode**

  .. _class_SpatialMaterial_params_cull_mode:

- :ref:`CullMode<enum_spatialmaterial_cullmode>` **params_cull_mode**

  .. _class_SpatialMaterial_params_depth_draw_mode:

- :ref:`DepthDrawMode<enum_spatialmaterial_depthdrawmode>` **params_depth_draw_mode**

  .. _class_SpatialMaterial_params_diffuse_mode:

- :ref:`DiffuseMode<enum_spatialmaterial_diffusemode>` **params_diffuse_mode**

  .. _class_SpatialMaterial_params_grow:

- :ref:`bool<class_bool>` **params_grow**

  .. _class_SpatialMaterial_params_grow_amount:

- :ref:`float<class_float>` **params_grow_amount**

  .. _class_SpatialMaterial_params_line_width:

- :ref:`float<class_float>` **params_line_width**

  .. _class_SpatialMaterial_params_point_size:

- :ref:`float<class_float>` **params_point_size**

  .. _class_SpatialMaterial_params_specular_mode:

- :ref:`SpecularMode<enum_spatialmaterial_specularmode>` **params_specular_mode**

  .. _class_SpatialMaterial_params_use_alpha_scissor:

- :ref:`bool<class_bool>` **params_use_alpha_scissor**

  .. _class_SpatialMaterial_particles_anim_h_frames:

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

  .. _class_SpatialMaterial_particles_anim_loop:

- :ref:`int<class_int>` **particles_anim_loop**

  .. _class_SpatialMaterial_particles_anim_v_frames:

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

  .. _class_SpatialMaterial_proximity_fade_distance:

- :ref:`float<class_float>` **proximity_fade_distance**

  .. _class_SpatialMaterial_proximity_fade_enable:

- :ref:`bool<class_bool>` **proximity_fade_enable**

  .. _class_SpatialMaterial_refraction_enabled:

- :ref:`bool<class_bool>` **refraction_enabled**

  .. _class_SpatialMaterial_refraction_scale:

- :ref:`float<class_float>` **refraction_scale**

  .. _class_SpatialMaterial_refraction_texture:

- :ref:`Texture<class_texture>` **refraction_texture**

  .. _class_SpatialMaterial_refraction_texture_channel:

- :ref:`TextureChannel<enum_spatialmaterial_texturechannel>` **refraction_texture_channel**

  .. _class_SpatialMaterial_rim:

- :ref:`float<class_float>` **rim**

  .. _class_SpatialMaterial_rim_enabled:

- :ref:`bool<class_bool>` **rim_enabled**

  .. _class_SpatialMaterial_rim_texture:

- :ref:`Texture<class_texture>` **rim_texture**

  .. _class_SpatialMaterial_rim_tint:

- :ref:`float<class_float>` **rim_tint**

  .. _class_SpatialMaterial_roughness:

- :ref:`float<class_float>` **roughness**

  .. _class_SpatialMaterial_roughness_texture:

- :ref:`Texture<class_texture>` **roughness_texture**

  .. _class_SpatialMaterial_roughness_texture_channel:

- :ref:`TextureChannel<enum_spatialmaterial_texturechannel>` **roughness_texture_channel**

  .. _class_SpatialMaterial_subsurf_scatter_enabled:

- :ref:`bool<class_bool>` **subsurf_scatter_enabled**

  .. _class_SpatialMaterial_subsurf_scatter_strength:

- :ref:`float<class_float>` **subsurf_scatter_strength**

  .. _class_SpatialMaterial_subsurf_scatter_texture:

- :ref:`Texture<class_texture>` **subsurf_scatter_texture**

  .. _class_SpatialMaterial_transmission:

- :ref:`Color<class_color>` **transmission**

  .. _class_SpatialMaterial_transmission_enabled:

- :ref:`bool<class_bool>` **transmission_enabled**

  .. _class_SpatialMaterial_transmission_texture:

- :ref:`Texture<class_texture>` **transmission_texture**

  .. _class_SpatialMaterial_uv1_offset:

- :ref:`Vector3<class_vector3>` **uv1_offset**

  .. _class_SpatialMaterial_uv1_scale:

- :ref:`Vector3<class_vector3>` **uv1_scale**

  .. _class_SpatialMaterial_uv1_triplanar:

- :ref:`bool<class_bool>` **uv1_triplanar**

  .. _class_SpatialMaterial_uv1_triplanar_sharpness:

- :ref:`float<class_float>` **uv1_triplanar_sharpness**

  .. _class_SpatialMaterial_uv2_offset:

- :ref:`Vector3<class_vector3>` **uv2_offset**

  .. _class_SpatialMaterial_uv2_scale:

- :ref:`Vector3<class_vector3>` **uv2_scale**

  .. _class_SpatialMaterial_uv2_triplanar:

- :ref:`bool<class_bool>` **uv2_triplanar**

  .. _class_SpatialMaterial_uv2_triplanar_sharpness:

- :ref:`float<class_float>` **uv2_triplanar_sharpness**

  .. _class_SpatialMaterial_vertex_color_is_srgb:

- :ref:`bool<class_bool>` **vertex_color_is_srgb**

  .. _class_SpatialMaterial_vertex_color_use_as_albedo:

- :ref:`bool<class_bool>` **vertex_color_use_as_albedo**


Enums
-----

  .. _enum_SpatialMaterial_DetailUV:

enum **DetailUV**

- **DETAIL_UV_1** = **0**
- **DETAIL_UV_2** = **1**

  .. _enum_SpatialMaterial_TextureParam:

enum **TextureParam**

- **TEXTURE_ALBEDO** = **0**
- **TEXTURE_METALLIC** = **1**
- **TEXTURE_ROUGHNESS** = **2**
- **TEXTURE_EMISSION** = **3**
- **TEXTURE_NORMAL** = **4**
- **TEXTURE_RIM** = **5**
- **TEXTURE_CLEARCOAT** = **6**
- **TEXTURE_FLOWMAP** = **7**
- **TEXTURE_AMBIENT_OCCLUSION** = **8**
- **TEXTURE_DEPTH** = **9**
- **TEXTURE_SUBSURFACE_SCATTERING** = **10**
- **TEXTURE_TRANSMISSION** = **11**
- **TEXTURE_REFRACTION** = **12**
- **TEXTURE_DETAIL_MASK** = **13**
- **TEXTURE_DETAIL_ALBEDO** = **14**
- **TEXTURE_DETAIL_NORMAL** = **15**
- **TEXTURE_MAX** = **16**

  .. _enum_SpatialMaterial_DepthDrawMode:

enum **DepthDrawMode**

- **DEPTH_DRAW_OPAQUE_ONLY** = **0**
- **DEPTH_DRAW_ALWAYS** = **1**
- **DEPTH_DRAW_DISABLED** = **2**
- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3**

  .. _enum_SpatialMaterial_DiffuseMode:

enum **DiffuseMode**

- **DIFFUSE_BURLEY** = **0**
- **DIFFUSE_LAMBERT** = **1**
- **DIFFUSE_LAMBERT_WRAP** = **2**
- **DIFFUSE_OREN_NAYAR** = **3**
- **DIFFUSE_TOON** = **4**

  .. _enum_SpatialMaterial_CullMode:

enum **CullMode**

- **CULL_BACK** = **0**
- **CULL_FRONT** = **1**
- **CULL_DISABLED** = **2**

  .. _enum_SpatialMaterial_Feature:

enum **Feature**

- **FEATURE_TRANSPARENT** = **0**
- **FEATURE_EMISSION** = **1**
- **FEATURE_NORMAL_MAPPING** = **2**
- **FEATURE_RIM** = **3**
- **FEATURE_CLEARCOAT** = **4**
- **FEATURE_ANISOTROPY** = **5**
- **FEATURE_AMBIENT_OCCLUSION** = **6**
- **FEATURE_DEPTH_MAPPING** = **7**
- **FEATURE_SUBSURACE_SCATTERING** = **8**
- **FEATURE_TRANSMISSION** = **9**
- **FEATURE_REFRACTION** = **10**
- **FEATURE_DETAIL** = **11**
- **FEATURE_MAX** = **12**

  .. _enum_SpatialMaterial_Flags:

enum **Flags**

- **FLAG_UNSHADED** = **0**
- **FLAG_USE_VERTEX_LIGHTING** = **1**
- **FLAG_DISABLE_DEPTH_TEST** = **2**
- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **3**
- **FLAG_SRGB_VERTEX_COLOR** = **4**
- **FLAG_USE_POINT_SIZE** = **5**
- **FLAG_FIXED_SIZE** = **6**
- **FLAG_UV1_USE_TRIPLANAR** = **7**
- **FLAG_UV2_USE_TRIPLANAR** = **8**
- **FLAG_AO_ON_UV2** = **10**
- **FLAG_EMISSION_ON_UV2** = **11**
- **FLAG_USE_ALPHA_SCISSOR** = **12**
- **FLAG_TRIPLANAR_USE_WORLD** = **9**
- **FLAG_ALBEDO_TEXTURE_FORCE_SRGB** = **13**
- **FLAG_MAX** = **14**

  .. _enum_SpatialMaterial_BlendMode:

enum **BlendMode**

- **BLEND_MODE_MIX** = **0**
- **BLEND_MODE_ADD** = **1**
- **BLEND_MODE_SUB** = **2**
- **BLEND_MODE_MUL** = **3**

  .. _enum_SpatialMaterial_SpecularMode:

enum **SpecularMode**

- **SPECULAR_SCHLICK_GGX** = **0**
- **SPECULAR_BLINN** = **1**
- **SPECULAR_PHONG** = **2**
- **SPECULAR_TOON** = **3**
- **SPECULAR_DISABLED** = **4**

  .. _enum_SpatialMaterial_TextureChannel:

enum **TextureChannel**

- **TEXTURE_CHANNEL_RED** = **0**
- **TEXTURE_CHANNEL_GREEN** = **1**
- **TEXTURE_CHANNEL_BLUE** = **2**
- **TEXTURE_CHANNEL_ALPHA** = **3**
- **TEXTURE_CHANNEL_GRAYSCALE** = **4**

  .. _enum_SpatialMaterial_BillboardMode:

enum **BillboardMode**

- **BILLBOARD_DISABLED** = **0**
- **BILLBOARD_ENABLED** = **1**
- **BILLBOARD_FIXED_Y** = **2**
- **BILLBOARD_PARTICLES** = **3**

  .. _enum_SpatialMaterial_EmissionOperator:

enum **EmissionOperator**

- **EMISSION_OP_ADD** = **0**
- **EMISSION_OP_MULTIPLY** = **1**