Skip to content
ipygame

ipygame.display

pygame-compatible display module.

init

Section titled “init”
def init() -> None

Initialise the display module.

quit

Section titled “quit”
def quit() -> None

Uninitialise the display module.

get_init

Section titled “get_init”
def get_init() -> bool

set_mode

Section titled “set_mode”
def set_mode(size: tuple[int, int] = (0, 0),
             flags: int = 0,
             depth: int = 0,
             display: int = 0,
             vsync: int = 0) -> Surface

Create a display Surface backed by an ipycanvas Canvas.

The canvas widget is automatically shown in the notebook output.

get_surface

Section titled “get_surface”
def get_surface() -> Surface | None

Return the current display Surface, or None.

flip

Section titled “flip”
def flip() -> None

Update the full display Surface to the canvas.

update

Section titled “update”
def update(rectangle=None) -> None

Update portions of the display (or the full display if rectangle is None).

set_caption

Section titled “set_caption”
def set_caption(title: str, icontitle: str = "") -> None

get_caption

Section titled “get_caption”
def get_caption() -> tuple[str, str]

set_icon

Section titled “set_icon”
def set_icon(surface: Surface) -> None

iconify

Section titled “iconify”
def iconify() -> bool

toggle_fullscreen

Section titled “toggle_fullscreen”
def toggle_fullscreen() -> int

_VidInfo Objects

Section titled “_VidInfo Objects”
class _VidInfo()

Minimal video-info object returned by Info().

__init__

Section titled “__init__”
def __init__(w: int, h: int)

Info

Section titled “Info”
def Info() -> _VidInfo

get_driver

Section titled “get_driver”
def get_driver() -> str

get_window_size

Section titled “get_window_size”
def get_window_size() -> tuple[int, int]