←Select platform

UnderlayImage Property

Summary

Gets or sets an RasterImage object that references the image to be used as the underlying image.

Syntax

WinRT C#

C++

public Leadtools.RasterImage UnderlayImage {get; set;}

Public Property UnderlayImage As Leadtools.RasterImage

public Leadtools.RasterImage UnderlayImage {get; set;}

get_UnderlayImage(); 
set_UnderlayImage(value); 
Object.defineProperty('UnderlayImage');

public: 
property Leadtools.RasterImage^ UnderlayImage { 
   Leadtools.RasterImage^ get(); 
   void set (    Leadtools.RasterImage^ ); 
}

Property Value

RasterImage object that references the image to be used as the underlying image. The command will use this image to underlay the mask image. You could ignore this property effect by passing null.

Example

Run the TextureAlphaBlendCommand on an image.

WinRT C#

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing.Effects 
 
    
Public Sub UnderlayImagePropertyExample() 
   Dim codecs As New RasterCodecs() 
   codecs.ThrowExceptionsOnInvalidImages = True 
   Dim leadImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg")) 
 
   ' Prepare the command 
   Try 
      Dim srcImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\image3.cmp"), 4, CodecsLoadByteOrder.Bgr, 1, 1) 
 
      'Load the fade mask image. 
      Dim maskImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ImageProcessingDemo\FadeMask.bmp"), 4, CodecsLoadByteOrder.Bgr, 1, 1) 
 
      Dim command As TextureAlphaBlendCommand = New TextureAlphaBlendCommand 
      command.DestinationRectangle = New LeadRect(leadImage.Width \ 2 - maskImage.Width \ 2, leadImage.Height \ 2 - maskImage.Height \ 2, maskImage.Width, maskImage.Height) 
      command.MaskImage = maskImage 
      command.Opacity = 100 
      command.SourceImage = srcImage 
      command.SourcePoint = New LeadPoint(0, 0) 
      command.UnderlayImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg"), 4, CodecsLoadByteOrder.Bgr, 1, 1) 
      command.UnderlayOffset = New LeadPoint(150, 10) 
      ' Combine ImageSource with the affected image, with MaskImage and a 100 opacity. 
      command.Run(leadImage) 
      codecs.Save(leadImage, Path.Combine(LEAD_VARS.ImagesDir, "Result.jpg"), RasterImageFormat.Jpeg, 24) 
 
   Catch ex As Exception 
      MessageBox.Show(ex.Message, "TextureAlphaBlendTest", MessageBoxButtons.OK, MessageBoxIcon.Exclamation) 
   End Try 
 
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.Effects; 
 
       
public void UnderlayImagePropertyExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Master.jpg")); 
 
   // Prepare the command 
   RasterImage srcImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\Image3.cmp"), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   //Load the fade mask image. 
   RasterImage maskImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, @"ImageProcessingDemo\FadeMask.bmp"), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   TextureAlphaBlendCommand command = new TextureAlphaBlendCommand(); 
   command.DestinationRectangle = new LeadRect(image.Width / 2 - maskImage.Width / 2, image.Height / 2  - maskImage.Height / 2, maskImage.Width, maskImage.Height); 
   command.MaskImage = maskImage; 
   command.Opacity = 100; 
   command.SourceImage = srcImage; 
   command.SourcePoint = new LeadPoint(0, 0); 
   command.UnderlayImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "cannon.jpg"), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
   command.UnderlayOffset = new LeadPoint(150, 10); 
   // Combine ImageSource with the affected image, with MaskImage and a 100 opacity. 
   command.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.Effects; 
using Leadtools.ImageProcessing; 
 
       
public async Task UnderlayImagePropertyExample() 
{ 
   // Load an image 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
   string srcFileName = @"Assets\Master.jpg"; 
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile)); 
 
   // Prepare the command 
   srcFileName = @"Assets\Image3.cmp"; 
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   RasterImage srcImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   //Load the fade mask image. 
   srcFileName = @"Assets\FadeMask.bmp"; 
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   RasterImage maskImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   TextureAlphaBlendCommand command = new TextureAlphaBlendCommand(); 
   command.DestinationRectangle = LeadRectHelper.Create(image.Width / 2 - maskImage.Width / 2, image.Height / 2 - maskImage.Height / 2, maskImage.Width, maskImage.Height); 
   command.MaskImage = maskImage; 
   command.Opacity = 100; 
   command.SourceImage = srcImage; 
   command.SourcePoint = LeadPointHelper.Create(0, 0); 
 
   //Load the underlay image. 
   srcFileName = @"Assets\cannon.jpg"; 
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName); 
   command.UnderlayImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 4, CodecsLoadByteOrder.Bgr, 1, 1); 
 
   command.UnderlayOffset = LeadPointHelper.Create(150, 10); 
   // Combine ImageSource with the affected image, with MaskImage and a 100 opacity. 
   command.Run(image); 
 
   string destFileName = @"result.bmp"; 
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName); 
   await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.Bmp, 24); 
}