←Select platform

CreateFromBuffer Method

Summary

Creates a new RasterImage using the specified parameters.

Syntax

WinRT C#

C++

public static Leadtools.RasterImage CreateFromBuffer(  
   Leadtools.RasterMemoryFlags flags, 
   int width, 
   int height, 
   int bitsPerPixel, 
   Leadtools.RasterByteOrder order, 
   Leadtools.RasterViewPerspective viewPerspective, 
   Leadtools.RasterColor[] palette, 
   IBuffer userData, 
   int userDataLength 
)

Public Shared Function CreateFromBuffer( _ 
   ByVal flags As Leadtools.RasterMemoryFlags, _ 
   ByVal width As Integer, _ 
   ByVal height As Integer, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal order As Leadtools.RasterByteOrder, _ 
   ByVal viewPerspective As Leadtools.RasterViewPerspective, _ 
   ByVal palette() As Leadtools.RasterColor, _ 
   ByVal userData As IBuffer, _ 
   ByVal userDataLength As Integer _ 
) As Leadtools.RasterImage

public static Leadtools.RasterImage CreateFromBuffer(  
   Leadtools.RasterMemoryFlags flags, 
   int width, 
   int height, 
   int bitsPerPixel, 
   Leadtools.RasterByteOrder order, 
   Leadtools.RasterViewPerspective viewPerspective, 
   Leadtools.RasterColor[] palette, 
   IBuffer userData, 
   int userDataLength 
)

 function Leadtools.RasterImage.CreateFromBuffer(  
   flags , 
   width , 
   height , 
   bitsPerPixel , 
   order , 
   viewPerspective , 
   palette , 
   userData , 
   userDataLength  
)

public: 
static Leadtools.RasterImage^ CreateFromBuffer(  
   Leadtools.RasterMemoryFlags flags, 
   int width, 
   int height, 
   int bitsPerPixel, 
   Leadtools.RasterByteOrder order, 
   Leadtools.RasterViewPerspective viewPerspective, 
   Leadtools.array<RasterColor>^ palette, 
   IBuffer^ userData, 
   int userDataLength 
)

Parameters

flags
A combination of the RasterMemoryFlags enumeration members indicating the type of memory to allocate for the image data.

width
Width of the image in pixels.

height
Height of the image in pixels.

bitsPerPixel
The number of bits per pixel.

Valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 24, 32, 48, and 64.

Use 0 to create an 8-bit grayscale image. In that case, the method ignores the order and the palette parameters.

order
Color order for 16-bit, 24-bit, 32-bit, 48-bit and 64-bit images.

If the resultant image is less than 16 bits per pixel, this will have no effect since palletized images have no order.

viewPerspective
Specifies where the beginning of the image is stored.

Most file formats start in the lower left corner while some formats start in the upper left corner.

palette
The palette that the image will use. You can specify your own palette, or use null for LEAD's fixed palette. The palette member is used only when bitsPerPixel is less than or equal to 8.

userData
Unmanaged data buffer that will contain the image data when flags is RasterMemoryFlags.User.

This data must be aligned on a four byte boundary. If userData is null, the data buffer must be passed later, by calling the SetUserData method, before the image can be used.

userDataLength
Length in bytes of the data passed to userData. Only when used when userData is not null and flags is RasterMemoryFlags.User.

Return Value

The newly created RasterImage object.

Remarks

Support for 12 and 16-bit grayscale images is only available in the Document/Medical Imaging editions.

There is some speed penalty (loss) for accessing RasterMemoryFlags.Tiled images. Therefore, it is not recommended for use with all images.

The RasterMemoryFlags.Tiled images are not used by default. LEADTOOLS will create them only if it failed to create RasterMemoryFlags.Conventional images and RasterMemoryFlags.NoTiled was not specified.

The distinct types of bitmaps are as follows:

Conventional (uncompressed and contiguous) This is the most common type.
Compressed (1-bit only)
Tiled (uncompressed, stored internally as up to 64MB tiles)

If you pass RasterMemoryFlags.User, you are responsible for freeing the image data.

Creating an image of type RasterMemoryFlags.User does not allocate memory for the image data. Instead, the data pointer userData is used. When you create a RasterImage with user data, the IsConventionalMemory and IsMirrored flags will both be set to true. Some image processing commands, such as RotateCommand, need to re-allocate the image data. If you create an image with RasterMemoryFlags.User, and pass it to these methods, the data will be re-allocated internally by LEADTOOLS and the image object will stop using the data in userData.

For more information, refer to Accounting for View Perspective.

For more information, refer to Grayscale Images.

Requirements

Target Platforms