Inherits: Resource < Reference < Object

Category: Core

Brief Description

Boolean matrix.

Member Functions

void create ( Vector2 size )
void create_from_image_alpha ( Image image )
bool get_bit ( Vector2 position ) const
Vector2 get_size ( ) const
int get_true_bit_count ( ) const
void set_bit ( Vector2 position, bool bit )
void set_bit_rect ( Rect2 p_rect, bool bit )


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.

Member Function Description

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

  • void create_from_image_alpha ( Image image )

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 0, 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.

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

  • void set_bit_rect ( Rect2 p_rect, bool bit )

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