:github_url: hide .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the BitMap.xml source instead. .. The source is found in doc/classes or modules//doc_classes. .. _class_BitMap: BitMap ====== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Boolean matrix. Methods ------- +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create` **(** :ref:`Vector2` size **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** const | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_size` **(** **)** const | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_true_bit_count` **(** **)** const | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit_rect` **(** :ref:`Rect2` rect, :ref:`bool` bit **)** | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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. Method Descriptions ------------------- .. _class_BitMap_method_create: - void **create** **(** :ref:`Vector2` size **)** Creates a bitmap with the specified size, filled with ``false``. ---- .. _class_BitMap_method_create_from_image_alpha: - void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case. ---- .. _class_BitMap_method_get_bit: - :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** const Returns bitmap's value at the specified position. ---- .. _class_BitMap_method_get_size: - :ref:`Vector2` **get_size** **(** **)** const Returns bitmap's dimensions. ---- .. _class_BitMap_method_get_true_bit_count: - :ref:`int` **get_true_bit_count** **(** **)** const Returns the amount of bitmap elements that are set to ``true``. ---- .. _class_BitMap_method_grow_mask: - void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** ---- .. _class_BitMap_method_opaque_to_polygons: - :ref:`Array` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** const ---- .. _class_BitMap_method_set_bit: - void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** Sets the bitmap's element at the specified position, to the specified value. ---- .. _class_BitMap_method_set_bit_rect: - void **set_bit_rect** **(** :ref:`Rect2` rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value.