ImageLibrary.AddCustomCompositeImage Method

Definition

Creates a custom image which is composed of multiple other images, and adds that image to the library.

public:
 Microsoft::VisualStudio::Imaging::Interop::IImageHandle ^ AddCustomCompositeImage(Microsoft::VisualStudio::Utilities::Int16Size virtualSize, cli::array <Microsoft::VisualStudio::Imaging::Interop::ImageCompositionLayer> ^ layers);
public Microsoft.VisualStudio.Imaging.Interop.IImageHandle AddCustomCompositeImage (Microsoft.VisualStudio.Utilities.Int16Size virtualSize, Microsoft.VisualStudio.Imaging.Interop.ImageCompositionLayer[] layers);
member this.AddCustomCompositeImage : Microsoft.VisualStudio.Utilities.Int16Size * Microsoft.VisualStudio.Imaging.Interop.ImageCompositionLayer[] -> Microsoft.VisualStudio.Imaging.Interop.IImageHandle
Public Function AddCustomCompositeImage (virtualSize As Int16Size, layers As ImageCompositionLayer()) As IImageHandle

Parameters

virtualSize
Int16Size

The virtual size of the canvas representing the image. This does not represent a pixel size, and is used as a point of reference for each image layer.

layers
ImageCompositionLayer[]

The stack of images to render. Later images in the array are drawn on top of previous images.

Returns

A handle which contains the moniker associated with the image. The handle maintains the object lifetime of the image itself. Allowing the handle to be garbage-collected will result in the image also being GC-eligible.

Applies to