ipygame.rect

pygame-compatible Rect and FRect classes.

Rect Objects

class Rect()

Stores rectangular coordinates (int).

__init__

def __init__(*args)

x

@property
def x() -> int

x

@x.setter
def x(v: int) -> None

y

@property
def y() -> int

y

@y.setter
def y(v: int) -> None

w

@property
def w() -> int

w

@w.setter
def w(v: int) -> None

h

@property
def h() -> int

h

@h.setter
def h(v: int) -> None

width

width = w

height

height = h

width

@property
def width() -> int

width

@width.setter
def width(v: int) -> None

height

@property
def height() -> int

height

@height.setter
def height(v: int) -> None

size

@property
def size() -> tuple[int, int]

size

@size.setter
def size(v: tuple[int, int]) -> None

top

@property
def top() -> int

top

@top.setter
def top(v: int) -> None

left

@property
def left() -> int

left

@left.setter
def left(v: int) -> None

bottom

@property
def bottom() -> int

bottom

@bottom.setter
def bottom(v: int) -> None

right

@property
def right() -> int

right

@right.setter
def right(v: int) -> None

topleft

@property
def topleft() -> tuple[int, int]

topleft

@topleft.setter
def topleft(v: tuple[int, int]) -> None

topright

@property
def topright() -> tuple[int, int]

topright

@topright.setter
def topright(v: tuple[int, int]) -> None

bottomleft

@property
def bottomleft() -> tuple[int, int]

bottomleft

@bottomleft.setter
def bottomleft(v: tuple[int, int]) -> None

bottomright

@property
def bottomright() -> tuple[int, int]

bottomright

@bottomright.setter
def bottomright(v: tuple[int, int]) -> None

centerx

@property
def centerx() -> int

centerx

@centerx.setter
def centerx(v: int) -> None

centery

@property
def centery() -> int

centery

@centery.setter
def centery(v: int) -> None

center

@property
def center() -> tuple[int, int]

center

@center.setter
def center(v: tuple[int, int]) -> None

midtop

@property
def midtop() -> tuple[int, int]

midtop

@midtop.setter
def midtop(v: tuple[int, int]) -> None

midbottom

@property
def midbottom() -> tuple[int, int]

midbottom

@midbottom.setter
def midbottom(v: tuple[int, int]) -> None

midleft

@property
def midleft() -> tuple[int, int]

midleft

@midleft.setter
def midleft(v: tuple[int, int]) -> None

midright

@property
def midright() -> tuple[int, int]

midright

@midright.setter
def midright(v: tuple[int, int]) -> None

move

def move(x: int, y: int) -> Rect

move_ip

def move_ip(x: int, y: int) -> None

move_to

def move_to(**kwargs) -> Rect

inflate

def inflate(x: int, y: int) -> Rect

inflate_ip

def inflate_ip(x: int, y: int) -> None

scale_by

def scale_by(sx: float, sy: float | None = None) -> Rect

scale_by_ip

def scale_by_ip(sx: float, sy: float | None = None) -> None

update

def update(*args) -> None

normalize

def normalize() -> None

clamp

def clamp(other) -> Rect

clamp_ip

def clamp_ip(other) -> None

clip

def clip(other) -> Rect

clipline

def clipline(*args) -> tuple[tuple[int, int], tuple[int, int]] | tuple[()]

Cohen-Sutherland line clipping.

union

def union(other) -> Rect

union_ip

def union_ip(other) -> None

unionall

def unionall(others: Sequence) -> Rect

unionall_ip

def unionall_ip(others: Sequence) -> None

fit

def fit(other) -> Rect

Scale and center self to fit inside other, preserving aspect ratio.

contains

def contains(other) -> bool

collidepoint

def collidepoint(*args) -> bool

colliderect

def colliderect(other) -> bool

collidelist

def collidelist(rects: Sequence) -> int

collidelistall

def collidelistall(rects: Sequence) -> list[int]

collidedict

def collidedict(d: dict, use_values: bool = True) -> tuple | None

collidedictall

def collidedictall(d: dict, use_values: bool = True) -> list[tuple]

collideobjects

def collideobjects(objects, key=None)

collideobjectsall

def collideobjectsall(objects, key=None) -> list

copy

def copy() -> Rect

FRect Objects

class FRect()

Stores rectangular coordinates (float).

__init__

def __init__(*args)

x

@property
def x() -> float

x

@x.setter
def x(v) -> None

y

@property
def y() -> float

y

@y.setter
def y(v) -> None

w

@property
def w() -> float

w

@w.setter
def w(v) -> None

h

@property
def h() -> float

h

@h.setter
def h(v) -> None

width

@property
def width() -> float

width

@width.setter
def width(v) -> None

height

@property
def height() -> float

height

@height.setter
def height(v) -> None

size

@property
def size() -> tuple[float, float]

size

@size.setter
def size(v) -> None

top

@property
def top() -> float

top

@top.setter
def top(v) -> None

left

@property
def left() -> float

left

@left.setter
def left(v) -> None

bottom

@property
def bottom() -> float

bottom

@bottom.setter
def bottom(v) -> None

right

@property
def right() -> float

right

@right.setter
def right(v) -> None

topleft

@property
def topleft() -> tuple[float, float]

topleft

@topleft.setter
def topleft(v) -> None

topright

@property
def topright() -> tuple[float, float]

topright

@topright.setter
def topright(v) -> None

bottomleft

@property
def bottomleft() -> tuple[float, float]

bottomleft

@bottomleft.setter
def bottomleft(v) -> None

bottomright

@property
def bottomright() -> tuple[float, float]

bottomright

@bottomright.setter
def bottomright(v) -> None

centerx

@property
def centerx() -> float

centerx

@centerx.setter
def centerx(v) -> None

centery

@property
def centery() -> float

centery

@centery.setter
def centery(v) -> None

center

@property
def center() -> tuple[float, float]

center

@center.setter
def center(v) -> None

midtop

@property
def midtop() -> tuple[float, float]

midtop

@midtop.setter
def midtop(v) -> None

midbottom

@property
def midbottom() -> tuple[float, float]

midbottom

@midbottom.setter
def midbottom(v) -> None

midleft

@property
def midleft() -> tuple[float, float]

midleft

@midleft.setter
def midleft(v) -> None

midright

@property
def midright() -> tuple[float, float]

midright

@midright.setter
def midright(v) -> None

move

def move(x, y) -> FRect

move_ip

def move_ip(x, y) -> None

move_to

def move_to(**kwargs) -> FRect

inflate

def inflate(x, y) -> FRect

inflate_ip

def inflate_ip(x, y) -> None

scale_by

def scale_by(sx, sy=None) -> FRect

scale_by_ip

def scale_by_ip(sx, sy=None) -> None

update

def update(*args) -> None

normalize

def normalize() -> None

clamp

def clamp(other) -> FRect

clamp_ip

def clamp_ip(other) -> None

clip

def clip(other) -> FRect

union

def union(other) -> FRect

union_ip

def union_ip(other) -> None

unionall

def unionall(others) -> FRect

unionall_ip

def unionall_ip(others) -> None

fit

def fit(other) -> FRect

contains

def contains(other) -> bool

collidepoint

def collidepoint(*args) -> bool

colliderect

def colliderect(other) -> bool

collidelist

def collidelist(rects) -> int

collidelistall

def collidelistall(rects) -> list[int]

copy

def copy() -> FRect