mcImageStorageCommandFlags Enumeration |
|
Predefined flags and command codes for the
IMcImageStorage.CommandFlags property.
Namespace: MediaCy.IQL.Engine
Assembly: MediaCy.IQL.Engine (in MediaCy.IQL.Engine.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcImageStorageCommandFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mciscfNoFlags | 0 | No flags. | |
| mciscfStorageWillNotBeUsed | 268435456 | Action flag assignedby the memory manager indicating that the IMcImageStorage instance will not be used. The absence of a call to IsStorageOpen indicates the same thing, but this flag assignment is a positive action rather than the abscence of an action. | |
| mciscfIncrementUsageCount | 268435457 | Action flag assignedby the memory manager to increment a useage count for the IMcImageStorage instance. See mciscfDecrementUsageCount for more discussion. | |
| mciscfDecrementUsageCount | 268435458 | Action flag assignedby the memory manager to decrement a useage count for the IMcImageStorage instance. When the useage count reaches zero, the storage should be closed. | |
| mciscfGetUsageCount | 268435459 | Action flag assignedrequesting that the useage count for the IMcImageStorage instance be place into the CommandData as a long integer value. | |
| mciscfGetNaturalSizeRatios | 268435472 | Action 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. | |
| mciscfGetNaturalIntegralSizeRatios | 268435473 | Action 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 mciscfGetNaturalSizeRatios flag, since all supported size-ratios may not be integral (see comments with mciscfGetClosestIntegralSizeRatio). 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. | |
| mciscfGetClosestSizeRatio | 268435477 | Action 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 mciscfGetBestLowerResolutionSizeRatio action flag is the opposite directional counterpart to the this one; that is, the mciscfGetBestLowerResolutionSizeRatio flag's purpose is to find a sub-sampling that is at an equal or lower resolution to the desired SizeRatio; by contrast, the mciscfGetClosestSizeRatio (this flag), mciscfGetClosestIntegralSizeRatio and mciscfGetClosestEvenSizeRatio 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 return 1.0:1.0 exactly. | |
| mciscfGetClosestIntegralSizeRatio | 268435478 | Action 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 mciscfGetClosestSizeRatio 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 mciscfGetClosestIntegralSizeRatio 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 mciscfGetClosestSizeRatio 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 return 1.0:1.0. | |
| mciscfGetClosestEvenSizeRatio | 268435479 | Action 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. | |
| mciscfGetBestLowerResolutionSizeRatio | 268435480 | Action 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 mciscfGetClosestSizeRatio 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 mciscfGetClosestSizeRatio, mciscfGetClosestIntegralSizeRatio and mciscfGetClosestEvenSizeRatio 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 return 1.0:1.0 exactly. | |
| mciscfGetSourceHost | 536870912 | Action flag assignedrequesting that the IMcImageStorage place its host source interface instance in the CommandData as an Object. The host may be a McStream or other kind of interface. The returned value may be Nothing in some cases. The CommandData is cleared to free the reference as soon as it is accessed. | |
| mciscfFramePropertyBeingAccessed | 536870913 | Action flag. Whenassigned, CommandData is to be set to the frame index of the frame in this IMcImageStorage for which a property "Get" has been requested with the McFrame.NotifyOnGetProperty property set to 1. Note that which property is being accessed is not indicated. The assumption is that the IMcImageStorage will import all properties of interest and then clear the low order bit of the McFrame.NotifyOnGetProperty. |
RemarksCommandFlags assignments that cause some action, but do not change the
state of the CommandFlags property are called "action flags".
See Also