Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_bitmap.rst

class_bitmap.rst 9.0 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/BitMap.xml.
    7. 

  7. 

  8. .. _class_BitMap:
    9. 

  9. 

  10. BitMap
    11. 

  11. ======
    12. 

  12. 

  13. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. Boolean matrix.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. 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.
    21. 

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`Image<class_Image>`     | :ref:`convert_to_image<class_BitMap_method_convert_to_image>` **(** **)** |const|                                                                                |
    27. 

  27. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | void                          | :ref:`create<class_BitMap_method_create>` **(** :ref:`Vector2<class_Vector2>` size **)**                                                                         |
    29. 

  29. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                          | :ref:`create_from_image_alpha<class_BitMap_method_create_from_image_alpha>` **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)** |
    31. 

  31. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`bool<class_bool>`       | :ref:`get_bit<class_BitMap_method_get_bit>` **(** :ref:`Vector2<class_Vector2>` position **)** |const|                                                           |
    33. 

  33. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Vector2<class_Vector2>` | :ref:`get_size<class_BitMap_method_get_size>` **(** **)** |const|                                                                                                |
    35. 

  35. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`int<class_int>`         | :ref:`get_true_bit_count<class_BitMap_method_get_true_bit_count>` **(** **)** |const|                                                                            |
    37. 

  37. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | void                          | :ref:`grow_mask<class_BitMap_method_grow_mask>` **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)**                                         |
    39. 

  39. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Array<class_Array>`     | :ref:`opaque_to_polygons<class_BitMap_method_opaque_to_polygons>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** |const|      |
    41. 

  41. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                          | :ref:`resize<class_BitMap_method_resize>` **(** :ref:`Vector2<class_Vector2>` new_size **)**                                                                     |
    43. 

  43. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                          | :ref:`set_bit<class_BitMap_method_set_bit>` **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)**                                      |
    45. 

  45. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                          | :ref:`set_bit_rect<class_BitMap_method_set_bit_rect>` **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)**                                    |
    47. 

  47. +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. 

  49. Method Descriptions
    50. 

  50. -------------------
    51. 

  51. 

  52. .. _class_BitMap_method_convert_to_image:
    53. 

  53. 

  54. - :ref:`Image<class_Image>` **convert_to_image** **(** **)** |const|
    55. 

  55. 

  56. Returns an image of the same size as the bitmap and with a :ref:`Format<enum_Image_Format>` of type ``FORMAT_L8``. ``true`` bits of the bitmap are being converted into white pixels, and ``false`` bits into black.
    57. 

  57. 

  58. ----
    59. 

  59. 

  60. .. _class_BitMap_method_create:
    61. 

  61. 

  62. - void **create** **(** :ref:`Vector2<class_Vector2>` size **)**
    63. 

  63. 

  64. Creates a bitmap with the specified size, filled with ``false``.
    65. 

  65. 

  66. ----
    67. 

  67. 

  68. .. _class_BitMap_method_create_from_image_alpha:
    69. 

  69. 

  70. - void **create_from_image_alpha** **(** :ref:`Image<class_Image>` image, :ref:`float<class_float>` threshold=0.1 **)**
    71. 

  71. 

  72. 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.
    73. 

  73. 

  74. ----
    75. 

  75. 

  76. .. _class_BitMap_method_get_bit:
    77. 

  77. 

  78. - :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_Vector2>` position **)** |const|
    79. 

  79. 

  80. Returns bitmap's value at the specified position.
    81. 

  81. 

  82. ----
    83. 

  83. 

  84. .. _class_BitMap_method_get_size:
    85. 

  85. 

  86. - :ref:`Vector2<class_Vector2>` **get_size** **(** **)** |const|
    87. 

  87. 

  88. Returns bitmap's dimensions.
    89. 

  89. 

  90. ----
    91. 

  91. 

  92. .. _class_BitMap_method_get_true_bit_count:
    93. 

  93. 

  94. - :ref:`int<class_int>` **get_true_bit_count** **(** **)** |const|
    95. 

  95. 

  96. Returns the amount of bitmap elements that are set to ``true``.
    97. 

  97. 

  98. ----
    99. 

  99. 

  100. .. _class_BitMap_method_grow_mask:
    101. 

  101. 

  102. - void **grow_mask** **(** :ref:`int<class_int>` pixels, :ref:`Rect2<class_Rect2>` rect **)**
    103. 

  103. 

  104. Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positive, dilation is applied to the bitmap. If ``pixels`` is negative, erosion is applied to the bitmap. ``rect`` defines the area where the morphological operation is applied. Pixels located outside the ``rect`` are unaffected by :ref:`grow_mask<class_BitMap_method_grow_mask>`.
    105. 

  105. 

  106. ----
    107. 

  107. 

  108. .. _class_BitMap_method_opaque_to_polygons:
    109. 

  109. 

  110. - :ref:`Array<class_Array>` **opaque_to_polygons** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`float<class_float>` epsilon=2.0 **)** |const|
    111. 

  111. 

  112. Creates an :ref:`Array<class_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 :ref:`PackedVector2Array<class_PackedVector2Array>` of its vertices.
    113. 

  113. 

  114. To get polygons covering the whole bitmap, pass:
    115. 

  115. 

  116. ::
    117. 

  117. 

  118.     Rect2(Vector2(), get_size())
    119. 

  119. 

  120. \ ``epsilon`` is passed to RDP to control how accurately the polygons cover the bitmap: a lower ``epsilon`` corresponds to more points in the polygons.
    121. 

  121. 

  122. ----
    123. 

  123. 

  124. .. _class_BitMap_method_resize:
    125. 

  125. 

  126. - void **resize** **(** :ref:`Vector2<class_Vector2>` new_size **)**
    127. 

  127. 

  128. Resizes the image to ``new_size``.
    129. 

  129. 

  130. ----
    131. 

  131. 

  132. .. _class_BitMap_method_set_bit:
    133. 

  133. 

  134. - void **set_bit** **(** :ref:`Vector2<class_Vector2>` position, :ref:`bool<class_bool>` bit **)**
    135. 

  135. 

  136. Sets the bitmap's element at the specified position, to the specified value.
    137. 

  137. 

  138. ----
    139. 

  139. 

  140. .. _class_BitMap_method_set_bit_rect:
    141. 

  141. 

  142. - void **set_bit_rect** **(** :ref:`Rect2<class_Rect2>` rect, :ref:`bool<class_bool>` bit **)**
    143. 

  143. 

  144. Sets a rectangular portion of the bitmap to the specified value.
    145. 

  145. 

  146. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    147. 

  147. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    148. 

  148. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    149. 

  149. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    150. 

  150. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    151. 

  151. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    152.