CanvasCommand Class

Visual Basic
C#
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public class CanvasCommand : Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

'Declaration
 
Public Class CanvasCommand 
   Inherits Leadtools.ImageProcessing.RasterCommand
   Implements Leadtools.ImageProcessing.IRasterCommand

'Usage
 
Dim instance As CanvasCommand

public sealed class CanvasCommand : Leadtools.ImageProcessing.IRasterCommand

function Leadtools.ImageProcessing.SpecialEffects.CanvasCommand()

public ref class CanvasCommand : public Leadtools.ImageProcessing.RasterCommand, Leadtools.ImageProcessing.IRasterCommand

CanvasCommand combines two images, superimposing one image on another image that is used like a canvas.

As an example, if you use the following figure:

And you use the following figure as the canvas image:

And you call CanvasCommand using the following values:

Parameter	Value
Transparency	90
Emboss	117
XOffset	0
YOffset	0
Flags	CanvasCommandFlags.TileShift
TilesOffset	0

The following figure results:

In the following figure the rafting image has been combined with the canvas image using the same values, except that the CanvasCommandFlags.TileFit flag is used and so instead of tiling the canvas image has been stretched to fit the dimensions of the rafting image:
Other commands that allow you to combine images include:

BumpCommand

CombineCommand

CombineWrapCommand

TextureAlphaBlendCommand

UnderlayCommand
For more information on this and other commands that can be used to combine images, Refer to Introduction to Image Processing With LEADTOOLS.
This command supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- and 64-bit color images is available only in the Document/Medical toolkits.
This command does not support signed data images.
This command does not support 32-bit grayscale images.

For more information Refer to Applying Artistic Effects.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy Code

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.ImageProcessing.SpecialEffects

Public Sub CanvasCommandExample()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"))
   Dim canvasImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ULAY1.BMP"))

   ' Prepare the command
   Dim canvasCommand As CanvasCommand = New CanvasCommand
   canvasCommand.CanvasImage = canvasImage
   canvasCommand.Emboss = 100
   canvasCommand.Transparency = 100
   canvasCommand.XOffset = 10
   canvasCommand.YOffset = 10
   canvasCommand.TileOffset = 20
   canvasCommand.Flags = CanvasCommandFlags.TileShift
   canvasCommand.Run(leadImage)
   codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24)

End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

public void CanvasCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;

   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg"));
   RasterImage canvasImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ULAY1.BMP"));

   // Prepaire the command
   CanvasCommand canvasCommand = new CanvasCommand();
   canvasCommand.CanvasImage = canvasImage;
   canvasCommand.Emboss = 100;
   canvasCommand.Transparency = 100;
   canvasCommand.XOffset = 10;
   canvasCommand.YOffset = 10;
   canvasCommand.TileOffset = 20;
   canvasCommand.Flags = CanvasCommandFlags.TileShift;

   // Apply the command
   canvasCommand.Run(image);
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24);

}

static class LEAD_VARS
{
public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

using Leadtools;
using Leadtools.Codecs;
using Leadtools.ImageProcessing.SpecialEffects;

[TestMethod]
public async Task CanvasCommandExample()
{
   // Load an image
   RasterCodecs codecs = new RasterCodecs();
   codecs.ThrowExceptionsOnInvalidImages = true;
   string srcFileName = @"Assets\Image1.cmp";
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   srcFileName = @"Assets\ULAY1.BMP";
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage canvasImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // Prepaire the command
   CanvasCommand canvasCommand = new CanvasCommand();
   canvasCommand.CanvasImage = canvasImage;
   canvasCommand.Emboss = 100;
   canvasCommand.Transparency = 100;
   canvasCommand.XOffset = 10;
   canvasCommand.YOffset = 10;
   canvasCommand.TileOffset = 20;
   canvasCommand.Flags = CanvasCommandFlags.TileShift;

   // Apply the command
   canvasCommand.Run(image);

   string destFileName = @"result.bmp";
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24);
}

Target Platforms

Reference