summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl')
-rw-r--r--offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl113
1 files changed, 113 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl b/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl
new file mode 100644
index 000000000000..166f38425d5c
--- /dev/null
+++ b/offapi/com/sun/star/rendering/XHalfFloatReadOnlyBitmap.idl
@@ -0,0 +1,113 @@
+/*************************************************************************
+ *
+ * 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_XHalfFloatReadOnlyBitmap_idl__
+#define __com_sun_star_rendering_XHalfFloatReadOnlyBitmap_idl__
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
+#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
+#endif
+#ifndef __com_sun_star_rendering_FloatingPointBitmapLayout_idl__
+#include <com/sun/star/rendering/FloatingPointBitmapLayout.idl>
+#endif
+#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__
+#include <com/sun/star/geometry/IntegerPoint2D.idl>
+#endif
+#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
+#include <com/sun/star/geometry/IntegerRectangle2D.idl>
+#endif
+#ifndef __com_sun_star_rendering_XBitmap_idl__
+#include <com/sun/star/rendering/XBitmap.idl>
+#endif
+#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
+#include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
+#endif
+
+module com { module sun { module star { module rendering {
+
+/** Specialized interface for bitmaps containing half floats as their
+ color components. Half floats are 16 bit wide, and some high-end
+ GPUs already have them as supported frame buffer format. In
+ contrast to <type>XHalfFloatBitmap</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 XHalfFloatReadOnlyBitmap : 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. Note: as we currently have no 16
+ bit float UNO data type, the values are transported as 16 bit
+ integers across the API (which requires casting on both
+ sides).<p>
+
+ @throws <type>VolatileContentDestroyedException</type>
+ if the bitmap is volatile, and the content has been destroyed by the system.
+ */
+ sequence<short> getData( [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>
+
+ @throws <type>VolatileContentDestroyedException</type>
+ if the bitmap is volatile, and the content has been destroyed by the system.
+ */
+ sequence<short> getPixel( [in] ::com::sun::star::geometry::IntegerPoint2D pos )
+ raises (com::sun::star::lang::IndexOutOfBoundsException,
+ VolatileContentDestroyedException);
+
+ //-------------------------------------------------------------------------
+
+ /** Query the memory layout for this bitmap.<p>
+ */
+ FloatingPointBitmapLayout getMemoryLayout();
+};
+
+}; }; }; };
+
+#endif