diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2023-07-13 02:25:33 +0200 |
|---|---|---|
| committer | Yuri Sizov <yuris@humnom.net> | 2023-07-27 19:18:27 +0200 |
| commit | bc58a8a34e3a2ed93439ff86a510f42970ea8c8d (patch) | |
| tree | 010bbbcf261f19a35e4fc6ec3d5c580f1c68747a /doc/classes/ResourceImporterBitMap.xml | |
| parent | 60f3b7967cbd00b4e1f52d33d372646f7bec02f6 (diff) | |
| download | redot-engine-bc58a8a34e3a2ed93439ff86a510f42970ea8c8d.tar.gz | |
Fill in descriptions for import options in the class reference
Diffstat (limited to 'doc/classes/ResourceImporterBitMap.xml')
| -rw-r--r-- | doc/classes/ResourceImporterBitMap.xml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/ResourceImporterBitMap.xml b/doc/classes/ResourceImporterBitMap.xml index a7eb94a75a..e54947ebb6 100644 --- a/doc/classes/ResourceImporterBitMap.xml +++ b/doc/classes/ResourceImporterBitMap.xml @@ -1,15 +1,22 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ResourceImporterBitMap" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> + Imports a [BitMap] resource (2D array of boolean values). </brief_description> <description> + [BitMap] resources are typically used as click masks in [TextureButton] and [TouchScreenButton]. </description> <tutorials> + <link title="Importing images">$DOCS_URL/tutorials/assets_pipeline/importing_images.html</link> </tutorials> <members> <member name="create_from" type="int" setter="" getter="" default="0"> + The data source to use for generating the bitmap. + [b]Black & White:[/b] Pixels whose HSV value is greater than the [member threshold] will be considered as "enabled" (bit is [code]true[/code]). If the pixel is lower than or equal to the threshold, it will be considered as "disabled" (bit is [code]false[/code]). + [b]Alpha:[/b] Pixels whose alpha value is greater than the [member threshold] will be considered as "enabled" (bit is [code]true[/code]). If the pixel is lower than or equal to the threshold, it will be considered as "disabled" (bit is [code]false[/code]). </member> <member name="threshold" type="float" setter="" getter="" default="0.5"> + The threshold to use to determine which bits should be considered enabled or disabled. See also [member create_from]. </member> </members> </class> |