offapi/com/sun/star/rendering/XHalfFloatBitmap.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: XHalfFloatBitmap.idl,v $
  10  * $Revision: 1.5 $
  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_XHalfFloatBitmap_idl__
  31 #define __com_sun_star_rendering_XHalfFloatBitmap_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_XHalfFloatReadOnlyBitmap_idl__
  49 #include <com/sun/star/rendering/XHalfFloatReadOnlyBitmap.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.<p>
  59
  60     Half floats are 16 bit wide, and newer GPUs already have them as
  61     supported frame buffer format.
  62  */
  63 interface XHalfFloatBitmap : XHalfFloatReadOnlyBitmap
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** Set raw data of a bitmap.<p>
  68
  69         Set raw data of a bitmap, in the format as defined by
  70         getMemoryLayout(). With the given rectangle, a subset of the
  71         bitmap can be changed. When setting subsets of the bitmap, the
  72         same scanline padding takes place as when the whole bitmap is
  73         changed.<p>
  74
  75      */
  76     void                                                setData( [in] sequence<short> data, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
  77         raises (com::sun::star::lang::IllegalArgumentException,
  78                 com::sun::star::lang::IndexOutOfBoundsException);
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** Set a single pixel of the bitmap with the given color
  83         value.<p>
  84
  85         When setting data on volatile bitmaps, always call isValid()
  86         before, and retrieve a new memory layout via
  87         getMemoryLayout(). At least under Windows, the memory layout
  88         can change for the same bitmap, if the user e.g. switches the
  89         screen resolution. Thus, this method will throw an
  90         IllegalArgumentException, if the memory layout changed between
  91         a call to getMemoryLayout() and setData().<p>
  92      */
  93     void                                                setPixel( [in] sequence<short> color, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
  94         raises (com::sun::star::lang::IllegalArgumentException,
  95                 com::sun::star::lang::IndexOutOfBoundsException);
  96 };
  97
  98 }; }; }; };
  99
 100 #endif