Rotates an image by the given number of degrees.

Parameters

$image: An image object returned by image_load().

$degrees: The number of (clockwise) degrees to rotate the image.

$background: An hexadecimal integer specifying the background color to use for the uncovered area of the image after the rotation. E.g. 0x000000 for black, 0xff00ff for magenta, and 0xffffff for white. For images that support transparency, this will default to transparent. Otherwise it will be white.

Return value

TRUE on success, FALSE on failure.

See also

image_load()

image_gd_rotate()

Related topics

2 calls to image_rotate()

ImageToolkitUnitTest::testRotate in modules/simpletest/tests/image.test

Test the image_rotate() function.

image_rotate_effect in modules/image/image.effects.inc

Image effect callback; Rotate an image resource.

1 string reference to 'image_rotate'

ImageDimensionsTestCase::testImageDimensions in modules/image/image.test

Test styled image dimensions cumulatively.

File

includes/image.inc, line 306

Code

function image_rotate(stdClass $image, $degrees, $background = NULL) {
    return image_toolkit_invoke('rotate', $image, array(
        $degrees,
        $background,
    ));
}

---