mirror of
https://github.com/godotengine/godot
synced 2024-09-19 14:58:24 +00:00
81064cc239
We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
115 lines
4.7 KiB
XML
115 lines
4.7 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="BitMap" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Boolean matrix.
|
|
</brief_description>
|
|
<description>
|
|
A two-dimensional array of boolean values, can be used to efficiently store a binary matrix (every matrix element takes only one bit) and query the values using natural cartesian coordinates.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="convert_to_image" qualifiers="const">
|
|
<return type="Image" />
|
|
<description>
|
|
Returns an image of the same size as the bitmap and with a [enum Image.Format] of type [constant Image.FORMAT_L8]. [code]true[/code] bits of the bitmap are being converted into white pixels, and [code]false[/code] bits into black.
|
|
</description>
|
|
</method>
|
|
<method name="create">
|
|
<return type="void" />
|
|
<param index="0" name="size" type="Vector2i" />
|
|
<description>
|
|
Creates a bitmap with the specified size, filled with [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="create_from_image_alpha">
|
|
<return type="void" />
|
|
<param index="0" name="image" type="Image" />
|
|
<param index="1" name="threshold" type="float" default="0.1" />
|
|
<description>
|
|
Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [param threshold] or less, and [code]true[/code] in other case.
|
|
</description>
|
|
</method>
|
|
<method name="get_bit" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="x" type="int" />
|
|
<param index="1" name="y" type="int" />
|
|
<description>
|
|
Returns bitmap's value at the specified position.
|
|
</description>
|
|
</method>
|
|
<method name="get_bitv" qualifiers="const">
|
|
<return type="bool" />
|
|
<param index="0" name="position" type="Vector2i" />
|
|
<description>
|
|
Returns bitmap's value at the specified position.
|
|
</description>
|
|
</method>
|
|
<method name="get_size" qualifiers="const">
|
|
<return type="Vector2i" />
|
|
<description>
|
|
Returns bitmap's dimensions.
|
|
</description>
|
|
</method>
|
|
<method name="get_true_bit_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of bitmap elements that are set to [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="grow_mask">
|
|
<return type="void" />
|
|
<param index="0" name="pixels" type="int" />
|
|
<param index="1" name="rect" type="Rect2i" />
|
|
<description>
|
|
Applies morphological dilation or erosion to the bitmap. If [param pixels] is positive, dilation is applied to the bitmap. If [param pixels] is negative, erosion is applied to the bitmap. [param rect] defines the area where the morphological operation is applied. Pixels located outside the [param rect] are unaffected by [method grow_mask].
|
|
</description>
|
|
</method>
|
|
<method name="opaque_to_polygons" qualifiers="const">
|
|
<return type="PackedVector2Array[]" />
|
|
<param index="0" name="rect" type="Rect2i" />
|
|
<param index="1" name="epsilon" type="float" default="2.0" />
|
|
<description>
|
|
Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices.
|
|
To get polygons covering the whole bitmap, pass:
|
|
[codeblock]
|
|
Rect2(Vector2(), get_size())
|
|
[/codeblock]
|
|
[param epsilon] is passed to RDP to control how accurately the polygons cover the bitmap: a lower [param epsilon] corresponds to more points in the polygons.
|
|
</description>
|
|
</method>
|
|
<method name="resize">
|
|
<return type="void" />
|
|
<param index="0" name="new_size" type="Vector2i" />
|
|
<description>
|
|
Resizes the image to [param new_size].
|
|
</description>
|
|
</method>
|
|
<method name="set_bit">
|
|
<return type="void" />
|
|
<param index="0" name="x" type="int" />
|
|
<param index="1" name="y" type="int" />
|
|
<param index="2" name="bit" type="bool" />
|
|
<description>
|
|
Sets the bitmap's element at the specified position, to the specified value.
|
|
</description>
|
|
</method>
|
|
<method name="set_bit_rect">
|
|
<return type="void" />
|
|
<param index="0" name="rect" type="Rect2i" />
|
|
<param index="1" name="bit" type="bool" />
|
|
<description>
|
|
Sets a rectangular portion of the bitmap to the specified value.
|
|
</description>
|
|
</method>
|
|
<method name="set_bitv">
|
|
<return type="void" />
|
|
<param index="0" name="position" type="Vector2i" />
|
|
<param index="1" name="bit" type="bool" />
|
|
<description>
|
|
Sets the bitmap's element at the specified position, to the specified value.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|