offapi/com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.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: XIeeeFloatReadOnlyBitmap.idl,v $
  10  * $Revision: 1.3 $
  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_XIeeeFloatReadOnlyBitmap_idl__
  31 #define __com_sun_star_rendering_XIeeeFloatReadOnlyBitmap_idl__
  32
  33 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  34 #include <com/sun/star/lang/IllegalArgumentException.idl>
  35 #endif
  36 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  37 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  38 #endif
  39 #ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  40 #include <com/sun/star/rendering/FloatingPointBitmapLayout.idl>
  41 #endif
  42 #ifndef __com_sun_star_geometry_IntegerPoint2D_idl__
  43 #include <com/sun/star/geometry/IntegerPoint2D.idl>
  44 #endif
  45 #ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
  46 #include <com/sun/star/geometry/IntegerRectangle2D.idl>
  47 #endif
  48 #ifndef __com_sun_star_rendering_XBitmap_idl__
  49 #include <com/sun/star/rendering/XBitmap.idl>
  50 #endif
  51 #ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
  52 #include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
  53 #endif
  54
  55
  56 module com { module sun { module star { module rendering {
  57
  58 /** Specialized interface for bitmaps containing IEEE floats as their
  59     color components. In contrast to <type>XIeeeFloatBitmap</type>,
  60     this interface only permits read-only access.<p>
  61
  62     Use this interface for e.g. bitmaps that are calculated
  63     on-the-fly, or that are pure functional, and thus cannot be
  64     modified.<p>
  65
  66     If you get passed an instance of
  67     <type>XHalfFloatReadOnlyBitmap</type> that also supports the
  68     <type>XVolatileBitmap</type> interface, things become a bit more
  69     complicated. When reading data, one has to check for both
  70     <type>VolatileContentDestroyedException</type> and mismatching
  71     <type>FloatingPointBitmapLayout</type> return values. If either of them
  72     occurs, the whole bitmap read operation should be repeated.<p>
  73  */
  74 interface XIeeeFloatReadOnlyBitmap : XBitmap
  75 {
  76     /** Query the raw data of this bitmap.<p>
  77
  78         Query the raw data of this bitmap, in the format as defined by
  79         getMemoryLayout(). With the given rectangle, a subset of the
  80         whole bitmap can be queried. When querying subsets of the
  81         bitmap, the same scanline padding takes place as when the
  82         whole bitmap is requested.<p>
  83
  84         Note that the bitmap memory layout might change for volatile
  85         bitmaps.<p>
  86
  87         @param bitmapLayout
  88         The memory layout the returned data is in.
  89
  90         @param rect
  91         A rectangle, within the bounds of the bitmap, to retrieve the
  92         contens from.
  93
  94         @throws <type>VolatileContentDestroyedException</type>
  95         if the bitmap is volatile, and the content has been destroyed by the system.
  96
  97         @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
  98         if parts of the given rectangle are outside the permissible
  99         bitmap area.
 100      */
 101     sequence<float>                             getData( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
 102         raises (com::sun::star::lang::IndexOutOfBoundsException,
 103                 VolatileContentDestroyedException);
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** Get a single pixel of the bitmap, returning its color
 108         value.<p>
 109
 110         Note that the bitmap memory layout might change for volatile
 111         bitmaps.<p>
 112
 113         @param bitmapLayout
 114         The memory layout the returned data is in.
 115
 116         @param pos
 117         A position, within the bounds of the bitmap, to retrieve the
 118         color from.
 119
 120         @throws <type>VolatileContentDestroyedException</type>
 121         if the bitmap is volatile, and the content has been destroyed by the system.
 122
 123         @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
 124         if the given position is outside the permissible bitmap area.
 125      */
 126     sequence<float>                             getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
 127         raises (com::sun::star::lang::IndexOutOfBoundsException,
 128                 VolatileContentDestroyedException);
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** Query the memory layout for this bitmap.<p>
 133
 134         Please note that for volatile bitmaps, the memory layout might
 135         change between subsequent calls.<p>
 136      */
 137     FloatingPointBitmapLayout   getMemoryLayout();
 138 };
 139
 140 }; }; }; };
 141
 142 #endif