godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/BaseMaterial3D.xml

741 lines
55 KiB
XML
Raw Normal View History

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 08:59:06 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="BaseMaterial3D" inherits="Material" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
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 08:59:06 +00:00
<brief_description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Default 3D rendering material.
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 08:59:06 +00:00
</brief_description>
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +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.
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 08:59:06 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Standard Material 3D">$DOCS_URL/tutorials/3d/standard_material_3d.html</link>
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 08:59:06 +00:00
</tutorials>
<methods>
<method name="get_feature" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
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 08:59:06 +00:00
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Returns [code]true[/code], if the specified [enum Feature] is enabled.
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 08:59:06 +00:00
</description>
</method>
<method name="get_flag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
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 08:59:06 +00:00
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options.
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 08:59:06 +00:00
</description>
</method>
<method name="get_texture" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
<argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
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 08:59:06 +00:00
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Returns the [Texture] associated with the specified [enum TextureParam].
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 08:59:06 +00:00
</description>
</method>
<method name="set_feature">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
<argument index="1" name="enable" type="bool" />
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 08:59:06 +00:00
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code].
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 08:59:06 +00:00
</description>
</method>
<method name="set_flag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
<argument index="1" name="enable" type="bool" />
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 08:59:06 +00:00
<description>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options.
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 08:59:06 +00:00
</description>
</method>
<method name="set_texture">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
<argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
<argument index="1" name="texture" type="Texture2D" />
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 08:59:06 +00:00
<description>
doc: Sync classref with current source
2020-03-13 16:16:44 +00:00
Sets the texture for the slot specified by [code]param[/code]. See [enum TextureParam] for available slots.
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 08:59:06 +00:00
</description>
</method>
</methods>
<members>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="albedo_color" type="Color" setter="set_albedo" getter="get_albedo" default="Color(1, 1, 1, 1)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The material's base color.
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
[b]Note:[/b] If [member detail_enabled] is [code]true[/code] and a [member detail_albedo] texture is specified, [member albedo_color] will [i]not[/i] modulate the detail texture. This can be used to color partial areas of a material by not specifying an albedo texture and using a transparent [member detail_albedo] texture instead.
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 08:59:06 +00:00
</member>
<member name="albedo_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture to multiply by [member albedo_color]. Used for basic texturing of objects.
Rename BaseMaterial3D properties to use fully spelled out "texture" This is more consistent with other BaseMaterial properties such as `ao_texture_channel`. This also improves the documentation related to `albedo_texture_force_srgb`. This also fixes a typo in the 3.x material converter.
2022-05-14 23:19:43 +00:00
If the texture appears unexpectedly too dark or too bright, check [member albedo_texture_force_srgb].
</member>
<member name="albedo_texture_force_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
If [code]true[/code], forces a conversion of the [member albedo_texture] from sRGB color space to linear color space. See also [member vertex_color_is_srgb].
This should only be enabled when needed (typically when using a [ViewportTexture] as [member albedo_texture]). If [member albedo_texture_force_srgb] is [code]true[/code] when it shouldn't be, the texture will appear to be too dark. If [member albedo_texture_force_srgb] is [code]false[/code] when it shouldn't be, the texture will appear to be too bright.
</member>
<member name="albedo_texture_msdf" type="bool" setter="set_flag" getter="get_flag" default="false">
Enables multichannel signed distance field rendering shader. Use [member msdf_pixel_range] and [member msdf_outline_size] to configure MSDF parameters.
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 08:59:06 +00:00
</member>
Alpha Hash and Alpha2Coverage Implementation
2020-07-13 08:27:01 +00:00
<member name="alpha_antialiasing_edge" type="float" setter="set_alpha_antialiasing_edge" getter="get_alpha_antialiasing_edge">
class reference proofreading
2021-03-18 11:04:28 +00:00
Threshold at which antialiasing will be applied on the alpha channel.
Alpha Hash and Alpha2Coverage Implementation
2020-07-13 08:27:01 +00:00
</member>
<member name="alpha_antialiasing_mode" type="int" setter="set_alpha_antialiasing" getter="get_alpha_antialiasing" enum="BaseMaterial3D.AlphaAntiAliasing">
The type of alpha antialiasing to apply. See [enum AlphaAntiAliasing].
</member>
<member name="alpha_hash_scale" type="float" setter="set_alpha_hash_scale" getter="get_alpha_hash_scale">
The hashing scale for Alpha Hash. Recommended values between [code]0[/code] and [code]2[/code].
</member>
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 08:59:06 +00:00
<member name="alpha_scissor_threshold" type="float" setter="set_alpha_scissor_threshold" getter="get_alpha_scissor_threshold">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Threshold at which the alpha scissor will discard values.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="anisotropy" type="float" setter="set_anisotropy" getter="get_anisotropy" default="0.0">
Document the expected format of anisotropy flowmaps in BaseMaterial3D
2021-12-31 16:22:29 +00:00
The strength of the anisotropy effect. This is multiplied by [member anisotropy_flowmap]'s alpha channel if a texture is defined there and the texture contains an alpha channel.
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 08:59:06 +00:00
</member>
<member name="anisotropy_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Document the expected format of anisotropy flowmaps in BaseMaterial3D
2021-12-31 16:22:29 +00:00
If [code]true[/code], anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections.
[b]Note:[/b] Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken.
[b]Note:[/b] Material anisotropy should not to be confused with anisotropic texture filtering, which can be enabled by setting [member texture_filter] to [constant TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC].
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 08:59:06 +00:00
</member>
<member name="anisotropy_flowmap" type="Texture2D" setter="set_texture" getter="get_texture">
Document the expected format of anisotropy flowmaps in BaseMaterial3D
2021-12-31 16:22:29 +00:00
Texture that offsets the tangent map for anisotropy calculations and optionally controls the anisotropy effect (if an alpha channel is present). The flowmap texture is expected to be a derivative map, with the red channel representing distortion on the X axis and green channel representing distortion on the Y axis. Values below 0.5 will result in negative distortion, whereas values above 0.5 will result in positive distortion.
If present, the texture's alpha channel will be used to multiply the strength of the [member anisotropy] effect. Fully opaque pixels will keep the anisotropy effect's original strength while fully transparent pixels will disable the anisotropy effect entirely. The flowmap texture's blue channel is ignored.
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 08:59:06 +00:00
</member>
<member name="ao_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], ambient occlusion is enabled. Ambient occlusion darkens areas based on the [member ao_texture].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="ao_light_affect" type="float" setter="set_ao_light_affect" getter="get_ao_light_affect" default="0.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Amount that ambient occlusion affects lighting from lights. If [code]0[/code], ambient occlusion only affects ambient light. If [code]1[/code], ambient occlusion affects lights just as much as it affects ambient light. This can be used to impact the strength of the ambient occlusion effect, but typically looks unrealistic.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="ao_on_uv2" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], use [code]UV2[/code] coordinates to look up from the [member ao_texture].
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 08:59:06 +00:00
</member>
<member name="ao_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture that defines the amount of ambient occlusion for a given point on the object.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="ao_texture_channel" type="int" setter="set_ao_texture_channel" getter="get_ao_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="backlight" type="Color" setter="set_backlight" getter="get_backlight" default="Color(0, 0, 0, 1)">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The color used by the backlight effect. Represents the light passing through an object.
</member>
<member name="backlight_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
If [code]true[/code], the backlight effect is enabled.
</member>
<member name="backlight_texture" type="Texture2D" setter="set_texture" getter="get_texture">
Texture used to control the backlight effect per-pixel. Added to [member backlight].
</member>
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 08:59:06 +00:00
<member name="billboard_keep_scale" type="bool" setter="set_flag" getter="get_flag" default="false">
class reference proofreading
2021-03-18 11:04:28 +00:00
If [code]true[/code], the shader will keep the scale set for the mesh. Otherwise, the scale is lost when billboarding. Only applies when [member billboard_mode] is [constant BILLBOARD_ENABLED].
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 08:59:06 +00:00
</member>
<member name="billboard_mode" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="BaseMaterial3D.BillboardMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Controls how the object faces the camera. See [enum BillboardMode].
Document the BaseMaterial3D billboard mode not being suited for VR See #41567.
2020-08-28 12:23:22 +00:00
[b]Note:[/b] Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See [url=https://github.com/godotengine/godot/issues/41567]GitHub issue #41567[/url] for details.
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 08:59:06 +00:00
</member>
<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="BaseMaterial3D.BlendMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +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].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="clearcoat" type="float" setter="set_clearcoat" getter="get_clearcoat" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Sets the strength of the clearcoat effect. Setting to [code]0[/code] looks the same as disabling the clearcoat effect.
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 08:59:06 +00:00
</member>
<member name="clearcoat_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], clearcoat rendering is enabled. Adds a secondary transparent pass to the lighting calculation resulting in an added specular blob. This makes materials appear as if they have a clear layer on them that can be either glossy or rough.
Document that clearcoat/rim lighting is not visible on unshaded materials
2021-04-28 15:38:06 +00:00
[b]Note:[/b] Clearcoat rendering is not visible if the material's [member shading_mode] is [constant SHADING_MODE_UNSHADED].
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 08:59:06 +00:00
</member>
Use Filament specular models and parametrization
2021-08-16 06:37:24 +00:00
<member name="clearcoat_roughness" type="float" setter="set_clearcoat_roughness" getter="get_clearcoat_roughness" default="0.5">
Sets the roughness of the clearcoat pass. A higher value results in a rougher clearcoat while a lower value results in a smoother clearcoat.
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 08:59:06 +00:00
</member>
<member name="clearcoat_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture that defines the strength of the clearcoat effect and the glossiness of the clearcoat. Strength is specified in the red channel while glossiness is specified in the green channel.
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 08:59:06 +00:00
</member>
<member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="BaseMaterial3D.CullMode" default="0">
Fix and improve cull mode description in material
2021-12-28 02:43:02 +00:00
Determines which side of the triangle to cull depending on whether the triangle faces towards or away from the camera. See [enum CullMode].
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 08:59:06 +00:00
</member>
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
<member name="depth_draw_mode" type="int" setter="set_depth_draw_mode" getter="get_depth_draw_mode" enum="BaseMaterial3D.DepthDrawMode" default="0">
Determines when depth rendering takes place. See [enum DepthDrawMode]. See also [member transparency].
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 08:59:06 +00:00
</member>
<member name="detail_albedo" type="Texture2D" setter="set_texture" getter="get_texture">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
Texture that specifies the color of the detail overlay. [member detail_albedo]'s alpha channel is used as a mask, even when the material is opaque. To use a dedicated texture as a mask, see [member detail_mask].
[b]Note:[/b] [member detail_albedo] is [i]not[/i] modulated by [member albedo_color].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="detail_blend_mode" type="int" setter="set_detail_blend_mode" getter="get_detail_blend_mode" enum="BaseMaterial3D.BlendMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies how the [member detail_albedo] should blend with the current [code]ALBEDO[/code]. See [enum BlendMode] for options.
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 08:59:06 +00:00
</member>
<member name="detail_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
If [code]true[/code], enables the detail overlay. Detail is a second texture that gets mixed over the surface of the object based on [member detail_mask] and [member detail_albedo]'s alpha channel. This can be used to add variation to objects, or to blend between two different albedo/normal textures.
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 08:59:06 +00:00
</member>
<member name="detail_mask" type="Texture2D" setter="set_texture" getter="get_texture">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
Texture used to specify how the detail textures get blended with the base textures. [member detail_mask] can be used together with [member detail_albedo]'s alpha channel (if any).
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 08:59:06 +00:00
</member>
<member name="detail_normal" type="Texture2D" setter="set_texture" getter="get_texture">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
Texture that specifies the per-pixel normal of the detail overlay. The [member detail_normal] texture only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [member detail_normal] is oriented around the surface normal provided by the [Mesh].
Fix normal map description
2022-01-09 20:03:33 +00:00
[b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="detail_uv_layer" type="int" setter="set_detail_uv" getter="get_detail_uv" enum="BaseMaterial3D.DetailUV" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies whether to use [code]UV[/code] or [code]UV2[/code] for the detail layer. See [enum DetailUV] for options.
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 08:59:06 +00:00
</member>
<member name="diffuse_mode" type="int" setter="set_diffuse_mode" getter="get_diffuse_mode" enum="BaseMaterial3D.DiffuseMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The algorithm used for diffuse light scattering. See [enum DiffuseMode].
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 08:59:06 +00:00
</member>
<member name="disable_ambient_light" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the object receives no ambient light.
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 08:59:06 +00:00
</member>
<member name="disable_receive_shadows" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the object receives no shadow that would otherwise be cast onto it.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance" default="10.0">
doc: Improve distance_fade documentation Changed the documentation of distance_fade_max_distance and min to be consistent with the behavior of the code as well as the user documentation. Also noted the behavior of swapping max_distance and min_distance (where max_distance < min_distance). Fixes #36051. Co-authored-by: Clay John <claynjohn@gmail.com>
2020-02-10 07:12:49 +00:00
Distance at which the object appears fully opaque.
[b]Note:[/b] If [code]distance_fade_max_distance[/code] is less than [code]distance_fade_min_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance" default="0.0">
doc: Improve distance_fade documentation Changed the documentation of distance_fade_max_distance and min to be consistent with the behavior of the code as well as the user documentation. Also noted the behavior of swapping max_distance and min_distance (where max_distance < min_distance). Fixes #36051. Co-authored-by: Clay John <claynjohn@gmail.com>
2020-02-10 07:12:49 +00:00
Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible.
[b]Note:[/b] If [code]distance_fade_min_distance[/code] is greater than [code]distance_fade_max_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code].
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 08:59:06 +00:00
</member>
<member name="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="BaseMaterial3D.DistanceFadeMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies which type of fade to use. Can be any of the [enum DistanceFadeMode]s.
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="emission" type="Color" setter="set_emission" getter="get_emission" default="Color(0, 0, 0, 1)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The emitted light's color. See [member emission_enabled].
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 08:59:06 +00:00
</member>
<member name="emission_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Rename GI Classes * GIProbe is now VoxelGI * BakedLightmap is now LightmapGI As godot adds more ways to provide GI (as an example, SDFGI in 4.0), the different techniques (which have different pros/cons) need to be properly named to avoid confusion.
2021-06-04 22:47:26 +00:00
If [code]true[/code], the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a [VoxelGI] is used and this object is used in baked lighting.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="emission_energy" type="float" setter="set_emission_energy" getter="get_emission_energy" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The emitted light's strength. See [member emission_enabled].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="emission_on_uv2" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use [code]UV2[/code] to read from the [member emission_texture].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="emission_operator" type="int" setter="set_emission_operator" getter="get_emission_operator" enum="BaseMaterial3D.EmissionOperator" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Sets how [member emission] interacts with [member emission_texture]. Can either add or multiply. See [enum EmissionOperator] for options.
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 08:59:06 +00:00
</member>
<member name="emission_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture that specifies how much surface emits light at a given point.
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 08:59:06 +00:00
</member>
<member name="fixed_size" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the object is rendered at the same size regardless of distance.
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 08:59:06 +00:00
</member>
<member name="grow" type="bool" setter="set_grow_enabled" getter="is_grow_enabled" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], enables the vertex grow setting. See [member grow_amount].
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 08:59:06 +00:00
</member>
<member name="grow_amount" type="float" setter="set_grow" getter="get_grow" default="0.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Grows object vertices in the direction of their normals.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="heightmap_deep_parallax" type="bool" setter="set_heightmap_deep_parallax" getter="is_heightmap_deep_parallax_enabled" default="false">
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 08:59:06 +00:00
</member>
<member name="heightmap_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Document that BaseMaterial3D doesn't support height mapping + triplanar See #44322.
2020-12-12 16:13:01 +00:00
If [code]true[/code], height mapping is enabled (also called "parallax mapping" or "depth mapping"). See also [member normal_enabled].
[b]Note:[/b] Height mapping is not supported if triplanar mapping is used on the same material. The value of [member heightmap_enabled] will be ignored if [member uv1_triplanar] is enabled.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="heightmap_flip_binormal" type="bool" setter="set_heightmap_deep_parallax_flip_binormal" getter="get_heightmap_deep_parallax_flip_binormal" default="false">
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="heightmap_flip_tangent" type="bool" setter="set_heightmap_deep_parallax_flip_tangent" getter="get_heightmap_deep_parallax_flip_tangent" default="false">
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="heightmap_flip_texture" type="bool" setter="set_flag" getter="get_flag" default="false">
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 08:59:06 +00:00
</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>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="heightmap_scale" type="float" setter="set_heightmap_scale" getter="get_heightmap_scale" default="0.05">
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 08:59:06 +00:00
</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">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
A high value makes the material appear more like a metal. Non-metals use their albedo as the diffuse color and add diffuse to the specular reflection. With non-metals, the reflection appears on top of the albedo color. Metals use their albedo as a multiplier to the specular reflection and set the diffuse color to black resulting in a tinted reflection. Materials work better when fully metal or fully non-metal, values between [code]0[/code] and [code]1[/code] should only be used for blending between metal and non-metal sections. To alter the amount of reflection use [member roughness].
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 08:59:06 +00:00
</member>
<member name="metallic_specular" type="float" setter="set_specular" getter="get_specular" default="0.5">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Sets the size of the specular lobe. The specular lobe is the bright spot that is reflected from light sources.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[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].
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 08:59:06 +00:00
</member>
<member name="metallic_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture used to specify metallic for an object. This is multiplied by [member metallic].
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 08:59:06 +00:00
</member>
<member name="metallic_texture_channel" type="int" setter="set_metallic_texture_channel" getter="get_metallic_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies the channel of the [member metallic_texture] in which the metallic information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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 08:59:06 +00:00
</member>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<member name="msdf_outline_size" type="float" setter="set_msdf_outline_size" getter="get_msdf_outline_size" default="0.0">
The width of the shape outine.
</member>
<member name="msdf_pixel_range" type="float" setter="set_msdf_pixel_range" getter="get_msdf_pixel_range" default="4.0">
The width of the range around the shape between the minimum and maximum representable signed distance.
</member>
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 08:59:06 +00:00
<member name="no_depth_test" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], depth testing is disabled and the object will be drawn in render order.
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 08:59:06 +00:00
</member>
<member name="normal_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], normal mapping is enabled.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="normal_scale" type="float" setter="set_normal_scale" getter="get_normal_scale" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The strength of the normal map's effect.
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 08:59:06 +00:00
</member>
<member name="normal_texture" type="Texture2D" setter="set_texture" getter="get_texture">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
Texture used to specify the normal at a given pixel. The [member normal_texture] only uses the red and green channels; the blue and alpha channels are ignored. The normal read from [member normal_texture] is oriented around the surface normal provided by the [Mesh].
Document that tangents are required for normal mapping in BaseMaterial3D
2021-10-01 15:30:19 +00:00
[b]Note:[/b] The mesh must have both normals and tangents defined in its vertex data. Otherwise, the normal map won't render correctly and will only appear to darken the whole surface. If creating geometry with [SurfaceTool], you can use [method SurfaceTool.generate_normals] and [method SurfaceTool.generate_tangents] to automatically generate normals and tangents respectively.
Fix normal map description
2022-01-09 20:03:33 +00:00
[b]Note:[/b] Godot expects the normal map to use X+, Y+, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines.
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
[b]Note:[/b] If [member detail_enabled] is [code]true[/code], the [member detail_albedo] texture is drawn [i]below[/i] the [member normal_texture]. To display a normal map [i]above[/i] the [member detail_albedo] texture, use [member detail_normal] instead.
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 08:59:06 +00:00
</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">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The number of horizontal frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member billboard_mode].
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 08:59:06 +00:00
</member>
<member name="particles_anim_loop" type="bool" setter="set_particles_anim_loop" getter="get_particles_anim_loop">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], particle animations are looped. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member billboard_mode].
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 08:59:06 +00:00
</member>
<member name="particles_anim_v_frames" type="int" setter="set_particles_anim_v_frames" getter="get_particles_anim_v_frames">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The number of vertical frames in the particle sprite sheet. Only enabled when using [constant BILLBOARD_PARTICLES]. See [member billboard_mode].
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 08:59:06 +00:00
</member>
<member name="point_size" type="float" setter="set_point_size" getter="get_point_size" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The point size in pixels. See [member use_point_size].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="proximity_fade_distance" type="float" setter="set_proximity_fade_distance" getter="get_proximity_fade_distance" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Distance over which the fade effect takes place. The larger the distance the longer it takes for an object to fade.
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 08:59:06 +00:00
</member>
<member name="proximity_fade_enable" type="bool" setter="set_proximity_fade" getter="is_proximity_fade_enabled" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the proximity fade effect is enabled. The proximity fade effect fades out each pixel based on its distance to another object.
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 08:59:06 +00:00
</member>
<member name="refraction_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the refraction effect is enabled. Distorts transparency based on light from behind the object.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="refraction_scale" type="float" setter="set_refraction" getter="get_refraction" default="0.05">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The strength of the refraction effect.
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 08:59:06 +00:00
</member>
<member name="refraction_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture that controls the strength of the refraction per-pixel. Multiplied by [member refraction_scale].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="refraction_texture_channel" type="int" setter="set_refraction_texture_channel" getter="get_refraction_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="rim" type="float" setter="set_rim" getter="get_rim" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Sets the strength of the rim lighting effect.
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 08:59:06 +00:00
</member>
<member name="rim_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], rim effect is enabled. Rim lighting increases the brightness at glancing angles on an object.
Document that clearcoat/rim lighting is not visible on unshaded materials
2021-04-28 15:38:06 +00:00
[b]Note:[/b] Rim lighting is not visible if the material's [member shading_mode] is [constant SHADING_MODE_UNSHADED].
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 08:59:06 +00:00
</member>
<member name="rim_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture used to set the strength of the rim lighting effect per-pixel. Multiplied by [member rim].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="rim_tint" type="float" setter="set_rim_tint" getter="get_rim_tint" default="0.5">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +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.
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 08:59:06 +00:00
</member>
<member name="roughness" type="float" setter="set_roughness" getter="get_roughness" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +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].
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 08:59:06 +00:00
</member>
<member name="roughness_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture used to control the roughness per-pixel. Multiplied by [member roughness].
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 08:59:06 +00:00
</member>
<member name="roughness_texture_channel" type="int" setter="set_roughness_texture_channel" getter="get_roughness_texture_channel" enum="BaseMaterial3D.TextureChannel" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Specifies the channel of the [member ao_texture] in which the ambient occlusion information is stored. This is useful when you store the information for multiple effects in a single texture. For example if you stored metallic in the red channel, roughness in the blue, and ambient occlusion in the green you could reduce the number of textures you use.
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 08:59:06 +00:00
</member>
<member name="shading_mode" type="int" setter="set_shading_mode" getter="get_shading_mode" enum="BaseMaterial3D.ShadingMode" default="1">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
Sets whether the shading takes place per-pixel or per-vertex. Per-vertex lighting is faster, making it the best choice for mobile applications, however it looks considerably worse than per-pixel.
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 08:59:06 +00:00
</member>
<member name="shadow_to_opacity" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], enables the "shadow to opacity" render mode where lighting modifies the alpha so shadowed areas are opaque and non-shadowed areas are transparent. Useful for overlaying shadows onto a camera feed in AR.
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 08:59:06 +00:00
</member>
<member name="specular_mode" type="int" setter="set_specular_mode" getter="get_specular_mode" enum="BaseMaterial3D.SpecularMode" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The method for rendering the specular blob. See [enum SpecularMode].
Use Filament specular models and parametrization
2021-08-16 06:37:24 +00:00
[b]Note:[/b] Only applies to the specular blob. Does not affect specular reflections from the Sky, SSR, or ReflectionProbes.
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 08:59:06 +00:00
</member>
<member name="subsurf_scatter_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges.
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="subsurf_scatter_skin_mode" type="bool" setter="set_flag" getter="get_flag" default="false">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
If [code]true[/code], subsurface scattering will use a special mode optimized for the color and density of human skin.
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 07:56:01 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="subsurf_scatter_strength" type="float" setter="set_subsurface_scattering_strength" getter="get_subsurface_scattering_strength" default="0.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The strength of the subsurface scattering effect.
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 08:59:06 +00:00
</member>
<member name="subsurf_scatter_texture" type="Texture2D" setter="set_texture" getter="get_texture">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture used to control the subsurface scattering strength. Stored in the red texture channel. Multiplied by [member subsurf_scatter_strength].
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 08:59:06 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="subsurf_scatter_transmittance_boost" type="float" setter="set_transmittance_boost" getter="get_transmittance_boost" default="0.0">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="subsurf_scatter_transmittance_color" type="Color" setter="set_transmittance_color" getter="get_transmittance_color" default="Color(1, 1, 1, 1)">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="subsurf_scatter_transmittance_depth" type="float" setter="set_transmittance_depth" getter="get_transmittance_depth" default="0.1">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
</member>
doc: Sync classref with current source
2021-03-10 09:54:21 +00:00
<member name="subsurf_scatter_transmittance_enabled" type="bool" setter="set_feature" getter="get_feature" default="false">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
</member>
<member name="subsurf_scatter_transmittance_texture" type="Texture2D" setter="set_texture" getter="get_texture">
</member>
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 08:59:06 +00:00
<member name="texture_filter" type="int" setter="set_texture_filter" getter="get_texture_filter" enum="BaseMaterial3D.TextureFilter" default="3">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Filter flags for the texture. See [enum TextureFilter] for options.
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 08:59:06 +00:00
</member>
<member name="texture_repeat" type="bool" setter="set_flag" getter="get_flag" default="true">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Repeat flags for the texture. See [enum TextureFilter] for options.
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 08:59:06 +00:00
</member>
<member name="transparency" type="int" setter="set_transparency" getter="get_transparency" enum="BaseMaterial3D.Transparency" default="0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], transparency is enabled on the body. See also [member blend_mode].
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 08:59:06 +00:00
</member>
Fix documentation following implementation of particle trails
2021-05-01 08:56:32 +00:00
<member name="use_particle_trails" type="bool" setter="set_flag" getter="get_flag" default="false">
</member>
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 08:59:06 +00:00
<member name="use_point_size" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], render point size can be changed.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 12:24:34 +00:00
[b]Note:[/b] This is only effective for objects whose geometry is point-based rather than triangle-based. See also [member point_size].
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="uv1_offset" type="Vector3" setter="set_uv1_offset" getter="get_uv1_offset" default="Vector3(0, 0, 0)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
How much to offset the [code]UV[/code] coordinates. This amount will be added to [code]UV[/code] in the vertex function. This can be used to offset a texture.
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="uv1_scale" type="Vector3" setter="set_uv1_scale" getter="get_uv1_scale" default="Vector3(1, 1, 1)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
How much to scale the [code]UV[/code] coordinates. This is multiplied by [code]UV[/code] in the vertex function.
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 08:59:06 +00:00
</member>
<member name="uv1_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], instead of using [code]UV[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
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 08:59:06 +00:00
</member>
<member name="uv1_triplanar_sharpness" type="float" setter="set_uv1_triplanar_blend_sharpness" getter="get_uv1_triplanar_blend_sharpness" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
A lower number blends the texture more softly while a higher number blends the texture more sharply.
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 08:59:06 +00:00
</member>
<member name="uv1_world_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], triplanar mapping for [code]UV[/code] is calculated in world space rather than object local space. See also [member uv1_triplanar].
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="uv2_offset" type="Vector3" setter="set_uv2_offset" getter="get_uv2_offset" default="Vector3(0, 0, 0)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
How much to offset the [code]UV2[/code] coordinates. This amount will be added to [code]UV2[/code] in the vertex function. This can be used to offset a texture.
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 08:59:06 +00:00
</member>
Better format arguments in variant parser
2019-09-24 17:45:03 +00:00
<member name="uv2_scale" type="Vector3" setter="set_uv2_scale" getter="get_uv2_scale" default="Vector3(1, 1, 1)">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
How much to scale the [code]UV2[/code] coordinates. This is multiplied by [code]UV2[/code] in the vertex function.
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 08:59:06 +00:00
</member>
<member name="uv2_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], instead of using [code]UV2[/code] textures will use a triplanar texture lookup to determine how to apply textures. Triplanar uses the orientation of the object's surface to blend between texture coordinates. It reads from the source texture 3 times, once for each axis and then blends between the results based on how closely the pixel aligns with each axis. This is often used for natural features to get a realistic blend of materials. Because triplanar texturing requires many more texture reads per-pixel it is much slower than normal UV texturing. Additionally, because it is blending the texture between the three axes, it is unsuitable when you are trying to achieve crisp texturing.
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 08:59:06 +00:00
</member>
<member name="uv2_triplanar_sharpness" type="float" setter="set_uv2_triplanar_blend_sharpness" getter="get_uv2_triplanar_blend_sharpness" default="1.0">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
A lower number blends the texture more softly while a higher number blends the texture more sharply.
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 08:59:06 +00:00
</member>
<member name="uv2_world_triplanar" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], triplanar mapping for [code]UV2[/code] is calculated in world space rather than object local space. See also [member uv2_triplanar].
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 08:59:06 +00:00
</member>
<member name="vertex_color_is_srgb" type="bool" setter="set_flag" getter="get_flag" default="false">
Rename BaseMaterial3D properties to use fully spelled out "texture" This is more consistent with other BaseMaterial properties such as `ao_texture_channel`. This also improves the documentation related to `albedo_texture_force_srgb`. This also fixes a typo in the 3.x material converter.
2022-05-14 23:19:43 +00:00
If [code]true[/code], vertex colors are considered to be stored in sRGB color space and are converted to linear color space during rendering. If [code]false[/code], vertex colors are considered to be stored in linear color space and are rendered as-is. See also [member albedo_texture_force_srgb].
[b]Note:[/b] Only effective when using the Vulkan Clustered or Vulkan Mobile backends.
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 08:59:06 +00:00
</member>
<member name="vertex_color_use_as_albedo" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
If [code]true[/code], the vertex color is used as albedo color.
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 08:59:06 +00:00
</member>
</members>
<constants>
<constant name="TEXTURE_ALBEDO" value="0" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel color.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_METALLIC" value="1" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel metallic value.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_ROUGHNESS" value="2" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel roughness value.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_EMISSION" value="3" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel emission color.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_NORMAL" value="4" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel normal vector.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_RIM" value="5" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel rim value.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CLEARCOAT" value="6" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel clearcoat value.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FLOWMAP" value="7" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel flowmap direction for use with [member anisotropy].
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_AMBIENT_OCCLUSION" value="8" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel ambient occlusion value.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_HEIGHTMAP" value="9" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel height.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_SUBSURFACE_SCATTERING" value="10" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel subsurface scattering.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_SUBSURFACE_TRANSMITTANCE" value="11" enum="TextureParam">
Texture specifying per-pixel transmittance for subsurface scattering.
</constant>
<constant name="TEXTURE_BACKLIGHT" value="12" enum="TextureParam">
Texture specifying per-pixel backlight color.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_REFRACTION" value="13" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel refraction strength.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_DETAIL_MASK" value="14" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel detail mask blending value.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_DETAIL_ALBEDO" value="15" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel detail color.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_DETAIL_NORMAL" value="16" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Texture specifying per-pixel detail normal.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_ORM" value="17" enum="TextureParam">
doc: Sync classref with current source Add missing enum bindings.
2020-04-20 09:48:00 +00:00
Texture holding ambient occlusion, roughness, and metallic.
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="TEXTURE_MAX" value="18" enum="TextureParam">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Represents the size of the [enum TextureParam] enum.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FILTER_NEAREST" value="0" enum="TextureFilter">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FILTER_LINEAR" value="1" enum="TextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The texture filter blends between the nearest 4 pixels. Use this when you want to avoid a pixelated style, but do not want mipmaps.
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 08:59:06 +00:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-19 23:31:43 +00:00
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS" value="2" enum="TextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The texture filter reads from the nearest pixel in the nearest mipmap. The fastest way to read from textures with mipmaps.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS" value="3" enum="TextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps. Use this for most cases as mipmaps are important to smooth out pixels that are far from the camera.
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 08:59:06 +00:00
</constant>
Fix MIMPAMPS typos in constants throughout the engine
2020-02-19 23:31:43 +00:00
<constant name="TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC" value="4" enum="TextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The texture filter reads from the nearest pixel, but selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC" value="5" enum="TextureFilter">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The texture filter blends between the nearest 4 pixels and selects a mipmap based on the angle between the surface and the camera view. This reduces artifacts on surfaces that are almost in line with the camera. This is the slowest of the filtering options, but results in the highest quality texturing.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_FILTER_MAX" value="6" enum="TextureFilter">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Represents the size of the [enum TextureFilter] enum.
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 08:59:06 +00:00
</constant>
<constant name="DETAIL_UV_1" value="0" enum="DetailUV">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use [code]UV[/code] with the detail texture.
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 08:59:06 +00:00
</constant>
<constant name="DETAIL_UV_2" value="1" enum="DetailUV">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use [code]UV2[/code] with the detail texture.
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 08:59:06 +00:00
</constant>
<constant name="TRANSPARENCY_DISABLED" value="0" enum="Transparency">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The material will not use transparency.
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 08:59:06 +00:00
</constant>
<constant name="TRANSPARENCY_ALPHA" value="1" enum="Transparency">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The material will use the texture's alpha values for transparency.
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 08:59:06 +00:00
</constant>
<constant name="TRANSPARENCY_ALPHA_SCISSOR" value="2" enum="Transparency">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The material will cut off all values below a threshold, the rest will remain opaque.
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 08:59:06 +00:00
</constant>
Alpha Hash and Alpha2Coverage Implementation
2020-07-13 08:27:01 +00:00
<constant name="TRANSPARENCY_ALPHA_HASH" value="3" enum="Transparency">
The material will cut off all values below a spatially-deterministic threshold, the rest will remain opaque.
</constant>
<constant name="TRANSPARENCY_ALPHA_DEPTH_PRE_PASS" value="4" enum="Transparency">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
The material will use the texture's alpha value for transparency, but will still be rendered in the pre-pass.
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 08:59:06 +00:00
</constant>
Alpha Hash and Alpha2Coverage Implementation
2020-07-13 08:27:01 +00:00
<constant name="TRANSPARENCY_MAX" value="5" enum="Transparency">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Represents the size of the [enum Transparency] enum.
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 08:59:06 +00:00
</constant>
<constant name="SHADING_MODE_UNSHADED" value="0" enum="ShadingMode">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The object will not receive shadows.
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 08:59:06 +00:00
</constant>
<constant name="SHADING_MODE_PER_PIXEL" value="1" enum="ShadingMode">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The object will be shaded per pixel. Useful for realistic shading effect.
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 08:59:06 +00:00
</constant>
<constant name="SHADING_MODE_PER_VERTEX" value="2" enum="ShadingMode">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality.
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 08:59:06 +00:00
</constant>
<constant name="SHADING_MODE_MAX" value="3" enum="ShadingMode">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Represents the size of the [enum ShadingMode] enum.
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_EMISSION" value="0" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member emission_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_NORMAL_MAPPING" value="1" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member normal_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_RIM" value="2" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member rim_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_CLEARCOAT" value="3" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member clearcoat_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_ANISOTROPY" value="4" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member anisotropy_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_AMBIENT_OCCLUSION" value="5" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member ao_enabled].
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 08:59:06 +00:00
</constant>
<constant name="FEATURE_HEIGHT_MAPPING" value="6" enum="Feature">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
Constant for setting [member heightmap_enabled].
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="FEATURE_SUBSURFACE_SCATTERING" value="7" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member subsurf_scatter_enabled].
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="FEATURE_SUBSURFACE_TRANSMITTANCE" value="8" enum="Feature">
Constant for setting [member subsurf_scatter_transmittance_enabled].
</constant>
<constant name="FEATURE_BACKLIGHT" value="9" enum="Feature">
Constant for setting [member backlight_enabled].
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="FEATURE_REFRACTION" value="10" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member refraction_enabled].
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="FEATURE_DETAIL" value="11" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Constant for setting [member detail_enabled].
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 08:59:06 +00:00
</constant>
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
<constant name="FEATURE_MAX" value="12" enum="Feature">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Represents the size of the [enum Feature] enum.
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 08:59:06 +00:00
</constant>
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Default blend mode. The color of the object is blended over the background based on the object's alpha value.
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 08:59:06 +00:00
</constant>
<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The color of the object is added to the background.
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 08:59:06 +00:00
</constant>
<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The color of the object is subtracted from the background.
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 08:59:06 +00:00
</constant>
<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The color of the object is multiplied by the background.
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 08:59:06 +00:00
</constant>
Alpha Hash and Alpha2Coverage Implementation
2020-07-13 08:27:01 +00:00
<constant name="ALPHA_ANTIALIASING_OFF" value="0" enum="AlphaAntiAliasing">
Disables Alpha AntiAliasing for the material.
</constant>
<constant name="ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE" value="1" enum="AlphaAntiAliasing">
Enables AlphaToCoverage. Alpha values in the material are passed to the AntiAliasing sample mask.
</constant>
<constant name="ALPHA_ANTIALIASING_ALPHA_TO_COVERAGE_AND_TO_ONE" value="2" enum="AlphaAntiAliasing">
Enables AlphaToCoverage and forces all non-zero alpha values to [code]1[/code]. Alpha values in the material are passed to the AntiAliasing sample mask.
</constant>
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 08:59:06 +00:00
<constant name="DEPTH_DRAW_OPAQUE_ONLY" value="0" enum="DepthDrawMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Default depth draw mode. Depth is drawn only for opaque objects.
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 08:59:06 +00:00
</constant>
<constant name="DEPTH_DRAW_ALWAYS" value="1" enum="DepthDrawMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Depth draw is calculated for both opaque and transparent objects.
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 08:59:06 +00:00
</constant>
<constant name="DEPTH_DRAW_DISABLED" value="2" enum="DepthDrawMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
No depth draw.
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 08:59:06 +00:00
</constant>
<constant name="CULL_BACK" value="0" enum="CullMode">
Fix and improve cull mode description in material
2021-12-28 02:43:02 +00:00
Default cull mode. The back of the object is culled when not visible. Back face triangles will be culled when facing the camera. This results in only the front side of triangles being drawn. For closed-surface meshes this means that only the exterior of the mesh will be visible.
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 08:59:06 +00:00
</constant>
<constant name="CULL_FRONT" value="1" enum="CullMode">
Fix and improve cull mode description in material
2021-12-28 02:43:02 +00:00
Front face triangles will be culled when facing the camera. This results in only the back side of triangles being drawn. For closed-surface meshes this means that the interior of the mesh will be drawn instead of the exterior.
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 08:59:06 +00:00
</constant>
<constant name="CULL_DISABLED" value="2" enum="CullMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
No culling is performed.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_DISABLE_DEPTH_TEST" value="0" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_ALBEDO_FROM_VERTEX_COLOR" value="1" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Set [code]ALBEDO[/code] to the per-vertex color specified in the mesh.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_SRGB_VERTEX_COLOR" value="2" enum="Flags">
Rename BaseMaterial3D properties to use fully spelled out "texture" This is more consistent with other BaseMaterial properties such as `ao_texture_channel`. This also improves the documentation related to `albedo_texture_force_srgb`. This also fixes a typo in the 3.x material converter.
2022-05-14 23:19:43 +00:00
Vertex colors are considered to be stored in sRGB color space and are converted to linear color space during rendering. See also [member vertex_color_is_srgb].
[b]Note:[/b] Only effective when using the Vulkan Clustered or Vulkan Mobile backends.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_USE_POINT_SIZE" value="3" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Uses point size to alter the size of primitive points. Also changes the albedo texture lookup to use [code]POINT_COORD[/code] instead of [code]UV[/code].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_FIXED_SIZE" value="4" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Object is scaled by depth so that it always appears the same size on screen.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_BILLBOARD_KEEP_SCALE" value="5" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Shader will keep the scale set for the mesh. Otherwise the scale is lost when billboarding. Only applies when [member billboard_mode] is [constant BILLBOARD_ENABLED].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_UV1_USE_TRIPLANAR" value="6" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV[/code].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_UV2_USE_TRIPLANAR" value="7" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV2[/code].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_UV1_USE_WORLD_TRIPLANAR" value="8" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV[/code].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_UV2_USE_WORLD_TRIPLANAR" value="9" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use triplanar texture lookup for all texture lookups that would normally use [code]UV2[/code].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_AO_ON_UV2" value="10" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use [code]UV2[/code] coordinates to look up from the [member ao_texture].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_EMISSION_ON_UV2" value="11" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Use [code]UV2[/code] coordinates to look up from the [member emission_texture].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_ALBEDO_TEXTURE_FORCE_SRGB" value="12" enum="Flags">
Rename BaseMaterial3D properties to use fully spelled out "texture" This is more consistent with other BaseMaterial properties such as `ao_texture_channel`. This also improves the documentation related to `albedo_texture_force_srgb`. This also fixes a typo in the 3.x material converter.
2022-05-14 23:19:43 +00:00
Forces the shader to convert albedo from sRGB space to linear space. See also [member albedo_texture_force_srgb].
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 08:59:06 +00:00
</constant>
<constant name="FLAG_DONT_RECEIVE_SHADOWS" value="13" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Disables receiving shadows from other objects.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_DISABLE_AMBIENT_LIGHT" value="14" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Disables receiving ambient light.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_USE_SHADOW_TO_OPACITY" value="15" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Enables the shadow to opacity feature.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_USE_TEXTURE_REPEAT" value="16" enum="Flags">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
Enables the texture to repeat when UV coordinates are outside the 0-1 range. If using one of the linear filtering modes, this can result in artifacts at the edges of a texture when the sampler filters across the edges of the texture.
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 08:59:06 +00:00
</constant>
<constant name="FLAG_INVERT_HEIGHTMAP" value="17" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Invert values read from a depth texture to convert them to height values (heightmap).
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 08:59:06 +00:00
</constant>
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 07:56:01 +00:00
<constant name="FLAG_SUBSURFACE_MODE_SKIN" value="18" enum="Flags">
Update many docs with recent rendering changes
2020-04-16 23:05:25 +00:00
Enables the skin mode for subsurface scattering which is used to improve the look of subsurface scattering when used for human skin.
i18n: Sync translate template for class reference Adds initial fr.po translation for initialization on Weblate.
2020-04-07 07:56:01 +00:00
</constant>
Fix documentation following implementation of particle trails
2021-05-01 08:56:32 +00:00
<constant name="FLAG_PARTICLE_TRAILS_MODE" value="19" enum="Flags">
</constant>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 10:27:18 +00:00
<constant name="FLAG_ALBEDO_TEXTURE_MSDF" value="20" enum="Flags">
Enables multichannel signed distance field rendering shader.
</constant>
<constant name="FLAG_MAX" value="21" enum="Flags">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Represents the size of the [enum Flags] enum.
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 08:59:06 +00:00
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Default diffuse scattering algorithm.
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 08:59:06 +00:00
</constant>
<constant name="DIFFUSE_LAMBERT" value="1" enum="DiffuseMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Diffuse scattering ignores roughness.
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 08:59:06 +00:00
</constant>
<constant name="DIFFUSE_LAMBERT_WRAP" value="2" enum="DiffuseMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Extends Lambert to cover more than 90 degrees when roughness increases.
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 08:59:06 +00:00
</constant>
Removes deleted OrenNayar mode from shaders and materials
2021-06-08 12:50:40 +00:00
<constant name="DIFFUSE_TOON" value="3" enum="DiffuseMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Uses a hard cut for lighting, with smoothing affected by roughness.
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 08:59:06 +00:00
</constant>
<constant name="SPECULAR_SCHLICK_GGX" value="0" enum="SpecularMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Default specular blob.
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 08:59:06 +00:00
</constant>
Use Filament specular models and parametrization
2021-08-16 06:37:24 +00:00
<constant name="SPECULAR_TOON" value="1" enum="SpecularMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Toon blob which changes size based on roughness.
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 08:59:06 +00:00
</constant>
Use Filament specular models and parametrization
2021-08-16 06:37:24 +00:00
<constant name="SPECULAR_DISABLED" value="2" enum="SpecularMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
No specular blob.
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 08:59:06 +00:00
</constant>
<constant name="BILLBOARD_DISABLED" value="0" enum="BillboardMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Billboard mode is disabled.
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 08:59:06 +00:00
</constant>
<constant name="BILLBOARD_ENABLED" value="1" enum="BillboardMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The object's Z axis will always face the camera.
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 08:59:06 +00:00
</constant>
<constant name="BILLBOARD_FIXED_Y" value="2" enum="BillboardMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
The object's X axis will always face the camera.
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 08:59:06 +00:00
</constant>
<constant name="BILLBOARD_PARTICLES" value="3" enum="BillboardMode">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-30 16:22:57 +00:00
Used for particle systems when assigned to [GPUParticles3D] and [CPUParticles3D] nodes. Enables [code]particles_anim_*[/code] properties.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 17:46:27 +00:00
The [member ParticlesMaterial.anim_speed_min] or [member CPUParticles3D.anim_speed_min] should also be set to a value bigger than zero for the animation to play.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CHANNEL_RED" value="0" enum="TextureChannel">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Used to read from the red channel of a texture.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CHANNEL_GREEN" value="1" enum="TextureChannel">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Used to read from the green channel of a texture.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CHANNEL_BLUE" value="2" enum="TextureChannel">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Used to read from the blue channel of a texture.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CHANNEL_ALPHA" value="3" enum="TextureChannel">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Used to read from the alpha channel of a texture.
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 08:59:06 +00:00
</constant>
<constant name="TEXTURE_CHANNEL_GRAYSCALE" value="4" enum="TextureChannel">
Improve documentation related to detail mapping in BaseMaterial3D
2022-03-22 18:02:51 +00:00
Used to read from the linear (non-perceptual) average of the red, green and blue channels of a texture.
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 08:59:06 +00:00
</constant>
<constant name="EMISSION_OP_ADD" value="0" enum="EmissionOperator">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Adds the emission color to the color from the emission texture.
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 08:59:06 +00:00
</constant>
<constant name="EMISSION_OP_MULTIPLY" value="1" enum="EmissionOperator">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Multiplies the emission color by the color from the emission texture.
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 08:59:06 +00:00
</constant>
<constant name="DISTANCE_FADE_DISABLED" value="0" enum="DistanceFadeMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Do not use distance fade.
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 08:59:06 +00:00
</constant>
<constant name="DISTANCE_FADE_PIXEL_ALPHA" value="1" enum="DistanceFadeMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Smoothly fades the object out based on each pixel's distance from the camera using the alpha channel.
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 08:59:06 +00:00
</constant>
<constant name="DISTANCE_FADE_PIXEL_DITHER" value="2" enum="DistanceFadeMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Smoothly fades the object out based on each pixel's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
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 08:59:06 +00:00
</constant>
<constant name="DISTANCE_FADE_OBJECT_DITHER" value="3" enum="DistanceFadeMode">
doc: Add BaseMaterial3D strings ported from SpatialMaterial Follow-up to #36135.
2020-02-12 14:22:55 +00:00
Smoothly fades the object out based on the object's distance from the camera using a dither approach. Dithering discards pixels based on a set pattern to smoothly fade without enabling transparency. On certain hardware this can be faster than [constant DISTANCE_FADE_PIXEL_ALPHA].
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 08:59:06 +00:00
</constant>
</constants>
</class>