Leadtools.ImageProcessing.SpecialEffects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
CanvasCommand Class
See Also  Members   Example 
Leadtools.ImageProcessing.SpecialEffects Namespace : CanvasCommand Class



Combines two images, superimposing one image on another image that is used like a canvas. This command is available in the Raster Pro and above toolkits.

Syntax

Visual Basic (Declaration)  
Public Class CanvasCommand 
   Inherits RasterCommand
   Implements IRasterCommand 
Visual Basic (Usage) Copy Code
Dim instance As CanvasCommand
C#  
public class CanvasCommand : RasterCommand, IRasterCommand 
C++/CLI  
public ref class CanvasCommand : public RasterCommand, IRasterCommand 

Example

This procedure run a CanvasCommand of the image using canvasImage.

Visual Basic Copy Code
Public Sub CanvasCommandExample()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")
   Dim canvasImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C# Copy Code
public void CanvasCommandExample() 
{ 
   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
   RasterImage canvasImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "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, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24); 
 
   RasterCodecs.Shutdown(); 
}

Remarks

  • 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.

Inheritance Hierarchy

System.Object
   Leadtools.ImageProcessing.RasterCommand
      Leadtools.ImageProcessing.SpecialEffects.CanvasCommand

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also