Underlay Method

Summary

Combines two images so that one appears to be an underlying texture for the other.

Syntax

Objective-C

C++

Java

public void Underlay( 
   RasterImage underlayImage, 
   RasterImageUnderlayFlags flags 
)

Public Sub Underlay( _ 
   ByVal underlayImage As RasterImage, _ 
   ByVal flags As RasterImageUnderlayFlags _ 
)

- (BOOL)underlay:(LTRasterImage *)underlayImage  
           flags:(LTRasterImageUnderlayFlags)flags  
           error:(NSError **)error

public void underlay( 
  RasterImage underlayImage,  
  RasterImageUnderlayFlags flags 
)

public: 
void Underlay(  
   RasterImage^ underlayImage, 
   RasterImageUnderlayFlags flags 
)

Parameters

underlayImage
The image that will be used as the underlying image. This is the image that appears to be on bottom and is grayscaled as it is combined with the target image.

flags
Indicators of how the underlying image is to be positioned.

Remarks

This is most effective when the underlying image is a filtered one, such as an embossed image.

This method changes the colors of the underlay to grayscale as it combines the images. It updates this RasterImage, leaving the underlayImage unchanged. underlayImage can either be stretched or tiled to fill the image, as shown in the following illustration:

For more information, refer to Introduction to Image Processing With LEADTOOLS.

For more information, refer to Applying Artistic Effects.

Example

This example draws an ellipse on the image.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Dicom; 
using Leadtools.Drawing; 
using Leadtools.Controls; 
using LeadtoolsExamples.Common; 
using Leadtools.Svg; 
 
public void UnderlayExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
   RasterImage image = codecs.Load(Path.Combine(ImagesPath.Path, "IMAGE1.CMP")); 
 
   // Load underlay image 
   RasterImage underlayImage = codecs.Load(Path.Combine(ImagesPath.Path, "ULAY1.BMP")); 
   // Use underlayImage as a tiled underlay for image 
   image.Underlay(underlayImage, RasterImageUnderlayFlags.None); 
 
   codecs.Save(image, Path.Combine(ImagesPath.Path, "IMAGE1_underlay.BMP"), RasterImageFormat.Bmp, 0); 
 
   image.Dispose(); 
   underlayImage.Dispose(); 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Controls 
Imports Leadtools.Dicom 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub UnderlayExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   Dim image As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1.CMP")) 
 
   ' Load underlay image 
   Dim underlayImage As RasterImage = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "ULAY1.BMP")) 
   ' Use underlayImage as a tiled underlay for image 
   image.Underlay(underlayImage, RasterImageUnderlayFlags.None) 
 
   codecs.Save(image, Path.Combine(LEAD_VARS.ImagesDir, "IMAGE1_underlay.BMP"), RasterImageFormat.Bmp, 0) 
 
   image.Dispose() 
   underlayImage.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Dicom; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Examples; 
using Leadtools.Windows.Media; 
 
public void UnderlayExample(RasterImage image, RasterImage underlayImage, Stream destStream) 
{ 
   // Use underlayImage as a tiled underlay for image 
   image.Underlay(underlayImage, RasterImageUnderlayFlags.None); 
 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0); 
 
   image.Dispose(); 
   underlayImage.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Dicom 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Public Sub UnderlayExample(ByVal image As RasterImage, ByVal underlayImage As RasterImage, ByVal destStream As Stream) 
   ' Use underlayImage as a tiled underlay for image 
   image.Underlay(underlayImage, RasterImageUnderlayFlags.None) 
 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0) 
 
   image.Dispose() 
   underlayImage.Dispose() 
End Sub

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies