1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XIeeeFloatBitmap_idl__
24cdf0e10cSrcweir#define __com_sun_star_rendering_XIeeeFloatBitmap_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
27cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
30cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
31cdf0e10cSrcweir#endif
32cdf0e10cSrcweir#ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
33cdf0e10cSrcweir#include <com/sun/star/rendering/FloatingPointBitmapLayout.idl>
34cdf0e10cSrcweir#endif
35cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__
36cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerPoint2D.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
39cdf0e10cSrcweir#include <com/sun/star/geometry/IntegerRectangle2D.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XIeeeFloatReadOnlyBitmap_idl__
42cdf0e10cSrcweir#include <com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl>
43cdf0e10cSrcweir#endif
44cdf0e10cSrcweir#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
45cdf0e10cSrcweir#include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
46cdf0e10cSrcweir#endif
47cdf0e10cSrcweir
48cdf0e10cSrcweir
49cdf0e10cSrcweirmodule com { module sun { module star { module rendering {
50cdf0e10cSrcweir
51cdf0e10cSrcweir/** Specialized interface for bitmaps containing IEEE floats as their
52cdf0e10cSrcweir    color components.<p>
53cdf0e10cSrcweir */
54cdf0e10cSrcweirinterface XIeeeFloatBitmap : XIeeeFloatReadOnlyBitmap
55cdf0e10cSrcweir{
56cdf0e10cSrcweir	//-------------------------------------------------------------------------
57cdf0e10cSrcweir
58cdf0e10cSrcweir	/** Set raw data of a bitmap.<p>
59cdf0e10cSrcweir
60cdf0e10cSrcweir    	Set raw data of a bitmap, in the format as defined by
61cdf0e10cSrcweir    	getMemoryLayout(). With the given rectangle, a subset of the
62cdf0e10cSrcweir    	bitmap can be changed. When setting subsets of the bitmap, the
63cdf0e10cSrcweir    	same scanline padding takes place as when the whole bitmap is
64cdf0e10cSrcweir    	changed.<p>
65cdf0e10cSrcweir
66cdf0e10cSrcweir        When setting data on volatile bitmaps, always call isValid()
67cdf0e10cSrcweir        before, and retrieve a new memory layout via
68cdf0e10cSrcweir        getMemoryLayout(). At least under Windows, the memory layout
69cdf0e10cSrcweir        can change for the same bitmap, if the user e.g. switches the
70cdf0e10cSrcweir        screen resolution. Thus, this method will throw an
71cdf0e10cSrcweir        IllegalArgumentException, if the memory layout changed between
72cdf0e10cSrcweir        a call to getMemoryLayout() and setData().<p>
73cdf0e10cSrcweir
74cdf0e10cSrcweir        @param data
75cdf0e10cSrcweir        Data to set
76cdf0e10cSrcweir
77cdf0e10cSrcweir        @param bitmapLayout
78cdf0e10cSrcweir        Layout of the data to set. Must match this bitmap's current
79cdf0e10cSrcweir        layout.
80cdf0e10cSrcweir
81cdf0e10cSrcweir        @param rect
82cdf0e10cSrcweir        Destination rectangle, within the bounds of the bitmap, to set
83cdf0e10cSrcweir        the data in.
84cdf0e10cSrcweir
85cdf0e10cSrcweir        @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
86cdf0e10cSrcweir        if parts of the given rectangle are outside the permissible
87cdf0e10cSrcweir        bitmap area.
88cdf0e10cSrcweir
89cdf0e10cSrcweir        @throws <type>com::sun::star::lang::IllegalArgumentException</type>
90cdf0e10cSrcweir        if the given memory layout does not match this bitmap's
91cdf0e10cSrcweir        layout, or if the given data sequence has too few or too much
92cdf0e10cSrcweir        elements.
93cdf0e10cSrcweir	 */
94cdf0e10cSrcweir	void						setData( [in] sequence<float> data, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
95cdf0e10cSrcweir        raises (com::sun::star::lang::IllegalArgumentException,
96cdf0e10cSrcweir                com::sun::star::lang::IndexOutOfBoundsException);
97cdf0e10cSrcweir
98cdf0e10cSrcweir	//-------------------------------------------------------------------------
99cdf0e10cSrcweir
100cdf0e10cSrcweir	/** Set a single pixel of the bitmap with the given color
101cdf0e10cSrcweir		value.<p>
102cdf0e10cSrcweir
103cdf0e10cSrcweir        When setting data on volatile bitmaps, always call isValid()
104cdf0e10cSrcweir        before, and retrieve a new memory layout via
105cdf0e10cSrcweir        getMemoryLayout(). At least under Windows, the memory layout
106cdf0e10cSrcweir        can change for the same bitmap, if the user e.g. switches the
107cdf0e10cSrcweir        screen resolution. Thus, this method will throw an
108cdf0e10cSrcweir        IllegalArgumentException, if the memory layout changed between
109cdf0e10cSrcweir        a call to getMemoryLayout() and setPixel().<p>
110cdf0e10cSrcweir
111cdf0e10cSrcweir        @param color
112cdf0e10cSrcweir        The color value(s) to set
113cdf0e10cSrcweir
114cdf0e10cSrcweir        @param bitmapLayout
115cdf0e10cSrcweir        Layout of the color elements to set. Must match this bitmap's
116cdf0e10cSrcweir        current layout.
117cdf0e10cSrcweir
118cdf0e10cSrcweir        @param pos
119cdf0e10cSrcweir        Pixel position with the bounds of the bitmap to set.
120cdf0e10cSrcweir
121cdf0e10cSrcweir        @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
122cdf0e10cSrcweir        if the given point is outside the permissible bitmap area.
123cdf0e10cSrcweir
124cdf0e10cSrcweir        @throws <type>com::sun::star::lang::IllegalArgumentException</type>
125cdf0e10cSrcweir        if the given memory layout does not match this bitmap's
126cdf0e10cSrcweir        layout, or if the given data sequence has too few or too much
127cdf0e10cSrcweir        elements.
128cdf0e10cSrcweir	 */
129cdf0e10cSrcweir	void						setPixel( [in] sequence<float> color, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
130cdf0e10cSrcweir        raises (com::sun::star::lang::IllegalArgumentException,
131cdf0e10cSrcweir                com::sun::star::lang::IndexOutOfBoundsException);
132cdf0e10cSrcweir};
133cdf0e10cSrcweir
134cdf0e10cSrcweir}; }; }; };
135cdf0e10cSrcweir
136cdf0e10cSrcweir#endif
137