ipygame.mask

pygame-compatible mask module.

from_surface

def from_surface(surface: Surface, threshold: int = 127) -> "Mask"

Create a Mask from a Surface’s alpha channel.

from_threshold

def from_threshold(surface: Surface,
                   color,
                   threshold=(0, 0, 0, 255),
                   other_surface: Surface | None = None,
                   palette_colors: int = 1) -> "Mask"

Create a Mask from a Surface using a color threshold.

Mask Objects

class Mask()

2D bit mask for pixel-perfect collision detection.

__init__

def __init__(size: tuple[int, int], fill: bool = False)

get_size

def get_size() -> tuple[int, int]

get_rect

def get_rect(**kwargs) -> Rect

get_at

def get_at(pos) -> int

set_at

def set_at(pos, value: int = 1) -> None

fill

def fill() -> None

clear

def clear() -> None

invert

def invert() -> None

count

def count() -> int

overlap

def overlap(other: "Mask", offset: tuple[int, int]) -> tuple[int, int] | None

Return the first overlapping bit position, or None.

overlap_area

def overlap_area(other: "Mask", offset: tuple[int, int]) -> int

Count overlapping set bits.

overlap_mask

def overlap_mask(other: "Mask", offset: tuple[int, int]) -> "Mask"

Return a Mask of overlapping bits.

draw

def draw(other: "Mask", offset: tuple[int, int]) -> None

OR another mask onto this mask.

erase

def erase(other: "Mask", offset: tuple[int, int]) -> None

Clear bits where other has bits set.

centroid

def centroid() -> tuple[int, int]

Return the centroid of set bits.

angle

def angle() -> float

Return the orientation angle of set bits in degrees.

outline

def outline(every: int = 1) -> list[tuple[int, int]]

Return a list of points on the outline of the mask.

scale

def scale(size: tuple[int, int]) -> "Mask"

Return a scaled copy of the mask.

connected_component

def connected_component(pos=None) -> "Mask"

Return the connected component containing pos (or the largest).

connected_components

def connected_components(minimum: int = 0) -> list["Mask"]

Return all connected components.

get_bounding_rects

def get_bounding_rects() -> list[Rect]

Return bounding rects for each connected component.

convolve

def convolve(
    other: "Mask",
    output: "Mask | None" = None,
    offset: tuple[int, int] = (0, 0)) -> "Mask"

Convolve this mask with another.

to_surface

def to_surface(
    surface: Surface | None = None,
    setsurface: Surface | None = None,
    unsetsurface: Surface | None = None,
    setcolor=(255, 255, 255, 255),
    unsetcolor=(0, 0, 0, 255),
    dest=(0, 0)
) -> Surface

Render the mask onto a Surface.

copy

def copy() -> "Mask"