PixelDataFormat Class

Summary: The pixel data format. This is an immutable object.

Module: aspose.psd

Full Name: aspose.psd.PixelDataFormat

Aspose.PSD Version: 24.9.0

Properties

Name	Type	Access	Description
bits_per_pixel	int	r	Gets the bits per pixel.
caption	string	r	Gets the pixel data format caption.
channel_bits	int	r	Gets the bits count for each channel.
channels_count	int	r	Gets the channels count.
cmyk [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the cyan, magenta, yellow and black.
cmyka [static]	PixelDataFormat	r	Gets the acmyk.
grayscale [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 8 bits per pixel with 8 bits representing grayscale intensity in the 0-255 interval.
grayscale_alpha [static]	PixelDataFormat	r	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.
pixel_format	PixelFormat	r	Gets the pixel format.
rgb_16_bpp_555 [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 16 bits per pixel with 5 bits for each of the red, green and blue, alpha is not defined.
rgb_16_bpp_565 [static]	PixelDataFormat	r	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.
rgb_24_bpp [static]	PixelDataFormat	r	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.
rgb_24_bpp_png [static]	PixelDataFormat	r	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.
rgb_32_bpp [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
rgb_indexed_1_bpp [static]	PixelDataFormat	r	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.
rgb_indexed_2_bpp [static]	PixelDataFormat	r	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.
rgb_indexed_4_bpp [static]	PixelDataFormat	r	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.
rgb_indexed_8_bpp [static]	PixelDataFormat	r	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.
rgba_32_bpp [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 32 bits per pixel with 8 bits for each of the alpha, red, green and blue.
rgba_64_bpp [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 64 bits per pixel with 16 bits for each of the alpha, red, green and blue.
y_cb_cr [static]	PixelDataFormat	r	Gets the PixelDataFormat defined for 24 bits per pixel with 8 bits for each of the luma, blue-difference and red-difference chroma components.
ycck [static]	PixelDataFormat	r	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.

Methods

Name	Description
get_bgr(bits_per_sample)	Gets BGRA color with a specified number of bits per sample.
get_bgra(bits_per_sample)	Gets BGRA color with a specified number of bits per sample.
get_cie_lab(bits_per_l, bits_per_a, bits_per_b)	Gets CIE Lab color with a specified number of bits per sample.
get_cmyk(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel)	Gets CMYK color with a specified number of bits per sample.
get_cmyk(bits_per_sample)	Gets CMYK color with a specified number of bits per sample.
get_cmyka(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel, bits_per_alpha_channel)	Gets CMYKA color with a specified number of bits per sample.
get_grayscale(bits_per_sample)	Gets Grayscale color with a specified number of bits per sample.
get_grayscale_alpha(bits_per_sample)	Gets GrayscaleAlpha color with a specified number of bits per sample.
get_grayscale_alpha(bits_per_sample, alpha_channel_bits)	Gets GrayscaleAlpha color with a specified number of bits per sample.
get_rgb(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel)	Gets RGB color with a specified number of bits per sample.
get_rgb(bits_per_sample)	Gets RGB color with a specified number of bits per sample.
get_rgb_indexed(bits_per_sample)	Gets BGRA indexed color with a specified number of bits per sample.
get_rgba(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel, bits_per_alpha_channel)	Gets RGBA color with a specified number of bits per sample.
get_rgba(bits_per_sample)	Gets RGBA color with a specified number of bits per sample.
get_y_cb_cr(bits_per_sample)	Gets YCbCr color with a specified number of bits per sample.
get_y_cb_cr(bits_per_y, bits_per_cb, bits_per_cr)	Gets YCbCr color with a specified number of bits per sample.
get_ycck(bits_per_sample)	Gets YCCK color with a specified number of bits per sample.

Method: get_bgr(bits_per_sample) [static]

 get_bgr(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The BGRA color.

Method: get_bgra(bits_per_sample) [static]

 get_bgra(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The BGRA color.

Method: get_cie_lab(bits_per_l, bits_per_a, bits_per_b) [static]

 get_cie_lab(bits_per_l, bits_per_a, bits_per_b) 

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

Parameters:

Parameter	Type	Description
bits_per_l	int	The number of bits per L channel.
bits_per_a	int	The number of bits per A channel.
bits_per_b	int	The number of bits per B channel.

Returns

Type	Description
PixelDataFormat	The CIE Lab color.

Method: get_cmyk(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel) [static]

 get_cmyk(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel) 

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

Parameters:

Parameter	Type	Description
bits_per_cyan_channel	int	The number of bits per Cyan channel.
bits_per_magenta_channel	int	The number of bits per Magenta channel.
bits_per_yellow_channel	int	The number of bits per Yellow channel.
bits_per_key_channel	int	The number of bits per Key channel.

Returns

Type	Description
PixelDataFormat	The CMYK color.

Method: get_cmyk(bits_per_sample) [static]

 get_cmyk(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The CMYK color.

Method: get_cmyka(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel, bits_per_alpha_channel) [static]

 get_cmyka(bits_per_cyan_channel, bits_per_magenta_channel, bits_per_yellow_channel, bits_per_key_channel, bits_per_alpha_channel) 

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

Parameters:

Parameter	Type	Description
bits_per_cyan_channel	int	The number of bits per Cyan channel.
bits_per_magenta_channel	int	The number of bits per Magenta channel.
bits_per_yellow_channel	int	The number of bits per Yellow channel.
bits_per_key_channel	int	The number of bits per Key channel.
bits_per_alpha_channel	int	The number of bits per Alpha channel.

Returns

Type	Description
PixelDataFormat	The CMYK color.

Method: get_grayscale(bits_per_sample) [static]

 get_grayscale(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The Grayscale color.

Method: get_grayscale_alpha(bits_per_sample) [static]

 get_grayscale_alpha(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The GrayscaleAlpha color.

Method: get_grayscale_alpha(bits_per_sample, alpha_channel_bits) [static]

 get_grayscale_alpha(bits_per_sample, alpha_channel_bits) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.
alpha_channel_bits	int	The number of bits per sample in the alpha channel.

Returns

Type	Description
PixelDataFormat	The GrayscaleAlpha color.

Method: get_rgb(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel) [static]

 get_rgb(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel) 

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

Parameters:

Parameter	Type	Description
bits_per_red_channel	int	The number of bits per Red channel.
bits_per_green_channel	int	The number of bits per Green channel.
bits_per_blue_channel	int	The number of bits per Blue channel.

Returns

Type	Description
PixelDataFormat	The RGB color.

Method: get_rgb(bits_per_sample) [static]

 get_rgb(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The RGB color.

Method: get_rgb_indexed(bits_per_sample) [static]

 get_rgb_indexed(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The BGRA color.

Method: get_rgba(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel, bits_per_alpha_channel) [static]

 get_rgba(bits_per_red_channel, bits_per_green_channel, bits_per_blue_channel, bits_per_alpha_channel) 

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

Parameters:

Parameter	Type	Description
bits_per_red_channel	int	The number of bits per Red channel.
bits_per_green_channel	int	The number of bits per Green channel.
bits_per_blue_channel	int	The number of bits per Blue channel.
bits_per_alpha_channel	int	The number of bits per Alpha channel.

Returns

Type	Description
PixelDataFormat	The RGBA color.

Method: get_rgba(bits_per_sample) [static]

 get_rgba(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The RGBA color.

Method: get_y_cb_cr(bits_per_sample) [static]

 get_y_cb_cr(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The YCbCr color.

Method: get_y_cb_cr(bits_per_y, bits_per_cb, bits_per_cr) [static]

 get_y_cb_cr(bits_per_y, bits_per_cb, bits_per_cr) 

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

Parameters:

Parameter	Type	Description
bits_per_y	int	The number of bits per Y channel.
bits_per_cb	int	The number of bits per Cb channel.
bits_per_cr	int	The number of bits per Cr channel.

Returns

Type	Description
PixelDataFormat	The YCbCr color.

Method: get_ycck(bits_per_sample) [static]

 get_ycck(bits_per_sample) 

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

Parameters:

Parameter	Type	Description
bits_per_sample	int	The number of bits per sample.

Returns

Type	Description
PixelDataFormat	The YCCK color.