GraphicsMagick

- Home
- Project
- Download
- Install
- Source
- News
- Utilities
- Programming
- Reference

# composite

Merge image pixels using a specified algorithm

# CompositeImage

## Synopsis

    MagickPassFail CompositeImage( Image *canvas_image, const CompositeOperator compose,
                                   const Image *composite_image, const long x_offset,
                                   const long y_offset );

## Description

CompositeImage() composites the second image (composite_image) onto the first (canvas_image) at the specified offsets.

The format of the CompositeImage method is:

    MagickPassFail CompositeImage( Image *canvas_image, const CompositeOperator compose,
                                   const Image *composite_image, const long x_offset,
                                   const long y_offset );

canvas_image:

  The image to be updated.

compose:

  This operator affects how the composite is applied to the image. Choose from one of these operators: AddCompositeOp, AtopCompositeOp, BumpmapCompositeOp, ClearCompositeOp, ColorizeCompositeOp, CopyBlackCompositeOp, CopyBlueCompositeOp, CopyCompositeOp, CopyCyanCompositeOp,CopyGreenCompositeOp, CopyMagentaCompositeOp, CopyOpacityCompositeOp, CopyRedCompositeOp, CopyYellowCompositeOp, DarkenCompositeOp, DifferenceCompositeOp, DisplaceCompositeOp, DissolveCompositeOp, DivideCompositeOp, HueCompositeOp, InCompositeOp, LightenCompositeOp, LuminizeCompositeOp, MinusCompositeOp, ModulateCompositeOp, MultiplyCompositeOp, NoCompositeOp, OutCompositeOp, OverlayCompositeOp, PlusCompositeOp, SaturateCompositeOp, ScreenCompositeOp, SubtractCompositeOp, ThresholdCompositeOp, XorCompositeOp, HardLightCompositeOp.

composite_image:

  The composite image.

x_offset:

  The column offset of the composited image.

y_offset:

  The row offset of the composited image.

Copyright © GraphicsMagick Group 2002-2026