Unit 'cybergraphics' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#os4units]

LockBitMapTagList

Lock supplied BitMap for a short amount of time to allow direct memory access

Declaration

Source position: cybergraphics.pas line 178

function LockBitMapTagList(

  Bitmap: Pointer;

  TagList: PTagItem

):Pointer;

Arguments

Bitmap

  

Pointer to a CyberGraphX bitmap pointer. please check if it is a cybermap by calling GetCyberMapAttr() first.

TagList

  

Pointer to a mandatory taglist which's tagdata pointer fields contain valid LongWords after a successful call.

Function result

0 if the bitmap could not be locked, <> 0 it contains a handle which should be passed to UnLockBitMap afterwards

Description

Lock supplied BitMap for a short amount of time to allow direct memory access

Available Tags

LBMI_WIDTH
(PLongWord) Points to a longword which contains the bitmap width after a succesful call
LBMI_HEIGHT
(PLongWord) Points to a longword which contains the bitmap height after a succesful call
LBMI_DEPTH
(PLongWord) Points to a longword which contains the bitmap depth after a succesful call
LBMI_PIXFMT
(PLongWord) Points to a longword which contains the usedpixel format. Possibly returned colormodels are: PIXFMT_LUT8, PIXFMT_RGB15, PIXFMT_BGR15, PIXFMT_RGB15PC, PIXFMT_BGR15PC, PIXFMT_RGB16, PIXFMT_BGR16, PIXFMT_RGB16PC, PIXFMT_BGR16PC, PIXFMT_RGB24, PIXFMT_BGR24, PIXFMT_ARGB32, PIXFMT_BGRA32, PIXFMT_RGBA32
LBMI_BYTESPERPIX
(PLongWord) points to a longword which contains the amount of bytes per pixel data.
LBMI_BYTESPERROW
(PLongWord) points to a longword which contains the number of bytes per row for one bitmap line
LBMI_BASEADDRESS
(PLongWord) points to a longword which contains the bitmap base address. This address is only valid inside of the Lock/UnLockBitmap call!

See also

LockBitMapTags

  

VarArgs version of LockBitMapTagList

UnLockBitMap

  

Unlock CyberGraphX BitMap that was previously locked


Documentation generated on: 2021-07-30