1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_rendering_IntegerBitmapLayout_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_XIntegerBitmapColorSpace_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/XIntegerBitmapColorSpace.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_XBitmapPalette_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/XBitmapPalette.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module rendering { 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski/** This structure describes the memory layout of a bitmap having 36*b1cdbd2cSJim Jagielski integer color channels.<p> 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski This structure collects all necessary information to describe the 39*b1cdbd2cSJim Jagielski memory layout of a bitmap having integer color channels<p> 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 42*b1cdbd2cSJim Jagielski */ 43*b1cdbd2cSJim Jagielskistruct IntegerBitmapLayout 44*b1cdbd2cSJim Jagielski{ 45*b1cdbd2cSJim Jagielski /** Number of scanlines for this bitmap. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski This value must not be negative 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski long ScanLines; 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski /** Number of data bytes per scanline. 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski This value must not be negative 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski long ScanLineBytes; 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** Byte offset between the start of two consecutive scanlines. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski This value is permitted to be negative, denoting a bitmap 60*b1cdbd2cSJim Jagielski whose content is flipped at the x axis. 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski long ScanLineStride; 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** Byte offset between the start of two consecutive planes. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski This value is permitted to be negative. If this value is zero, 67*b1cdbd2cSJim Jagielski the bitmap is assumed to be in chunky format, otherwise it is 68*b1cdbd2cSJim Jagielski assumed to be planar. The difference between chunky and 69*b1cdbd2cSJim Jagielski planar layout lies in the way how color channels are 70*b1cdbd2cSJim Jagielski interleaved. For a chunky format, all channel data for a 71*b1cdbd2cSJim Jagielski single pixel lies consecutively in memory. For a planar 72*b1cdbd2cSJim Jagielski layout, the first channel of all pixel is stored consecutive, 73*b1cdbd2cSJim Jagielski followed by the second channel, and so forth.<p> 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski long PlaneStride; 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** Color space the bitmap colors shall be interpreted within.<p> 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski Note that the actual pixel layout is specified at the color 80*b1cdbd2cSJim Jagielski space. If this layout describes a palette bitmap format, this 81*b1cdbd2cSJim Jagielski color space describes the index format (plus maybe an extra 82*b1cdbd2cSJim Jagielski alpha channel). The palette itself references another color 83*b1cdbd2cSJim Jagielski space, which describes the layout of the palette entries. 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski @see XBitmapPalette 86*b1cdbd2cSJim Jagielski */ 87*b1cdbd2cSJim Jagielski XIntegerBitmapColorSpace ColorSpace; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski /** This member determines whether the bitmap data are actually 90*b1cdbd2cSJim Jagielski indices into a color map.<p> 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski When set to the nil reference, the bitmap data is assumed to 93*b1cdbd2cSJim Jagielski contain direct color values (to be interpreted according to 94*b1cdbd2cSJim Jagielski the associated color space). If this member references a valid 95*b1cdbd2cSJim Jagielski palette, one of the pixel components as returned by the color 96*b1cdbd2cSJim Jagielski space referenced from the <member>ColorSpace</member> is 97*b1cdbd2cSJim Jagielski required to be of type 98*b1cdbd2cSJim Jagielski <member>ColorComponentTag::INDEX</member>. That component is 99*b1cdbd2cSJim Jagielski then used to index the palette.<p> 100*b1cdbd2cSJim Jagielski */ 101*b1cdbd2cSJim Jagielski XBitmapPalette Palette; 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski /** This member determines the bit order (only relevant if a pixel 104*b1cdbd2cSJim Jagielski uses less than 8 bits, of course).<p> 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski When <TRUE/>, this member denotes that the leftmost pixel from 107*b1cdbd2cSJim Jagielski an 8 bit amount of pixel data consists of the bits starting 108*b1cdbd2cSJim Jagielski with the most significant bit. When <FALSE/>, it's starting 109*b1cdbd2cSJim Jagielski with the least significant bit.<p> 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski Example: for a 1bpp bitmap, each pixel is represented by 112*b1cdbd2cSJim Jagielski exactly one bit. If this member is <TRUE/>, the first pixel is 113*b1cdbd2cSJim Jagielski the MSB of the first byte, and the eighth pixel is the LSB of 114*b1cdbd2cSJim Jagielski the first byte. If this member is <FALSE/>, it's just the 115*b1cdbd2cSJim Jagielski opposite. 116*b1cdbd2cSJim Jagielski */ 117*b1cdbd2cSJim Jagielski boolean IsMsbFirst; 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski}; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski}; }; }; }; 122*b1cdbd2cSJim Jagielski 123*b1cdbd2cSJim Jagielski#endif 124