GetPalette Method

Summary

Gets a copy of the palette of this RasterImage object that will be used by 1-8 bit color or grayscale images.

Syntax

Objective-C

C++

Java

public RasterColor[] GetPalette()

Public Function GetPalette() As RasterColor()

@property (nonatomic, strong, readonly, nullable) NSArray<LTRasterColor *> *palette

public RasterColor[] getPalette()

public: 
array<RasterColor>^ GetPalette();

Remarks

The palette is used for 1-8 bit color or grayscale image rendering. Image is grayscale when red, green and blue (R=G=B) components for each palette entry has the same value.

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.

Example

For an example, refer to SetPalette and StartDithering.

Requirements

Target Platforms