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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FloatingPointBitmapLayout.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  31 #define __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  32
  33 #ifndef __com_sun_star_rendering_FloatingPointBitmapFormat_idl__
  34 #include <com/sun/star/rendering/FloatingPointBitmapFormat.idl>
  35 #endif
  36 #ifndef __com_sun_star_rendering_XColorSpace_idl__
  37 #include <com/sun/star/rendering/XColorSpace.idl>
  38 #endif
  39
  40 module com { module sun { module star { module rendering {
  41
  42 /** This structure describes the memory layout of a bitmap having
  43     floating point color channels.<p>
  44
  45     This structure collects all necessary information to describe the
  46     memory layout of a bitmap having floating point color channels<p>
  47
  48     @since OOo 2.0.0
  49  */
  50 struct FloatingPointBitmapLayout
  51 {
  52     /** Number of scanlines for this bitmap.
  53
  54         This value must not be negative
  55      */
  56     long                                ScanLines;
  57
  58     /** Number of data bytes per scanline.
  59
  60         This value must not be negative
  61      */
  62     long                                ScanLineBytes;
  63
  64     /** Byte offset between the start of two consecutive scanlines.
  65
  66         This value is permitted to be negative, denoting a bitmap
  67         whose content is flipped at the x axis.
  68      */
  69     long                                ScanLineStride;
  70
  71     /** Byte offset between the start of two consecutive planes.
  72
  73         This value is permitted to be negative. If this value is zero,
  74         the bitmap is assumed to be in chunky format, otherwise it is
  75         assumed to be planar.  The difference between chunky and
  76         planar layout lies in the way how color channels are
  77         interleaved. For a chunky format, all channel data for a
  78         single pixel lies consecutively in memory. For a planar
  79         layout, the first channel of all pixel is stored consecutive,
  80         followed by the second channel, and so forth.<p>
  81      */
  82     long                                PlaneStride;
  83
  84     // TODO(F3): Need some specializations of XColorSpace for float
  85     // and half float formats. This maybe translates to the bitmap
  86     // layout as well, leading to separate structs for double, float
  87     // and half float formats, because of the ColorSpace member. Or
  88     // leave it as it is, forcing the client to query for derived
  89     // interfaces...
  90
  91     /// Color space the bitmap colors shall be interpreted within.
  92     XColorSpace                 ColorSpace;
  93
  94     /** Number of color components per pixel.
  95
  96         This value must not be negative
  97      */
  98     long                            NumComponents;
  99
 100     /** Endianness of the pixel values.
 101
 102         This value must be one of the <type>Endianness</type> constants
 103      */
 104     byte                            Endianness;
 105
 106     /** Format type of this bitmap.<p>
 107
 108         This value must be one of the
 109         <type>FloatingPointBitmapFormat</type> constants.<p>
 110     */
 111     byte                                Format;
 112 };
 113
 114 }; }; }; };
 115
 116 #endif