ConvertToImageSource Method

public static WinRT_ImageSource ConvertToImageSource( 
   RasterImage image,
   ConvertToImageOptions options
)

'Declaration
 
Public Shared Function ConvertToImageSource( _
   ByVal image As RasterImage, _
   ByVal options As ConvertToImageOptions _
) As WinRT_ImageSource

'Usage
 
Dim image As RasterImage
Dim options As ConvertToImageOptions
Dim value As WinRT_ImageSource
 
value = RasterImageConverter.ConvertToImageSource(image, options)

public static WinRT_ImageSource ConvertToImageSource( 
   RasterImage image,
   ConvertToImageOptions options
)

 function Leadtools.Converters.RasterImageConverter.ConvertToImageSource( 
   image ,
   options 
)

public:
static WinRT_ImageSource^ ConvertToImageSource( 
   RasterImage^ image,
   ConvertToImageOptions options
) 

Parameters

image

The Leadtools.RasterImage object containing the image data to convert.

options

Options to control the conversion operation.

Return Value

Microsoft WinRT

LEADTOOLS for .NET and WinRT support different pixel formats. These pixel formats may not be identical in some cases. The conversion process takes care of converting scanlines to a suitable format that best matches the source data.

The ConvertToImageSource method supports converting from any Leadtools.RasterImage regardless of the combination of the bits/pixel, compression, color order, or grayscale properties of the source image. The ConvertToImageSource method will always returns a valid WinRT Windows.UI.Xaml.Media.ImageSource by allocating temporary memory for the data and performing the necessary conversion on it.

The options parameter can have the following values:

In some cases, the Leadtools.RasterImage data is compatible with WinRT and no conversion takes place. Converting a compatible Leadtools.RasterImage into a WinRT Windows.UI.Xaml.Media.ImageSource is faster and takes less resources than converting a non-compatible image. Please note that currently WinRT does not allow direct access to the raw data pointers where the image data is stored. Therefore, there is always at least one copy operation regardless of whether the source data can be used directly by a WinRT image (For example, through the use of the System.Windows.Media.Imaging.BitmapSource.Create method).

For a Leadtools.RasterImage to be compatible with WinRT, it must have the following properties:

• The Leadtools.RasterImage must use conventional memory, not disk and nor tiled memory. ( RasterImage.IsConventionalMemory must be true and RasterImage.IsDiskMemory, RasterImage.IsTiled, RasterImage.IsGlobalMemory and RasterImage.IsMirrored must all be false)

• The Leadtools.RasterImage data must not be compressed (RasterImage.IsCompressed and RasterImage.IsSuperCompressed must both be false)

• The Leadtools.RasterImage data must not be signed (RasterImage.Signed must be false)

• The Leadtools.RasterImage must have compatible bits/pixel and color order values according the table below.

The following table lists the source Leadtools.RasterImage bits/pixel and source data properties and whether the combination is compatible with WinRT.

Notes on grayscale images

Both LEADTOOLS and Windows Presentation Foundation support 16-bit grayscale image data. However, LEADTOOLS supports extra features such as low/high bit values and color lookup tables. For a LEADTOOLS 16-bit grayscale Leadtools.RasterImage to be compatible with a WinRT image with System.Windows.Media.PixelFormats.Gray16, the following conditions must be met:

• The value of the RasterImage.UseLookupTable property must be false.

• The low/high bit values must not be used. Either the values of RasterImage.LowBit and RasterImage.HighBit are set to the default values or the ConvertToImageSource.IgnoreLowHighBitsOnGrayImages flag must be passed to the ConvertToImageSource method.

Notes on the alpha channel

When converting images that support an alpha channel (32 or 64 bits/pixel images), the ConvertToImageSource method supports masking out the alpha channel bits to all 1's through or using the source image alpha channel bits through the use of the ConvertToImageSource.KeepAlphaValues flag. Masking out the alpha channel bits requires the source data image to be processed and as a result, the image will not be compatible with WinRT.

For more information refer to RasterImage and WinRT.

For an example, refer to RasterImageConverter.

Target Platforms

Reference

RasterImageConverter Class
RasterImageConverter Members