2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 10:33:56 +00:00
<class name= "SpatialMaterial" inherits= "Material" category= "Core" version= "3.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
2018-10-07 00:39:24 +00:00
Default 3D rendering material.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2018-10-07 00:39:24 +00:00
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.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2018-11-05 07:46:27 +00:00
<link > https://docs.godotengine.org/en/latest/tutorials/3d/spatial_material.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
2019-06-27 14:10:09 +00:00
<method name= "get_feature" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "feature" type= "int" enum= "SpatialMaterial.Feature" >
</argument>
<description >
</description>
</method>
<method name= "get_flag" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "flag" type= "int" enum= "SpatialMaterial.Flags" >
</argument>
<description >
</description>
</method>
<method name= "get_texture" qualifiers= "const" >
<return type= "Texture" >
</return>
<argument index= "0" name= "param" type= "int" enum= "SpatialMaterial.TextureParam" >
</argument>
<description >
</description>
</method>
<method name= "set_feature" >
<return type= "void" >
</return>
<argument index= "0" name= "feature" type= "int" enum= "SpatialMaterial.Feature" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
</description>
</method>
<method name= "set_flag" >
<return type= "void" >
</return>
<argument index= "0" name= "flag" type= "int" enum= "SpatialMaterial.Flags" >
</argument>
<argument index= "1" name= "enable" type= "bool" >
</argument>
<description >
</description>
</method>
<method name= "set_texture" >
<return type= "void" >
</return>
<argument index= "0" name= "param" type= "int" enum= "SpatialMaterial.TextureParam" >
</argument>
<argument index= "1" name= "texture" type= "Texture" >
</argument>
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "albedo_color" type= "Color" setter= "set_albedo" getter= "get_albedo" default= "Color( 1, 1, 1, 1 )" >
2018-10-07 00:39:24 +00:00
The material's base color.
2017-09-12 20:42:36 +00:00
</member>
2019-07-15 18:42:47 +00:00
<member name= "albedo_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "anisotropy" type= "float" setter= "set_anisotropy" getter= "get_anisotropy" >
2018-10-07 00:39:24 +00:00
The strength of the anisotropy effect.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "anisotropy_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "anisotropy_flowmap" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "ao_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], ambient occlusion is enabled.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "ao_light_affect" type= "float" setter= "set_ao_light_affect" getter= "get_ao_light_affect" >
2017-10-11 21:54:43 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "ao_on_uv2" type= "bool" setter= "set_flag" getter= "get_flag" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "ao_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "ao_texture_channel" type= "int" setter= "set_ao_texture_channel" getter= "get_ao_texture_channel" enum= "SpatialMaterial.TextureChannel" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "clearcoat" type= "float" setter= "set_clearcoat" getter= "get_clearcoat" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "clearcoat_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the material.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "clearcoat_gloss" type= "float" setter= "set_clearcoat_gloss" getter= "get_clearcoat_gloss" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "clearcoat_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_deep_parallax" type= "bool" setter= "set_depth_deep_parallax" getter= "is_depth_deep_parallax_enabled" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "depth_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-21 23:04:47 +00:00
If [code]true[/code], depth mapping is enabled (also called "parallax mapping" or "height mapping"). See also [member normal_enabled].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_flip_binormal" type= "bool" setter= "set_depth_deep_parallax_flip_binormal" getter= "get_depth_deep_parallax_flip_binormal" >
2018-11-20 08:34:45 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_flip_tangent" type= "bool" setter= "set_depth_deep_parallax_flip_tangent" getter= "get_depth_deep_parallax_flip_tangent" >
2018-11-20 08:34:45 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_max_layers" type= "int" setter= "set_depth_deep_parallax_max_layers" getter= "get_depth_deep_parallax_max_layers" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_min_layers" type= "int" setter= "set_depth_deep_parallax_min_layers" getter= "get_depth_deep_parallax_min_layers" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_scale" type= "float" setter= "set_depth_scale" getter= "get_depth_scale" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "depth_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "detail_albedo" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "detail_blend_mode" type= "int" setter= "set_detail_blend_mode" getter= "get_detail_blend_mode" enum= "SpatialMaterial.BlendMode" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "detail_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "detail_mask" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "detail_normal" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "detail_uv_layer" type= "int" setter= "set_detail_uv" getter= "get_detail_uv" enum= "SpatialMaterial.DetailUV" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "distance_fade_max_distance" type= "float" setter= "set_distance_fade_max_distance" getter= "get_distance_fade_max_distance" >
2017-09-23 08:59:35 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "distance_fade_min_distance" type= "float" setter= "set_distance_fade_min_distance" getter= "get_distance_fade_min_distance" >
2017-09-23 08:59:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "distance_fade_mode" type= "int" setter= "set_distance_fade" getter= "get_distance_fade" enum= "SpatialMaterial.DistanceFadeMode" default= "0" >
2018-08-29 20:25:11 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "emission" type= "Color" setter= "set_emission" getter= "get_emission" >
2018-10-07 00:39:24 +00:00
The emitted light's color. See [member emission_enabled].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "emission_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], the body emits light.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "emission_energy" type= "float" setter= "set_emission_energy" getter= "get_emission_energy" >
2018-10-07 00:39:24 +00:00
The emitted light's strength. See [member emission_enabled].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "emission_on_uv2" type= "bool" setter= "set_flag" getter= "get_flag" >
2017-12-16 19:34:16 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "emission_operator" type= "int" setter= "set_emission_operator" getter= "get_emission_operator" enum= "SpatialMaterial.EmissionOperator" >
2017-11-15 19:35:18 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "emission_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_albedo_tex_force_srgb" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2017-12-07 07:23:08 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_disable_ambient_light" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the object receives no ambient light.
2018-07-26 09:56:21 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_do_not_receive_shadows" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the object receives no shadow that would otherwise be cast onto it.
2018-05-12 07:38:00 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_ensure_correct_normals" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2018-07-26 09:56:21 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_fixed_size" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the object is rendered at the same size regardless of distance.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_no_depth_test" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], depth testing is disabled and the object will be drawn in render order.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_transparent" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], transparency is enabled on the body. See also [member params_blend_mode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_unshaded" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the object is unaffected by lighting.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_use_point_size" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-21 23:04:47 +00:00
If [code]true[/code], render point size can be changed.
[b]Note:[/b] this is only effective for objects whose geometry is point-based rather than triangle-based. See also [member params_point_size].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_use_shadow_to_opacity" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-05-28 16:08:13 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_vertex_lighting" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "flags_world_triplanar" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], triplanar mapping is calculated in world space rather than object local space. See also [member uv1_triplanar].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "metallic" type= "float" setter= "set_metallic" getter= "get_metallic" default= "0.0" >
2019-06-21 23:04:47 +00:00
The reflectivity of the object's surface. The higher the value, the more light is reflected.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "metallic_specular" type= "float" setter= "set_specular" getter= "get_specular" default= "0.5" >
2019-06-21 23:04:47 +00:00
General reflectivity amount.
[b]Note:[/b] unlike [member metallic], this is not energy-conserving, so it should be left at [code]0.5[/code] in most cases. See also [member roughness].
2017-09-12 20:42:36 +00:00
</member>
2019-07-15 18:42:47 +00:00
<member name= "metallic_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-07-22 10:24:14 +00:00
<member name= "metallic_texture_channel" type= "int" setter= "set_metallic_texture_channel" getter= "get_metallic_texture_channel" enum= "SpatialMaterial.TextureChannel" default= "0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "normal_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], normal mapping is enabled.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "normal_scale" type= "float" setter= "set_normal_scale" getter= "get_normal_scale" >
2018-10-07 00:39:24 +00:00
The strength of the normal map's effect.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "normal_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "params_alpha_scissor_threshold" type= "float" setter= "set_alpha_scissor_threshold" getter= "get_alpha_scissor_threshold" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_billboard_keep_scale" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2018-07-26 09:56:21 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_billboard_mode" type= "int" setter= "set_billboard_mode" getter= "get_billboard_mode" enum= "SpatialMaterial.BillboardMode" default= "0" >
2018-10-07 00:39:24 +00:00
Controls how the object faces the camera. See [enum BillboardMode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_blend_mode" type= "int" setter= "set_blend_mode" getter= "get_blend_mode" enum= "SpatialMaterial.BlendMode" default= "0" >
2019-06-21 23:04:47 +00:00
The material's blend mode.
[b]Note:[/b] Values other than [code]Mix[/code] force the object into the transparent pipeline. See [enum BlendMode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_cull_mode" type= "int" setter= "set_cull_mode" getter= "get_cull_mode" enum= "SpatialMaterial.CullMode" default= "0" >
2018-10-07 00:39:24 +00:00
Which side of the object is not drawn when backfaces are rendered. See [enum CullMode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_depth_draw_mode" type= "int" setter= "set_depth_draw_mode" getter= "get_depth_draw_mode" enum= "SpatialMaterial.DepthDrawMode" default= "0" >
2018-10-07 00:39:24 +00:00
Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member flags_transparent].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_diffuse_mode" type= "int" setter= "set_diffuse_mode" getter= "get_diffuse_mode" enum= "SpatialMaterial.DiffuseMode" default= "0" >
2018-10-07 00:39:24 +00:00
The algorithm used for diffuse light scattering. See [enum DiffuseMode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_grow" type= "bool" setter= "set_grow_enabled" getter= "is_grow_enabled" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], enables the vertex grow setting. See [member params_grow_amount].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "params_grow_amount" type= "float" setter= "set_grow" getter= "get_grow" >
2018-10-07 00:39:24 +00:00
Grows object vertices in the direction of their normals.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_line_width" type= "float" setter= "set_line_width" getter= "get_line_width" default= "1.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_point_size" type= "float" setter= "set_point_size" getter= "get_point_size" default= "1.0" >
2018-10-07 00:39:24 +00:00
The point size in pixels. See [member flags_use_point_size].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_specular_mode" type= "int" setter= "set_specular_mode" getter= "get_specular_mode" enum= "SpatialMaterial.SpecularMode" default= "0" >
2018-10-07 00:39:24 +00:00
The method for rendering the specular blob. See [enum SpecularMode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "params_use_alpha_scissor" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "particles_anim_h_frames" type= "int" setter= "set_particles_anim_h_frames" getter= "get_particles_anim_h_frames" >
2019-06-21 23:04:47 +00:00
The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "particles_anim_loop" type= "bool" setter= "set_particles_anim_loop" getter= "get_particles_anim_loop" >
2019-06-21 23:04:47 +00:00
If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "particles_anim_v_frames" type= "int" setter= "set_particles_anim_v_frames" getter= "get_particles_anim_v_frames" >
2019-06-21 23:04:47 +00:00
The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member params_billboard_mode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "proximity_fade_distance" type= "float" setter= "set_proximity_fade_distance" getter= "get_proximity_fade_distance" >
2017-09-23 08:59:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "proximity_fade_enable" type= "bool" setter= "set_proximity_fade" getter= "is_proximity_fade_enabled" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the proximity and distance fade effect is enabled.
2017-09-23 08:59:35 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "refraction_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "refraction_scale" type= "float" setter= "set_refraction" getter= "get_refraction" >
2018-10-07 00:39:24 +00:00
The strength of the refraction effect.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "refraction_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "refraction_texture_channel" type= "int" setter= "set_refraction_texture_channel" getter= "get_refraction_texture_channel" enum= "SpatialMaterial.TextureChannel" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "rim" type= "float" setter= "set_rim" getter= "get_rim" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "rim_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], rim effect is enabled.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "rim_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "rim_tint" type= "float" setter= "set_rim_tint" getter= "get_rim_tint" >
2018-10-07 00:39:24 +00:00
The amount of to blend light and albedo color when rendering rim effect. If [code]0[/code] the light color is used, while [code]1[/code] means albedo color is used. An intermediate value generally works best.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "roughness" type= "float" setter= "set_roughness" getter= "get_roughness" default= "1.0" >
2018-10-07 00:39:24 +00:00
Surface reflection. A value of [code]0[/code] represents a perfect mirror while a value of [code]1[/code] completely blurs the reflection. See also [member metallic].
2017-09-12 20:42:36 +00:00
</member>
2019-07-15 18:42:47 +00:00
<member name= "roughness_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-07-22 10:24:14 +00:00
<member name= "roughness_texture_channel" type= "int" setter= "set_roughness_texture_channel" getter= "get_roughness_texture_channel" enum= "SpatialMaterial.TextureChannel" default= "0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "subsurf_scatter_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2018-12-20 12:46:54 +00:00
If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "subsurf_scatter_strength" type= "float" setter= "set_subsurface_scattering_strength" getter= "get_subsurface_scattering_strength" >
2018-10-07 00:39:24 +00:00
The strength of the subsurface scattering effect.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "subsurf_scatter_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "transmission" type= "Color" setter= "set_transmission" getter= "get_transmission" >
2018-10-07 00:39:24 +00:00
The color used by the transmission effect. Represents the light passing through an object.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "transmission_enabled" type= "bool" setter= "set_feature" getter= "get_feature" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the transmission effect is enabled.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 19:22:15 +00:00
<member name= "transmission_texture" type= "Texture" setter= "set_texture" getter= "get_texture" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv1_offset" type= "Vector3" setter= "set_uv1_offset" getter= "get_uv1_offset" default= "Vector3( 0, 0, 0 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv1_scale" type= "Vector3" setter= "set_uv1_scale" getter= "get_uv1_scale" default= "Vector3( 1, 1, 1 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv1_triplanar" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv1_triplanar_sharpness" type= "float" setter= "set_uv1_triplanar_blend_sharpness" getter= "get_uv1_triplanar_blend_sharpness" default= "1.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv2_offset" type= "Vector3" setter= "set_uv2_offset" getter= "get_uv2_offset" default= "Vector3( 0, 0, 0 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv2_scale" type= "Vector3" setter= "set_uv2_scale" getter= "get_uv2_scale" default= "Vector3( 1, 1, 1 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv2_triplanar" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "uv2_triplanar_sharpness" type= "float" setter= "set_uv2_triplanar_blend_sharpness" getter= "get_uv2_triplanar_blend_sharpness" default= "1.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "vertex_color_is_srgb" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the model's vertex colors are processed as sRGB mode.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "vertex_color_use_as_albedo" type= "bool" setter= "set_flag" getter= "get_flag" default= "false" >
2019-06-29 13:24:23 +00:00
If [code]true[/code], the vertex color is used as albedo color.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_ALBEDO" value= "0" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_METALLIC" value= "1" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_ROUGHNESS" value= "2" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_EMISSION" value= "3" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_NORMAL" value= "4" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_RIM" value= "5" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CLEARCOAT" value= "6" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_FLOWMAP" value= "7" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_AMBIENT_OCCLUSION" value= "8" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_DEPTH" value= "9" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_SUBSURFACE_SCATTERING" value= "10" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_TRANSMISSION" value= "11" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_REFRACTION" value= "12" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_DETAIL_MASK" value= "13" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_DETAIL_ALBEDO" value= "14" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_DETAIL_NORMAL" value= "15" enum= "TextureParam" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_MAX" value= "16" enum= "TextureParam" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum TextureParam] enum.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DETAIL_UV_1" value= "0" enum= "DetailUV" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DETAIL_UV_2" value= "1" enum= "DetailUV" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_TRANSPARENT" value= "0" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_EMISSION" value= "1" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_NORMAL_MAPPING" value= "2" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_RIM" value= "3" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_CLEARCOAT" value= "4" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_ANISOTROPY" value= "5" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_AMBIENT_OCCLUSION" value= "6" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_DEPTH_MAPPING" value= "7" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_SUBSURACE_SCATTERING" value= "8" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_TRANSMISSION" value= "9" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_REFRACTION" value= "10" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_DETAIL" value= "11" enum= "Feature" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FEATURE_MAX" value= "12" enum= "Feature" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum Feature] enum.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BLEND_MODE_MIX" value= "0" enum= "BlendMode" >
2018-10-07 00:39:24 +00:00
Default blend mode.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BLEND_MODE_ADD" value= "1" enum= "BlendMode" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BLEND_MODE_SUB" value= "2" enum= "BlendMode" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BLEND_MODE_MUL" value= "3" enum= "BlendMode" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DEPTH_DRAW_OPAQUE_ONLY" value= "0" enum= "DepthDrawMode" >
2018-10-07 00:39:24 +00:00
Default depth draw mode. Depth is drawn only for opaque objects.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DEPTH_DRAW_ALWAYS" value= "1" enum= "DepthDrawMode" >
2018-10-07 00:39:24 +00:00
Depth draw is calculated for both opaque and transparent objects.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DEPTH_DRAW_DISABLED" value= "2" enum= "DepthDrawMode" >
2018-10-07 00:39:24 +00:00
No depth draw.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DEPTH_DRAW_ALPHA_OPAQUE_PREPASS" value= "3" enum= "DepthDrawMode" >
2018-10-07 00:39:24 +00:00
For transparent objects, an opaque pass is made first with the opaque parts, then transparency is drawn.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CULL_BACK" value= "0" enum= "CullMode" >
2018-10-07 00:39:24 +00:00
Default cull mode. The back of the object is culled when not visible.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CULL_FRONT" value= "1" enum= "CullMode" >
2018-10-07 00:39:24 +00:00
The front of the object is culled when not visible.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CULL_DISABLED" value= "2" enum= "CullMode" >
2018-10-07 00:39:24 +00:00
No culling is performed.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_UNSHADED" value= "0" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_USE_VERTEX_LIGHTING" value= "1" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_DISABLE_DEPTH_TEST" value= "2" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_ALBEDO_FROM_VERTEX_COLOR" value= "3" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_SRGB_VERTEX_COLOR" value= "4" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_USE_POINT_SIZE" value= "5" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "FLAG_FIXED_SIZE" value= "6" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_BILLBOARD_KEEP_SCALE" value= "7" enum= "Flags" >
</constant>
<constant name= "FLAG_UV1_USE_TRIPLANAR" value= "8" enum= "Flags" >
</constant>
<constant name= "FLAG_UV2_USE_TRIPLANAR" value= "9" enum= "Flags" >
</constant>
<constant name= "FLAG_AO_ON_UV2" value= "11" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_EMISSION_ON_UV2" value= "12" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_USE_ALPHA_SCISSOR" value= "13" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_TRIPLANAR_USE_WORLD" value= "10" enum= "Flags" >
2017-12-16 19:34:16 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value= "14" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_DONT_RECEIVE_SHADOWS" value= "15" enum= "Flags" >
2017-09-12 20:42:36 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_DISABLE_AMBIENT_LIGHT" value= "17" enum= "Flags" >
2017-12-07 07:23:08 +00:00
</constant>
2018-07-26 09:56:21 +00:00
<constant name= "FLAG_ENSURE_CORRECT_NORMALS" value= "16" enum= "Flags" >
2018-05-12 07:38:00 +00:00
</constant>
2019-05-28 16:08:13 +00:00
<constant name= "FLAG_USE_SHADOW_TO_OPACITY" value= "18" enum= "Flags" >
</constant>
<constant name= "FLAG_MAX" value= "19" enum= "Flags" >
2019-06-27 09:10:53 +00:00
Represents the size of the [enum Flags] enum.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DIFFUSE_BURLEY" value= "0" enum= "DiffuseMode" >
2018-10-07 00:39:24 +00:00
Default diffuse scattering algorithm.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DIFFUSE_LAMBERT" value= "1" enum= "DiffuseMode" >
2018-10-07 00:39:24 +00:00
Diffuse scattering ignores roughness.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DIFFUSE_LAMBERT_WRAP" value= "2" enum= "DiffuseMode" >
2018-10-07 00:39:24 +00:00
Extends Lambert to cover more than 90 degrees when roughness increases.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DIFFUSE_OREN_NAYAR" value= "3" enum= "DiffuseMode" >
2018-10-07 00:39:24 +00:00
Attempts to use roughness to emulate microsurfacing.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "DIFFUSE_TOON" value= "4" enum= "DiffuseMode" >
2018-10-07 00:39:24 +00:00
Uses a hard cut for lighting, with smoothing affected by roughness.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPECULAR_SCHLICK_GGX" value= "0" enum= "SpecularMode" >
2018-10-07 00:39:24 +00:00
Default specular blob.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPECULAR_BLINN" value= "1" enum= "SpecularMode" >
2018-10-07 00:39:24 +00:00
Older specular algorithm, included for compatibility.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPECULAR_PHONG" value= "2" enum= "SpecularMode" >
2018-10-07 00:39:24 +00:00
Older specular algorithm, included for compatibility.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPECULAR_TOON" value= "3" enum= "SpecularMode" >
2018-10-07 00:39:24 +00:00
Toon blob which changes size based on roughness.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "SPECULAR_DISABLED" value= "4" enum= "SpecularMode" >
2018-10-07 00:39:24 +00:00
No specular blob.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BILLBOARD_DISABLED" value= "0" enum= "BillboardMode" >
2019-06-29 13:24:23 +00:00
Billboard mode is disabled.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BILLBOARD_ENABLED" value= "1" enum= "BillboardMode" >
2019-06-21 23:04:47 +00:00
The object's Z axis will always face the camera.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BILLBOARD_FIXED_Y" value= "2" enum= "BillboardMode" >
2019-06-21 23:04:47 +00:00
The object's X axis will always face the camera.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "BILLBOARD_PARTICLES" value= "3" enum= "BillboardMode" >
2018-10-07 00:39:24 +00:00
Used for particle systems. Enables particle animation options.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CHANNEL_RED" value= "0" enum= "TextureChannel" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CHANNEL_GREEN" value= "1" enum= "TextureChannel" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CHANNEL_BLUE" value= "2" enum= "TextureChannel" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CHANNEL_ALPHA" value= "3" enum= "TextureChannel" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "TEXTURE_CHANNEL_GRAYSCALE" value= "4" enum= "TextureChannel" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "EMISSION_OP_ADD" value= "0" enum= "EmissionOperator" >
2017-11-15 19:35:18 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "EMISSION_OP_MULTIPLY" value= "1" enum= "EmissionOperator" >
2017-11-15 19:35:18 +00:00
</constant>
2018-08-29 20:25:11 +00:00
<constant name= "DISTANCE_FADE_DISABLED" value= "0" enum= "DistanceFadeMode" >
</constant>
<constant name= "DISTANCE_FADE_PIXEL_ALPHA" value= "1" enum= "DistanceFadeMode" >
</constant>
<constant name= "DISTANCE_FADE_PIXEL_DITHER" value= "2" enum= "DistanceFadeMode" >
</constant>
<constant name= "DISTANCE_FADE_OBJECT_DITHER" value= "3" enum= "DistanceFadeMode" >
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>
