1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_rendering_IntegerBitmapLayout_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XIntegerBitmapColorSpace_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/rendering/XIntegerBitmapColorSpace.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmapPalette_idl__ 34*cdf0e10cSrcweir#include <com/sun/star/rendering/XBitmapPalette.idl> 35*cdf0e10cSrcweir#endif 36*cdf0e10cSrcweir 37*cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir/** This structure describes the memory layout of a bitmap having 40*cdf0e10cSrcweir integer color channels.<p> 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir This structure collects all necessary information to describe the 43*cdf0e10cSrcweir memory layout of a bitmap having integer color channels<p> 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir @since OOo 2.0 46*cdf0e10cSrcweir */ 47*cdf0e10cSrcweirstruct IntegerBitmapLayout 48*cdf0e10cSrcweir{ 49*cdf0e10cSrcweir /** Number of scanlines for this bitmap. 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir This value must not be negative 52*cdf0e10cSrcweir */ 53*cdf0e10cSrcweir long ScanLines; 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir /** Number of data bytes per scanline. 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir This value must not be negative 58*cdf0e10cSrcweir */ 59*cdf0e10cSrcweir long ScanLineBytes; 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir /** Byte offset between the start of two consecutive scanlines. 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir This value is permitted to be negative, denoting a bitmap 64*cdf0e10cSrcweir whose content is flipped at the x axis. 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir long ScanLineStride; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir /** Byte offset between the start of two consecutive planes. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir This value is permitted to be negative. If this value is zero, 71*cdf0e10cSrcweir the bitmap is assumed to be in chunky format, otherwise it is 72*cdf0e10cSrcweir assumed to be planar. The difference between chunky and 73*cdf0e10cSrcweir planar layout lies in the way how color channels are 74*cdf0e10cSrcweir interleaved. For a chunky format, all channel data for a 75*cdf0e10cSrcweir single pixel lies consecutively in memory. For a planar 76*cdf0e10cSrcweir layout, the first channel of all pixel is stored consecutive, 77*cdf0e10cSrcweir followed by the second channel, and so forth.<p> 78*cdf0e10cSrcweir */ 79*cdf0e10cSrcweir long PlaneStride; 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir /** Color space the bitmap colors shall be interpreted within.<p> 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir Note that the actual pixel layout is specified at the color 84*cdf0e10cSrcweir space. If this layout describes a palette bitmap format, this 85*cdf0e10cSrcweir color space describes the index format (plus maybe an extra 86*cdf0e10cSrcweir alpha channel). The palette itself references another color 87*cdf0e10cSrcweir space, which describes the layout of the palette entries. 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir @see XBitmapPalette 90*cdf0e10cSrcweir */ 91*cdf0e10cSrcweir XIntegerBitmapColorSpace ColorSpace; 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir /** This member determines whether the bitmap data are actually 94*cdf0e10cSrcweir indices into a color map.<p> 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir When set to the nil reference, the bitmap data is assumed to 97*cdf0e10cSrcweir contain direct color values (to be interpreted according to 98*cdf0e10cSrcweir the associated color space). If this member references a valid 99*cdf0e10cSrcweir palette, one of the pixel components as returned by the color 100*cdf0e10cSrcweir space referenced from the <member>ColorSpace</member> is 101*cdf0e10cSrcweir required to be of type 102*cdf0e10cSrcweir <member>ColorComponentTag::INDEX</member>. That component is 103*cdf0e10cSrcweir then used to index the palette.<p> 104*cdf0e10cSrcweir */ 105*cdf0e10cSrcweir XBitmapPalette Palette; 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir /** This member determines the bit order (only relevant if a pixel 108*cdf0e10cSrcweir uses less than 8 bits, of course).<p> 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir When <TRUE/>, this member denotes that the leftmost pixel from 111*cdf0e10cSrcweir an 8 bit amount of pixel data consists of the bits starting 112*cdf0e10cSrcweir with the most significant bit. When <FALSE/>, it's starting 113*cdf0e10cSrcweir with the least significant bit.<p> 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir Example: for a 1bpp bitmap, each pixel is represented by 116*cdf0e10cSrcweir exactly one bit. If this member is <TRUE/>, the first pixel is 117*cdf0e10cSrcweir the MSB of the first byte, and the eighth pixel is the LSB of 118*cdf0e10cSrcweir the first byte. If this member is <FALSE/>, it's just the 119*cdf0e10cSrcweir opposite. 120*cdf0e10cSrcweir */ 121*cdf0e10cSrcweir boolean IsMsbFirst; 122*cdf0e10cSrcweir 123*cdf0e10cSrcweir}; 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir}; }; }; }; 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir#endif 128