PiDuplicateImage()

Duplicate an image

Synopsis:

PhImage_t *PiDuplicateImage( PhImage_t *image,
                             int flags );

Arguments:

image

A pointer to the image you want to duplicate.

flags

Flags that indicate how the function should behave. They can be one or more of the following values:

Pi_FREE

Free the original image if the duplication succeeds.

Pi_SHMEM

Store the newly created image data in shared memory. This speeds up the rendering of the image if the graphics driver is local.

Library:

ph

Description:

This function creates a duplicate of the Photon image defined in the PhImage_t structure pointed to by image. PiDuplicateImage() does a "deep copy" of the PhImage_t, meaning it copies not only the structure itself but also any data associated with it such as the palette and image pixel data.

---

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, PiConvertImage(), PiCropImage(), PiFlipImage(), PiResizeImage

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