LibreOffice
LibreOffice 24.2 SDK API Reference
Public Attributes | List of all members
FloatingPointBitmapLayout Struct Reference

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

import"FloatingPointBitmapLayout.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...
 
XColorSpace ColorSpace
 Color space the bitmap colors shall be interpreted within. More...
 
long NumComponents
 Number of color components per pixel. More...
 
byte Endianness
 Endianness of the pixel values. More...
 
byte Format
 Format type of this bitmap. More...
 

Detailed Description

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

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

Since
OOo 2.0

Member Data Documentation

◆ ColorSpace

XColorSpace ColorSpace

Color space the bitmap colors shall be interpreted within.

◆ Endianness

byte Endianness

Endianness of the pixel values.

This value must be one of the Endianness constants

◆ Format

byte Format

Format type of this bitmap.

This value must be one of the FloatingPointBitmapFormat constants.

◆ NumComponents

long NumComponents

Number of color components per pixel.

This value must not be negative

◆ 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: