Click or drag to resize

IMcCompositeHostCachedCompositeImage Method

Execute the current composite on all or a portion of a given frame.

Namespace:  MediaCy.IQL.Operations
Assembly:  MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function CachedCompositeImage ( 
	FrameIndex As Integer,
	Optional ControlFlags As mcCachedCompositeImageFlags = mcCachedCompositeImageFlags.mccccifDefault,
	<OptionalAttribute> <OutAttribute> ByRef CachedImageBounds As Object
) As McImage

Parameters

FrameIndex
Type: SystemInt32
Index into the composite frames
ControlFlags (Optional)
Type: MediaCy.IQL.OperationsmcCachedCompositeImageFlags
Flags to control optional aspects of the color compositing process.
CachedImageBounds (Optional)
Type: SystemObject
If not missing or empty on input, then specifies the bounds of the composite desired. If not missing (VT_ERROR), then on exit it will be replaced by the actual bounds of the cached image, which is guaranteed to encompass any requested bounds. If Missing, Empty or NULL, then the default bounds will always be the full bounds of the current composite in the coordinate space of a source image with no binning and no offset. Depending on the SourceOffsetXY and Status mcCompositeHostStatusFlags.mcchsfDestCreationOptions value and mcCompositeHostStatusFlags.mcchsfUseAoiAsSource bit, as well as the DestOffsetXY the full destination image origin may be offset either direction from 0,0 and the full destination image size may be smaller or larger than any of the source images. If the mcchsfUseAoiAsSource Status bit is clear (the default) then full source images are used; if it is set, then source McImage.Aoi is used unless the source McImage.ImageSet is assigned in which case the McImageSet.Aoi is used. The Status value masked by the mcchsfDestCreationOptions value determines how the source images are combined to render the composite.

Return Value

Type: McImage
A McImage instance holding the single requested frame with contents that at least encompass the specified CachedImageBounds. The created image will be un-named, non-visible and not part of the Images collection. It may or may not be the same McImage as one returned from an earlier call to this method and even if it is the same image, the contents may or may not be changed. If there are no sources, then Nothing is returned.
Remarks
An image is created
See Also