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