RenderWare V2.1

Previous Page Index Next Page

RwRaster *

RwReleaseRasterPixels(RwRaster *raster, unsigned char *pixels);

Description

Releases a pointer to the pixels of a raster previously obtained with RwGetRasterPixels().

Arguments

raster Pointer to the raster.

pixels Pointer to the pixels of raster.

Return Value

The argument raster if successful, and NULL otherwise.

Comments

The pointer pixels must have been obtained by a call to RwGetRasterPixels() with raster as an argument.

The memory used to store the pixels of a raster may be stored in the memory of a peripheral device or may move in main memory. In order that an application can read and write to this memory it must be locked. RwGetRasterPixels() performs this locking. The pointer returned by this function must be released (and the associated memory unlocked) after use by a call to RwReleaseRasterPixels(). Following RwReleaseRasterPixels() the pointer is no longer valid and it must not be cached for later use. To prevent performance degradation it is essential that the pointer is released as soon as possible.

See Also

RwBitmapRaster()

RwCreateRaster()

RwGetRasterDepth()

RwGetRasterHeight()

RwGetRasterPixels()

RwGetRasterStride()

RwGetRasterWidth()

RwReadMaskRaster()

RwReadRaster()