offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.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: XHalfFloatReadOnlyBitmap.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_XHalfFloatReadOnlyBitmap_idl__
  31 #define __com_sun_star_rendering_XHalfFloatReadOnlyBitmap_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 module com { module sun { module star { module rendering {
  56
  57 /** Specialized interface for bitmaps containing half floats as their
  58     color components. Half floats are 16 bit wide, and some high-end
  59     GPUs already have them as supported frame buffer format. In
  60     contrast to <type>XHalfFloatBitmap</type>, this interface only
  61     permits 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 XHalfFloatReadOnlyBitmap : 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. Note: as we currently have no 16
  84         bit float UNO data type, the values are transported as 16 bit
  85         integers across the API (which requires casting on both
  86         sides).<p>
  87
  88         @throws <type>VolatileContentDestroyedException</type>
  89         if the bitmap is volatile, and the content has been destroyed by the system.
  90      */
  91     sequence<short>                             getData( [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
  92         raises (com::sun::star::lang::IndexOutOfBoundsException,
  93                 VolatileContentDestroyedException);
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** Get a single pixel of the bitmap, returning its color
  98         value.<p>
  99
 100         @throws <type>VolatileContentDestroyedException</type>
 101         if the bitmap is volatile, and the content has been destroyed by the system.
 102      */
 103     sequence<short>                             getPixel( [in] ::com::sun::star::geometry::IntegerPoint2D pos )
 104         raises (com::sun::star::lang::IndexOutOfBoundsException,
 105                 VolatileContentDestroyedException);
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** Query the memory layout for this bitmap.<p>
 110      */
 111     FloatingPointBitmapLayout   getMemoryLayout();
 112 };
 113
 114 }; }; }; };
 115
 116 #endif