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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_rendering_XHalfFloatBitmap_idl__
  28 #define __com_sun_star_rendering_XHalfFloatBitmap_idl__
  29
  30 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  31 #include <com/sun/star/lang/IllegalArgumentException.idl>
  32 #endif
  33 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  34 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  35 #endif
  36 #ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
  37 #include <com/sun/star/rendering/FloatingPointBitmapLayout.idl>
  38 #endif
  39 #ifndef __com_sun_star_geometry_IntegerPoint2D_idl__
  40 #include <com/sun/star/geometry/IntegerPoint2D.idl>
  41 #endif
  42 #ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
  43 #include <com/sun/star/geometry/IntegerRectangle2D.idl>
  44 #endif
  45 #ifndef __com_sun_star_rendering_XHalfFloatReadOnlyBitmap_idl__
  46 #include <com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl>
  47 #endif
  48 #ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
  49 #include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
  50 #endif
  51
  52 module com { module sun { module star { module rendering {
  53
  54 /** Specialized interface for bitmaps containing half floats as their
  55     color components.<p>
  56
  57     Half floats are 16 bit wide, and newer GPUs already have them as
  58     supported frame buffer format.
  59  */
  60 interface XHalfFloatBitmap : XHalfFloatReadOnlyBitmap
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** Set raw data of a bitmap.<p>
  65
  66         Set raw data of a bitmap, in the format as defined by
  67         getMemoryLayout(). With the given rectangle, a subset of the
  68         bitmap can be changed. When setting subsets of the bitmap, the
  69         same scanline padding takes place as when the whole bitmap is
  70         changed.<p>
  71
  72      */
  73     void                        setData( [in] sequence<short> data, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
  74         raises (com::sun::star::lang::IllegalArgumentException,
  75                 com::sun::star::lang::IndexOutOfBoundsException);
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** Set a single pixel of the bitmap with the given color
  80         value.<p>
  81
  82         When setting data on volatile bitmaps, always call isValid()
  83         before, and retrieve a new memory layout via
  84         getMemoryLayout(). At least under Windows, the memory layout
  85         can change for the same bitmap, if the user e.g. switches the
  86         screen resolution. Thus, this method will throw an
  87         IllegalArgumentException, if the memory layout changed between
  88         a call to getMemoryLayout() and setData().<p>
  89      */
  90     void                        setPixel( [in] sequence<short> color, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
  91         raises (com::sun::star::lang::IllegalArgumentException,
  92                 com::sun::star::lang::IndexOutOfBoundsException);
  93 };
  94
  95 }; }; }; };
  96
  97 #endif