PiFlipImage()

Flip all or part of an image

Synopsis:

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

Library:

ph

Description:

This function flips 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 flipped, while the bounds argument points to a PhRect_t structure specifying the rectangle within the image to flip. Specifying NULL for bounds causes the entire image to be flipped.

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

Pi_HORIZONTAL

Perform a horizontal flip (may be used in conjunction with Pi_VERTICAL).

Pi_VERTICAL

Perform a vertical flip (may be used in conjunction with Pi_HORIZONTAL).

Pi_FREE

Free the original image if the flip succeeds.

Pi_SHMEM

Store the newly created image data in shared memory. This is useful if fast rendering of the image is required.

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

See also:

PhCreateImage(), PhImage_t, PhRect_t, PiCropImage(), PiDuplicateImage()

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