MGL_getPenBitmapPattern

Returns the currently active bitmap pattern index, and pattern data.

Declaration

int MGLAPI MGL_getPenBitmapPattern(
    int index,
    pattern_t *pat)

Prototype In

mgraph.h

Parameters

index

Index of the bitmap pattern slot to read from

pat

Place to store the bitmap pattern

 

Return Value

Currently active bitmap pattern index.

Description

This function returns a copy of the specified bitmap pattern used when rendering patterned primitives in the MGL_BITMAP_TRANSPARENT and MGL_BITMAP_OPQAUE pen styles. It also returns the currently active bitmap pattern index, since the MGL supports 8 patterns cached internally in the driver.

Note:    You can pass a value of NULL in the pat parameter, and the pattern data will not be copied. Ie: MGL_getPenBitmapPattern(0,NULL) returns just the currently active bitmap pattern index.

See Also

MGL_setPenBitmapPattern, MGL_usePenBitmapPattern, MGL_setPenPixmapPattern, MGL_setPenStyle

Copyright © 2002 SciTech Software, Inc. Visit our web site at http://www.scitechsoft.com