"""
Copyright (c) Contributors to the Open 3D Engine Project

SPDX-License-Identifier: Apache-2.0 OR MIT

Utility package for LyTestTools.

Provides image capturing functionality.
"""
import pyscreenshot


def screencap(x1=None, y1=None, x2=None, y2=None, filename='screenshot.png'):
    """
    Capture an arbitrary portion (in absolute coordinates) of the screen to a file.  Note currently accepts coords
    for the leftmost screen only.  Any span beyond/below will be blank.

    If any of the coordinate parameters is None, the entire screen will be captured.

    Note this is a brittle way to verify a portion of an application.

    :param x1: Top left X
    :param y1: Top left Y
    :param x2: Bottom right X
    :param y2: Bottom right Y
    :param filename: Filename to save to.
    :return: Image that was saved in PIL "Image" class.
    """

    if x1 is not None and x2 is not None and y1 is not None and y2 is not None:
        im = pyscreenshot.grab(bbox=(x1, y1, x2, y2), childprocess=False)
    else:
        im = pyscreenshot.grab(childprocess=False)

    im.save(filename)

    return im