Packages

 

com.aspose.psd

Interfaces

Classes

Exceptions

com.aspose.psd

Class PixelDataFormat



  • public class PixelDataFormat
    extends Object

    The pixel data format. This is an immutable object.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(Object obj)
      Determines whether the specified System.Object is equal to this instance.
      static PixelDataFormat getBgr(int bitsPerSample)
      Gets BGR color with a specified number of bits per sample.
      static PixelDataFormat getBgra(int bitsPerSample)
      Gets BGRA color with a specified number of bits per sample.
      int getBitsPerPixel()
      Gets the bits per pixel.
      String getCaption()
      Gets the pixel data format caption.
      int[] getChannelBits()
      Gets the bits count for each channel.
      int getChannelsCount()
      Gets the channels count.
      static PixelDataFormat getCieLab(int bitsPerL, int bitsPerA, int bitsPerB)
      Gets CIE Lab color with a specified number of bits per sample.
      static PixelDataFormat getCmyk()
      Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.
      static PixelDataFormat getCmyk(int bitsPerSample)
      Gets CMYK color with a specified number of bits per sample.
      static PixelDataFormat getCmyk(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel)
      Gets CMYK color with a specified number of bits per sample.
      static PixelDataFormat getCmyka()
      Gets the acmyk.
      static PixelDataFormat getCmyka(int bitsPerCyanChannel, int bitsPerMagentaChannel, int bitsPerYellowChannel, int bitsPerKeyChannel, int bitsPerAlphaChannel)
      Gets CMYKA color with a specified number of bits per sample.
      static PixelDataFormat getGrayscale()
      Gets the PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.
      static PixelDataFormat getGrayscale(int bitsPerSample)
      Gets Grayscale color with a specified number of bits per sample.
      static PixelDataFormat getGrayscaleAlpha()
      Gets the PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.
      static PixelDataFormat getGrayscaleAlpha(int bitsPerSample)
      Gets GrayscaleAlpha color with a specified number of bits per sample.
      static PixelDataFormat getGrayscaleAlpha(int bitsPerSample, int alphaChannelBits)
      Gets GrayscaleAlpha color with a specified number of bits per sample.
      int getPixelFormat()
      Gets the pixel format.
      static PixelDataFormat getRgb(int bitsPerSample)
      Gets RGB color with a specified number of bits per sample.
      static PixelDataFormat getRgb(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel)
      Gets RGB color with a specified number of bits per sample.
      static PixelDataFormat getRgb16Bpp555()
      Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.
      static PixelDataFormat getRgb16Bpp565()
      Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.
      static PixelDataFormat getRgb24Bpp()
      Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
      static PixelDataFormat getRgb24BppPng()
      Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
      static PixelDataFormat getRgb32Bpp()
      Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
      static PixelDataFormat getRgba(int bitsPerSample)
      Gets RGBA color with a specified number of bits per sample.
      static PixelDataFormat getRgba(int bitsPerRedChannel, int bitsPerGreenChannel, int bitsPerBlueChannel, int bitsPerAlphaChannel)
      Gets RGBA color with a specified number of bits per sample.
      static PixelDataFormat getRgba32Bpp()
      Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
      static PixelDataFormat getRgbIndexed(int bitsPerSample)
      Gets BGRA indexed color with a specified number of bits per sample.
      static PixelDataFormat getRgbIndexed1Bpp()
      Gets the PixelDataFormat defined for indexed 1 bit per color.
      static PixelDataFormat getRgbIndexed2Bpp()
      Gets the PixelDataFormat defined for indexed 2 bit per color.
      static PixelDataFormat getRgbIndexed4Bpp()
      Gets the PixelDataFormat defined for indexed 4 bit per color.
      static PixelDataFormat getRgbIndexed8Bpp()
      Gets the PixelDataFormat defined for indexed 8 bit per color.
      static PixelDataFormat getYCbCr()
      Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.
      static PixelDataFormat getYCbCr(int bitsPerSample)
      Gets YCbCr color with a specified number of bits per sample.
      static PixelDataFormat getYCbCr(int bitsPerY, int bitsPerCb, int bitsPerCr)
      Gets YCbCr color with a specified number of bits per sample.
      static PixelDataFormat getYcck()
      Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.
      static PixelDataFormat getYcck(int bitsPerSample)
      Gets YCCK color with a specified number of bits per sample.
      int hashCode()
      Returns a hash code for this instance.
      static boolean op_Equality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)
      Returns result of equality for two PixelDataFormat classes.
      static boolean op_Inequality(PixelDataFormat pixelFormat1, PixelDataFormat pixelFormat2)
      Returns result of non-equality for two PixelDataFormat classes.
      String toString()
      Returns a System.String that represents this instance.
    • Method Detail

      • getRgb32Bpp

        public static PixelDataFormat getRgb32Bpp()

        Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

        Returns:
        The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
      • getCmyk

        public static PixelDataFormat getCmyk()

        Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.

        Returns:
        The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.
      • getCmyka

        public static PixelDataFormat getCmyka()

        Gets the acmyk.

        Returns:
        The PixelDataFormat defined for 40 bits per pixel with 8 bits for each of the alpha, cyan, magenta, yellow and black.
      • getRgb24Bpp

        public static PixelDataFormat getRgb24Bpp()

        Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

        Returns:
        The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
      • getRgb16Bpp555

        public static PixelDataFormat getRgb16Bpp555()

        Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.

        Returns:
        The PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.
      • getRgb16Bpp565

        public static PixelDataFormat getRgb16Bpp565()

        Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.

        Returns:
        The PixelDataFormat defined for 16 bits per pixel with 5 bits for red, 6 bits for green and 5 bits for blue, alpha is not defined.
      • getRgbIndexed8Bpp

        public static PixelDataFormat getRgbIndexed8Bpp()

        Gets the PixelDataFormat defined for indexed 8 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

        Returns:
        The PixelDataFormat defined for indexed 8 bit per color.
      • getRgbIndexed4Bpp

        public static PixelDataFormat getRgbIndexed4Bpp()

        Gets the PixelDataFormat defined for indexed 4 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

        Returns:
        The PixelDataFormat defined for indexed 4 bit per color.
      • getRgbIndexed2Bpp

        public static PixelDataFormat getRgbIndexed2Bpp()

        Gets the PixelDataFormat defined for indexed 2 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

        Returns:
        The PixelDataFormat defined for indexed 2 bit per color.
      • getRgbIndexed1Bpp

        public static PixelDataFormat getRgbIndexed1Bpp()

        Gets the PixelDataFormat defined for indexed 1 bit per color. The indexed pixel data storage is intended to allow data storage and retrieval everywhere the color palette is used. Use with caution, because may require conversion from one palette to another or from RGBA to indexed color model.

        Returns:
        The PixelDataFormat defined for indexed 1 bit per color.
      • getYCbCr

        public static PixelDataFormat getYCbCr()

        Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.

        Returns:
        The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.
      • getGrayscale

        public static PixelDataFormat getGrayscale()

        Gets the PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.

        Returns:
        The PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.
      • getYcck

        public static PixelDataFormat getYcck()

        Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.

        Returns:
        The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the luma, blue-difference, red-difference and black chroma components.
      • getRgba32Bpp

        public static PixelDataFormat getRgba32Bpp()

        Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.

        Returns:
        The PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
      • getRgb24BppPng

        public static PixelDataFormat getRgb24BppPng()

        Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.

        Returns:
        The PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the alpha, red, green and blue, alpha is not defined.
      • getGrayscaleAlpha

        public static PixelDataFormat getGrayscaleAlpha()

        Gets the PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.

        Returns:
        The PixelDataFormat defined for 16 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval and additional 8 bit alpha component.
      • getPixelFormat

        public int getPixelFormat()

        Gets the pixel format.

        Returns:
        The pixel format.
      • getBitsPerPixel

        public int getBitsPerPixel()

        Gets the bits per pixel.

        Returns:
        The bits per pixel.
      • getChannelsCount

        public int getChannelsCount()

        Gets the channels count.

        Returns:
        The channels count.
      • getChannelBits

        public int[] getChannelBits()

        Gets the bits count for each channel.

        Returns:
        The channel bits.
      • getCaption

        public String getCaption()

        Gets the pixel data format caption.

      • getGrayscale

        public static PixelDataFormat getGrayscale(int bitsPerSample)

        Gets Grayscale color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The Grayscale color.
      • getGrayscaleAlpha

        public static PixelDataFormat getGrayscaleAlpha(int bitsPerSample)

        Gets GrayscaleAlpha color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The GrayscaleAlpha color.
      • getGrayscaleAlpha

        public static PixelDataFormat getGrayscaleAlpha(int bitsPerSample,
                                                        int alphaChannelBits)

        Gets GrayscaleAlpha color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        alphaChannelBits - The number of bits per sample in the alpha channel.
        Returns:
        The GrayscaleAlpha color.
      • getRgb

        public static PixelDataFormat getRgb(int bitsPerSample)

        Gets RGB color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The RGB color.
      • getRgb

        public static PixelDataFormat getRgb(int bitsPerRedChannel,
                                             int bitsPerGreenChannel,
                                             int bitsPerBlueChannel)

        Gets RGB color with a specified number of bits per sample.

        Parameters:
        bitsPerRedChannel - The number of bits per Red channel.
        bitsPerGreenChannel - The number of bits per Green channel.
        bitsPerBlueChannel - The number of bits per Blue channel.
        Returns:
        The RGB color.
      • getRgba

        public static PixelDataFormat getRgba(int bitsPerSample)

        Gets RGBA color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The RGBA color.
      • getRgba

        public static PixelDataFormat getRgba(int bitsPerRedChannel,
                                              int bitsPerGreenChannel,
                                              int bitsPerBlueChannel,
                                              int bitsPerAlphaChannel)

        Gets RGBA color with a specified number of bits per sample.

        Parameters:
        bitsPerRedChannel - The number of bits per Red channel.
        bitsPerGreenChannel - The number of bits per Green channel.
        bitsPerBlueChannel - The number of bits per Blue channel.
        bitsPerAlphaChannel - The number of bits per Alpha channel.
        Returns:
        The RGBA color.
      • getRgbIndexed

        public static PixelDataFormat getRgbIndexed(int bitsPerSample)

        Gets BGRA indexed color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The BGRA color.
      • getBgra

        public static PixelDataFormat getBgra(int bitsPerSample)

        Gets BGRA color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The BGRA color.
      • getBgr

        public static PixelDataFormat getBgr(int bitsPerSample)

        Gets BGR color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The BGR color.
      • getYCbCr

        public static PixelDataFormat getYCbCr(int bitsPerSample)

        Gets YCbCr color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The YCbCr color.
      • getYCbCr

        public static PixelDataFormat getYCbCr(int bitsPerY,
                                               int bitsPerCb,
                                               int bitsPerCr)

        Gets YCbCr color with a specified number of bits per sample.

        Parameters:
        bitsPerY - The number of bits per Y channel.
        bitsPerCb - The number of bits per Cb channel.
        bitsPerCr - The number of bits per Cr channel.
        Returns:
        The YCbCr color.
      • getCmyk

        public static PixelDataFormat getCmyk(int bitsPerSample)

        Gets CMYK color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The CMYK color.
      • getCmyk

        public static PixelDataFormat getCmyk(int bitsPerCyanChannel,
                                              int bitsPerMagentaChannel,
                                              int bitsPerYellowChannel,
                                              int bitsPerKeyChannel)

        Gets CMYK color with a specified number of bits per sample.

        Parameters:
        bitsPerCyanChannel - The number of bits per Cyan channel.
        bitsPerMagentaChannel - The number of bits per Magenta channel.
        bitsPerYellowChannel - The number of bits per Yellow channel.
        bitsPerKeyChannel - The number of bits per Key channel.
        Returns:
        The CMYK color.
      • getCmyka

        public static PixelDataFormat getCmyka(int bitsPerCyanChannel,
                                               int bitsPerMagentaChannel,
                                               int bitsPerYellowChannel,
                                               int bitsPerKeyChannel,
                                               int bitsPerAlphaChannel)

        Gets CMYKA color with a specified number of bits per sample.

        Parameters:
        bitsPerCyanChannel - The number of bits per Cyan channel.
        bitsPerMagentaChannel - The number of bits per Magenta channel.
        bitsPerYellowChannel - The number of bits per Yellow channel.
        bitsPerKeyChannel - The number of bits per Key channel.
        bitsPerAlphaChannel - The number of bits per Alpha channel.
        Returns:
        The CMYK color.
      • getYcck

        public static PixelDataFormat getYcck(int bitsPerSample)

        Gets YCCK color with a specified number of bits per sample.

        Parameters:
        bitsPerSample - The number of bits per sample.
        Returns:
        The YCCK color.
      • getCieLab

        public static PixelDataFormat getCieLab(int bitsPerL,
                                                int bitsPerA,
                                                int bitsPerB)

        Gets CIE Lab color with a specified number of bits per sample.

        Parameters:
        bitsPerL - The number of bits per L channel.
        bitsPerA - The number of bits per A channel.
        bitsPerB - The number of bits per B channel.
        Returns:
        The CIE Lab color.
      • op_Inequality

        public static boolean op_Inequality(PixelDataFormat pixelFormat1,
                                            PixelDataFormat pixelFormat2)

        Returns result of non-equality for two PixelDataFormat classes.

        Parameters:
        pixelFormat1 - The first PixelDataFormat to compare.
        pixelFormat2 - The second PixelDataFormat to compare.
        Returns:
        True if both pixelFormat1 and pixelFormat2 contain non-equal data or one of the parameters is null.
      • op_Equality

        public static boolean op_Equality(PixelDataFormat pixelFormat1,
                                          PixelDataFormat pixelFormat2)

        Returns result of equality for two PixelDataFormat classes.

        Parameters:
        pixelFormat1 - The first PixelDataFormat to compare.
        pixelFormat2 - The second PixelDataFormat to compare.
        Returns:
        True if both pixelFormat1 and pixelFormat2 contain equal data or both parameters are null.
      • equals

        public boolean equals(Object obj)

        Determines whether the specified System.Object is equal to this instance.

        Overrides:
        equals in class Object
        Parameters:
        obj - The System.Object to compare with this instance.
        Returns:
        true if the specified System.Object is equal to this instance; otherwise, false.
      • hashCode

        public int hashCode()

        Returns a hash code for this instance.

        Overrides:
        hashCode in class Object
        Returns:
        A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
      • toString

        public String toString()

        Returns a System.String that represents this instance.

        Overrides:
        toString in class Object
        Returns:
        A System.String that represents this instance.