function image_desaturate

Converts an image to grayscale.

Parameters

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

Return value

bool TRUE on success, FALSE on failure.

See also

image_load()

\Drupal\system\Plugin\ImageToolkitInterface::desaturate()

Related topics

Image toolkits
Functions for image file manipulations.
2 calls to image_desaturate()
image_desaturate_effect in drupal/core/modules/image/image.effects.inc
Image effect callback; Desaturate (grayscale) an image resource.
ToolkitTest::testDesaturate in drupal/core/modules/system/lib/Drupal/system/Tests/Image/ToolkitTest.php
Test the image_desaturate() function.
2 string references to 'image_desaturate'
ImageDimensionsTest::testImageDimensions in drupal/core/modules/image/lib/Drupal/image/Tests/ImageDimensionsTest.php
Test styled image dimensions cumulatively.
ImageUpgradePathTest::testImageStyleUpgrade in drupal/core/modules/system/lib/Drupal/system/Tests/Upgrade/ImageUpgradePathTest.php
Tests that custom and overridden image styles have been upgraded.

File

drupal/core/includes/image.inc, line 289
API for manipulating images.

Code

function image_desaturate($image) {
  return $image->toolkit
    ->desaturate($image);
}