Warning: main(/www/www/htdocs/style/globals.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 1

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/globals.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 1

Warning: main(/www/www/htdocs/style/header.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 8

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/header.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 8

PiCropImage()

Crop an image to the specified boundary

Synopsis:

PhImage_t *PiCropImage( PhImage_t *image,
                        PhRect_t const *bounds,
                        int flags );

Library:

ph

Description:

This function crops a Photon image. It allocates space for the resulting image, leaving the original image untouched.

The image argument is a pointer to a PhImage_t structure that defines the image to be cropped, while the bounds argument points to a PhRect_t structure specifying the rectangle within the image to keep.

The flags argument dictates special behavior of the cropping process and can take on the following values:

Pi_FREE
Free the original image if the cropping succeeds.
Pi_SHMEM
Store the newly created image data in shared memory. This is useful if fast rendering of the image is required.

Note: If you set the Pi_FREE flag, the function will free the old image by setting all its release flags and calling PhReleaseImage() on it.

Returns:

A pointer to the new image on success, or NULL if an error occurred.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PhCreateImage(), PhImage_t, PhRect_t, PiConvertImage(), PiDuplicateImage(), PiFlipImage(), PiResizeImage

Images in the Raw Drawing and Animation chapter of the Photon Programmer's Guide


Warning: main(/www/www/htdocs/style/footer.php) [function.main]: failed to open stream: No such file or directory in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 137

Warning: main() [function.include]: Failed opening '/www/www/htdocs/style/footer.php' for inclusion (include_path='.:/www/www/common:/www/www/php/lib/php') in /www/www/docs/6.4.1/photon/lib_ref/pi/picropimage.html on line 137