Convert(byte[],int,int,int,int,RasterByteOrder,RasterByteOrder,RasterColor[],RasterColor[],RasterColor16[],RasterColor16[],int,int,int,RasterConvertBufferFlags) Method

Summary

Converts data in the specified buffer to the specified bits per pixel and color order.

Syntax

C++

public static void Convert( 
   byte[] buffer, 
   int bufferOffset, 
   int width, 
   int inBitsPerPixel, 
   int outBitsPerPixel, 
   RasterByteOrder inOrder, 
   RasterByteOrder outOrder, 
   RasterColor[] inPalette, 
   RasterColor[] outPalette, 
   RasterColor16[] inPalette16, 
   RasterColor16[] outPalette16, 
   int lowBit, 
   int highBit, 
   int alpha, 
   RasterConvertBufferFlags flags 
)

  
Public Overloads Shared Sub Convert( _ 
   ByVal buffer() As Byte, _ 
   ByVal bufferOffset As Integer, _ 
   ByVal width As Integer, _ 
   ByVal inBitsPerPixel As Integer, _ 
   ByVal outBitsPerPixel As Integer, _ 
   ByVal inOrder As RasterByteOrder, _ 
   ByVal outOrder As RasterByteOrder, _ 
   ByVal inPalette() As RasterColor, _ 
   ByVal outPalette() As RasterColor, _ 
   ByVal inPalette16() As RasterColor16, _ 
   ByVal outPalette16() As RasterColor16, _ 
   ByVal lowBit As Integer, _ 
   ByVal highBit As Integer, _ 
   ByVal alpha As Integer, _ 
   ByVal flags As RasterConvertBufferFlags _ 
)

            public: 
static void Convert(  
   array<byte>^ buffer, 
   int bufferOffset, 
   int width, 
   int inBitsPerPixel, 
   int outBitsPerPixel, 
   RasterByteOrder inOrder, 
   RasterByteOrder outOrder, 
   array<RasterColor>^ inPalette, 
   array<RasterColor>^ outPalette, 
   array<RasterColor16>^ inPalette16, 
   array<RasterColor16>^ outPalette16, 
   int lowBit, 
   int highBit, 
   int alpha, 
   RasterConvertBufferFlags flags 
)

Parameters

buffer
The input buffer.

bufferOffset
The zero-based offset into the buffer where conversion should start.

width
Width in pixels of the input image data.

inBitsPerPixel
BitsPerPixel of the input image data.

outBitsPerPixel
BitsPerPixel of the desired output image data.

inOrder
The input color order.

outOrder
The output color order.

inPalette
The palette or 8-bit LUT for the existing data, before conversion. If the input data is not palettized and not grayscale, use NULL.

outPalette
The palette for the converted data. If the data is converted to 16 or 24 bits per pixel color, use NULL for no palette.

inPalette16
The 16-bit LUT for the existing data, before conversion. Use NULL for no 16-bit LUT.

outPalette16
The 16-bit LUT for the converted data. Reserved for future use. Use NULL.

lowBit
Value indicating the low bit in the source buffer, if the source buffer contains grayscale data.

highBit
Value indicating the high bit in the source buffer, if the source buffer contains grayscale data.

alpha
The alpha value if the destination bits per pixel contains an alpha component

flags
Flags indicating whether to treat 16 bit data as grayscale or color.

Remarks

Note: This method will also work for 12 and 16-bit grayscale images, but only in the Document/Medical Imaging editions. If you attempt to use this method with a 12 or 16-bit grayscale image, but you do not have a Medical Imaging edition, it will throw an exception.

The conversion uses only one buffer, which must be large enough to hold the data before and after conversion.

Image data that is 8 bits per pixel or less must use a palette, and this method can use such data as input, output, or both. Therefore, you may need to specify the palette for the input, or for the output, or both.

If either inBitsPerPixel or outBitsPerPixel is 16, flags is used to determine whether the data should be treated as color or grayscale.

If nBitsPerPixelSrc is 12, it is assumed to be grayscale. However, the flags parameter should also reflect that it is grayscale for future compatibility. If the source is grayscale, inPalette can be set to a palette. The palette should contain N entries. If the source uses lowBit and highBit, then N equals 2 raised to the power of ( highBit - lowBit + 1). Otherwise, N equals 2 raised to the power of inBitsPerPixel.

The flags parameter supersedes inOrder and outOrder. If you specify RasterByteOrder.Bgr for inOrder, but use RasterConvertBufferFlags.SourceGray in flags, it will be assumed that the source buffer contains grayscale data.

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

Example

Refer to RasterBufferConverter and CalculateConvertSize

Requirements

Target Platforms