function ImageInterface::rotate

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::rotate()
  2. 10 core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::rotate()
  3. 11.x core/lib/Drupal/Core/Image/ImageInterface.php \Drupal\Core\Image\ImageInterface::rotate()

Rotates an image by the given number of degrees.

Parameters

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

string|null $background: (optional) A hexadecimal integer specifying the background color to use for the uncovered area of the image after the rotation; for example, 0x000000 for black, 0xff00ff for magenta, and 0xffffff for white. When NULL (the default) is specified, for images that support transparency, this will default to transparent; otherwise, it will default to white.

Return value

bool TRUE on success, FALSE on failure.

1 method overrides ImageInterface::rotate()
Image::rotate in core/lib/Drupal/Core/Image/Image.php
Rotates an image by the given number of degrees.

File

core/lib/Drupal/Core/Image/ImageInterface.php, line 239

Class

ImageInterface
Provides an interface for image objects.

Namespace

Drupal\Core\Image

Code

public function rotate($degrees, $background = NULL);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.