LibreOffice
LibreOffice 7.2 SDK API Reference
Public Attributes | List of all members
IntegerBitmapLayout Struct Reference

This structure describes the memory layout of a bitmap having integer color channels. More...

import"IntegerBitmapLayout.idl";

Public Attributes

long ScanLines
 Number of scanlines for this bitmap. More...
 
long ScanLineBytes
 Number of data bytes per scanline. More...
 
long ScanLineStride
 Byte offset between the start of two consecutive scanlines. More...
 
long PlaneStride
 Byte offset between the start of two consecutive planes. More...
 
XIntegerBitmapColorSpace ColorSpace
 Color space the bitmap colors shall be interpreted within. More...
 
XBitmapPalette Palette
 This member determines whether the bitmap data are actually indices into a color map. More...
 
boolean IsMsbFirst
 This member determines the bit order (only relevant if a pixel uses less than 8 bits, of course). More...
 

Detailed Description

This structure describes the memory layout of a bitmap having integer color channels.

This structure collects all necessary information to describe the memory layout of a bitmap having integer color channels

Since
OOo 2.0

Member Data Documentation

◆ ColorSpace

Color space the bitmap colors shall be interpreted within.

Note that the actual pixel layout is specified at the color space. If this layout describes a palette bitmap format, this color space describes the index format (plus maybe an extra alpha channel). The palette itself references another color space, which describes the layout of the palette entries.

See also
XBitmapPalette

◆ IsMsbFirst

boolean IsMsbFirst

This member determines the bit order (only relevant if a pixel uses less than 8 bits, of course).

When TRUE, this member denotes that the leftmost pixel from an 8 bit amount of pixel data consists of the bits starting with the most significant bit. When FALSE, it's starting with the least significant bit.

Example: for a 1bpp bitmap, each pixel is represented by exactly one bit. If this member is TRUE, the first pixel is the MSB of the first byte, and the eighth pixel is the LSB of the first byte. If this member is FALSE, it's just the opposite.

◆ Palette

XBitmapPalette Palette

This member determines whether the bitmap data are actually indices into a color map.

When set to the nil reference, the bitmap data is assumed to contain direct color values (to be interpreted according to the associated color space). If this member references a valid palette, one of the pixel components as returned by the color space referenced from the ColorSpace is required to be of type ColorComponentTag::INDEX. That component is then used to index the palette.

◆ PlaneStride

long PlaneStride

Byte offset between the start of two consecutive planes.

This value is permitted to be negative. If this value is zero, the bitmap is assumed to be in chunky format, otherwise it is assumed to be planar. The difference between chunky and planar layout lies in the way how color channels are interleaved. For a chunky format, all channel data for a single pixel lies consecutively in memory. For a planar layout, the first channel of all pixel is stored consecutive, followed by the second channel, and so forth.

◆ ScanLineBytes

long ScanLineBytes

Number of data bytes per scanline.

This value must not be negative

◆ ScanLines

long ScanLines

Number of scanlines for this bitmap.

This value must not be negative

◆ ScanLineStride

long ScanLineStride

Byte offset between the start of two consecutive scanlines.

This value is permitted to be negative, denoting a bitmap whose content is flipped at the x axis.


The documentation for this struct was generated from the following file: