LEADTOOLS (Leadtools assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Order Property
See Also 
Leadtools Namespace > RasterImage Class : Order Property



Gets or sets the color order of this RasterImage. Supported in Silverlight, Windows Phone 7

Syntax

Visual Basic (Declaration) 
Public Property Order As RasterByteOrder
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim value As RasterByteOrder
 
instance.Order = value
 
value = instance.Order
C# 
public RasterByteOrder Order {get; set;}
C++/CLI 
public:
property RasterByteOrder Order {
   RasterByteOrder get();
   void set (    RasterByteOrder value);
}

Property Value

The color order of this RasterImage.

Example

Visual BasicCopy Code
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
C#Copy Code
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";
}
SilverlightCSharpCopy Code
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();
}
SilverlightVBCopy Code
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

Remarks

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 qual to 8) will also report a byte order of RGB although the image data stored is really indices into the palette.
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.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.

Requirements

Target Platforms: Silverlight, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only), Windows Phone 7

See Also