SetPalette Method (RasterImage)

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

public void SetPalette( 
   RasterColor[] palette,
   int startIndex,
   int count
)

'Declaration
 
Public Sub SetPalette( _
   ByVal palette() As RasterColor, _
   ByVal startIndex As Integer, _
   ByVal count As Integer _
)

'Usage
 
Dim instance As RasterImage
Dim palette() As RasterColor
Dim startIndex As Integer
Dim count As Integer
 
instance.SetPalette(palette, startIndex, count)

public void SetPalette( 
   RasterColor[] palette,
   int startIndex,
   int count
)

 function Leadtools.RasterImage.SetPalette( 
   palette ,
   startIndex ,
   count 
)

public:
void SetPalette( 
   array<RasterColor>^ palette,
   int startIndex,
   int count
)

Parameters

palette: An array of RasterColor containing the new palette to use.
startIndex: Index of the first palette entry to replace.
count: Number of palette entries to replace.

The image data of a RasterImage object with BitsPerPixel values of 1, 2, 3, 4, 5, 6, 7 or 8 consists of an index into the image palette. You can get a copy of the palette used by using the GetPalette method.

You can change the palette used by the RasterImage object with the SetPalette method.

This method does not support signed images.

For more information, refer to RasterPalette and Introduction: Palette Handling.

For information on 10 to 16-bit grayscale image, refer to the Grayscale Images.

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

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

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

      ' Load the image as 8 bits/pixel
      Dim image As RasterImage = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1)

      ' Get the palette of this image and change it to shades of red
      Dim palette As RasterColor() = image.GetPalette()
      Dim i As Integer = 0
      Do While i < palette.Length
         palette(i) = New RasterColor(i, 0, 0)
         i += 1
      Loop

      ' Set the palette back in the image then save the file
      image.SetPalette(palette, 0, palette.Length)
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel)

      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 PaletteExample()
   {
      RasterCodecs codecs = new RasterCodecs();

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

      // Load the image as 8 bits/pixel
      RasterImage image = codecs.Load(srcFileName, 8, CodecsLoadByteOrder.Rgb, 1, 1);

      // Get the palette of this image and change it to shades of red
      RasterColor[] palette = image.GetPalette();
      for(int i = 0; i < palette.Length; i++)
         palette[i] = new RasterColor(i, 0, 0);

      // Set the palette back in the image then save the file
      image.SetPalette(palette, 0, palette.Length);
      codecs.Save(image, destFileName, RasterImageFormat.Bmp, image.BitsPerPixel);

      image.Dispose();

      codecs.Dispose();
   }

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

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

      var srcFileName = "Assets\\Image1.cmp";
      var destFileName = "Image1_RedPalette.bmp";
      var image = null;
      // Load the image as 8 bits/pixel
      return Tools.AppInstallFolder().getFileAsync(srcFileName).then(function (loadFile) {
         return codecs.loadAsync(Leadtools.LeadStreamFactory.create(loadFile), 8, CodecsLoadByteOrder.rgb, 1, 1);
      })
      .then(function (img) {
         image = img;
         console.assert(image.bitsPerPixel === 8, "image.bitsPerPixel === 8");

         // Get the palette of this image and change it to shades of red
         var palette = image.getPalette();
         for (var i = 0; i < palette.length; i++)
            palette[i] = Leadtools.RasterColorHelper.create(i, 0, 0);

         // Set the palette back in the image then save the file
         image.setPalette(palette, 0, palette.length);
         return Tools.AppLocalFolder().createFileAsync(destFileName);
      })
      .then(function (saveFile) {
         var saveStream = Leadtools.LeadStreamFactory.create(saveFile);
         return codecs.saveAsync(image, saveStream, Leadtools.RasterImageFormat.bmp, 0);
      })
      .then(function () {

         image.close();

         codecs.close();
      });
   }
}

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

   // Load the image as 8 bits/pixel
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName);
   RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile), 8, CodecsLoadByteOrder.Rgb, 1, 1);
   Assert.IsTrue(image.BitsPerPixel == 8);

   // Get the palette of this image and change it to shades of red
   RasterColor[] palette = image.GetPalette();
   for (int i = 0; i < palette.Length; i++)
      palette[i] = RasterColorHelper.Create(i, 0, 0);

   // Set the palette back in the image then save the file
   image.SetPalette(palette, 0, palette.Length);
   StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(destFileName);
   ILeadStream saveStream = LeadStreamFactory.Create(saveFile);
   await codecs.SaveAsync(image, saveStream, RasterImageFormat.Bmp, 0);

   image.Dispose();

   codecs.Dispose();
}

public void PaletteExample(RasterImage image, Stream destStream)
{
   // image should be loaded as 8 bits/pixel
   // Get the palette of this image and change it to shades of red
   RasterColor[] palette = image.GetPalette();
   for (int i = 0; i < palette.Length; i++)
      palette[i] = new RasterColor(i, 0, 0);

   // Set the palette back in the image then save the file
   image.SetPalette(palette, 0, palette.Length);
   RasterCodecs codecs = new RasterCodecs();
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0);
   image.Dispose();
}

Public Sub PaletteExample(ByVal image As RasterImage, ByVal destStream As Stream)
   ' image should be loaded as 8 bits/pixel
   ' Get the palette of this image and change it to shades of red
   Dim palette As RasterColor() = image.GetPalette()
   Dim i As Integer = 0
   Do While i < palette.Length
      palette(i) = New RasterColor(i, 0, 0)
      i += 1
   Loop

   ' Set the palette back in the image then save the file
   image.SetPalette(palette, 0, palette.Length)
   Dim codecs As RasterCodecs = New RasterCodecs()
   codecs.Save(image, destStream, RasterImageFormat.Bmp, 0)
   image.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