Home/ Manual/ imagick / imagick/ Imagick::frameImage

Imagick::frameImage

PHP function Edit on GitHub ✎

(PECL imagick 2, PECL imagick 3)

Adds a simulated three-dimensional border

Description

Imagick::frameImage(mixed $matte_color, int $width, int $height, int $inner_bevel, int $outer_bevel): bool

Adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame.

Parameters

matte_color: ImagickPixel object or a string representing the matte color
width: The width of the border
height: The height of the border
inner_bevel: The inner bevel width
outer_bevel: The outer bevel width

Return Values

Success

Errors/Exceptions

Throws

Changelog

Version	Description
PECL imagick 2.1.0	Now allows a string representing the color as the first parameter. Previous versions allow only an ImagickPixel object.

Examples

Imagick::frameImage()

php

<?php
function frameImage($imagePath, $color, $width, $height, $innerBevel, $outerBevel) {
    $imagick = new \Imagick(realpath($imagePath));

    $width = $width + $innerBevel + $outerBevel;
    $height = $height + $innerBevel + $outerBevel;

    $imagick->frameimage(
        $color,
        $width,
        $height,
        $innerBevel,
        $outerBevel
    );
    header("Content-Type: image/jpg");
    echo $imagick->getImageBlob();
}

?>

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