Pylsr Index / Pylsr
Auto-generated documentation for pylsr module.
LSRImage contains data on the overall size, the layers and the name of the lsr image.
class LSRImage:
def __init__(
self, size: tuple[int, int], name: str, layers: list[LSRLayer] | None = None
) -> None: ...
Flatten all of the layers.
def flatten(self) -> Image.Image: ...
LSRImageData stores the PIL Image along with the name, scale of the image and the idiom.
class LSRImageData:
def __init__(
self,
image: Image.Image,
name: str,
scale: str = "1x",
idiom: str = "universal",
offsets: tuple[int, int] = (0, 0),
) -> None: ...
Get the scaled image.
Image.Image: The image to scale
def scaledImage(self): ...
LSRLayer contains data on the layer such as the list of images, the name, the size and the centre offset.
class LSRLayer:
def __init__(
self,
images: list[LSRImageData],
name: str,
size: tuple[int, int],
center: tuple[int, int],
) -> None: ...
Flatten all of the layers.
def flatten(self) -> Image.Image: ...
Calculate the x, y offset for the top left corner.
tuple[int, int]: tuple for x, y offset
def offsets(self) -> tuple[int, int]: ...
Flatten a list of layers and groups.
layers
list[LSRImageData] - A list of layers and groups imageDimensions (tuple[int, int]): size of the image been flattened. Defaults to None.
Image.Image
- Flattened image
def flattenAll(
layers: list[LSRImageData], imageDimensions: tuple[int, int]
) -> Image.Image: ...
Flatten two layers of an image.
layer
LSRImageData - lsrimagedata imageDimensions (tuple[int, int]): a tuple of the image dimensionsflattenedSoFar
Image.Image, optional - Render of what has already been flattened. Defaults to None.
Image.Image
- Flattened image
def flattenTwoLayers(
layer: LSRImageData,
imageDimensions: tuple[int, int],
flattenedSoFar: Image.Image | None = None,
) -> Image.Image: ...
def jsonLoadsFromArchive(x): ...
Render an image with offset to a given size. (deprecated, use renderImageOffset).
@deprecated(deprecated_in="2022", removed_in="2023", details="Use renderImageOffset")
def rasterImageOffset(
image: Image.Image, size: tuple[int, int], offsets: tuple[int, int] = (0, 0)
) -> Image.Image: ...
Read an lsr file.
filename
str - the path to the file
- LSRImage - An lsr image representation
def read(filename: str) -> LSRImage: ...
Render an image with offset to a given size.
def renderImageOffset(
image: Image.Image, size: tuple[int, int], offsets: tuple[int, int] = (0, 0)
) -> Image.Image: ...
Write an lsr image to disk.
filename
str - filename and extensionlsrImage
LSRImage - the lsr image representation to save
def write(filename: str, lsrImage: LSRImage) -> None: ...