diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/rendering/IntegerBitmapLayout.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/rendering/IntegerBitmapLayout.idl | 117 |
1 files changed, 117 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl new file mode 100644 index 000000000..d1af5ae9c --- /dev/null +++ b/offapi/com/sun/star/rendering/IntegerBitmapLayout.idl @@ -0,0 +1,117 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__ +#define __com_sun_star_rendering_IntegerBitmapLayout_idl__ + +#include <com/sun/star/rendering/XIntegerBitmapColorSpace.idl> +#include <com/sun/star/rendering/XBitmapPalette.idl> + +module com { module sun { module star { module rendering { + +/** This structure describes the memory layout of a bitmap having + integer color channels.<p> + + This structure collects all necessary information to describe the + memory layout of a bitmap having integer color channels<p> + + @since OOo 2.0 + */ +struct IntegerBitmapLayout +{ + /** Number of scanlines for this bitmap. + + This value must not be negative + */ + long ScanLines; + + /** Number of data bytes per scanline. + + This value must not be negative + */ + long ScanLineBytes; + + /** 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. + */ + long ScanLineStride; + + /** 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.<p> + */ + long PlaneStride; + + /** Color space the bitmap colors shall be interpreted within.<p> + + 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 XBitmapPalette + */ + XIntegerBitmapColorSpace ColorSpace; + + /** This member determines whether the bitmap data are actually + indices into a color map.<p> + + 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.<p> + */ + XBitmapPalette Palette; + + /** This member determines the bit order (only relevant if a pixel + uses less than 8 bits, of course).<p> + + 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.<p> + + 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. + */ + boolean IsMsbFirst; + +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |