CanvasCommand Constructor(RasterImage,int,int,int,int,int,CanvasCommandFlags)

Summary

Initializes a new CanvasCommand class object with explicit parameters.

Syntax

C++

public CanvasCommand( 
   RasterImage canvasImage, 
   int transparency, 
   int emboss, 
   int xOffset, 
   int yOffset, 
   int tileOffset, 
   CanvasCommandFlags flags 
)

  
Public Function New( _ 
   ByVal canvasImage As RasterImage, _ 
   ByVal transparency As Integer, _ 
   ByVal emboss As Integer, _ 
   ByVal xOffset As Integer, _ 
   ByVal yOffset As Integer, _ 
   ByVal tileOffset As Integer, _ 
   ByVal flags As CanvasCommandFlags _ 
)

public: 
CanvasCommand(  
   RasterImage^ canvasImage, 
   int transparency, 
   int emboss, 
   int xOffset, 
   int yOffset, 
   int tileOffset, 
   CanvasCommandFlags flags 
)

Parameters

canvasImage
References the canvas image.

transparency
The transparency amount between the image and the canvas. Valid range is from 0 to 100. When set to 0, only the canvas image displays, and when set to 100, the canvas image is barely visible.

emboss
Apparent depth of the canvas image. Valid range is from 0 to 200. When Transparency is at 100, and Emboss is 0 only the image displays. Increasing Emboss increases the apparent depth of the canvas image.

xOffset
The X distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image width to +Canvas image width.

yOffset
The Y distance between the canvas origin point and the image origin point (in pixels). Valid range is from -Canvas image height to +Canvas image height.

tileOffset
The amount to shift every row of the canvas image from the origin. This parameter is not used when Flags is set to CanvasCommandFlags.TileFit.

flags
Flags that identify how to distribute the canvas image with respect to the image and how to handle resizing.

Example

This procedure run a CanvasCommand of the image using canvasImage.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing.SpecialEffects; 
 
public void CanvasConstructorExample_S2() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg")); 
   RasterImage canvasImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ULAY1.BMP")); 
 
   // Prepaire the command 
   CanvasCommand canvasCommand = new CanvasCommand(canvasImage, 100, 100, 10, 10, 20, CanvasCommandFlags.TileFit); 
 
   // 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"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.SpecialEffects 
 
Public Sub CanvasConstructorExample_S2() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg")) 
   Dim canvasImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ULAY1.BMP")) 
 
   ' Prepare the command 
   Dim canvasCommand As CanvasCommand = New CanvasCommand(canvasImage, 100, 100, 10, 10, 20, CanvasCommandFlags.TileFit) 
   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

Requirements

Target Platforms

Reference

CanvasCommand Class

CanvasCommand Members

Overload List

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.ImageProcessing.SpecialEffects Assembly

Introduction

Getting Started

Namespaces

Leadtools.ImageProcessing.SpecialEffects Namespace

Assemblies