BitMap

Inherits: Resource < Reference < Object

Boolean matrix.

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.

Methods

voidcreate ( Vector2 size )
voidcreate_from_image_alpha ( Image image, float threshold=0.1 )
boolget_bit ( Vector2 position ) const
Vector2get_size ( ) const
intget_true_bit_count ( ) const
voidgrow_mask ( int pixels, Rect2 rect )
Arrayopaque_to_polygons ( Rect2 rect, float epsilon=2.0 ) const
voidset_bit ( Vector2 position, bool bit )
voidset_bit_rect ( Rect2 rect, bool bit )

Method Descriptions

Creates a bitmap with the specified size, filled with false.


  • void create_from_image_alpha ( Image image, 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.


Returns bitmap’s value at the specified position.


Returns bitmap’s dimensions.


  • int get_true_bit_count ( ) const

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


  • void grow_mask ( int pixels, Rect2 rect )


Sets the bitmap’s element at the specified position, to the specified value.


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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.