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