Leadtools.Jpeg2000 Requires Document/Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.12.10
Load(RasterCodecs,Stream,Int32,CodecsLoadByteOrder) Method
See Also 
Leadtools.Jpeg2000 Namespace > Jpeg2000Engine Class > Load Method : Load(RasterCodecs,Stream,Int32,CodecsLoadByteOrder) Method




codecs
The RasterCodecs object.
steam
A Stream containing the image data to be loaded.
bitsPerPixel
Resulting image pixel depth. If this value is zero [0], the image will have the original file’s pixel depth (the image will not be converted).
order

Color order for 16-, 24-, 32-, 48-, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images do not use color order. Possible values are:

ValueMeaning
CodecsLoadByteOrder.RgbRed, green, and blue color order in memory
CodecsLoadByteOrder.BgrBlue, green, and red color order in memory
CodecsLoadByteOrder.Gray12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGrayLoad the image as red, green, blue OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.BgrOrGrayLoad the image as blue, green, red OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RommROMM order. ROMM only supports 24- and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRommLoad the image as red, green, blue OR as a 12- or 16-bit grayscale image OR as ROMM. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions. ROMM only supports 24- and 48-bit color images.

Loads the specified JPEG 2000 image stream using the specified options.

Syntax

Visual Basic (Declaration) 
Overloads Public Function Load( _
   ByVal codecs As RasterCodecs, _
   ByVal steam As Stream, _
   ByVal bitsPerPixel As Integer, _
   ByVal order As CodecsLoadByteOrder _
) As RasterImage
Visual Basic (Usage)Copy Code
Dim instance As Jpeg2000Engine
Dim codecs As RasterCodecs
Dim steam As Stream
Dim bitsPerPixel As Integer
Dim order As CodecsLoadByteOrder
Dim value As RasterImage
 
value = instance.Load(codecs, steam, bitsPerPixel, order)
C# 
public RasterImage Load( 
   RasterCodecs codecs,
   Stream steam,
   int bitsPerPixel,
   CodecsLoadByteOrder order
)
Managed Extensions for C++ 
public: RasterImage Load( 
   RasterCodecs codecs,
   Stream* steam,
   int bitsPerPixel,
   CodecsLoadByteOrder order
) 
C++/CLI 
public:
RasterImage Load( 
   RasterCodecs codecs,
   Stream^ steam,
   int bitsPerPixel,
   CodecsLoadByteOrder order
) 

Parameters

codecs
The RasterCodecs object.
steam
A Stream containing the image data to be loaded.
bitsPerPixel
Resulting image pixel depth. If this value is zero [0], the image will have the original file’s pixel depth (the image will not be converted).
order

Color order for 16-, 24-, 32-, 48-, and 64-bit images. If the resulting image is less than 16 bits per pixel, this will have no effect since palletized images do not use color order. Possible values are:

ValueMeaning
CodecsLoadByteOrder.RgbRed, green, and blue color order in memory
CodecsLoadByteOrder.BgrBlue, green, and red color order in memory
CodecsLoadByteOrder.Gray12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGrayLoad the image as red, green, blue OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.BgrOrGrayLoad the image as blue, green, red OR as a 12- or 16-bit grayscale image. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RommROMM order. ROMM only supports 24- and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRommLoad the image as red, green, blue OR as a 12- or 16-bit grayscale image OR as ROMM. 12- and 16-bit grayscale images are supported only in the Document/Medical Imaging editions. ROMM only supports 24- and 48-bit color images.

Return Value

The RasterImage object that this method loads.

Example

Remarks

All of the engine boxes will be reset and updated with new loaded boxes only.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Leadtools.Jpeg2000 requires a Document or Medical toolkit license and unlock key. For more information, refer to: Raster Pro/Document/Medical Features