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