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
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_rendering_XIntegerReadOnlyBitmap_idl__
#define __com_sun_star_rendering_XIntegerReadOnlyBitmap_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#include <com/sun/star/geometry/IntegerPoint2D.idl>
#include <com/sun/star/geometry/IntegerRectangle2D.idl>
#include <com/sun/star/rendering/IntegerBitmapLayout.idl>
#include <com/sun/star/rendering/XBitmap.idl>
#include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
module com { module sun { module star { module rendering {
interface XBitmapPalette;
/** This is a specialized interface for bitmaps having integer color
channels. In contrast to XIntegerBitmap, 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
XIntegerReadOnlyBitmap that also supports the
XVolatileBitmap interface, things become a bit more
complicated. When reading data, one has to check for both
VolatileContentDestroyedException and mismatching
IntegerBitmapLayout return values. If either of them
occurs, the whole bitmap read operation should be repeated, if you
need consistent information.<p>
*/
interface XIntegerReadOnlyBitmap : 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. If the internal data format's
pixel are not integer multiples of bytes (i.e. if one pixel
occupies less than a byte), the leftover content of the bytes
at the right of each scanline is filled with zeros. The
details of the scanline padding are to be retrieved from the
passed bitmap layout.<p>
Note that the bitmap memory layout might change over time for
volatile bitmaps.<p>
@param bitmapLayout
The memory layout the returned data is in. Note that the color
space returned therein needs to always match the current color
space as would have been returned by getMemoryLayout(). This
is necessary to ensure correct operation under changing
XVolatileBitmap.
@param rect
A rectangle, within the bounds of the bitmap, to retrieve the
consent from.
@throws VolatileContentDestroyedException
if the bitmap is volatile, and the content has been destroyed by the system.
@throws com::sun::star::lang::IndexOutOfBoundsException
if parts of the given rectangle are outside the permissible
bitmap area.
*/
sequence<byte> getData( [out] IntegerBitmapLayout 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>
If the internal data format's pixel are not integer multiples
of bytes (i.e. if one pixel occupies less than a byte - the
case of more than one byte per pixel is not specified), the
color value is returned in the least significant bits of the
single byte returned as the color. The details of the returned
pixel data are to be retrieved from the passed bitmap layout.<p>
Note that the bitmap memory layout might change for volatile
bitmaps.<p>
@param bitmapLayout
The memory layout the returned data is in. Note that the color
space returned therein needs to always match the current color
space as would have been returned by getMemoryLayout(). This
is necessary to ensure correct operation under changing
XVolatileBitmap.
@param pos
A position, within the bounds of the bitmap, to retrieve the
color from.
@throws VolatileContentDestroyedException
if the bitmap is volatile, and the content has been destroyed by the system.
@throws com::sun::star::lang::IndexOutOfBoundsException
if the given position is outside the permissible bitmap area.
*/
sequence<byte> getPixel( [out] IntegerBitmapLayout 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>
*/
IntegerBitmapLayout getMemoryLayout();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
