PhReleaseImage()

Release the allocated members of an image

Synopsis:

void PhReleaseImage( PhImage_t *image );

Description:

This function releases the allocated members of the PhImage_t pointed to by image, based on the value of image->flags. The valid flags are:

• Ph_RELEASE_IMAGE
• Ph_RELEASE_PALETTE
• Ph_RELEASE_TRANSPARENCY_MASK
• Ph_RELEASE_GHOST_BITMAP
• Ph_RELEASE_IMAGE_ALL-free all the above.

This function doesn't release the image structure itself.

Widgets that use images call PhReleaseImage() automatically when the widget is destroyed or the image is changed. If you set Pt_FREE_MEMORY in the widget's Pt_ARG_FLAGS resource, the Ph_RELEASE_IMAGE_ALL flag is set before calling PhReleaseImage().

Classification:

Photon

See also:

ApGetImageRes(), PgDrawPhImagemx(), PhImage_t, PhMakeGhostBitmap(), PhMakeTransBitmap(), PmMemCreateMC(), PmMemFlush(), PxLoadImage()