1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XIeeeFloatReadOnlyBitmap_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_rendering_XIeeeFloatReadOnlyBitmap_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 34*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 35*cdf0e10cSrcweir#endif 36*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__ 37*cdf0e10cSrcweir#include <com/sun/star/rendering/FloatingPointBitmapLayout.idl> 38*cdf0e10cSrcweir#endif 39*cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerPoint2D.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerRectangle2D.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmap_idl__ 46*cdf0e10cSrcweir#include <com/sun/star/rendering/XBitmap.idl> 47*cdf0e10cSrcweir#endif 48*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__ 49*cdf0e10cSrcweir#include <com/sun/star/rendering/VolatileContentDestroyedException.idl> 50*cdf0e10cSrcweir#endif 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir 53*cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir/** Specialized interface for bitmaps containing IEEE floats as their 56*cdf0e10cSrcweir color components. In contrast to <type>XIeeeFloatBitmap</type>, 57*cdf0e10cSrcweir this interface only permits read-only access.<p> 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir Use this interface for e.g. bitmaps that are calculated 60*cdf0e10cSrcweir on-the-fly, or that are pure functional, and thus cannot be 61*cdf0e10cSrcweir modified.<p> 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir If you get passed an instance of 64*cdf0e10cSrcweir <type>XHalfFloatReadOnlyBitmap</type> that also supports the 65*cdf0e10cSrcweir <type>XVolatileBitmap</type> interface, things become a bit more 66*cdf0e10cSrcweir complicated. When reading data, one has to check for both 67*cdf0e10cSrcweir <type>VolatileContentDestroyedException</type> and mismatching 68*cdf0e10cSrcweir <type>FloatingPointBitmapLayout</type> return values. If either of them 69*cdf0e10cSrcweir occurs, the whole bitmap read operation should be repeated.<p> 70*cdf0e10cSrcweir */ 71*cdf0e10cSrcweirinterface XIeeeFloatReadOnlyBitmap : XBitmap 72*cdf0e10cSrcweir{ 73*cdf0e10cSrcweir /** Query the raw data of this bitmap.<p> 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir Query the raw data of this bitmap, in the format as defined by 76*cdf0e10cSrcweir getMemoryLayout(). With the given rectangle, a subset of the 77*cdf0e10cSrcweir whole bitmap can be queried. When querying subsets of the 78*cdf0e10cSrcweir bitmap, the same scanline padding takes place as when the 79*cdf0e10cSrcweir whole bitmap is requested.<p> 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir Note that the bitmap memory layout might change for volatile 82*cdf0e10cSrcweir bitmaps.<p> 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir @param bitmapLayout 85*cdf0e10cSrcweir The memory layout the returned data is in. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @param rect 88*cdf0e10cSrcweir A rectangle, within the bounds of the bitmap, to retrieve the 89*cdf0e10cSrcweir contens from. 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir @throws <type>VolatileContentDestroyedException</type> 92*cdf0e10cSrcweir if the bitmap is volatile, and the content has been destroyed by the system. 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 95*cdf0e10cSrcweir if parts of the given rectangle are outside the permissible 96*cdf0e10cSrcweir bitmap area. 97*cdf0e10cSrcweir */ 98*cdf0e10cSrcweir sequence<float> getData( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) 99*cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 100*cdf0e10cSrcweir VolatileContentDestroyedException); 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir //------------------------------------------------------------------------- 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir /** Get a single pixel of the bitmap, returning its color 105*cdf0e10cSrcweir value.<p> 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir Note that the bitmap memory layout might change for volatile 108*cdf0e10cSrcweir bitmaps.<p> 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir @param bitmapLayout 111*cdf0e10cSrcweir The memory layout the returned data is in. 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir @param pos 114*cdf0e10cSrcweir A position, within the bounds of the bitmap, to retrieve the 115*cdf0e10cSrcweir color from. 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir @throws <type>VolatileContentDestroyedException</type> 118*cdf0e10cSrcweir if the bitmap is volatile, and the content has been destroyed by the system. 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 121*cdf0e10cSrcweir if the given position is outside the permissible bitmap area. 122*cdf0e10cSrcweir */ 123*cdf0e10cSrcweir sequence<float> getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) 124*cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 125*cdf0e10cSrcweir VolatileContentDestroyedException); 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir //------------------------------------------------------------------------- 128*cdf0e10cSrcweir 129*cdf0e10cSrcweir /** Query the memory layout for this bitmap.<p> 130*cdf0e10cSrcweir 131*cdf0e10cSrcweir Please note that for volatile bitmaps, the memory layout might 132*cdf0e10cSrcweir change between subsequent calls.<p> 133*cdf0e10cSrcweir */ 134*cdf0e10cSrcweir FloatingPointBitmapLayout getMemoryLayout(); 135*cdf0e10cSrcweir}; 136*cdf0e10cSrcweir 137*cdf0e10cSrcweir}; }; }; }; 138*cdf0e10cSrcweir 139*cdf0e10cSrcweir#endif 140