Click or drag to resize

IMcDibAccessGetDibBytesEx Method

Returns a VARIANT holding a 2-D array that are the bytes for a 24-bit BGR, anti-raster order DIB.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function GetDibBytesEx ( 
	lFrame As Integer,
	lChannelToProcess As Integer,
	<OutAttribute> ByRef pdLeftImage As Double,
	<OutAttribute> ByRef pdTopImage As Double,
	<OutAttribute> ByRef plDibSizeX As Integer,
	<OutAttribute> ByRef plDibSizeY As Integer,
	dMagnificationX As Double,
	dMagnificationY As Double,
	<OutAttribute> ByRef pFlags As mcDibAccessFlags,
	<OutAttribute> ByRef pvarBITMAPINFOHEADER As Object
) As Object

Parameters

lFrame
Type: SystemInt32
The frame to get the DIB from. May be McActiveFrame, McLastFrame or a frame index from zero up through FrameCount-1 of the ParentPixelBuffer.
lChannelToProcess
Type: SystemInt32
If a DIB is to be gotten from a single channel, then this should be set to the zero-based channel number (e.g., Red=0, Blue=1, Green=2). Otherwise, it should be mcwcAllChannels (-1).
pdLeftImage
Type: SystemDouble
The requested and returned starting, left pixel in image coordinates.
pdTopImage
Type: SystemDouble
The requested and returned starting, top pixel in image coordinates.
plDibSizeX
Type: SystemInt32
The requested and returned width of the returned DIB array (starting at the returned pdLeftImage) in pixels (not bytes).The requested and returned height of the returned DIB array (starting at the returned pdTopImage) in scan lines.
plDibSizeY
Type: SystemInt32
dMagnificationX
Type: SystemDouble
The magnification of image pixels along the X axis. Magnifications greater than 1 uses pixel duplication, while magnifications less than 1 use pixel skipping.
dMagnificationY
Type: SystemDouble
The magnification of image pixels along the Y axis. Magnifications greater than 1 uses pixel duplication, while magnifications less than 1 use pixel skipping.
pFlags
Type: MediaCy.IQL.EnginemcDibAccessFlags
On entry, controls whether a copy of the bitmap bits is always made and if the requested size of the bitmap is allowed to be exanded (if this can be done at no cost). On exit bits will be set indicating if the source is a native Dib and if the source is a McImage.
pvarBITMAPINFOHEADER
Type: SystemObject
On exit this Variant is set to any array of Byte that maps directly onto a BITMAPINFOHEADER structure that describes the returned array of BGR triplets.

Return Value

Type: Object
A 2-D Byte array that is a reverse or forward raster, DWORD aligned BGR DIB of the requested size, starting at the the requested image coordinates, at the requested magnification.
Remarks
Coordinates outside of the source frame bounds are clipped to the image bounds. Image pixel channel values are passed through an optional, per-color Byte lookup table after being cast to BGR. Call SetDisplayLut to assign these LUT's.
See Also