Inside Macintosh: /

QuickDraw 3D RAVE / QuickDraw 3D RAVE Reference

QuickDraw 3D RAVE Routines / Manipulating Textures and Bitmaps

QABitmapNew

You can use the QABitmapNew function to create a new bitmap.

TQAError QABitmapNew (
                      const TQAEngine *engine, 
                      unsigned long flags, 
                      TQAImagePixelType pixelType, 
                      const TQAImage *image, 
                      TQABitmap **newBitmap);

engine

A drawing engine.

flags

A set of bit flags specifying features of the new bitmap. See "Bitmap Flags Masks" (page 1-64) for complete information

pixelType

The type of pixels in the new bitmap. See "Pixel Types" (page 1-35) for a description of the values you can pass in this parameter.

image

A pixel image to use for the new bitmap. The width and height fields of this image can have any values greater than 0.

newBitmap

On entry, the address of a pointer variable. On exit, that variable points to a new bitmap. If a new bitmap cannot be created, *newBitmap is set to the value NULL.

DESCRIPTION

The QABitmapNew function returns, through the newBitmap parameter, a pointer to a new bitmap associated with the drawing engine specified by the engine parameter. You can draw the returned bitmap by calling the QADrawBitmap function.

The flags parameter specifies a set of bitmap features. If the kQABitmap_Lock bit in that parameter is set but the drawing engine cannot guarantee that the bitmap will remain locked in memory, the QABitmapNew function returns an error.

SPECIAL CONSIDERATIONS

QABitmapNew does not automatically copy the pixmap data pointed to by the images parameter. As a result, you should not release or reuse the storage occupied by the pixel image until you've called QABitmapDetach. Note, however, that QABitmapNew does copy all of the information contained in the TQAImage structure, so you can free or reuse that memory after QABitmapNew completes successfully.