imagegetclip

(PHP 7 >= 7.2.0, PHP 8)

imagegetclipGet the clipping rectangle

Description

imagegetclip(GdImage $image): array

imagegetclip() retrieves the current clipping rectangle, i.e. the area beyond which no pixels will be drawn.

Parameters

image

A GdImage object, returned by one of the image creation functions, such as imagecreatetruecolor().

Return Values

The function returns an indexed array with the coordinates of the clipping rectangle which has the following entries:

  • x-coordinate of the upper left corner
  • y-coordinate of the upper left corner
  • x-coordinate of the lower right corner
  • y-coordinate of the lower right corner

Changelog

Version Description
8.0.0 image expects a GdImage instance now; previously, a resource was expected.

Examples

Example #1 imagegetclip() example

Setting and retrieving the clipping rectangle.

<?php
$im 
imagecreate(100100);
imagesetclip($im10,1089,89);
print_r(imagegetclip($im));

The above example will output:

Array
(
    [0] => 10
    [1] => 10
    [2] => 89
    [3] => 89
)

See Also