Click or drag to resize

mcImage2CommandFlags Enumeration

Predefined flags and command codes for theIMcImage2.CommandFlags property and IMcImage2.DoCommand method.

Namespace:  MediaCy.IQL.Engine
Assembly:  MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcImage2CommandFlags
Members
  Member nameValueDescription
mci2cfNoFlags0No flags.
mci2cfGetNaturalSizeRatios268435472Action flag. Whenassigned sets CommandData to either an Empty Variant or to an array of 1 or more sets of three pairs of double values, each giving a "natural" X,Y size-ratio (reduction in resolution) followed by the X,Y dimensions of the sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). If any such natural low-resolution images are available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be set in the IMcImage2.ImageState property. The CommandData is cleared to Empty as soon as it is accessed.
mci2cfGetNaturalIntegralSizeRatios268435473Action flag. Whenassigned sets CommandData to either an Empty Variant or to an array of 1 or more sets of three pairs of double values, each giving a "natural" X,Y size-ratio (reduction in resolution, where each tile consists of an exact number of full-resolution pixels along each axis) followed by the X,Y dimensions of the sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). Note that fewer pairs of natural size ratios may be returned from this call as compared to the mci2cfGetNaturalSizeRatios flag, since all supported size-ratios may not be integral (see comments with mci2cfGetClosestIntegralSizeRatio). If any such natural, integrally tiled low-resolution images may be available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be set in the IMcImage2.ImageState property. The CommandData is cleared to Empty as soon as it is accessed.
mci2cfGetClosestSizeRatio268435477Action flag. Whenassigned CommandData must be a scalar numeric value or length-2 array giving a desired X,Y size-ratio; on exit sets CommandData to a length-6 array of Double, giving the nearest supported X,Y decimation value that is no larger than the desired values on either axis, followed by the X,Y dimensions of that sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). For example, if a size-ratio of 6 is desired on both axes, a value of 6:6, 5:5, 4:4, etcetra might be returned. Note that the mci2cfGetBestLowerResolutionSizeRatio action flag is the opposite directional counterpart to the this one; that is, the mci2cfGetBestLowerResolutionSizeRatio flag's purpose is to find a sub-sampling that is at an equal or lower resolution to the desired SizeRatio; by contrast, the mci2cfGetClosestSizeRatio (this flag), mci2cfGetClosestIntegralSizeRatio and mci2cfGetClosestEvenSizeRatio action flags all return a sub-sampling that is at an equal or higher resolution than the one requested. If no natural low-resolution images are available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be clear in the IMcImage2.ImageState property and this routine will always set CommandData to Empty. exactly.
mci2cfGetClosestIntegralSizeRatio268435478Action flag. Whenassigned CommandData must be a scalar numeric value or length-2 array giving a desired X,Y size-ratio; on exit sets CommandData to a length-6 array of Double, giving the nearest supported X,Y decimation value that is no larger than the desired values on either axis and which specifies an integral subsampling (a whole number of full-resolution pixels per subsampled tile), followed by the X,Y dimensions of that sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). For example, consider a 150 by 90 (W,H as reported by the IMcImageStorage.GetDimensions method) image for which mci2cfGetClosestSizeRatio reports an X and Y size ratios of 4.054054 by 4.090909; dividing these numbers into 150 by 90 reveals that the subsampled coordinate space covers 37 by 22 pixels each holding a 4 by 4 tile of full-resolution pixels. Two pixels (148,149) at the right and two at the bottom (88,89) are not included in the subsampled coordinate space. In this example mci2cfGetClosestIntegralSizeRatio would return 4.0 and 4.0 for the X and Y integral size ratio. It is possible, though not usual, to have natural size ratios that are not integral. For example, for our 150 by 90 example image mci2cfGetClosestSizeRatio might return 1.5 as a natural size-ratio for each axis. This would result in a 100 by 60 sub-sampled image, with each subsampled tile holding 1.5 by 1.5 full resolution pixels; such a size ratio would never be returned by this action flag. If no natural low-resolution images are available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be clear in the IMcImage2.ImageState property and this routine will always set CommandData to Empty..
mci2cfGetClosestEvenSizeRatio268435479Action flag. Whenassigned CommandData must be a scalar numeric value or length-2 array giving a desired X,Y integral size-ratio; on exit sets CommandData to a length-6 array of Double, giving the nearest supported X,Y decimation value that is no larger than the desired values on either axis and is evenly divisible into it on both axes, followed by the X,Y dimensions of that sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). For example, if a subsampling of 6 is desired on both axes, then a value of 4:4 would not be returned, even if such a natural subsampling were available, but either 3:3 or 2:2 could be returned. If no natural low-resolution images are available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be clear in the IMcImage2.ImageState property and this routine will always return 1:1:FullXsize:FullYsize.
mci2cfGetBestLowerResolutionSizeRatio268435480Action flag.When assigned CommandData must be a scalar numeric value or length-2 array giving a desired X,Y size-ratio; on exit sets CommandData to a length-6 array of Double, giving the nearest supported X,Y decimation value that is no less than the desired values on both axes, followed by the X,Y dimensions of that sub-image followed by the X,Y dimensions of any tiling (0,0 if not tiled). For example, if a size-ratio of 6 is desired on both axes, a value of 8:8 or 16:16, etcetra might be returned. Note that this action flag is the opposite directional counterpart to the mci2cfGetClosestSizeRatio flag; that is, its purpose is to find a sub-sampling that is at an equal or lower resolution to the desired SizeRatio; by contrast, the mci2cfGetClosestSizeRatio, mci2cfGetClosestIntegralSizeRatio and mci2cfGetClosestEvenSizeRatio action flags all return a sub-sampling that is at an equal or higher resolution than the one requested. If no natural low-resolution images are available, then the mcImageStateFlags.mcisfHasNaturalSizeRatios bit will be clear in the IMcImage2.ImageState property and this routine will always set CommandData to Empty. exactly.
mci2cfGetSourceHost536870912Standard command flags
mci2cfDataGet-556883968When assigned, gets the data elementidentified by the lowest 12 bits of the command into CommandData. CommandData is cleared once it is next accessed.
mci2cfDataSet-556879872When assigned, sets the data elementidentified by the lowest 12 bits of the command from the current CommandData. CommandData is cleared after its value is stored.
mci2cfDataClear-556875776When assigned, clears the dataelement identified by the lowest 12 bits of the command.
mci2cfDataClearAll-556871680When assigned, clears all storeddata elements.
mci2cfDataList-556867584When assigned, sets CommandDatato an array of integers identifying the storage elements than have been assigned to and not yet cleared.
mci2cfDataElementMask4095A mask for the data element portionof the mcdecfDataXxxx action commands.
Remarks
CommandFlags assignments that cause some action, but do not change the state of the CommandFlags property are called "action flags"; they can be used with the DoCommand method.
See Also