/* -*- 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 . */ 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.
Use this interface for e.g. bitmaps that are calculated on-the-fly, or that are pure functional, and thus cannot be modified.
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.
*/ interface XIntegerReadOnlyBitmap : XBitmap { /** Query the raw data of this bitmap.
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.
Note that the bitmap memory layout might change over time for volatile bitmaps.
@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
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.
Note that the bitmap memory layout might change for volatile
bitmaps.
@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
Please note that for volatile bitmaps, the memory layout might
change between subsequent calls.
*/
IntegerBitmapLayout getMemoryLayout();
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */