virtualx-engine/doc/classes/BaseMaterial3D.xml
Rémi Verschelde 0e3d625737 doc: Sync classref with current source
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.

Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +01:00

477 lines
22 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BaseMaterial3D" inherits="Material" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_feature" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature">
</argument>
<description>
</description>
</method>
<method name="get_flag" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags">
</argument>
<description>
</description>
</method>
<method name="get_texture" qualifiers="const">
<return type="Texture2D">
</return>
<argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam">
</argument>
<description>
</description>
</method>
<method name="set_feature">
<return type="void">
</return>
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.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="BaseMaterial3D.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="BaseMaterial3D.TextureParam">
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo" default="Color( 1, 1, 1, 1 )">
</member>
<member name="albedo_tex_force_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="albedo_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold">
</member>
<member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy">
</member>
<member name="anisotropy_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="anisotropy_flowmap" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="ao_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect">
</member>
<member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="ao_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="BaseMaterial3D.TextureChannel">
</member>
<member name="billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="BaseMaterial3D.BillboardMode" default="0">
</member>
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="BaseMaterial3D.BlendMode" default="0">
</member>
<member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat">
</member>
<member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="clearcoat_gloss" type="float" setter="set_clearcoat_gloss" getter="get_clearcoat_gloss">
</member>
<member name="clearcoat_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="BaseMaterial3D.CullMode" default="0">
</member>
<member name="depth_draw" type="int" setter="set_depth_draw_mode" getter="get_depth_draw_mode" enum="BaseMaterial3D.DepthDrawMode" default="0">
</member>
<member name="detail_albedo" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="BaseMaterial3D.BlendMode">
</member>
<member name="detail_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="detail_mask" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="detail_normal" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="BaseMaterial3D.DetailUV">
</member>
<member name="diffuse_mode" type="int" setter="set_diffuse_mode" getter="get_diffuse_mode" enum="BaseMaterial3D.DiffuseMode" default="0">
</member>
<member name="disable_ambient_light" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="disable_receive_shadows" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance">
</member>
<member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance">
</member>
<member name="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="BaseMaterial3D.DistanceFadeMode" default="0">
</member>
<member name="emission" type="Color" setter="set_emission" getter="get_emission">
</member>
<member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy">
</member>
<member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="BaseMaterial3D.EmissionOperator">
</member>
<member name="emission_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="fixed_size" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="grow" type="bool" setter="set_grow_enabled" getter="is_grow_enabled" default="false">
</member>
<member name="grow_amount" type="float" setter="set_grow" getter="get_grow" default="0.0">
</member>
<member name="heightmap_deep_parallax" type="bool" setter="set_heightmap_deep_parallax" getter="is_heightmap_deep_parallax_enabled">
</member>
<member name="heightmap_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="heightmap_flip_binormal" type="bool" setter="set_heightmap_deep_parallax_flip_binormal" getter="get_heightmap_deep_parallax_flip_binormal">
</member>
<member name="heightmap_flip_tangent" type="bool" setter="set_heightmap_deep_parallax_flip_tangent" getter="get_heightmap_deep_parallax_flip_tangent">
</member>
<member name="heightmap_flip_texture" type="bool" setter="set_flag" getter="get_flag">
</member>
<member name="heightmap_max_layers" type="int" setter="set_heightmap_deep_parallax_max_layers" getter="get_heightmap_deep_parallax_max_layers">
</member>
<member name="heightmap_min_layers" type="int" setter="set_heightmap_deep_parallax_min_layers" getter="get_heightmap_deep_parallax_min_layers">
</member>
<member name="heightmap_scale" type="float" setter="set_heightmap_scale" getter="get_heightmap_scale">
</member>
<member name="heightmap_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="metallic" type="float" setter="set_metallic" getter="get_metallic" default="0.0">
</member>
<member name="metallic_specular" type="float" setter="set_specular" getter="get_specular" default="0.5">
</member>
<member name="metallic_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
</member>
<member name="no_depth_test" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale">
</member>
<member name="normal_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="orm_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="particles_anim_h_frames" type="int" setter="set_particles_anim_h_frames" getter="get_particles_anim_h_frames">
</member>
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
</member>
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
</member>
<member name="point_size" type="float" setter="set_point_size" getter="get_point_size" default="1.0">
</member>
<member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance">
</member>
<member name="proximity_fade_enable" type="bool" setter="set_proximity_fade" getter="is_proximity_fade_enabled" default="false">
</member>
<member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction">
</member>
<member name="refraction_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="BaseMaterial3D.TextureChannel">
</member>
<member name="rim" type="float" setter="set_rim" getter="get_rim">
</member>
<member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="rim_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint">
</member>
<member name="roughness" type="float" setter="set_roughness" getter="get_roughness" default="1.0">
</member>
<member name="roughness_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
</member>
<member name="shading_mode" type="int" setter="set_shading_mode" getter="get_shading_mode" enum="BaseMaterial3D.ShadingMode" default="1">
</member>
<member name="shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="specular_mode" type="int" setter="set_specular_mode" getter="get_specular_mode" enum="BaseMaterial3D.SpecularMode" default="0">
</member>
<member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength">
</member>
<member name="subsurf_scatter_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="BaseMaterial3D.TextureFilter" default="3">
</member>
<member name="texture_repeat" type="bool" setter="set_flag" getter="get_flag" default="true">
</member>
<member name="transmission" type="Color" setter="set_transmission" getter="get_transmission">
</member>
<member name="transmission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
</member>
<member name="transmission_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
<member name="transparency" type="int" setter="set_transparency" getter="get_transparency" enum="BaseMaterial3D.Transparency" default="0">
</member>
<member name="use_point_size" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" default="Vector3( 0, 0, 0 )">
</member>
<member name="uv1_scale" type="Vector3" setter="set_uv1_scale" getter="get_uv1_scale" default="Vector3( 1, 1, 1 )">
</member>
<member name="uv1_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="uv1_triplanar_sharpness" type="float" setter="set_uv1_triplanar_blend_sharpness" getter="get_uv1_triplanar_blend_sharpness" default="1.0">
</member>
<member name="uv1_world_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="uv2_offset" type="Vector3" setter="set_uv2_offset" getter="get_uv2_offset" default="Vector3( 0, 0, 0 )">
</member>
<member name="uv2_scale" type="Vector3" setter="set_uv2_scale" getter="get_uv2_scale" default="Vector3( 1, 1, 1 )">
</member>
<member name="uv2_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="uv2_triplanar_sharpness" type="float" setter="set_uv2_triplanar_blend_sharpness" getter="get_uv2_triplanar_blend_sharpness" default="1.0">
</member>
<member name="uv2_world_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="vertex_color_is_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
<member name="vertex_color_use_as_albedo" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
</members>
<constants>
<constant name="TEXTURE_ALBEDO" value="0" enum="TextureParam">
</constant>
<constant name="TEXTURE_METALLIC" value="1" enum="TextureParam">
</constant>
<constant name="TEXTURE_ROUGHNESS" value="2" enum="TextureParam">
</constant>
<constant name="TEXTURE_EMISSION" value="3" enum="TextureParam">
</constant>
<constant name="TEXTURE_NORMAL" value="4" enum="TextureParam">
</constant>
<constant name="TEXTURE_RIM" value="5" enum="TextureParam">
</constant>
<constant name="TEXTURE_CLEARCOAT" value="6" enum="TextureParam">
</constant>
<constant name="TEXTURE_FLOWMAP" value="7" enum="TextureParam">
</constant>
<constant name="TEXTURE_AMBIENT_OCCLUSION" value="8" enum="TextureParam">
</constant>
<constant name="TEXTURE_HEIGHTMAP" value="9" enum="TextureParam">
</constant>
<constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10" enum="TextureParam">
</constant>
<constant name="TEXTURE_TRANSMISSION" value="11" enum="TextureParam">
</constant>
<constant name="TEXTURE_REFRACTION" value="12" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_MASK" value="13" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_ALBEDO" value="14" enum="TextureParam">
</constant>
<constant name="TEXTURE_DETAIL_NORMAL" value="15" enum="TextureParam">
</constant>
<constant name="TEXTURE_ORM" value="16" enum="TextureParam">
</constant>
<constant name="TEXTURE_MAX" value="17" enum="TextureParam">
</constant>
<constant name="TEXTURE_FILTER_NEAREST" value="0" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_LINEAR" value="1" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIMPAMPS" value="2" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="3" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIMPAMPS_ANISOTROPIC" value="4" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="TextureFilter">
</constant>
<constant name="TEXTURE_FILTER_MAX" value="6" enum="TextureFilter">
</constant>
<constant name="DETAIL_UV_1" value="0" enum="DetailUV">
</constant>
<constant name="DETAIL_UV_2" value="1" enum="DetailUV">
</constant>
<constant name="TRANSPARENCY_DISABLED" value="0" enum="Transparency">
</constant>
<constant name="TRANSPARENCY_ALPHA" value="1" enum="Transparency">
</constant>
<constant name="TRANSPARENCY_ALPHA_SCISSOR" value="2" enum="Transparency">
</constant>
<constant name="TRANSPARENCY_ALPHA_DEPTH_PRE_PASS" value="3" enum="Transparency">
</constant>
<constant name="TRANSPARENCY_MAX" value="4" enum="Transparency">
</constant>
<constant name="SHADING_MODE_UNSHADED" value="0" enum="ShadingMode">
</constant>
<constant name="SHADING_MODE_PER_PIXEL" value="1" enum="ShadingMode">
</constant>
<constant name="SHADING_MODE_PER_VERTEX" value="2" enum="ShadingMode">
</constant>
<constant name="SHADING_MODE_MAX" value="3" enum="ShadingMode">
</constant>
<constant name="FEATURE_EMISSION" value="0" enum="Feature">
</constant>
<constant name="FEATURE_NORMAL_MAPPING" value="1" enum="Feature">
</constant>
<constant name="FEATURE_RIM" value="2" enum="Feature">
</constant>
<constant name="FEATURE_CLEARCOAT" value="3" enum="Feature">
</constant>
<constant name="FEATURE_ANISOTROPY" value="4" enum="Feature">
</constant>
<constant name="FEATURE_AMBIENT_OCCLUSION" value="5" enum="Feature">
</constant>
<constant name="FEATURE_HEIGHT_MAPPING" value="6" enum="Feature">
</constant>
<constant name="FEATURE_SUBSURACE_SCATTERING" value="7" enum="Feature">
</constant>
<constant name="FEATURE_TRANSMISSION" value="8" enum="Feature">
</constant>
<constant name="FEATURE_REFRACTION" value="9" enum="Feature">
</constant>
<constant name="FEATURE_DETAIL" value="10" enum="Feature">
</constant>
<constant name="FEATURE_MAX" value="11" enum="Feature">
</constant>
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
</constant>
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
</constant>
<constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0" enum="DepthDrawMode">
</constant>
<constant name="DEPTH_DRAW_ALWAYS" value="1" enum="DepthDrawMode">
</constant>
<constant name="DEPTH_DRAW_DISABLED" value="2" enum="DepthDrawMode">
</constant>
<constant name="CULL_BACK" value="0" enum="CullMode">
</constant>
<constant name="CULL_FRONT" value="1" enum="CullMode">
</constant>
<constant name="CULL_DISABLED" value="2" enum="CullMode">
</constant>
<constant name="FLAG_DISABLE_DEPTH_TEST" value="0" enum="Flags">
</constant>
<constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="1" enum="Flags">
</constant>
<constant name="FLAG_SRGB_VERTEX_COLOR" value="2" enum="Flags">
</constant>
<constant name="FLAG_USE_POINT_SIZE" value="3" enum="Flags">
</constant>
<constant name="FLAG_FIXED_SIZE" value="4" enum="Flags">
</constant>
<constant name="FLAG_BILLBOARD_KEEP_SCALE" value="5" enum="Flags">
</constant>
<constant name="FLAG_UV1_USE_TRIPLANAR" value="6" enum="Flags">
</constant>
<constant name="FLAG_UV2_USE_TRIPLANAR" value="7" enum="Flags">
</constant>
<constant name="FLAG_UV1_USE_WORLD_TRIPLANAR" value="8" enum="Flags">
</constant>
<constant name="FLAG_UV2_USE_WORLD_TRIPLANAR" value="9" enum="Flags">
</constant>
<constant name="FLAG_AO_ON_UV2" value="10" enum="Flags">
</constant>
<constant name="FLAG_EMISSION_ON_UV2" value="11" enum="Flags">
</constant>
<constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags">
</constant>
<constant name="FLAG_DONT_RECEIVE_SHADOWS" value="13" enum="Flags">
</constant>
<constant name="FLAG_DISABLE_AMBIENT_LIGHT" value="14" enum="Flags">
</constant>
<constant name="FLAG_USE_SHADOW_TO_OPACITY" value="15" enum="Flags">
</constant>
<constant name="FLAG_USE_TEXTURE_REPEAT" value="16" enum="Flags">
</constant>
<constant name="FLAG_INVERT_HEIGHTMAP" value="17" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="18" enum="Flags">
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_LAMBERT" value="1" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_LAMBERT_WRAP" value="2" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_OREN_NAYAR" value="3" enum="DiffuseMode">
</constant>
<constant name="DIFFUSE_TOON" value="4" enum="DiffuseMode">
</constant>
<constant name="SPECULAR_SCHLICK_GGX" value="0" enum="SpecularMode">
</constant>
<constant name="SPECULAR_BLINN" value="1" enum="SpecularMode">
</constant>
<constant name="SPECULAR_PHONG" value="2" enum="SpecularMode">
</constant>
<constant name="SPECULAR_TOON" value="3" enum="SpecularMode">
</constant>
<constant name="SPECULAR_DISABLED" value="4" enum="SpecularMode">
</constant>
<constant name="BILLBOARD_DISABLED" value="0" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_ENABLED" value="1" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode">
</constant>
<constant name="BILLBOARD_PARTICLES" value="3" enum="BillboardMode">
</constant>
<constant name="TEXTURE_CHANNEL_RED" value="0" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_GREEN" value="1" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_BLUE" value="2" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_ALPHA" value="3" enum="TextureChannel">
</constant>
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4" enum="TextureChannel">
</constant>
<constant name="EMISSION_OP_ADD" value="0" enum="EmissionOperator">
</constant>
<constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator">
</constant>
<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>
</constants>
</class>