mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-27 09:16:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
5c43e4c1ef
godot/doc/classes/BitMap.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

115 lines
4.7 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header 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).
2023-07-06 16:08:05 +08:00
<class name="BitMap" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08: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>
Expose BitMap's `convert_to_image` and `resize` methods to GDScript
2021-12-12 07:05:25 +08:00
<method name="convert_to_image" qualifiers="const">
<return type="Image" />
<description>
Style: Misc docs and comment style and language fixes - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-01 22:29:38 +08:00
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.
Expose BitMap's `convert_to_image` and `resize` methods to GDScript
2021-12-12 07:05:25 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="create">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="0" name="size" type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Consistently wrap booleans in [code]
2019-04-17 19:42:56 +08:00
Creates a bitmap with the specified size, filled with [code]false[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="create_from_image_alpha">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="image" type="Image" />
<param index="1" name="threshold" type="float" default="0.1" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-13 01:13:27 +08: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 [param threshold] or less, and [code]true[/code] in other case.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_bit" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<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" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Returns bitmap's value at the specified position.
</description>
</method>
<method name="get_size" qualifiers="const">
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<return type="Vector2i" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Returns bitmap's dimensions.
</description>
</method>
<method name="get_true_bit_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-18 06:08:09 +08:00
Returns the number of bitmap elements that are set to [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<method name="grow_mask">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="pixels" type="int" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="1" name="rect" type="Rect2i" />
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-13 01:13:27 +08:00
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].
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
</description>
</method>
<method name="opaque_to_polygons" qualifiers="const">
Replace Array return types with TypedArray
2022-08-05 09:41:48 +08:00
<return type="PackedVector2Array[]" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="0" name="rect" type="Rect2i" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="1" name="epsilon" type="float" default="2.0" />
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
<description>
Add documentation to Bitmaps opaque_to_polygons.
2021-03-22 04:46:28 +08:00
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]
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-13 01:13:27 +08:00
[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.
doc: Sync classref with current source
2018-08-21 06:35:30 +08:00
</description>
</method>
Expose BitMap's `convert_to_image` and `resize` methods to GDScript
2021-12-12 07:05:25 +08:00
<method name="resize">
<return type="void" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="0" name="new_size" type="Vector2i" />
Expose BitMap's `convert_to_image` and `resize` methods to GDScript
2021-12-12 07:05:25 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-13 01:13:27 +08:00
Resizes the image to [param new_size].
Expose BitMap's `convert_to_image` and `resize` methods to GDScript
2021-12-12 07:05:25 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="set_bit">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="0" name="x" type="int" />
<param index="1" name="y" type="int" />
<param index="2" name="bit" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Sets the bitmap's element at the specified position, to the specified value.
</description>
</method>
<method name="set_bit_rect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<param index="0" name="rect" type="Rect2i" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="1" name="bit" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Sets a rectangular portion of the bitmap to the specified value.
</description>
</method>
Refactor BitMap and add tests Co-authored-by: Resul Çelik <resul_celik@hotmail.com>
2022-09-02 00:39:17 +08:00
<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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</methods>
</class>
Reference in New Issue Copy Permalink