1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XHalfFloatReadOnlyBitmap_idl__ 24cdf0e10cSrcweir#define __com_sun_star_rendering_XHalfFloatReadOnlyBitmap_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 27cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 30cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir#ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__ 33cdf0e10cSrcweir#include <com/sun/star/rendering/FloatingPointBitmapLayout.idl> 34cdf0e10cSrcweir#endif 35cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__ 36cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerPoint2D.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__ 39cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerRectangle2D.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmap_idl__ 42cdf0e10cSrcweir#include <com/sun/star/rendering/XBitmap.idl> 43cdf0e10cSrcweir#endif 44cdf0e10cSrcweir#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__ 45cdf0e10cSrcweir#include <com/sun/star/rendering/VolatileContentDestroyedException.idl> 46cdf0e10cSrcweir#endif 47cdf0e10cSrcweir 48cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 49cdf0e10cSrcweir 50cdf0e10cSrcweir/** Specialized interface for bitmaps containing half floats as their 51cdf0e10cSrcweir color components. Half floats are 16 bit wide, and some high-end 52cdf0e10cSrcweir GPUs already have them as supported frame buffer format. In 53cdf0e10cSrcweir contrast to <type>XHalfFloatBitmap</type>, this interface only 54cdf0e10cSrcweir permits read-only access.<p> 55cdf0e10cSrcweir 56cdf0e10cSrcweir Use this interface for e.g. bitmaps that are calculated 57cdf0e10cSrcweir on-the-fly, or that are pure functional, and thus cannot be 58cdf0e10cSrcweir modified.<p> 59cdf0e10cSrcweir 60cdf0e10cSrcweir If you get passed an instance of 61cdf0e10cSrcweir <type>XHalfFloatReadOnlyBitmap</type> that also supports the 62cdf0e10cSrcweir <type>XVolatileBitmap</type> interface, things become a bit more 63cdf0e10cSrcweir complicated. When reading data, one has to check for both 64cdf0e10cSrcweir <type>VolatileContentDestroyedException</type> and mismatching 65cdf0e10cSrcweir <type>FloatingPointBitmapLayout</type> return values. If either of them 66cdf0e10cSrcweir occurs, the whole bitmap read operation should be repeated.<p> 67cdf0e10cSrcweir */ 68cdf0e10cSrcweirinterface XHalfFloatReadOnlyBitmap : XBitmap 69cdf0e10cSrcweir{ 70cdf0e10cSrcweir /** Query the raw data of this bitmap.<p> 71cdf0e10cSrcweir 72cdf0e10cSrcweir Query the raw data of this bitmap, in the format as defined by 73cdf0e10cSrcweir getMemoryLayout(). With the given rectangle, a subset of the 74cdf0e10cSrcweir whole bitmap can be queried. When querying subsets of the 75cdf0e10cSrcweir bitmap, the same scanline padding takes place as when the 76cdf0e10cSrcweir whole bitmap is requested. Note: as we currently have no 16 77cdf0e10cSrcweir bit float UNO data type, the values are transported as 16 bit 78cdf0e10cSrcweir integers across the API (which requires casting on both 79cdf0e10cSrcweir sides).<p> 80cdf0e10cSrcweir 81cdf0e10cSrcweir @throws <type>VolatileContentDestroyedException</type> 82cdf0e10cSrcweir if the bitmap is volatile, and the content has been destroyed by the system. 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir sequence<short> getData( [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) 85cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 86cdf0e10cSrcweir VolatileContentDestroyedException); 87cdf0e10cSrcweir 88cdf0e10cSrcweir //------------------------------------------------------------------------- 89cdf0e10cSrcweir 90cdf0e10cSrcweir /** Get a single pixel of the bitmap, returning its color 91cdf0e10cSrcweir value.<p> 92cdf0e10cSrcweir 93cdf0e10cSrcweir @throws <type>VolatileContentDestroyedException</type> 94cdf0e10cSrcweir if the bitmap is volatile, and the content has been destroyed by the system. 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir sequence<short> getPixel( [in] ::com::sun::star::geometry::IntegerPoint2D pos ) 97cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 98cdf0e10cSrcweir VolatileContentDestroyedException); 99cdf0e10cSrcweir 100cdf0e10cSrcweir //------------------------------------------------------------------------- 101cdf0e10cSrcweir 102cdf0e10cSrcweir /** Query the memory layout for this bitmap.<p> 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir FloatingPointBitmapLayout getMemoryLayout(); 105cdf0e10cSrcweir}; 106cdf0e10cSrcweir 107cdf0e10cSrcweir}; }; }; }; 108cdf0e10cSrcweir 109cdf0e10cSrcweir#endif 110