~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="annotated.html"><font color="#004faf">Annotated</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="functions.html"><font color="#004faf">Functions</font></a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QGLColormap Class Reference</h1>

<p>The QGLColormap class is used for installing custom colormaps into QGLWidgets. <a href="#details">More...</a></p>

<pre>#include <QGLColormap></pre><p>Part of the <a href="qtopengl.html">QtOpenGL</a> module.</p>

<ul>

<li><a href="qglcolormap-members.html">List of all members, including inherited members</a></li>

</ul>

<h3>Public Functions</h3>

<ul>

<li><div class="fn"/><b><a href="qglcolormap.html#QGLColormap">QGLColormap</a></b> ()</li>

<li><div class="fn"/><b><a href="qglcolormap.html#QGLColormap-2">QGLColormap</a></b> ( const QGLColormap & <i>map</i> )</li>

<li><div class="fn"/><b><a href="qglcolormap.html#dtor.QGLColormap">~QGLColormap</a></b> ()</li>

<li><div class="fn"/>void <b><a href="qglcolormap.html#detach">detach</a></b> ()</li>

<li><div class="fn"/>QColor <b><a href="qglcolormap.html#entryColor">entryColor</a></b> ( int <i>idx</i> ) const</li>

<li><div class="fn"/>QRgb <b><a href="qglcolormap.html#entryRgb">entryRgb</a></b> ( int <i>idx</i> ) const</li>

<li><div class="fn"/>int <b><a href="qglcolormap.html#find">find</a></b> ( QRgb <i>color</i> ) const</li>

<li><div class="fn"/>int <b><a href="qglcolormap.html#findNearest">findNearest</a></b> ( QRgb <i>color</i> ) const</li>

<li><div class="fn"/>bool <b><a href="qglcolormap.html#isEmpty">isEmpty</a></b> () const</li>

<li><div class="fn"/>void <b><a href="qglcolormap.html#setEntries">setEntries</a></b> ( int <i>count</i>, const QRgb * <i>colors</i>, int <i>base</i> = 0 )</li>

<li><div class="fn"/>void <b><a href="qglcolormap.html#setEntry">setEntry</a></b> ( int <i>idx</i>, QRgb <i>color</i> )</li>

<li><div class="fn"/>void <b><a href="qglcolormap.html#setEntry-2">setEntry</a></b> ( int <i>idx</i>, const QColor & <i>color</i> )</li>

<li><div class="fn"/>int <b><a href="qglcolormap.html#size">size</a></b> () const</li>

<li><div class="fn"/>QGLColormap & <b><a href="qglcolormap.html#operator-eq">operator=</a></b> ( const QGLColormap & <i>map</i> )</li>

</ul>

<hr />

<h2>Detailed Description</h2>

<p>The QGLColormap class is used for installing custom colormaps into QGLWidgets.</p>

<p>QGLColormap provides a platform independent way of specifying and installing indexed colormaps into QGLWidgets. QGLColormap is especially useful when using the <a href="opengl.html">OpenGL</a> color-index mode.</p>

<p>Under <a href="winsystem.html#x11">X11</a> you must use an X server that supports either a <tt>PseudoColor</tt> or <tt>DirectColor</tt> visual class. If your X server currently only provides a <tt>GrayScale</tt>, <tt>TrueColor</tt>, <tt>StaticColor</tt> or <tt>StaticGray</tt> visual, you will not be able to allocate colorcells for writing. If this is the case, try setting your X server to 8 bit mode. It should then provide you with at least a <tt>PseudoColor</tt> visual. Note that you may experience colormap flashing if your X server is running in 8 bit mode.</p>

<p>Under Windows the size of the colormap is always set to 256 colors. Note that under Windows you can also install colormaps in child widgets.</p>

<p>This class uses explicit sharing (see <a href="shclass.html">Shared Classes</a>).</p>

<p>Example of use:</p>

<pre>  #include <qapplication.h>

#include <qglcolormap.h>

int main()

{

QApplication a(argc, argv);

MySuperGLWidget widget(0); // A QGLWidget in color-index mode

QGLColormap colormap;

// This will fill the colormap with colors ranging from

// black to white.

for (int i = 0; i < colormap.size(); i++)

colormap.setEntry(i, qRgb(i, i, i));

widget.setColormap(colormap);

widget.show();

return a.exec();

}</pre>

<p>See also <a href="qglwidget.html#setColormap">QGLWidget::setColormap</a>() and <a href="qglwidget.html#colormap">QGLWidget::colormap</a>().</p>

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="QGLColormap"></a>QGLColormap::QGLColormap ()</h3>

<p>Construct a <a href="qglcolormap.html">QGLColormap</a>.</p>

<h3 class="fn"><a name="QGLColormap-2"></a>QGLColormap::QGLColormap ( const QGLColormap & <i>map</i> )</h3>

<p>Construct a shallow copy of <i>map</i>.</p>

<h3 class="fn"><a name="dtor.QGLColormap"></a>QGLColormap::~QGLColormap ()</h3>

<p>Dereferences the <a href="qglcolormap.html">QGLColormap</a> and deletes it if this was the last reference to it.</p>

<h3 class="fn"><a name="detach"></a>void QGLColormap::detach ()</h3>

<p>Detaches this <a href="qglcolormap.html">QGLColormap</a> from the shared block.</p>

<h3 class="fn"><a name="entryColor"></a><a href="qcolor.html">QColor</a> QGLColormap::entryColor ( int <i>idx</i> ) const</h3>

<p>Returns the QRgb value in the colorcell with index <i>idx</i>.</p>

<h3 class="fn"><a name="entryRgb"></a>QRgb QGLColormap::entryRgb ( int <i>idx</i> ) const</h3>

<p>Returns the QRgb value in the colorcell with index <i>idx</i>.</p>

<h3 class="fn"><a name="find"></a>int QGLColormap::find ( QRgb <i>color</i> ) const</h3>

<p>Returns the index of the color <i>color</i>. If <i>color</i> is not in the map, -1 is returned.</p>

<h3 class="fn"><a name="findNearest"></a>int QGLColormap::findNearest ( QRgb <i>color</i> ) const</h3>

<p>Returns the index of the color that is the closest match to color <i>color</i>.</p>

<h3 class="fn"><a name="isEmpty"></a>bool QGLColormap::isEmpty () const</h3>

<p>Returns true if the colormap is empty; otherwise returns false. A colormap with no color values set is considered to be empty.</p>

<h3 class="fn"><a name="setEntries"></a>void QGLColormap::setEntries ( int <i>count</i>, const QRgb * <i>colors</i>, int <i>base</i> = 0 )</h3>

<p>Set an array of cells in this colormap. <i>count</i> is the number of colors that should be set, <i>colors</i> is the array of colors, and <i>base</i> is the starting index.</p>

<h3 class="fn"><a name="setEntry"></a>void QGLColormap::setEntry ( int <i>idx</i>, QRgb <i>color</i> )</h3>

<p>Set cell at index <i>idx</i> in the colormap to color <i>color</i>.</p>

<h3 class="fn"><a name="setEntry-2"></a>void QGLColormap::setEntry ( int <i>idx</i>, const <a href="qcolor.html">QColor</a> & <i>color</i> )</h3>

<p>This is an overloaded member function, provided for convenience. It behaves essentially like the above function.</p>

<p>Set the cell with index <i>idx</i> in the colormap to color <i>color</i>.</p>

100

<h3 class="fn"><a name="size"></a>int QGLColormap::size () const</h3>

101

<p>Returns the number of colorcells in the colormap.</p>

102

<h3 class="fn"><a name="operator-eq"></a>QGLColormap & QGLColormap::operator= ( const QGLColormap & <i>map</i> )</h3>

103

<p>Assign a shallow copy of <i>map</i> to this <a href="qglcolormap.html">QGLColormap</a>.</p>

104

105

106

107

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

108

109

</tr></table></div></address></body>

110

</html>

Older »