php8.5
Home/ Manual/ imagick / imagick/ Imagick::exportImagePixels

Imagick::exportImagePixels

PHP function Edit on GitHub ✎

(PECL imagick 2 >=2.3.0, PECL imagick 3)

Exports raw image pixels

Description

Imagick::exportImagePixels(int $x, int $y, int $width, int $height, string $map, int $STORAGE): array

Exports image pixels into an array. The map defines the ordering of the exported pixels. The size of the returned array is width * height * strlen(map). 0x647

Parameters

x

X-coordinate of the exported area

y

Y-coordinate of the exported area

width

Width of the exported aread

height

Height of the exported area

map

Ordering of the exported pixels. For example "RGB". Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P.

STORAGE

Refer to this list of pixel type constants

Return Values

Returns an array containing the pixels values.

Errors/Exceptions

Throws

Examples

Using Imagick::exportImagePixels()

Export image pixels into an array

php
<?php

/* Create new object */
$im = new Imagick();

/* Create new image */
$im->newPseudoImage(0, 0, "magick:rose");

/* Export the image pixels */
$pixels = $im->exportImagePixels(10, 10, 2, 2, "RGB", Imagick::PIXEL_CHAR);

/* Output */
var_dump($pixels);
?>

The above example will output:

output
array(12) {
  [0]=>
  int(72)
  [1]=>
  int(64)
  [2]=>
  int(57)
  [3]=>
  int(69)
  [4]=>
  int(59)
  [5]=>
  int(43)
  [6]=>
  int(124)
  [7]=>
  int(120)
  [8]=>
  int(-96)
  [9]=>
  int(91)
  [10]=>
  int(84)
  [11]=>
  int(111)
}

Source: reference/imagick/imagick/exportimagepixels.xml · from the official PHP manual (php/doc-en)