<html> <head> <title>Struct IntegerBitmapLayout</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="IntegerBitmapLayout-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Elements" class="navisub">Elements' Summary</a></td> <td class="navisub"><a href="#ElementDetails" class="navisub">Elements' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">struct IntegerBitmapLayout</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>This structure describes the memory layout of a bitmap having integer color channels.</dd> <dd><p> This structure collects all necessary information to describe the memory layout of a bitmap having integer color channels<p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> <hr> <a name="Elements"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Elements' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#ScanLines">ScanLines</a></td> <td class="imsum_right">Number of scanlines for this bitmap. This value must not be negative </td> </tr> <tr> <td class="imsum_left"><a href="#ScanLineBytes">ScanLineBytes</a></td> <td class="imsum_right">Number of data bytes per scanline. This value must not be negative </td> </tr> <tr> <td class="imsum_left"><a href="#ScanLineStride">ScanLineStride</a></td> <td class="imsum_right">Byte offset between the start of two consecutive scanlines. This value is permitted to be negative, denoting a bitmap whose content is flipped at the x axis. </td> </tr> <tr> <td class="imsum_left"><a href="#PlaneStride">PlaneStride</a></td> <td class="imsum_right">Byte offset between the start of two consecutive planes. This value is permitted to be negative. If this value is zero, the bitmap is assumed to be in chunky format, otherwise it is assumed to be planar. The difference between chunky and planar layout lies in the way how color channels are interleaved. For a chunky format, all channel data for a single pixel lies consecutively in memory. For a planar layout, the first channel of all pixel is stored consecutive, followed by the second channel, and so forth. </td> </tr> <tr> <td class="imsum_left"><a href="#ColorSpace">ColorSpace</a></td> <td class="imsum_right">Color space the bitmap colors shall be interpreted within. </td> </tr> <tr> <td class="imsum_left"><a href="#Palette">Palette</a></td> <td class="imsum_right">This member determines whether the bitmap data are actually indices into a color map. </td> </tr> <tr> <td class="imsum_left"><a href="#IsMsbFirst">IsMsbFirst</a></td> <td class="imsum_right">This member determines the bit order (only relevant if a pixel uses less than 8 bits, of course). </td> </tr> </table> <a name="ElementDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Elements' Details</td> </tr> <tr> <td class="imdetail"><a name="ScanLines" class="membertitle">ScanLines</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>ScanLines</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Number of scanlines for this bitmap. This value must not be negative </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ScanLineBytes" class="membertitle">ScanLineBytes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>ScanLineBytes</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Number of data bytes per scanline. This value must not be negative </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ScanLineStride" class="membertitle">ScanLineStride</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>ScanLineStride</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Byte offset between the start of two consecutive scanlines. This value is permitted to be negative, denoting a bitmap whose content is flipped at the x axis. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PlaneStride" class="membertitle">PlaneStride</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>PlaneStride</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Byte offset between the start of two consecutive planes. This value is permitted to be negative. If this value is zero, the bitmap is assumed to be in chunky format, otherwise it is assumed to be planar. The difference between chunky and planar layout lies in the way how color channels are interleaved. For a chunky format, all channel data for a single pixel lies consecutively in memory. For a planar layout, the first channel of all pixel is stored consecutive, followed by the second channel, and so forth.</dd> <dd><p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ColorSpace" class="membertitle">ColorSpace</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XIntegerBitmapColorSpace.html">XIntegerBitmapColorSpace</a> <b>ColorSpace</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Color space the bitmap colors shall be interpreted within.</dd> <dd><p> Note that the actual pixel layout is specified at the color space. If this layout describes a palette bitmap format, this color space describes the index format (plus maybe an extra alpha channel). The palette itself references another color space, which describes the layout of the palette entries. </dd> <dt><b>See also</b></dt> <dd><a href="XBitmapPalette.html">XBitmapPalette</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Palette" class="membertitle">Palette</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="XBitmapPalette.html">XBitmapPalette</a> <b>Palette</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This member determines whether the bitmap data are actually indices into a color map.</dd> <dd><p> When set to the nil reference, the bitmap data is assumed to contain direct color values (to be interpreted according to the associated color space). If this member references a valid palette, one of the pixel components as returned by the color space referenced from the <a href="#ColorSpace">ColorSpace</a> is required to be of type <a href="ColorComponentTag.html">ColorComponentTag</a>::<a href="ColorComponentTag.html#INDEX">INDEX</a>. That component is then used to index the palette.<p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsMsbFirst" class="membertitle">IsMsbFirst</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IsMsbFirst</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>This member determines the bit order (only relevant if a pixel uses less than 8 bits, of course).</dd> <dd><p> When <b>true</b>, this member denotes that the leftmost pixel from an 8 bit amount of pixel data consists of the bits starting with the most significant bit. When <b>false</b>, it's starting with the least significant bit.<p> Example: for a 1bpp bitmap, each pixel is represented by exactly one bit. If this member is <b>true</b>, the first pixel is the MSB of the first byte, and the eighth pixel is the LSB of the first byte. If this member is <b>false</b>, it's just the opposite. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>