Order Property (RasterImage)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public RasterByteOrder Order {get; set;}

'Declaration
 
Public Property Order As RasterByteOrder

'Usage
 
Dim instance As RasterImage
Dim value As RasterByteOrder
 
instance.Order = value
 
value = instance.Order

public RasterByteOrder Order {get; set;}

 get_Order();
 set_Order(value);

public:
property RasterByteOrder Order {
   RasterByteOrder get();
   void set (    RasterByteOrder value);
}

Property Value

The color order of this RasterImage.

The RasterImage object supports storing the image data in one of the following color orders:

Order	Notes
RasterByteOrder.Rgb	The image data contains the color in the RGB order. For example, for 24-bits per pixel images the data is stored as the 3 bytes representing the red, green and blue component respectively. Palettized images (with bits per pixel less than or equal to 8) will also report a byte order of RGB although the image data stored is really indices into the palette. 16-bit bitmaps use 5 bits for R, G and B components and one bit for alpha
RasterByteOrder.Bgr	The image data contains the color in the BGR order. For example, for 24-bits per pixel images the data is stored as the 3 bytes representing the blue, green and red component respectively.
RasterByteOrder.Rgb565	The image data contains the color in RGB color order with 5 bits for red and blue component and 6 bits for green component (16 bits per pixel). There is no alpha information.
RasterByteOrder.Gray	The image data contains the grayscale colors. For 12 and 16-bits per pixel images, the image data contains the grayscale values of the pixel, for 8-bits per pixel gray scale images, the image data contains an index into the grayscale palette.
RasterByteOrder.Romm	The image data is compressed in memory using ROMM. Only valid for 24-bits per pixel images.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Public Sub OrderExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      Dim srcFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")

      ' Load the image as BGR (default) and get the first pixel value
      Dim image As RasterImage = codecs.Load(srcFileName, 24, CodecsLoadByteOrder.Bgr, 1, 1)
      Console.WriteLine("Order is {0}", image.Order)
      image.Dispose()

      ' Load the image as RGB and get the first pixel value
      image = codecs.Load(srcFileName, 24, CodecsLoadByteOrder.Rgb, 1, 1)
      Console.WriteLine("Order is {0}", image.Order)
      image.Dispose()

      codecs.Dispose()
   End Sub

Public NotInheritable Class LEAD_VARS
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
End Class

public void OrderExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp");

      // Load the image as BGR (default) and get the first pixel value
      RasterImage image = codecs.Load(srcFileName, 24, CodecsLoadByteOrder.Bgr, 1, 1);
      Console.WriteLine("Order is {0}", image.Order);
      image.Dispose();

      // Load the image as RGB and get the first pixel value
      image = codecs.Load(srcFileName, 24, CodecsLoadByteOrder.Rgb, 1, 1);
      Console.WriteLine("Order is {0}", image.Order);
      image.Dispose();

      codecs.Dispose();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}

RasterImageExamples.prototype.OrderExample = function () {
   Tools.SetLicense();
   var codecs = new Leadtools.Codecs.RasterCodecs();

   var srcFileName = "Assets\\Image1.cmp";

   // Load the image as BGR (default) and get the first pixel value
   return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
      return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile), 24, Leadtools.Codecs.CodecsLoadByteOrder.bgr, 1, 1);
   })
.then(function (image) {
   console.info("Order is ", image.order);
   image.close();

   // Load the image as RGB and get the first pixel value
   return Tools.AppInstallFolder().getFileAsync(srcFileName);
})
.then(function (loadFile) {
   return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile), 24, Leadtools.Codecs.CodecsLoadByteOrder.rgb, 1, 1);
})
.then(function (image) {
   console.info("Order is ", image.order);

   image.close();

   codecs.close();
});
}

[TestMethod]
public async Task OrderExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName = @"Assets\Image1.cmp";

   // Load the image as BGR (default) and get the first pixel value
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 24, CodecsLoadByteOrder.Bgr, 1, 1);
   Debug.WriteLine("Order is {0}", image.Order);
   image.Dispose();

   // Load the image as RGB and get the first pixel value
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 24, CodecsLoadByteOrder.Rgb, 1, 1);
   Debug.WriteLine("Order is {0}", image.Order);
   image.Dispose();

   codecs.Dispose();
}

public void OrderExample()
{
   // Create an image as BGR
   RasterImage srcImage = new RasterImage(RasterMemoryFlags.Conventional, 300, 300, 24, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, null, null, 0);
   Debug.WriteLine("Order is {0}", srcImage.Order);
   Debug.Assert(srcImage.Order == RasterByteOrder.Bgr);
   srcImage.Dispose();
   // Create an image as RGB
   srcImage = new RasterImage(RasterMemoryFlags.Conventional, 300, 300, 24, RasterByteOrder.Rgb, RasterViewPerspective.TopLeft, null, null, 0);
   Debug.WriteLine("Order is {0}", srcImage.Order);
   Debug.Assert(srcImage.Order == RasterByteOrder.Rgb);
   srcImage.Dispose();
}

Public Sub OrderExample()
   ' Create an image as BGR
   Dim srcImage As RasterImage = New RasterImage(RasterMemoryFlags.Conventional, 300, 300, 24, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, Nothing, Nothing, 0)
   Debug.WriteLine("Order is {0}", srcImage.Order)
   Debug.Assert(srcImage.Order = RasterByteOrder.Bgr)
   srcImage.Dispose()
   ' Create an image as RGB
   srcImage = New RasterImage(RasterMemoryFlags.Conventional, 300, 300, 24, RasterByteOrder.Rgb, RasterViewPerspective.TopLeft, Nothing, Nothing, 0)
   Debug.WriteLine("Order is {0}", srcImage.Order)
   Debug.Assert(srcImage.Order = RasterByteOrder.Rgb)
   srcImage.Dispose()
End Sub

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterImage Class
RasterImage Members