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_XIntegerReadOnlyBitmap_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_rendering_XIntegerReadOnlyBitmap_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_geometry_IntegerPoint2D_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/geometry/IntegerPoint2D.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/geometry/IntegerRectangle2D.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/IntegerBitmapLayout.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 Jagielski 49*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module rendering { 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielskiinterface XBitmapPalette; 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski/** This is a specialized interface for bitmaps having integer color 54*b1cdbd2cSJim Jagielski channels. In contrast to <type>XIntegerBitmap</type>, this 55*b1cdbd2cSJim Jagielski interface only permits read-only access.<p> 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski Use this interface for e.g. bitmaps that are calculated 58*b1cdbd2cSJim Jagielski on-the-fly, or that are pure functional, and thus cannot be 59*b1cdbd2cSJim Jagielski modified.<p> 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski If you get passed an instance of 62*b1cdbd2cSJim Jagielski <type>XIntegerReadOnlyBitmap</type> that also supports the 63*b1cdbd2cSJim Jagielski <type>XVolatileBitmap</type> interface, things become a bit more 64*b1cdbd2cSJim Jagielski complicated. When reading data, one has to check for both 65*b1cdbd2cSJim Jagielski <type>VolatileContentDestroyedException</type> and mismatching 66*b1cdbd2cSJim Jagielski <type>IntegerBitmapLayout</type> return values. If either of them 67*b1cdbd2cSJim Jagielski occurs, the whole bitmap read operation should be repeated, if you 68*b1cdbd2cSJim Jagielski need consistent information.<p> 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielskiinterface XIntegerReadOnlyBitmap : XBitmap 71*b1cdbd2cSJim Jagielski{ 72*b1cdbd2cSJim Jagielski /** Query the raw data of this bitmap.<p> 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski Query the raw data of this bitmap, in the format as defined by 75*b1cdbd2cSJim Jagielski getMemoryLayout(). With the given rectangle, a subset of the 76*b1cdbd2cSJim Jagielski whole bitmap can be queried. If the internal data format's 77*b1cdbd2cSJim Jagielski pixel are not integer multiples of bytes (i.e. if one pixel 78*b1cdbd2cSJim Jagielski occupies less than a byte), the leftover content of the bytes 79*b1cdbd2cSJim Jagielski at the right of each scanline is filled with zeros. The 80*b1cdbd2cSJim Jagielski details of the scanline padding are to be retrieved from the 81*b1cdbd2cSJim Jagielski passed bitmap layout.<p> 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski Note that the bitmap memory layout might change over time for 84*b1cdbd2cSJim Jagielski volatile bitmaps.<p> 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski @param bitmapLayout 87*b1cdbd2cSJim Jagielski The memory layout the returned data is in. Note that the color 88*b1cdbd2cSJim Jagielski space returned therein needs to always match the current color 89*b1cdbd2cSJim Jagielski space as would have been returned by getMemoryLayout(). This 90*b1cdbd2cSJim Jagielski is necessary to ensure correct operation under changing 91*b1cdbd2cSJim Jagielski <type>XVolatileBitmap</type>. 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski @param rect 94*b1cdbd2cSJim Jagielski A rectangle, within the bounds of the bitmap, to retrieve the 95*b1cdbd2cSJim Jagielski contens from. 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski @throws <type>VolatileContentDestroyedException</type> 98*b1cdbd2cSJim Jagielski if the bitmap is volatile, and the content has been destroyed by the system. 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 101*b1cdbd2cSJim Jagielski if parts of the given rectangle are outside the permissible 102*b1cdbd2cSJim Jagielski bitmap area. 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski sequence<byte> getData( [out] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) 105*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IndexOutOfBoundsException, 106*b1cdbd2cSJim Jagielski VolatileContentDestroyedException); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski /** Get a single pixel of the bitmap, returning its color 111*b1cdbd2cSJim Jagielski value.<p> 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski If the internal data format's pixel are not integer multiples 114*b1cdbd2cSJim Jagielski of bytes (i.e. if one pixel occupies less than a byte - the 115*b1cdbd2cSJim Jagielski case of more than one byte per pixel is not specified), the 116*b1cdbd2cSJim Jagielski color value is returned in the least significant bits of the 117*b1cdbd2cSJim Jagielski single byte returned as the color. The details of the returned 118*b1cdbd2cSJim Jagielski pixel data are to be retrieved from the passed bitmap layout.<p> 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski Note that the bitmap memory layout might change for volatile 121*b1cdbd2cSJim Jagielski bitmaps.<p> 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski @param bitmapLayout 124*b1cdbd2cSJim Jagielski The memory layout the returned data is in. Note that the color 125*b1cdbd2cSJim Jagielski space returned therein needs to always match the current color 126*b1cdbd2cSJim Jagielski space as would have been returned by getMemoryLayout(). This 127*b1cdbd2cSJim Jagielski is necessary to ensure correct operation under changing 128*b1cdbd2cSJim Jagielski <type>XVolatileBitmap</type>. 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski @param pos 131*b1cdbd2cSJim Jagielski A position, within the bounds of the bitmap, to retrieve the 132*b1cdbd2cSJim Jagielski color from. 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski @throws <type>VolatileContentDestroyedException</type> 135*b1cdbd2cSJim Jagielski if the bitmap is volatile, and the content has been destroyed by the system. 136*b1cdbd2cSJim Jagielski 137*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 138*b1cdbd2cSJim Jagielski if the given position is outside the permissible bitmap area. 139*b1cdbd2cSJim Jagielski */ 140*b1cdbd2cSJim Jagielski sequence<byte> getPixel( [out] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) 141*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IndexOutOfBoundsException, 142*b1cdbd2cSJim Jagielski VolatileContentDestroyedException); 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski /** Query the memory layout for this bitmap.<p> 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski Please note that for volatile bitmaps, the memory layout might 149*b1cdbd2cSJim Jagielski change between subsequent calls.<p> 150*b1cdbd2cSJim Jagielski */ 151*b1cdbd2cSJim Jagielski IntegerBitmapLayout getMemoryLayout(); 152*b1cdbd2cSJim Jagielski}; 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski}; }; }; }; 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski#endif 157