:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/DPITexture.xml. .. _class_DPITexture: DPITexture ========== **Experimental:** This class may be changed or removed in future versions. **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` An automatically scalable :ref:`Texture2D` based on an SVG image. .. rst-class:: classref-introduction-group Description ----------- An automatically scalable :ref:`Texture2D` based on an SVG image. **DPITexture**\ s are used to automatically re-rasterize icons and other texture based UI theme elements to match viewport scale and font oversampling. See also :ref:`ProjectSettings.display/window/stretch/mode` ("canvas_items" mode) and :ref:`Viewport.oversampling_override`. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`base_scale` | ``1.0`` | +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`color_map` | ``{}`` | +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`saturation` | ``1.0`` | +-------------------------------------+---------------------------------------------------------+----------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`DPITexture` | :ref:`create_from_string`\ (\ source\: :ref:`String`, scale\: :ref:`float` = 1.0, saturation\: :ref:`float` = 1.0, color_map\: :ref:`Dictionary` = {}\ ) |static| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_scaled_rid`\ (\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_source`\ (\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_size_override`\ (\ size\: :ref:`Vector2i`\ ) | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_source`\ (\ source\: :ref:`String`\ ) | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_DPITexture_property_base_scale: .. rst-class:: classref-property :ref:`float` **base_scale** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_base_scale**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_base_scale**\ (\ ) Texture scale. ``1.0`` is the original SVG size. Higher values result in a larger image. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_property_color_map: .. rst-class:: classref-property :ref:`Dictionary` **color_map** = ``{}`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color_map**\ (\ value\: :ref:`Dictionary`\ ) - :ref:`Dictionary` **get_color_map**\ (\ ) If set, remaps texture colors according to :ref:`Color`-:ref:`Color` map. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_property_saturation: .. rst-class:: classref-property :ref:`float` **saturation** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_saturation**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_saturation**\ (\ ) Overrides texture saturation. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_DPITexture_method_create_from_string: .. rst-class:: classref-method :ref:`DPITexture` **create_from_string**\ (\ source\: :ref:`String`, scale\: :ref:`float` = 1.0, saturation\: :ref:`float` = 1.0, color_map\: :ref:`Dictionary` = {}\ ) |static| :ref:`🔗` Creates a new **DPITexture** and initializes it by allocating and setting the SVG data from string. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_method_get_scaled_rid: .. rst-class:: classref-method :ref:`RID` **get_scaled_rid**\ (\ ) |const| :ref:`🔗` Returns the :ref:`RID` of the texture rasterized to match the oversampling of the currently drawn canvas item. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_method_get_source: .. rst-class:: classref-method :ref:`String` **get_source**\ (\ ) |const| :ref:`🔗` Returns SVG source code. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_method_set_size_override: .. rst-class:: classref-method |void| **set_size_override**\ (\ size\: :ref:`Vector2i`\ ) :ref:`🔗` Resizes the texture to the specified dimensions. .. rst-class:: classref-item-separator ---- .. _class_DPITexture_method_set_source: .. rst-class:: classref-method |void| **set_source**\ (\ source\: :ref:`String`\ ) :ref:`🔗` Sets SVG source code. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`