<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>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/></dt> <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. </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="#NumComponents">NumComponents</a></td> <td class="imsum_right">Number of color components per pixel. This value must not be negative </td> </tr> <tr> <td class="imsum_left"><a href="#ComponentMasks">ComponentMasks</a></td> <td class="imsum_right">Mask values for packed bitmaps This member contains NumComponents 64 bit masks, which can be used to mask out the corresponding color component from the bitmap data. For the typical 32 bit RGBA color data, the four mask values would look like 0xFF000000, 0x00FF0000, 0x0000FF00, and 0x000000FF. </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="#Endianness">Endianness</a></td> <td class="imsum_right">Endianness of the pixel values. This value must be one of the <a href="Endianness.html">Endianness</a> constants </td> </tr> <tr> <td class="imsum_left"><a href="#Format">Format</a></td> <td class="imsum_right">Format type of this bitmap. </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. </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="XColorSpace.html">XColorSpace</a> <b>ColorSpace</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Color space the bitmap colors shall be interpreted within.</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NumComponents" class="membertitle">NumComponents</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>NumComponents</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Number of color components per pixel. This value must not be negative </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ComponentMasks" class="membertitle">ComponentMasks</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< hyper > <b>ComponentMasks</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Mask values for packed bitmaps This member contains NumComponents 64 bit masks, which can be used to mask out the corresponding color component from the bitmap data. For the typical 32 bit RGBA color data, the four mask values would look like 0xFF000000, 0x00FF0000, 0x0000FF00, and 0x000000FF. </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).<p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Endianness" class="membertitle">Endianness</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>byte <b>Endianness</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Endianness of the pixel values. This value must be one of the <a href="Endianness.html">Endianness</a> constants </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Format" class="membertitle">Format</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>byte <b>Format</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>Format type of this bitmap.</dd> <dd><p> This value must be one of the <a href="IntegerBitmapFormat.html">IntegerBitmapFormat</a> constants. The precise layout of the color channels within a bitmap pixel is further specified via the ComponentMasks member.<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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>