offapi/com/sun/star/rendering/FloatingPointBitmapLayout.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  20 #define __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  21
  22 #include <com/sun/star/rendering/FloatingPointBitmapFormat.idl>
  23 #include <com/sun/star/rendering/XColorSpace.idl>
  24
  25 module com { module sun { module star { module rendering {
  26
  27 /** This structure describes the memory layout of a bitmap having
  28     floating point color channels.<p>
  29
  30     This structure collects all necessary information to describe the
  31     memory layout of a bitmap having floating point color channels<p>
  32
  33     @since OOo 2.0
  34  */
  35 struct FloatingPointBitmapLayout
  36 {
  37     /** Number of scanlines for this bitmap.
  38
  39         This value must not be negative
  40      */
  41     long                ScanLines;
  42
  43     /** Number of data bytes per scanline.
  44
  45         This value must not be negative
  46      */
  47     long                ScanLineBytes;
  48
  49     /** Byte offset between the start of two consecutive scanlines.
  50
  51         This value is permitted to be negative, denoting a bitmap
  52         whose content is flipped at the x axis.
  53      */
  54     long                ScanLineStride;
  55
  56     /** Byte offset between the start of two consecutive planes.
  57
  58         This value is permitted to be negative. If this value is zero,
  59         the bitmap is assumed to be in chunky format, otherwise it is
  60         assumed to be planar.  The difference between chunky and
  61         planar layout lies in the way how color channels are
  62         interleaved. For a chunky format, all channel data for a
  63         single pixel lies consecutively in memory. For a planar
  64         layout, the first channel of all pixel is stored consecutive,
  65         followed by the second channel, and so forth.<p>
  66      */
  67     long                PlaneStride;
  68
  69     // TODO(F3): Need some specializations of XColorSpace for float
  70     // and half float formats. This maybe translates to the bitmap
  71     // layout as well, leading to separate structs for double, float
  72     // and half float formats, because of the ColorSpace member. Or
  73     // leave it as it is, forcing the client to query for derived
  74     // interfaces...
  75
  76     /// Color space the bitmap colors shall be interpreted within.
  77     XColorSpace         ColorSpace;
  78
  79     /** Number of color components per pixel.
  80
  81         This value must not be negative
  82      */
  83     long                NumComponents;
  84
  85     /** Endianness of the pixel values.
  86
  87         This value must be one of the Endianness constants
  88      */
  89     byte                Endianness;
  90
  91     /** Format type of this bitmap.<p>
  92
  93         This value must be one of the
  94         FloatingPointBitmapFormat constants.<p>
  95     */
  96     byte                Format;
  97 };
  98
  99 }; }; }; };
 100
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */