Description

Create an image that converts the image data using the region access's area and casting as the source, and the supplied type as the destination.

Return Type

A Variant value.  

VARIANT* : variant returing McImage* interface pointer to new image

Syntax

object.ConvertImage (vIMcImageType, [Flags])

The ConvertImage Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McRegionAccess.
vIMcImageTypeRequired. A Variant value.

VARIANT : variant describing the desired image type

FlagsOptional. A mcImageCreateFlags enumeration, as described in settings.

long : Image creation flags

Settings

The settings for Flags are:

ConstantValueDescription
 mcicfDefault0
 mcicfContiguous1

If set, frames are allocated contiguously, and you cannot add to the FrameCount at a later time.

 mcicfNoInit2

Default is to initialize to 0 (black), this flag suppresses initialization.

 mcicfNoAddToCollection4

If set, the image is created, but not added to the collection (see Notes).

 mcicfNotVisible8

If set, the image is created, possibly added to collection (see above), but not made visible.

 mcipfNoImportProperties8388608

Suppress ImportProperties for functions creating an image from another.

Remarks

[TODO: Fill in longer description and remarks]