SpatialMaterial

Inherits: Material < Resource < Reference < Object

Category: Core

Brief Description

Properties

Color albedo_color
Texture albedo_texture
float anisotropy
bool anisotropy_enabled
Texture anisotropy_flowmap
bool ao_enabled
float ao_light_affect
bool ao_on_uv2
Texture ao_texture
TextureChannel ao_texture_channel
float clearcoat
bool clearcoat_enabled
float clearcoat_gloss
Texture clearcoat_texture
bool depth_deep_parallax
bool depth_enabled
int depth_max_layers
int depth_min_layers
float depth_scale
Texture depth_texture
Texture detail_albedo
BlendMode detail_blend_mode
bool detail_enabled
Texture detail_mask
Texture detail_normal
DetailUV detail_uv_layer
float distance_fade_max_distance
float distance_fade_min_distance
DistanceFadeMode distance_fade_mode
Color emission
bool emission_enabled
float emission_energy
bool emission_on_uv2
EmissionOperator emission_operator
Texture emission_texture
bool flags_albedo_tex_force_srgb
bool flags_disable_ambient_light
bool flags_do_not_receive_shadows
bool flags_ensure_correct_normals
bool flags_fixed_size
bool flags_no_depth_test
bool flags_transparent
bool flags_unshaded
bool flags_use_point_size
bool flags_vertex_lighting
bool flags_world_triplanar
float metallic
float metallic_specular
Texture metallic_texture
TextureChannel metallic_texture_channel
bool normal_enabled
float normal_scale
Texture normal_texture
float params_alpha_scissor_threshold
bool params_billboard_keep_scale
BillboardMode params_billboard_mode
BlendMode params_blend_mode
CullMode params_cull_mode
DepthDrawMode params_depth_draw_mode
DiffuseMode params_diffuse_mode
bool params_grow
float params_grow_amount
float params_line_width
float params_point_size
SpecularMode params_specular_mode
bool params_use_alpha_scissor
int particles_anim_h_frames
int particles_anim_loop
int particles_anim_v_frames
float proximity_fade_distance
bool proximity_fade_enable
bool refraction_enabled
float refraction_scale
Texture refraction_texture
TextureChannel refraction_texture_channel
float rim
bool rim_enabled
Texture rim_texture
float rim_tint
float roughness
Texture roughness_texture
TextureChannel roughness_texture_channel
bool subsurf_scatter_enabled
float subsurf_scatter_strength
Texture subsurf_scatter_texture
Color transmission
bool transmission_enabled
Texture transmission_texture
Vector3 uv1_offset
Vector3 uv1_scale
bool uv1_triplanar
float uv1_triplanar_sharpness
Vector3 uv2_offset
Vector3 uv2_scale
bool uv2_triplanar
float uv2_triplanar_sharpness
bool vertex_color_is_srgb
bool vertex_color_use_as_albedo

Enumerations

enum DetailUV:

  • DETAIL_UV_1 = 0
  • DETAIL_UV_2 = 1

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 DistanceFadeMode:

  • DISTANCE_FADE_DISABLED = 0
  • DISTANCE_FADE_PIXEL_ALPHA = 1
  • DISTANCE_FADE_PIXEL_DITHER = 2
  • DISTANCE_FADE_OBJECT_DITHER = 3

enum DepthDrawMode:

  • DEPTH_DRAW_OPAQUE_ONLY = 0
  • DEPTH_DRAW_ALWAYS = 1
  • DEPTH_DRAW_DISABLED = 2
  • DEPTH_DRAW_ALPHA_OPAQUE_PREPASS = 3

enum DiffuseMode:

  • DIFFUSE_BURLEY = 0
  • DIFFUSE_LAMBERT = 1
  • DIFFUSE_LAMBERT_WRAP = 2
  • DIFFUSE_OREN_NAYAR = 3
  • DIFFUSE_TOON = 4

enum CullMode:

  • CULL_BACK = 0
  • CULL_FRONT = 1
  • CULL_DISABLED = 2

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 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_BILLBOARD_KEEP_SCALE = 7
  • FLAG_UV1_USE_TRIPLANAR = 8
  • FLAG_UV2_USE_TRIPLANAR = 9
  • FLAG_AO_ON_UV2 = 11
  • FLAG_EMISSION_ON_UV2 = 12
  • FLAG_USE_ALPHA_SCISSOR = 13
  • FLAG_TRIPLANAR_USE_WORLD = 10
  • FLAG_ALBEDO_TEXTURE_FORCE_SRGB = 14
  • FLAG_DONT_RECEIVE_SHADOWS = 15
  • FLAG_DISABLE_AMBIENT_LIGHT = 17
  • FLAG_ENSURE_CORRECT_NORMALS = 16
  • FLAG_MAX = 18

enum BlendMode:

  • BLEND_MODE_MIX = 0
  • BLEND_MODE_ADD = 1
  • BLEND_MODE_SUB = 2
  • BLEND_MODE_MUL = 3

enum SpecularMode:

  • SPECULAR_SCHLICK_GGX = 0
  • SPECULAR_BLINN = 1
  • SPECULAR_PHONG = 2
  • SPECULAR_TOON = 3
  • SPECULAR_DISABLED = 4

enum TextureChannel:

  • TEXTURE_CHANNEL_RED = 0
  • TEXTURE_CHANNEL_GREEN = 1
  • TEXTURE_CHANNEL_BLUE = 2
  • TEXTURE_CHANNEL_ALPHA = 3
  • TEXTURE_CHANNEL_GRAYSCALE = 4

enum BillboardMode:

  • BILLBOARD_DISABLED = 0
  • BILLBOARD_ENABLED = 1
  • BILLBOARD_FIXED_Y = 2
  • BILLBOARD_PARTICLES = 3

enum EmissionOperator:

  • EMISSION_OP_ADD = 0
  • EMISSION_OP_MULTIPLY = 1

Tutorials

Property Descriptions

Setter set_albedo(value)
Getter get_albedo()
Setter set_texture(value)
Getter get_texture()
Setter set_anisotropy(value)
Getter get_anisotropy()
  • bool anisotropy_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_texture(value)
Getter get_texture()
Setter set_feature(value)
Getter get_feature()
Setter set_ao_light_affect(value)
Getter get_ao_light_affect()
Setter set_flag(value)
Getter get_flag()
Setter set_texture(value)
Getter get_texture()
Setter set_ao_texture_channel(value)
Getter get_ao_texture_channel()
Setter set_clearcoat(value)
Getter get_clearcoat()
  • bool clearcoat_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_clearcoat_gloss(value)
Getter get_clearcoat_gloss()
Setter set_texture(value)
Getter get_texture()
  • bool depth_deep_parallax
Setter set_depth_deep_parallax(value)
Getter is_depth_deep_parallax_enabled()
  • bool depth_enabled
Setter set_feature(value)
Getter get_feature()
  • int depth_max_layers
Setter set_depth_deep_parallax_max_layers(value)
Getter get_depth_deep_parallax_max_layers()
  • int depth_min_layers
Setter set_depth_deep_parallax_min_layers(value)
Getter get_depth_deep_parallax_min_layers()
Setter set_depth_scale(value)
Getter get_depth_scale()
Setter set_texture(value)
Getter get_texture()
Setter set_texture(value)
Getter get_texture()
Setter set_detail_blend_mode(value)
Getter get_detail_blend_mode()
  • bool detail_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_texture(value)
Getter get_texture()
Setter set_texture(value)
Getter get_texture()
Setter set_detail_uv(value)
Getter get_detail_uv()
  • float distance_fade_max_distance
Setter set_distance_fade_max_distance(value)
Getter get_distance_fade_max_distance()
  • float distance_fade_min_distance
Setter set_distance_fade_min_distance(value)
Getter get_distance_fade_min_distance()
Setter set_distance_fade(value)
Getter get_distance_fade()
Setter set_emission(value)
Getter get_emission()
  • bool emission_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_emission_energy(value)
Getter get_emission_energy()
  • bool emission_on_uv2
Setter set_flag(value)
Getter get_flag()
Setter set_emission_operator(value)
Getter get_emission_operator()
Setter set_texture(value)
Getter get_texture()
  • bool flags_albedo_tex_force_srgb
Setter set_flag(value)
Getter get_flag()
  • bool flags_disable_ambient_light
Setter set_flag(value)
Getter get_flag()
  • bool flags_do_not_receive_shadows
Setter set_flag(value)
Getter get_flag()
  • bool flags_ensure_correct_normals
Setter set_flag(value)
Getter get_flag()
  • bool flags_fixed_size
Setter set_flag(value)
Getter get_flag()
  • bool flags_no_depth_test
Setter set_flag(value)
Getter get_flag()
  • bool flags_transparent
Setter set_feature(value)
Getter get_feature()
  • bool flags_unshaded
Setter set_flag(value)
Getter get_flag()
  • bool flags_use_point_size
Setter set_flag(value)
Getter get_flag()
  • bool flags_vertex_lighting
Setter set_flag(value)
Getter get_flag()
  • bool flags_world_triplanar
Setter set_flag(value)
Getter get_flag()
Setter set_metallic(value)
Getter get_metallic()
  • float metallic_specular
Setter set_specular(value)
Getter get_specular()
Setter set_texture(value)
Getter get_texture()
Setter set_metallic_texture_channel(value)
Getter get_metallic_texture_channel()
  • bool normal_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_normal_scale(value)
Getter get_normal_scale()
Setter set_texture(value)
Getter get_texture()
  • float params_alpha_scissor_threshold
Setter set_alpha_scissor_threshold(value)
Getter get_alpha_scissor_threshold()
  • bool params_billboard_keep_scale
Setter set_flag(value)
Getter get_flag()
Setter set_billboard_mode(value)
Getter get_billboard_mode()
Setter set_blend_mode(value)
Getter get_blend_mode()
Setter set_cull_mode(value)
Getter get_cull_mode()
Setter set_depth_draw_mode(value)
Getter get_depth_draw_mode()
Setter set_diffuse_mode(value)
Getter get_diffuse_mode()
Setter set_grow_enabled(value)
Getter is_grow_enabled()
  • float params_grow_amount
Setter set_grow(value)
Getter get_grow()
  • float params_line_width
Setter set_line_width(value)
Getter get_line_width()
  • float params_point_size
Setter set_point_size(value)
Getter get_point_size()
Setter set_specular_mode(value)
Getter get_specular_mode()
  • bool params_use_alpha_scissor
Setter set_flag(value)
Getter get_flag()
  • int particles_anim_h_frames
Setter set_particles_anim_h_frames(value)
Getter get_particles_anim_h_frames()
  • int particles_anim_loop
Setter set_particles_anim_loop(value)
Getter get_particles_anim_loop()
  • int particles_anim_v_frames
Setter set_particles_anim_v_frames(value)
Getter get_particles_anim_v_frames()
  • float proximity_fade_distance
Setter set_proximity_fade_distance(value)
Getter get_proximity_fade_distance()
  • bool proximity_fade_enable
Setter set_proximity_fade(value)
Getter is_proximity_fade_enabled()
  • bool refraction_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_refraction(value)
Getter get_refraction()
Setter set_texture(value)
Getter get_texture()
Setter set_refraction_texture_channel(value)
Getter get_refraction_texture_channel()
Setter set_rim(value)
Getter get_rim()
Setter set_feature(value)
Getter get_feature()
Setter set_texture(value)
Getter get_texture()
Setter set_rim_tint(value)
Getter get_rim_tint()
Setter set_roughness(value)
Getter get_roughness()
Setter set_texture(value)
Getter get_texture()
Setter set_roughness_texture_channel(value)
Getter get_roughness_texture_channel()
  • bool subsurf_scatter_enabled
Setter set_feature(value)
Getter get_feature()
  • float subsurf_scatter_strength
Setter set_subsurface_scattering_strength(value)
Getter get_subsurface_scattering_strength()
Setter set_texture(value)
Getter get_texture()
Setter set_transmission(value)
Getter get_transmission()
  • bool transmission_enabled
Setter set_feature(value)
Getter get_feature()
Setter set_texture(value)
Getter get_texture()
Setter set_uv1_offset(value)
Getter get_uv1_offset()
Setter set_uv1_scale(value)
Getter get_uv1_scale()
  • bool uv1_triplanar
Setter set_flag(value)
Getter get_flag()
  • float uv1_triplanar_sharpness
Setter set_uv1_triplanar_blend_sharpness(value)
Getter get_uv1_triplanar_blend_sharpness()
Setter set_uv2_offset(value)
Getter get_uv2_offset()
Setter set_uv2_scale(value)
Getter get_uv2_scale()
  • bool uv2_triplanar
Setter set_flag(value)
Getter get_flag()
  • float uv2_triplanar_sharpness
Setter set_uv2_triplanar_blend_sharpness(value)
Getter get_uv2_triplanar_blend_sharpness()
  • bool vertex_color_is_srgb
Setter set_flag(value)
Getter get_flag()
  • bool vertex_color_use_as_albedo
Setter set_flag(value)
Getter get_flag()