gml_TSharedBitmapRing Class Reference

#include <gml_Bitmap_shared.h>

Collaboration diagram for gml_TSharedBitmapRing:

Detailed Description


Public Member Functions
gml_TError	Init (UInt32 width, UInt32 height, gml_TPixelEncoding encoding, int offset=GML_BITMAP_PADDING_AUTO, char *name=NULL, UInt8 count=5)
	Setup the ring, allocate all bitmaps, create shared memory segments.
void	Dispose ()
	Release all resources, including locks and shared memory files.
gml_TError	NextBitmap (gml_TBitmap bitmap, UInt8 index=(UInt8 *) NULL)
	Return in bitmap the next available buffer. Its buffer MUST NOT be freed by the caller.
void	Release ()
	Signal that the buffer acquired by NextBitmap is ready. Should be called once for each call to NextBitmap.
UInt32	SegmentName ()

gml_TError Init	(	UInt32	width,
		UInt32	height,
		gml_TPixelEncoding	encoding,
		int	offset = `GML_BITMAP_PADDING_AUTO`,
		char *	name = `NULL`,
		UInt8	count = `5`
	)

Setup the ring, allocate all bitmaps, create shared memory segments.

Parameters:

Return in bitmap the next available buffer. Its buffer MUST NOT be freed by the caller.

If index is not NULL, set it to the ring index of the returned bitmap.

The documentation for this class was generated from the following files: