magickMontageImage method

Future<MagickWand?> magickMontageImage({
  1. required DrawingWand drawingWand,
  2. required String tileGeometry,
  3. required String thumbnailGeometry,
  4. required MontageMode mode,
  5. required String frame,
})

MagickMontageImage() creates a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile.

This method runs inside an isolate different from the main isolate.

  • drawingWand: the drawing wand. The font name, size, and color are obtained from this wand.
  • tileGeometry: the number of tiles per row and page (e.g. 6x4+0+0).
  • thumbnailGeometry: Preferred image size and border size of each thumbnail (e.g. 120x120+4+3>).
  • mode: Thumbnail framing mode: Frame, Unframe, or Concatenate.
  • frame: Surround the image with an ornamental border (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte color.

Don't forget to call destroyMagickWand on the returned MagickWand when done.

Sending invalid parameters will cause an invalid state and may crash the app, so you should make sure to validate the input to this method.

Implementation

Future<MagickWand?> magickMontageImage({
  required DrawingWand drawingWand,
  required String tileGeometry,
  required String thumbnailGeometry,
  required MontageMode mode,
  required String frame,
}) async =>
    MagickWand._fromAddress(
      await _magickCompute(
        _magickMontageImage,
        _MagickMontageImageParams(
          _wandPtr.address,
          drawingWand._wandPtr.address,
          tileGeometry,
          thumbnailGeometry,
          mode,
          frame,
        ),
      ),
    );