function image_desaturate

1 image.inc image_desaturate(stdClass $image)

Converts an image to grayscale.

Parameters

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

Return value

TRUE on success, FALSE on failure.:

See also

image_gd_desaturate()

Related topics

Image toolkits Functions for image file manipulations.

2 calls to image_desaturate()

ImageToolkitUnitTest::testDesaturate in core/modules/simpletest/tests/image.test: Test the image_desaturate() function.
image_desaturate_effect in core/modules/image/image.effects.inc: Image effect callback; Desaturate (grayscale) an image resource.

5 string references to 'image_desaturate'

hook_image_styles_alter in core/modules/image/image.api.php: Modify any image styles provided by other modules or the user.
ImageAdminStylesUnitTest::testDefaultStyle in core/modules/image/tests/image.test: Test to override, edit, then revert a style.
ImageAdminStylesUnitTest::testStyle in core/modules/image/tests/image.test: General test to add a style, add/remove/edit effects to it, then delete it.
ImageDimensionsUnitTest::testImageDimensions in core/modules/image/tests/image.test: Test styled image dimensions cumulatively.
image_image_effect_info in core/modules/image/image.effects.inc: Implements hook_image_effect_info().

File

core/includes/image.inc, line 406: API for manipulating images.

Code

function image_desaturate(stdClass $image) {
  return image_toolkit_invoke('desaturate', $image);
}