Files
Function/.venv/lib/python3.14/site-packages/pygame/pixelarray.pyi
T
2026-11-04 21:01:26 +01:00

69 lines
2.3 KiB
Python

import sys
from types import EllipsisType
from typing import Any, TypeAlias, overload
from pygame.color import Color
from pygame.surface import Surface
from pygame.typing import SequenceLike
_PixelColor: TypeAlias = int | Color | tuple[int, int, int] | tuple[int, int, int, int]
class PixelArray:
@property
def surface(self) -> Surface: ...
@property
def itemsize(self) -> int: ...
@property
def ndim(self) -> int: ...
@property
def shape(self) -> tuple[int, ...]: ...
@property
def strides(self) -> tuple[int, ...]: ...
# possibly going to be deprecated/removed soon, in which case these
# typestubs must be removed too
@property
def __array_interface__(self) -> dict[str, Any]: ...
@property
def __array_struct__(self) -> Any: ...
if sys.version_info >= (3, 12):
def __buffer__(self, flags: int, /) -> memoryview[int]: ...
def __new__(cls, surface: Surface) -> PixelArray: ...
def __enter__(self) -> PixelArray: ...
def __exit__(self, *args, **kwargs) -> None: ...
# if indexing into a 2D PixelArray, a 1D PixelArray will be returned
# if indexing into a 1D PixelArray, an int will be returned
@overload
def __getitem__(self, index: int) -> PixelArray | int: ...
# complicated, but I'm pretty sure this is guaranteed to return a PixelArray or None
# will only return None if the slice start and end are the same
@overload
def __getitem__(self, index_range: slice) -> PixelArray | None: ...
# only valid for a 2D PixelArray
@overload
def __getitem__(self, indices: tuple[int, int]) -> int: ...
# returns self
@overload
def __getitem__(self, ell: EllipsisType) -> PixelArray: ...
def make_surface(self) -> Surface: ...
def replace(
self,
color: _PixelColor,
repcolor: _PixelColor,
distance: float = 0,
weights: SequenceLike[float] = (0.299, 0.587, 0.114),
) -> None: ...
def extract(
self,
color: _PixelColor,
distance: float = 0,
weights: SequenceLike[float] = (0.299, 0.587, 0.114),
) -> PixelArray: ...
def compare(
self,
array: PixelArray,
distance: float = 0,
weights: SequenceLike[float] = (0.299, 0.587, 0.114),
) -> PixelArray: ...
def transpose(self) -> PixelArray: ...
def close(self) -> None: ...