Click or drag to resize

IMcImageStorageReadSubsampledSubFrame Method

Read a subsampled sub-rectangle from the storage.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Sub ReadSubsampledSubFrame ( 
	BufferAddress As IntPtr,
	FrameIndex As Integer,
	FrameCount As Integer,
	Left As Integer,
	Top As Integer,
	Right As Integer,
	Bottom As Integer,
	SizeRatioX As Double,
	SizeRatioY As Double
)

Parameters

BufferAddress
Type: SystemIntPtr
In-process buffer into which the frame will be read. This buffer must be organized as specified by the NaturalImageType property. If the NaturalImageType.Organization is mcoBMPArray, then rows will be WORD (2 byte) aligned; if NaturalImageType.Organization is mcoDIBArray or mcoNewDIBArray, then the rows will be DWORD (4 byte) aligned. The width of each row returned can be gotten from the SizeClosestSubsampledSubFrame method's SubsampledWidth property.
FrameIndex
Type: SystemInt32
Index of frame to be accessed
FrameCount
Type: SystemInt32
Left
Type: SystemInt32
Left of rectangle to read.
Top
Type: SystemInt32
Top of rectangle to read.
Right
Type: SystemInt32
Right of rectangle to read.
Bottom
Type: SystemInt32
Bottom of rectangle to read.
SizeRatioX
Type: SystemDouble
Requested horizontal decimation (i.e., skip count; 1 is no skipping).
SizeRatioY
Type: SystemDouble
Requested vertical decimation (i.e., skip count; 1 is no skipping).
Remarks
It is presumed that SizeClosestSubsampledSubFrame has been called before this method to ensure that the requested read can be done; it will fail if it cannot. SizeClosestSubsampledSubFrame will also return the sizes of the buffer necessary to receive the read image bytes. Do not call this method unless the mciscFrameRead and/or mciscSubFrameRead bits of the Capabilities property are set. If mciscSubFrameRead is not set, then only full-frame reads should be attempted.
See Also