godot-module-template/engine/doc/classes/ResourceImporterSVG.xml
Sara c3f9669b10 Add 'engine/' from commit 'a8e37fc010'
git-subtree-dir: engine
git-subtree-mainline: b74841629e
git-subtree-split: a8e37fc010
2026-03-13 11:22:19 +01:00

33 lines
2.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterSVG" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Imports an SVG file as an automatically scalable texture for use in UI elements and 2D rendering.
</brief_description>
<description>
This importer imports [DPITexture] resources. See also [ResourceImporterTexture] and [ResourceImporterImage].
</description>
<tutorials>
</tutorials>
<members>
<member name="base_scale" type="float" setter="" getter="" default="1.0">
Texture scale. [code]1.0[/code] is the original SVG size. Higher values result in a larger image.
</member>
<member name="color_map" type="Dictionary" setter="" getter="" default="{}">
If set, remaps texture colors according to [Color]-[Color] map.
</member>
<member name="compress" type="bool" setter="" getter="" default="true">
If [code]true[/code], uses lossless compression for the SVG source.
</member>
<member name="fix_alpha_border" type="bool" setter="" getter="" default="false">
If [code]true[/code], puts pixels of the same surrounding color in transition from transparent to opaque areas. For textures displayed with bilinear filtering, this helps to reduce the outline effect when exporting images from an image editor.
</member>
<member name="premult_alpha" type="bool" setter="" getter="" default="false">
An alternative to fixing darkened borders with [member fix_alpha_border] is to use premultiplied alpha. By enabling this option, the texture will be converted to this format. A premultiplied alpha texture requires specific materials to be displayed correctly:
- In 2D, a [CanvasItemMaterial] will need to be created and configured to use the [constant CanvasItemMaterial.BLEND_MODE_PREMULT_ALPHA] blend mode on [CanvasItem]s that use this texture. In custom [code]canvas_item[/code] shaders, [code]render_mode blend_premul_alpha;[/code] should be used.
- In 3D, a [BaseMaterial3D] will need to be created and configured to use the [constant BaseMaterial3D.BLEND_MODE_PREMULT_ALPHA] blend mode on materials that use this texture. In custom [code]spatial[/code] shaders, [code]render_mode blend_premul_alpha;[/code] should be used.
</member>
<member name="saturation" type="float" setter="" getter="" default="1.0">
Overrides texture saturation.
</member>
</members>
</class>