function image_desaturate_effect

Image effect callback; Desaturate (grayscale) an image resource.

Parameters

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

array $data: An array of attributes to use when performing the desaturate effect.

Return value

bool TRUE on success. FALSE on failure to desaturate image.

See also

image_desaturate()

1 call to image_desaturate_effect()
ImageEffectsTest::testDesaturateEffect in drupal/core/modules/image/lib/Drupal/image/Tests/ImageEffectsTest.php
Test the image_desaturate_effect() function.
1 string reference to 'image_desaturate_effect'
image_image_effect_info in drupal/core/modules/image/image.effects.inc
Implements hook_image_effect_info().

File

drupal/core/modules/image/image.effects.inc, line 232
Functions needed to execute image effects provided by Image module.

Code

function image_desaturate_effect($image, $data) {
  if (!image_desaturate($image)) {
    watchdog('image', 'Image desaturate failed using the %toolkit toolkit on %path (%mimetype, %dimensions)', array(
      '%toolkit' => $image->toolkit
        ->getPluginId(),
      '%path' => $image->source,
      '%mimetype' => $image->info['mime_type'],
      '%dimensions' => $image->info['width'] . 'x' . $image->info['height'],
    ), WATCHDOG_ERROR);
    return FALSE;
  }
  return TRUE;
}