In This Topic ▼

Load(RasterCodecs,string,int,CodecsLoadByteOrder) Method

Summary

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

Syntax

C++

public RasterImage Load( 
   RasterCodecs codecs, 
   string fileName, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order 
)

  
Public Overloads Function Load( _ 
   ByVal codecs As RasterCodecs, _ 
   ByVal fileName As String, _ 
   ByVal bitsPerPixel As Integer, _ 
   ByVal order As CodecsLoadByteOrder _ 
) As RasterImage

public: 
RasterImage^ Load(  
   RasterCodecs^ codecs, 
   String^ fileName, 
   int bitsPerPixel, 
   CodecsLoadByteOrder order 
)

Parameters

codecs
The Leadtools.Codecs.RasterCodecs object.

fileName
System.String containing the name of the JPEG 2000 image file being 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-bit, 24-bit, 32-bit, 48-bit, 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:

Value	Meaning
CodecsLoadByteOrder.Rgb	Red, green, and blue color order in memory
CodecsLoadByteOrder.Bgr	Blue, green, and red color order in memory
CodecsLoadByteOrder.Gray	12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.RgbOrGray	Load the image as red, green, blue OR as a 12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.BgrOrGray	Load the image as blue, green, red OR as a 12-bit or 16-bit grayscale image. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions.
CodecsLoadByteOrder.Romm	ROMM order. ROMM only supports 24-bit and 48-bit images.
CodecsLoadByteOrder.BgrOrGrayOrRomm	Load the image as red, green, blue OR as a 12-bit or 16-bit grayscale image OR as ROMM. 12-bit and 16-bit grayscale images are supported only in the Document/Medical Imaging editions. ROMM only supports 24-bit and 48-bit color images.

Return Value

The Leadtools.RasterImage object that this method loads.

Remarks

All of the engine boxes will be reset (both those that have been loaded and any that have not been loaded). Only those boxes that have been found in the file during loading are updated.

Example

For an example, refer to Jpeg2000Engine.Save(RasterCodecs, string, RasterImage, Jpeg2000FileFormat, int, int) example.

Requirements

Target Platforms