Files
godot-docs/classes/class_spatialmaterial.rst
2017-09-06 14:46:15 +02:00

771 lines
54 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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 Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_albedo<class_SpatialMaterial_get_albedo>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_alpha_scissor_threshold<class_SpatialMaterial_get_alpha_scissor_threshold>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_anisotropy<class_SpatialMaterial_get_anisotropy>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_ao_texture_channel<class_SpatialMaterial_get_ao_texture_channel>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_billboard_mode<class_SpatialMaterial_get_billboard_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_SpatialMaterial_get_blend_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_clearcoat<class_SpatialMaterial_get_clearcoat>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_clearcoat_gloss<class_SpatialMaterial_get_clearcoat_gloss>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cull_mode<class_SpatialMaterial_get_cull_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_depth_deep_parallax_max_layers<class_SpatialMaterial_get_depth_deep_parallax_max_layers>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_depth_deep_parallax_min_layers<class_SpatialMaterial_get_depth_deep_parallax_min_layers>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_depth_draw_mode<class_SpatialMaterial_get_depth_draw_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth_scale<class_SpatialMaterial_get_depth_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_detail_blend_mode<class_SpatialMaterial_get_detail_blend_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_detail_uv<class_SpatialMaterial_get_detail_uv>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_diffuse_mode<class_SpatialMaterial_get_diffuse_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_emission<class_SpatialMaterial_get_emission>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_emission_energy<class_SpatialMaterial_get_emission_energy>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_feature<class_SpatialMaterial_get_feature>` **(** :ref:`int<class_int>` feature **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_SpatialMaterial_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_grow<class_SpatialMaterial_get_grow>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_line_width<class_SpatialMaterial_get_line_width>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_metallic<class_SpatialMaterial_get_metallic>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_metallic_texture_channel<class_SpatialMaterial_get_metallic_texture_channel>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_normal_scale<class_SpatialMaterial_get_normal_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_particles_anim_h_frames<class_SpatialMaterial_get_particles_anim_h_frames>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_particles_anim_loop<class_SpatialMaterial_get_particles_anim_loop>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_particles_anim_v_frames<class_SpatialMaterial_get_particles_anim_v_frames>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_size<class_SpatialMaterial_get_point_size>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_refraction<class_SpatialMaterial_get_refraction>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_refraction_texture_channel<class_SpatialMaterial_get_refraction_texture_channel>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rim<class_SpatialMaterial_get_rim>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rim_tint<class_SpatialMaterial_get_rim_tint>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_roughness<class_SpatialMaterial_get_roughness>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_roughness_texture_channel<class_SpatialMaterial_get_roughness_texture_channel>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_specular<class_SpatialMaterial_get_specular>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_specular_mode<class_SpatialMaterial_get_specular_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_subsurface_scattering_strength<class_SpatialMaterial_get_subsurface_scattering_strength>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_SpatialMaterial_get_texture>` **(** :ref:`int<class_int>` param **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_transmission<class_SpatialMaterial_get_transmission>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_uv1_offset<class_SpatialMaterial_get_uv1_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_uv1_scale<class_SpatialMaterial_get_uv1_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_uv1_triplanar_blend_sharpness<class_SpatialMaterial_get_uv1_triplanar_blend_sharpness>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_uv2_offset<class_SpatialMaterial_get_uv2_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_uv2_scale<class_SpatialMaterial_get_uv2_scale>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_uv2_triplanar_blend_sharpness<class_SpatialMaterial_get_uv2_triplanar_blend_sharpness>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_depth_deep_parallax_enabled<class_SpatialMaterial_is_depth_deep_parallax_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_grow_enabled<class_SpatialMaterial_is_grow_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_albedo<class_SpatialMaterial_set_albedo>` **(** :ref:`Color<class_color>` albedo **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_alpha_scissor_threshold<class_SpatialMaterial_set_alpha_scissor_threshold>` **(** :ref:`float<class_float>` threshold **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anisotropy<class_SpatialMaterial_set_anisotropy>` **(** :ref:`float<class_float>` anisotropy **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_texture_channel<class_SpatialMaterial_set_ao_texture_channel>` **(** :ref:`int<class_int>` channel **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_billboard_mode<class_SpatialMaterial_set_billboard_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_mode<class_SpatialMaterial_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clearcoat<class_SpatialMaterial_set_clearcoat>` **(** :ref:`float<class_float>` clearcoat **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clearcoat_gloss<class_SpatialMaterial_set_clearcoat_gloss>` **(** :ref:`float<class_float>` clearcoat_gloss **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cull_mode<class_SpatialMaterial_set_cull_mode>` **(** :ref:`int<class_int>` cull_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth_deep_parallax<class_SpatialMaterial_set_depth_deep_parallax>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth_deep_parallax_max_layers<class_SpatialMaterial_set_depth_deep_parallax_max_layers>` **(** :ref:`int<class_int>` layer **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth_deep_parallax_min_layers<class_SpatialMaterial_set_depth_deep_parallax_min_layers>` **(** :ref:`int<class_int>` layer **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth_draw_mode<class_SpatialMaterial_set_depth_draw_mode>` **(** :ref:`int<class_int>` depth_draw_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth_scale<class_SpatialMaterial_set_depth_scale>` **(** :ref:`float<class_float>` depth_scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_detail_blend_mode<class_SpatialMaterial_set_detail_blend_mode>` **(** :ref:`int<class_int>` detail_blend_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_detail_uv<class_SpatialMaterial_set_detail_uv>` **(** :ref:`int<class_int>` detail_uv **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_diffuse_mode<class_SpatialMaterial_set_diffuse_mode>` **(** :ref:`int<class_int>` diffuse_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_emission<class_SpatialMaterial_set_emission>` **(** :ref:`Color<class_color>` emission **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_emission_energy<class_SpatialMaterial_set_emission_energy>` **(** :ref:`float<class_float>` emission_energy **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_feature<class_SpatialMaterial_set_feature>` **(** :ref:`int<class_int>` feature, :ref:`bool<class_bool>` enable **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_SpatialMaterial_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_grow<class_SpatialMaterial_set_grow>` **(** :ref:`float<class_float>` amount **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_grow_enabled<class_SpatialMaterial_set_grow_enabled>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_line_width<class_SpatialMaterial_set_line_width>` **(** :ref:`float<class_float>` line_width **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_metallic<class_SpatialMaterial_set_metallic>` **(** :ref:`float<class_float>` metallic **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_metallic_texture_channel<class_SpatialMaterial_set_metallic_texture_channel>` **(** :ref:`int<class_int>` channel **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_scale<class_SpatialMaterial_set_normal_scale>` **(** :ref:`float<class_float>` normal_scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_particles_anim_h_frames<class_SpatialMaterial_set_particles_anim_h_frames>` **(** :ref:`int<class_int>` frames **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_particles_anim_loop<class_SpatialMaterial_set_particles_anim_loop>` **(** :ref:`int<class_int>` frames **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_particles_anim_v_frames<class_SpatialMaterial_set_particles_anim_v_frames>` **(** :ref:`int<class_int>` frames **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_size<class_SpatialMaterial_set_point_size>` **(** :ref:`float<class_float>` point_size **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_refraction<class_SpatialMaterial_set_refraction>` **(** :ref:`float<class_float>` refraction **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_refraction_texture_channel<class_SpatialMaterial_set_refraction_texture_channel>` **(** :ref:`int<class_int>` channel **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rim<class_SpatialMaterial_set_rim>` **(** :ref:`float<class_float>` rim **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rim_tint<class_SpatialMaterial_set_rim_tint>` **(** :ref:`float<class_float>` rim_tint **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_roughness<class_SpatialMaterial_set_roughness>` **(** :ref:`float<class_float>` roughness **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_roughness_texture_channel<class_SpatialMaterial_set_roughness_texture_channel>` **(** :ref:`int<class_int>` channel **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_specular<class_SpatialMaterial_set_specular>` **(** :ref:`float<class_float>` specular **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_specular_mode<class_SpatialMaterial_set_specular_mode>` **(** :ref:`int<class_int>` specular_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_subsurface_scattering_strength<class_SpatialMaterial_set_subsurface_scattering_strength>` **(** :ref:`float<class_float>` strength **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_SpatialMaterial_set_texture>` **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transmission<class_SpatialMaterial_set_transmission>` **(** :ref:`Color<class_color>` transmission **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv1_offset<class_SpatialMaterial_set_uv1_offset>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv1_scale<class_SpatialMaterial_set_uv1_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv1_triplanar_blend_sharpness<class_SpatialMaterial_set_uv1_triplanar_blend_sharpness>` **(** :ref:`float<class_float>` sharpness **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2_offset<class_SpatialMaterial_set_uv2_offset>` **(** :ref:`Vector3<class_vector3>` offset **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2_scale<class_SpatialMaterial_set_uv2_scale>` **(** :ref:`Vector3<class_vector3>` scale **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2_triplanar_blend_sharpness<class_SpatialMaterial_set_uv2_triplanar_blend_sharpness>` **(** :ref:`float<class_float>` sharpness **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Color<class_color>` **albedo_color**
- :ref:`Texture<class_texture>` **albedo_texture**
- :ref:`float<class_float>` **anisotropy**
- :ref:`bool<class_bool>` **anisotropy_enabled**
- :ref:`Texture<class_texture>` **anisotropy_flowmap**
- :ref:`bool<class_bool>` **ao_enabled**
- :ref:`bool<class_bool>` **ao_on_uv2**
- :ref:`Texture<class_texture>` **ao_texture**
- :ref:`int<class_int>` **ao_texture_channel**
- :ref:`float<class_float>` **clearcoat**
- :ref:`bool<class_bool>` **clearcoat_enabled**
- :ref:`float<class_float>` **clearcoat_gloss**
- :ref:`Texture<class_texture>` **clearcoat_texture**
- :ref:`bool<class_bool>` **depth_deep_parallax**
- :ref:`bool<class_bool>` **depth_enabled**
- :ref:`int<class_int>` **depth_max_layers**
- :ref:`int<class_int>` **depth_min_layers**
- :ref:`float<class_float>` **depth_scale**
- :ref:`Texture<class_texture>` **depth_texture**
- :ref:`Texture<class_texture>` **detail_albedo**
- :ref:`int<class_int>` **detail_blend_mode**
- :ref:`bool<class_bool>` **detail_enabled**
- :ref:`Texture<class_texture>` **detail_mask**
- :ref:`Texture<class_texture>` **detail_normal**
- :ref:`int<class_int>` **detail_uv_layer**
- :ref:`Color<class_color>` **emission**
- :ref:`bool<class_bool>` **emission_enabled**
- :ref:`float<class_float>` **emission_energy**
- :ref:`Texture<class_texture>` **emission_texture**
- :ref:`bool<class_bool>` **flags_fixed_size**
- :ref:`bool<class_bool>` **flags_no_depth_test**
- :ref:`bool<class_bool>` **flags_transparent**
- :ref:`bool<class_bool>` **flags_unshaded**
- :ref:`bool<class_bool>` **flags_use_point_size**
- :ref:`bool<class_bool>` **flags_vertex_lighting**
- :ref:`bool<class_bool>` **flags_world_triplanar**
- :ref:`float<class_float>` **metallic**
- :ref:`float<class_float>` **metallic_specular**
- :ref:`Texture<class_texture>` **metallic_texture**
- :ref:`int<class_int>` **metallic_texture_channel**
- :ref:`bool<class_bool>` **normal_enabled**
- :ref:`float<class_float>` **normal_scale**
- :ref:`Texture<class_texture>` **normal_texture**
- :ref:`float<class_float>` **params_alpha_scissor_threshold**
- :ref:`int<class_int>` **params_billboard_mode**
- :ref:`int<class_int>` **params_blend_mode**
- :ref:`int<class_int>` **params_cull_mode**
- :ref:`int<class_int>` **params_depth_draw_mode**
- :ref:`int<class_int>` **params_diffuse_mode**
- :ref:`bool<class_bool>` **params_grow**
- :ref:`float<class_float>` **params_grow_amount**
- :ref:`float<class_float>` **params_line_width**
- :ref:`float<class_float>` **params_point_size**
- :ref:`int<class_int>` **params_specular_mode**
- :ref:`bool<class_bool>` **params_use_alpha_scissor**
- :ref:`int<class_int>` **particles_anim_h_frames**
- :ref:`int<class_int>` **particles_anim_loop**
- :ref:`int<class_int>` **particles_anim_v_frames**
- :ref:`bool<class_bool>` **refraction_enabled**
- :ref:`float<class_float>` **refraction_scale**
- :ref:`Texture<class_texture>` **refraction_texture**
- :ref:`int<class_int>` **refraction_texture_channel**
- :ref:`float<class_float>` **rim**
- :ref:`bool<class_bool>` **rim_enabled**
- :ref:`Texture<class_texture>` **rim_texture**
- :ref:`float<class_float>` **rim_tint**
- :ref:`float<class_float>` **roughness**
- :ref:`Texture<class_texture>` **roughness_texture**
- :ref:`int<class_int>` **roughness_texture_channel**
- :ref:`bool<class_bool>` **subsurf_scatter_enabled**
- :ref:`float<class_float>` **subsurf_scatter_strength**
- :ref:`Texture<class_texture>` **subsurf_scatter_texture**
- :ref:`Color<class_color>` **transmission**
- :ref:`bool<class_bool>` **transmission_enabled**
- :ref:`Texture<class_texture>` **transmission_texture**
- :ref:`Vector3<class_vector3>` **uv1_offset**
- :ref:`Vector3<class_vector3>` **uv1_scale**
- :ref:`bool<class_bool>` **uv1_triplanar**
- :ref:`float<class_float>` **uv1_triplanar_sharpness**
- :ref:`Vector3<class_vector3>` **uv2_offset**
- :ref:`Vector3<class_vector3>` **uv2_scale**
- :ref:`bool<class_bool>` **uv2_triplanar**
- :ref:`float<class_float>` **uv2_triplanar_sharpness**
- :ref:`bool<class_bool>` **vertex_color_is_srgb**
- :ref:`bool<class_bool>` **vertex_color_use_as_albedo**
Numeric Constants
-----------------
- **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**
- **DETAIL_UV_1** = **0**
- **DETAIL_UV_2** = **1**
- **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**
- **BLEND_MODE_MIX** = **0**
- **BLEND_MODE_ADD** = **1**
- **BLEND_MODE_SUB** = **2**
- **BLEND_MODE_MUL** = **3**
- **DEPTH_DRAW_OPAQUE_ONLY** = **0**
- **DEPTH_DRAW_ALWAYS** = **1**
- **DEPTH_DRAW_DISABLED** = **2**
- **DEPTH_DRAW_ALPHA_OPAQUE_PREPASS** = **3**
- **CULL_BACK** = **0**
- **CULL_FRONT** = **1**
- **CULL_DISABLED** = **2**
- **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_USE_ALPHA_SCISSOR** = **11**
- **FLAG_TRIPLANAR_USE_WORLD** = **9**
- **FLAG_MAX** = **12**
- **DIFFUSE_LAMBERT** = **0**
- **DIFFUSE_LAMBERT_WRAP** = **1**
- **DIFFUSE_OREN_NAYAR** = **2**
- **DIFFUSE_BURLEY** = **3**
- **DIFFUSE_TOON** = **4**
- **SPECULAR_SCHLICK_GGX** = **0**
- **SPECULAR_BLINN** = **1**
- **SPECULAR_PHONG** = **2**
- **SPECULAR_TOON** = **3**
- **SPECULAR_DISABLED** = **4**
- **BILLBOARD_DISABLED** = **0**
- **BILLBOARD_ENABLED** = **1**
- **BILLBOARD_FIXED_Y** = **2**
- **BILLBOARD_PARTICLES** = **3**
- **TEXTURE_CHANNEL_RED** = **0**
- **TEXTURE_CHANNEL_GREEN** = **1**
- **TEXTURE_CHANNEL_BLUE** = **2**
- **TEXTURE_CHANNEL_ALPHA** = **3**
- **TEXTURE_CHANNEL_GRAYSCALE** = **4**
Member Function Description
---------------------------
.. _class_SpatialMaterial_get_albedo:
- :ref:`Color<class_color>` **get_albedo** **(** **)** const
.. _class_SpatialMaterial_get_alpha_scissor_threshold:
- :ref:`float<class_float>` **get_alpha_scissor_threshold** **(** **)** const
.. _class_SpatialMaterial_get_anisotropy:
- :ref:`float<class_float>` **get_anisotropy** **(** **)** const
.. _class_SpatialMaterial_get_ao_texture_channel:
- :ref:`int<class_int>` **get_ao_texture_channel** **(** **)** const
.. _class_SpatialMaterial_get_billboard_mode:
- :ref:`int<class_int>` **get_billboard_mode** **(** **)** const
.. _class_SpatialMaterial_get_blend_mode:
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
.. _class_SpatialMaterial_get_clearcoat:
- :ref:`float<class_float>` **get_clearcoat** **(** **)** const
.. _class_SpatialMaterial_get_clearcoat_gloss:
- :ref:`float<class_float>` **get_clearcoat_gloss** **(** **)** const
.. _class_SpatialMaterial_get_cull_mode:
- :ref:`int<class_int>` **get_cull_mode** **(** **)** const
.. _class_SpatialMaterial_get_depth_deep_parallax_max_layers:
- :ref:`int<class_int>` **get_depth_deep_parallax_max_layers** **(** **)** const
.. _class_SpatialMaterial_get_depth_deep_parallax_min_layers:
- :ref:`int<class_int>` **get_depth_deep_parallax_min_layers** **(** **)** const
.. _class_SpatialMaterial_get_depth_draw_mode:
- :ref:`int<class_int>` **get_depth_draw_mode** **(** **)** const
.. _class_SpatialMaterial_get_depth_scale:
- :ref:`float<class_float>` **get_depth_scale** **(** **)** const
.. _class_SpatialMaterial_get_detail_blend_mode:
- :ref:`int<class_int>` **get_detail_blend_mode** **(** **)** const
.. _class_SpatialMaterial_get_detail_uv:
- :ref:`int<class_int>` **get_detail_uv** **(** **)** const
.. _class_SpatialMaterial_get_diffuse_mode:
- :ref:`int<class_int>` **get_diffuse_mode** **(** **)** const
.. _class_SpatialMaterial_get_emission:
- :ref:`Color<class_color>` **get_emission** **(** **)** const
.. _class_SpatialMaterial_get_emission_energy:
- :ref:`float<class_float>` **get_emission_energy** **(** **)** const
.. _class_SpatialMaterial_get_feature:
- :ref:`bool<class_bool>` **get_feature** **(** :ref:`int<class_int>` feature **)** const
.. _class_SpatialMaterial_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
.. _class_SpatialMaterial_get_grow:
- :ref:`float<class_float>` **get_grow** **(** **)** const
.. _class_SpatialMaterial_get_line_width:
- :ref:`float<class_float>` **get_line_width** **(** **)** const
.. _class_SpatialMaterial_get_metallic:
- :ref:`float<class_float>` **get_metallic** **(** **)** const
.. _class_SpatialMaterial_get_metallic_texture_channel:
- :ref:`int<class_int>` **get_metallic_texture_channel** **(** **)** const
.. _class_SpatialMaterial_get_normal_scale:
- :ref:`float<class_float>` **get_normal_scale** **(** **)** const
.. _class_SpatialMaterial_get_particles_anim_h_frames:
- :ref:`int<class_int>` **get_particles_anim_h_frames** **(** **)** const
.. _class_SpatialMaterial_get_particles_anim_loop:
- :ref:`int<class_int>` **get_particles_anim_loop** **(** **)** const
.. _class_SpatialMaterial_get_particles_anim_v_frames:
- :ref:`int<class_int>` **get_particles_anim_v_frames** **(** **)** const
.. _class_SpatialMaterial_get_point_size:
- :ref:`float<class_float>` **get_point_size** **(** **)** const
.. _class_SpatialMaterial_get_refraction:
- :ref:`float<class_float>` **get_refraction** **(** **)** const
.. _class_SpatialMaterial_get_refraction_texture_channel:
- :ref:`int<class_int>` **get_refraction_texture_channel** **(** **)** const
.. _class_SpatialMaterial_get_rim:
- :ref:`float<class_float>` **get_rim** **(** **)** const
.. _class_SpatialMaterial_get_rim_tint:
- :ref:`float<class_float>` **get_rim_tint** **(** **)** const
.. _class_SpatialMaterial_get_roughness:
- :ref:`float<class_float>` **get_roughness** **(** **)** const
.. _class_SpatialMaterial_get_roughness_texture_channel:
- :ref:`int<class_int>` **get_roughness_texture_channel** **(** **)** const
.. _class_SpatialMaterial_get_specular:
- :ref:`float<class_float>` **get_specular** **(** **)** const
.. _class_SpatialMaterial_get_specular_mode:
- :ref:`int<class_int>` **get_specular_mode** **(** **)** const
.. _class_SpatialMaterial_get_subsurface_scattering_strength:
- :ref:`float<class_float>` **get_subsurface_scattering_strength** **(** **)** const
.. _class_SpatialMaterial_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` param **)** const
.. _class_SpatialMaterial_get_transmission:
- :ref:`Color<class_color>` **get_transmission** **(** **)** const
.. _class_SpatialMaterial_get_uv1_offset:
- :ref:`Vector3<class_vector3>` **get_uv1_offset** **(** **)** const
.. _class_SpatialMaterial_get_uv1_scale:
- :ref:`Vector3<class_vector3>` **get_uv1_scale** **(** **)** const
.. _class_SpatialMaterial_get_uv1_triplanar_blend_sharpness:
- :ref:`float<class_float>` **get_uv1_triplanar_blend_sharpness** **(** **)** const
.. _class_SpatialMaterial_get_uv2_offset:
- :ref:`Vector3<class_vector3>` **get_uv2_offset** **(** **)** const
.. _class_SpatialMaterial_get_uv2_scale:
- :ref:`Vector3<class_vector3>` **get_uv2_scale** **(** **)** const
.. _class_SpatialMaterial_get_uv2_triplanar_blend_sharpness:
- :ref:`float<class_float>` **get_uv2_triplanar_blend_sharpness** **(** **)** const
.. _class_SpatialMaterial_is_depth_deep_parallax_enabled:
- :ref:`bool<class_bool>` **is_depth_deep_parallax_enabled** **(** **)** const
.. _class_SpatialMaterial_is_grow_enabled:
- :ref:`bool<class_bool>` **is_grow_enabled** **(** **)** const
.. _class_SpatialMaterial_set_albedo:
- void **set_albedo** **(** :ref:`Color<class_color>` albedo **)**
.. _class_SpatialMaterial_set_alpha_scissor_threshold:
- void **set_alpha_scissor_threshold** **(** :ref:`float<class_float>` threshold **)**
.. _class_SpatialMaterial_set_anisotropy:
- void **set_anisotropy** **(** :ref:`float<class_float>` anisotropy **)**
.. _class_SpatialMaterial_set_ao_texture_channel:
- void **set_ao_texture_channel** **(** :ref:`int<class_int>` channel **)**
.. _class_SpatialMaterial_set_billboard_mode:
- void **set_billboard_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_SpatialMaterial_set_blend_mode:
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
.. _class_SpatialMaterial_set_clearcoat:
- void **set_clearcoat** **(** :ref:`float<class_float>` clearcoat **)**
.. _class_SpatialMaterial_set_clearcoat_gloss:
- void **set_clearcoat_gloss** **(** :ref:`float<class_float>` clearcoat_gloss **)**
.. _class_SpatialMaterial_set_cull_mode:
- void **set_cull_mode** **(** :ref:`int<class_int>` cull_mode **)**
.. _class_SpatialMaterial_set_depth_deep_parallax:
- void **set_depth_deep_parallax** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_set_depth_deep_parallax_max_layers:
- void **set_depth_deep_parallax_max_layers** **(** :ref:`int<class_int>` layer **)**
.. _class_SpatialMaterial_set_depth_deep_parallax_min_layers:
- void **set_depth_deep_parallax_min_layers** **(** :ref:`int<class_int>` layer **)**
.. _class_SpatialMaterial_set_depth_draw_mode:
- void **set_depth_draw_mode** **(** :ref:`int<class_int>` depth_draw_mode **)**
.. _class_SpatialMaterial_set_depth_scale:
- void **set_depth_scale** **(** :ref:`float<class_float>` depth_scale **)**
.. _class_SpatialMaterial_set_detail_blend_mode:
- void **set_detail_blend_mode** **(** :ref:`int<class_int>` detail_blend_mode **)**
.. _class_SpatialMaterial_set_detail_uv:
- void **set_detail_uv** **(** :ref:`int<class_int>` detail_uv **)**
.. _class_SpatialMaterial_set_diffuse_mode:
- void **set_diffuse_mode** **(** :ref:`int<class_int>` diffuse_mode **)**
.. _class_SpatialMaterial_set_emission:
- void **set_emission** **(** :ref:`Color<class_color>` emission **)**
.. _class_SpatialMaterial_set_emission_energy:
- void **set_emission_energy** **(** :ref:`float<class_float>` emission_energy **)**
.. _class_SpatialMaterial_set_feature:
- void **set_feature** **(** :ref:`int<class_int>` feature, :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_set_flag:
- void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_set_grow:
- void **set_grow** **(** :ref:`float<class_float>` amount **)**
.. _class_SpatialMaterial_set_grow_enabled:
- void **set_grow_enabled** **(** :ref:`bool<class_bool>` enable **)**
.. _class_SpatialMaterial_set_line_width:
- void **set_line_width** **(** :ref:`float<class_float>` line_width **)**
.. _class_SpatialMaterial_set_metallic:
- void **set_metallic** **(** :ref:`float<class_float>` metallic **)**
.. _class_SpatialMaterial_set_metallic_texture_channel:
- void **set_metallic_texture_channel** **(** :ref:`int<class_int>` channel **)**
.. _class_SpatialMaterial_set_normal_scale:
- void **set_normal_scale** **(** :ref:`float<class_float>` normal_scale **)**
.. _class_SpatialMaterial_set_particles_anim_h_frames:
- void **set_particles_anim_h_frames** **(** :ref:`int<class_int>` frames **)**
.. _class_SpatialMaterial_set_particles_anim_loop:
- void **set_particles_anim_loop** **(** :ref:`int<class_int>` frames **)**
.. _class_SpatialMaterial_set_particles_anim_v_frames:
- void **set_particles_anim_v_frames** **(** :ref:`int<class_int>` frames **)**
.. _class_SpatialMaterial_set_point_size:
- void **set_point_size** **(** :ref:`float<class_float>` point_size **)**
.. _class_SpatialMaterial_set_refraction:
- void **set_refraction** **(** :ref:`float<class_float>` refraction **)**
.. _class_SpatialMaterial_set_refraction_texture_channel:
- void **set_refraction_texture_channel** **(** :ref:`int<class_int>` channel **)**
.. _class_SpatialMaterial_set_rim:
- void **set_rim** **(** :ref:`float<class_float>` rim **)**
.. _class_SpatialMaterial_set_rim_tint:
- void **set_rim_tint** **(** :ref:`float<class_float>` rim_tint **)**
.. _class_SpatialMaterial_set_roughness:
- void **set_roughness** **(** :ref:`float<class_float>` roughness **)**
.. _class_SpatialMaterial_set_roughness_texture_channel:
- void **set_roughness_texture_channel** **(** :ref:`int<class_int>` channel **)**
.. _class_SpatialMaterial_set_specular:
- void **set_specular** **(** :ref:`float<class_float>` specular **)**
.. _class_SpatialMaterial_set_specular_mode:
- void **set_specular_mode** **(** :ref:`int<class_int>` specular_mode **)**
.. _class_SpatialMaterial_set_subsurface_scattering_strength:
- void **set_subsurface_scattering_strength** **(** :ref:`float<class_float>` strength **)**
.. _class_SpatialMaterial_set_texture:
- void **set_texture** **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)**
.. _class_SpatialMaterial_set_transmission:
- void **set_transmission** **(** :ref:`Color<class_color>` transmission **)**
.. _class_SpatialMaterial_set_uv1_offset:
- void **set_uv1_offset** **(** :ref:`Vector3<class_vector3>` offset **)**
.. _class_SpatialMaterial_set_uv1_scale:
- void **set_uv1_scale** **(** :ref:`Vector3<class_vector3>` scale **)**
.. _class_SpatialMaterial_set_uv1_triplanar_blend_sharpness:
- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float<class_float>` sharpness **)**
.. _class_SpatialMaterial_set_uv2_offset:
- void **set_uv2_offset** **(** :ref:`Vector3<class_vector3>` offset **)**
.. _class_SpatialMaterial_set_uv2_scale:
- void **set_uv2_scale** **(** :ref:`Vector3<class_vector3>` scale **)**
.. _class_SpatialMaterial_set_uv2_triplanar_blend_sharpness:
- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float<class_float>` sharpness **)**