LibreOffice
LibreOffice 24.2 SDK API Reference
|
A color space for integer bitmap formats. More...
import"XIntegerBitmapColorSpace.idl";
Public Member Functions | |
long | getBitsPerPixel () |
Query number of bits used per bitmap pixel. More... | |
sequence< long > | getComponentBitCounts () |
Query the number of bits used for each component. More... | |
byte | getEndianness () |
Query whether color data bytes need to be swapped. More... | |
sequence< ColorComponent > | convertFromIntegerColorSpace ([in] sequence< byte > deviceColor, [in] XColorSpace targetColorSpace) raises (com::sun::star::lang::IllegalArgumentException) |
Convert integer bitmap color to generic IEEE double device color of another color space. More... | |
sequence< byte > | convertToIntegerColorSpace ([in] sequence< byte > deviceColor, [in] XIntegerBitmapColorSpace targetColorSpace) raises (com::sun::star::lang::IllegalArgumentException) |
Convert integer bitmap color to integer bitmap color of another integer bitmap color space. More... | |
sequence< RGBColor > | convertIntegerToRGB ([in] sequence< byte > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to sRGB color values. More... | |
sequence< ARGBColor > | convertIntegerToARGB ([in] sequence< byte > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to sRGB color values, with linear alpha. More... | |
sequence< ARGBColor > | convertIntegerToPARGB ([in] sequence< byte > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to premultiplied sRGB color values, with linear alpha. More... | |
sequence< byte > | convertIntegerFromRGB ([in] sequence< RGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert sRGB color to an integer representation in this color space. More... | |
sequence< byte > | convertIntegerFromARGB ([in] sequence< ARGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert sRGB color with linear alpha into this color space. More... | |
sequence< byte > | convertIntegerFromPARGB ([in] sequence< ARGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert premultiplied sRGB color with linear alpha into this color space. More... | |
![]() | |
byte | getType () |
Query type of this color space. More... | |
sequence< byte > | getComponentTags () |
Query the kind for each color component. More... | |
byte | getRenderingIntent () |
Query rendering intent of this color space. More... | |
sequence< ::com::sun::star::beans::PropertyValue > | getProperties () |
Query various optional properties from the color space. More... | |
sequence< ColorComponent > | convertColorSpace ([in] sequence< ColorComponent > deviceColor, [in] XColorSpace targetColorSpace) raises (com::sun::star::lang::IllegalArgumentException) |
Convert to color of another color space. More... | |
sequence< RGBColor > | convertToRGB ([in] sequence< ColorComponent > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to sRGB color values. More... | |
sequence< ARGBColor > | convertToARGB ([in] sequence< ColorComponent > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to sRGB color values, with linear alpha. More... | |
sequence< ARGBColor > | convertToPARGB ([in] sequence< ColorComponent > deviceColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert color value in this color space to premultiplied sRGB color values, with linear alpha. More... | |
sequence< ColorComponent > | convertFromRGB ([in] sequence< RGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert sRGB color to a representation in this color space. More... | |
sequence< ColorComponent > | convertFromARGB ([in] sequence< ARGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert sRGB color with linear alpha into this color space. More... | |
sequence< ColorComponent > | convertFromPARGB ([in] sequence< ARGBColor > rgbColor) raises (com::sun::star::lang::IllegalArgumentException) |
Convert premultiplied sRGB color with linear alpha into this color space. More... | |
A color space for integer bitmap formats.
This interface encapsulates all information specific to a certain integer bitmap color space, like for example 1555 ARGB. Note that the individual elements of the integer color representation sequence need not correspond to the color space's components - instead, the color components might be packed back-to-back into those bytes, as they appear in the raw bitmap data.
sequence<ColorComponent> convertFromIntegerColorSpace | ( | [in] sequence< byte > | deviceColor, |
[in] XColorSpace | targetColorSpace | ||
) | |||
raises | ( | com::sun::star::lang::IllegalArgumentException | |
) |
Convert integer bitmap color to generic IEEE double device color of another color space.
Color values are properly rounded and clipped, to be valid in the target color space.
deviceColor | Sequence of device color components. Is permitted to contain more than one device color element, therefore, batch conversion of multiple color values is possible. |
targetColorSpace | the color space to convert to. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<byte> convertIntegerFromARGB | ( | [in] sequence< ARGBColor > | rgbColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert sRGB color with linear alpha into this color space.
If this color space does not convey alpha information, the specified alpha value is silently ignored. Color values are properly rounded and clipped, to be valid in the target color space.
rgbColor | Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<byte> convertIntegerFromPARGB | ( | [in] sequence< ARGBColor > | rgbColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert premultiplied sRGB color with linear alpha into this color space.
If this color space does not convey alpha information, the specified alpha value is silently ignored. Color values are properly rounded and clipped, to be valid in the target color space.
rgbColor | Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. The individual RGB color values are assumed to be premultiplied by the alpha value already. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<byte> convertIntegerFromRGB | ( | [in] sequence< RGBColor > | rgbColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert sRGB color to an integer representation in this color space.
If this color space conveys alpha information, it is assumed be fully opaque for the given RGB color value. Color values are properly rounded and clipped, to be valid in the target color space.
rgbColor | Sequence of sRGB color components. Is permitted to contain more than one color element, therefore, batch conversion of multiple color values is possible. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<ARGBColor> convertIntegerToARGB | ( | [in] sequence< byte > | deviceColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert color value in this color space to sRGB color values, with linear alpha.
If the given input color does not carry alpha information, an alpha value of 1.0 (fully opaque) is assumed. Color values are properly rounded and clipped, to be valid in the target color space.
deviceColor | Sequence of device color components. Is permitted to contain more than one device color element, therefore, batch conversion of multiple color values is possible. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<ARGBColor> convertIntegerToPARGB | ( | [in] sequence< byte > | deviceColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert color value in this color space to premultiplied sRGB color values, with linear alpha.
If the given input color does not carry alpha information, an alpha value of 1.0 (fully opaque) is assumed. Color values are properly rounded and clipped, to be valid in the target color space. The resulting individual RGB color values are premultiplied by the alpha value (e.g. if alpha is 0.5, each color value has only half of the original intensity).
deviceColor | Sequence of device color components. Is permitted to contain more than one device color element, therefore, batch conversion of multiple color values is possible. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<RGBColor> convertIntegerToRGB | ( | [in] sequence< byte > | deviceColor | ) | |
raises | ( | com::sun::star::lang::IllegalArgumentException | |||
) |
Convert color value in this color space to sRGB color values.
Any information not representable in the RGBColor struct is discarded during the conversion. This includes alpha information. Color values are properly rounded and clipped, to be valid in the target color space.
deviceColor | Sequence of device color components. Is permitted to contain more than one device color element, therefore, batch conversion of multiple color values is possible. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
sequence<byte> convertToIntegerColorSpace | ( | [in] sequence< byte > | deviceColor, |
[in] XIntegerBitmapColorSpace | targetColorSpace | ||
) | |||
raises | ( | com::sun::star::lang::IllegalArgumentException | |
) |
Convert integer bitmap color to integer bitmap color of another integer bitmap color space.
Color values are properly rounded and clipped, to be valid in the target color space.
deviceColor | Sequence of device color components. Is permitted to contain more than one device color element, therefore, batch conversion of multiple color values is possible. |
targetColorSpace | the color space to convert to. |
a | com::sun::star::lang::IllegalArgumentException, if the input sequence does not match the device color format. |
long getBitsPerPixel | ( | ) |
Query number of bits used per bitmap pixel.
This method yields the total number of bits used for a color value. At the associated XIntegerBitmap, the XIntegerBitmap::setPixel() method will expect a sequence of ceil(BitsPerPixel/8) bytes, and the XIntegerReadOnlyBitmap::getPixel() will return that number of bytes. Similarly, the color conversion expect input data in multiples of ceil(BitsPerPixel/8), and also return converted data in chunks of this.
sequence<long> getComponentBitCounts | ( | ) |
Query the number of bits used for each component.
This method returns a sequence of integers, each denoting the number of bits occupied by the respective component. The sum of all component bits must be less or equal than the value returned from getBitsPerPixel(). If the sum is less, excess bits are always kept in the most significant bits of a pixel. Color components will appear in the byte sequences returned from the XIntegerBitmap methods in the order defined here, with the first element starting from the least significant bits of the pixel, etc.
byte getEndianness | ( | ) |
Query whether color data bytes need to be swapped.
TRUE
, This method returns the endianness of the color data. The value is one of the Endianness constants. If color data is represented using more than one byte, the actual channel positions are specified using bit positions. Therefore, depending on the architecture, the actual color data bytes might need to get swapped, for the bits to align properly.