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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_rendering_XIeeeDoubleReadOnlyBitmap_idl__
  20 #define __com_sun_star_rendering_XIeeeDoubleReadOnlyBitmap_idl__
  21
  22 #include <com/sun/star/lang/IllegalArgumentException.idl>
  23 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  24 #include <com/sun/star/rendering/FloatingPointBitmapLayout.idl>
  25 #include <com/sun/star/geometry/IntegerPoint2D.idl>
  26 #include <com/sun/star/geometry/IntegerRectangle2D.idl>
  27 #include <com/sun/star/rendering/XBitmap.idl>
  28 #include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
  29
  30
  31 module com { module sun { module star { module rendering {
  32
  33 /** This is a specialized interface for bitmaps containing IEEE
  34     doubles for their color components. In contrast to
  35     XIeeeDoubleBitmap, this interface only permits
  36     read-only access.<p>
  37
  38     Use this interface for e.g. bitmaps that are calculated
  39     on-the-fly, or that are pure functional, and thus cannot be
  40     modified.<p>
  41
  42     If you get passed an instance of
  43     XHalfFloatReadOnlyBitmap that also supports the
  44     XVolatileBitmap interface, things become a bit more
  45     complicated. When reading data, one has to check for both
  46     VolatileContentDestroyedException and mismatching
  47     FloatingPointBitmapLayout return values. If either of them
  48     occurs, the whole bitmap read operation should be repeated.<p>
  49  */
  50 interface XIeeeDoubleReadOnlyBitmap : XBitmap
  51 {
  52     /** Query the raw data of this bitmap.<p>
  53
  54         Query the raw data of this bitmap, in the format as defined by
  55         getMemoryLayout(). With the given rectangle, a subset of the
  56         whole bitmap can be queried. When querying subsets of the
  57         bitmap, the same scanline padding takes place as when the
  58         whole bitmap is requested.<p>
  59
  60         Note that the bitmap memory layout might change for volatile
  61         bitmaps.<p>
  62
  63         @param bitmapLayout
  64         The memory layout the returned data is in.
  65
  66         @param rect
  67         A rectangle, within the bounds of the bitmap, to retrieve the
  68         consent from.
  69
  70         @throws VolatileContentDestroyedException
  71         if the bitmap is volatile, and the content has been destroyed by the system.
  72
  73         @throws com::sun::star::lang::IndexOutOfBoundsException
  74         if parts of the given rectangle are outside the permissible
  75         bitmap area.
  76      */
  77     sequence<double>            getData( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
  78         raises (com::sun::star::lang::IndexOutOfBoundsException,
  79                 VolatileContentDestroyedException);
  80
  81
  82     /** Get a single pixel of the bitmap, returning its color
  83         value.<p>
  84
  85         Note that the bitmap memory layout might change for volatile
  86         bitmaps.<p>
  87
  88         @param bitmapLayout
  89         The memory layout the returned data is in.
  90
  91         @param pos
  92         A position, within the bounds of the bitmap, to retrieve the
  93         color from.
  94
  95         @throws VolatileContentDestroyedException
  96         if the bitmap is volatile, and the content has been destroyed by the system.
  97
  98         @throws com::sun::star::lang::IndexOutOfBoundsException
  99         if the given position is outside the permissible bitmap area.
 100      */
 101     sequence<double>            getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
 102         raises (com::sun::star::lang::IndexOutOfBoundsException,
 103                 VolatileContentDestroyedException);
 104
 105
 106     /** Query the memory layout for this bitmap.<p>
 107
 108         Please note that for volatile bitmaps, the memory layout might
 109         change between subsequent calls.<p>
 110      */
 111     FloatingPointBitmapLayout   getMemoryLayout();
 112 };
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */