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

GetCyberMapAttr

Returns information about a cybergraphics bitmap

Declaration

Source position: cybergraphics.pas line 164

function GetCyberMapAttr(

CyberGfxBitmap: PBitMap;

CyberAttrTag: LongWord

):LongWord;

Arguments

CyberAttrTag

A number telling cybergraphics which attribute of the bitmap should be returned

Function result

Value described by CyberAttrTag

Description

Gets information about an extended cybergraphics bitmap. This function should be used instead of making any assumptions about fields in the bitmap structure. This will provide future compatibility.

You should know what you are doing if you call this function! Always use the CYBRMATTR_ISCYBERGFX attribute first to check if the bitmap is a CyberGraphX one.

Available CyberAttrTag

CYBRMATTR_XMOD: returns bytes per row of the supplied bitmap
CYBRMATTR_BPPIX: returns number of bytes per pixel
CYBRMATTR_PIXFMT: return the pixel format of the bitmap
CYBRMATTR_WIDTH: return width of the bitmap in pixels
CYBRMATTR_HEIGHT: return the height in lines
CYBRMATTR_DEPTH: returns bits per pixel
CYBRMATTR_ISCYBERGFX: returns True (result <> 0) if supplied bitmap is a CyberGraphX one
CYBRMATTR_ISLINEARMEM: returns True (result <> 0) if the related display buffer supports linear memory access

Unknown attributes are reserved for future use, and return ($FFFFFFFF).