2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2021-03-23 12:40:34 +00:00
<class name= "BitMap" inherits= "Resource" version= "3.3" >
2017-09-12 20:42:36 +00:00
<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= "create" >
<return type= "void" >
</return>
<argument index= "0" name= "size" type= "Vector2" >
</argument>
<description >
2019-04-17 11:42:56 +00:00
Creates a bitmap with the specified size, filled with [code]false[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "create_from_image_alpha" >
<return type= "void" >
</return>
<argument index= "0" name= "image" type= "Image" >
</argument>
2018-02-25 06:19:42 +00:00
<argument index= "1" name= "threshold" type= "float" default= "0.1" >
</argument>
2017-09-12 20:42:36 +00:00
<description >
2019-04-17 11:42:56 +00:00
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 [code]threshold[/code] or less, and [code]true[/code] in other case.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_bit" qualifiers= "const" >
<return type= "bool" >
</return>
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<description >
Returns bitmap's value at the specified position.
</description>
</method>
<method name= "get_size" qualifiers= "const" >
<return type= "Vector2" >
</return>
<description >
Returns bitmap's dimensions.
</description>
</method>
<method name= "get_true_bit_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2019-04-17 11:42:56 +00:00
Returns the amount of bitmap elements that are set to [code]true[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-08-20 22:35:30 +00:00
<method name= "grow_mask" >
<return type= "void" >
</return>
<argument index= "0" name= "pixels" type= "int" >
</argument>
<argument index= "1" name= "rect" type= "Rect2" >
</argument>
<description >
2020-08-12 08:50:15 +00:00
Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied.
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name= "opaque_to_polygons" qualifiers= "const" >
<return type= "Array" >
</return>
<argument index= "0" name= "rect" type= "Rect2" >
</argument>
<argument index= "1" name= "epsilon" type= "float" default= "2.0" >
</argument>
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "set_bit" >
<return type= "void" >
</return>
2017-09-10 13:37:49 +00:00
<argument index= "0" name= "position" type= "Vector2" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "bit" type= "bool" >
</argument>
<description >
Sets the bitmap's element at the specified position, to the specified value.
</description>
</method>
<method name= "set_bit_rect" >
<return type= "void" >
</return>
2018-12-27 10:10:09 +00:00
<argument index= "0" name= "rect" type= "Rect2" >
2017-09-12 20:42:36 +00:00
</argument>
<argument index= "1" name= "bit" type= "bool" >
</argument>
<description >
Sets a rectangular portion of the bitmap to the specified value.
</description>
</method>
</methods>
<constants >
</constants>
</class>