diff options
Diffstat (limited to 'doc/html/qglcolormap.html')
| -rw-r--r-- | doc/html/qglcolormap.html | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/doc/html/qglcolormap.html b/doc/html/qglcolormap.html new file mode 100644 index 0000000..e4c6ccb --- /dev/null +++ b/doc/html/qglcolormap.html @@ -0,0 +1,179 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/opengl/qglcolormap.cpp:38 --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>QGLColormap Class</title> +<style type="text/css"><!-- +fn { margin-left: 1cm; text-indent: -1cm; } +a:link { color: #004faf; text-decoration: none } +a:visited { color: #672967; text-decoration: none } +body { background: #ffffff; color: black; } +--></style> +</head> +<body> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr bgcolor="#E5E5E5"> +<td 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="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QGLColormap Class Reference<br><small>[<a href="opengl.html">OpenGL module</a>]</small></h1> + +<p>The QGLColormap class is used for installing custom colormaps into +QGLWidgets. +<a href="#details">More...</a> +<p><tt>#include <<a href="qglcolormap-h.html">qglcolormap.h</a>></tt> +<p><a href="qglcolormap-members.html">List of all member functions.</a> +<h2>Public Members</h2> +<ul> +<li class=fn><a href="#QGLColormap"><b>QGLColormap</b></a> ()</li> +<li class=fn><a href="#QGLColormap-2"><b>QGLColormap</b></a> ( const QGLColormap & map )</li> +<li class=fn><a href="#~QGLColormap"><b>~QGLColormap</b></a> ()</li> +<li class=fn>QGLColormap & <a href="#operator-eq"><b>operator=</b></a> ( const QGLColormap & map )</li> +<li class=fn>bool <a href="#isEmpty"><b>isEmpty</b></a> () const</li> +<li class=fn>int <a href="#size"><b>size</b></a> () const</li> +<li class=fn>void <a href="#detach"><b>detach</b></a> ()</li> +<li class=fn>void <a href="#setEntries"><b>setEntries</b></a> ( int count, const QRgb * colors, int base = 0 )</li> +<li class=fn>void <a href="#setEntry"><b>setEntry</b></a> ( int idx, QRgb color )</li> +<li class=fn>void <a href="#setEntry-2"><b>setEntry</b></a> ( int idx, const QColor & color )</li> +<li class=fn>QRgb <a href="#entryRgb"><b>entryRgb</b></a> ( int idx ) const</li> +<li class=fn>QColor <a href="#entryColor"><b>entryColor</b></a> ( int idx ) const</li> +<li class=fn>int <a href="#find"><b>find</b></a> ( QRgb color ) const</li> +<li class=fn>int <a href="#findNearest"><b>findNearest</b></a> ( QRgb color ) const</li> +</ul> +<hr><a name="details"></a><h2>Detailed Description</h2> + + +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> Under X11 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> 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> This class uses <a href="shclass.html#explicit-sharing">explicit sharing</a> (see <a href="shclass.html">Shared + Classes</a>). +<p> Example of use: +<pre> + #include <<a href="qapplication-h.html">qapplication.h</a>> + #include <<a href="qglcolormap-h.html">qglcolormap.h</a>> + + int main() + { + <a href="qapplication.html">QApplication</a> 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.<a href="#size">size</a>(); i++ ) + colormap.<a href="#setEntry">setEntry</a>( i, qRgb( i, i, i ) ); + + widget.setColormap( colormap ); + widget.show(); + return a.<a href="qapplication.html#exec">exec</a>(); + } + </pre> + +<p> <p>See also <a href="qglwidget.html#setColormap">QGLWidget::setColormap</a>(), <a href="qglwidget.html#colormap">QGLWidget::colormap</a>(), <a href="graphics.html">Graphics Classes</a>, and <a href="images.html">Image Processing Classes</a>. + +<hr><h2>Member Function Documentation</h2> +<h3 class=fn><a name="QGLColormap"></a>QGLColormap::QGLColormap () +</h3> +Construct a QGLColormap. + +<h3 class=fn><a name="QGLColormap-2"></a>QGLColormap::QGLColormap ( const <a href="qglcolormap.html">QGLColormap</a> & map ) +</h3> +Construct a <a href="shclass.html#shallow-copy">shallow copy</a> of <em>map</em>. + +<h3 class=fn><a name="~QGLColormap"></a>QGLColormap::~QGLColormap () +</h3> +Dereferences the QGLColormap and deletes it if this was the last +reference to it. + +<h3 class=fn>void <a name="detach"></a>QGLColormap::detach () +</h3> +Detaches this QGLColormap from the shared block. + +<h3 class=fn><a href="qcolor.html">QColor</a> <a name="entryColor"></a>QGLColormap::entryColor ( int idx ) const +</h3> +Returns the QRgb value in the colorcell with index <em>idx</em>. + +<h3 class=fn>QRgb <a name="entryRgb"></a>QGLColormap::entryRgb ( int idx ) const +</h3> +Returns the QRgb value in the colorcell with index <em>idx</em>. + +<h3 class=fn>int <a name="find"></a>QGLColormap::find ( QRgb color ) const +</h3> +Returns the index of the color <em>color</em>. If <em>color</em> is not in the +map, -1 is returned. + +<h3 class=fn>int <a name="findNearest"></a>QGLColormap::findNearest ( QRgb color ) const +</h3> +Returns the index of the color that is the closest match to color +<em>color</em>. + +<h3 class=fn>bool <a name="isEmpty"></a>QGLColormap::isEmpty () const +</h3> +Returns TRUE if the colormap is empty; otherwise returns FALSE. A +colormap with no color values set is considered to be empty. + +<h3 class=fn><a href="qglcolormap.html">QGLColormap</a> & <a name="operator-eq"></a>QGLColormap::operator= ( const <a href="qglcolormap.html">QGLColormap</a> & map ) +</h3> +Assign a <a href="shclass.html#shallow-copy">shallow copy</a> of <em>map</em> to this QGLColormap. + +<h3 class=fn>void <a name="setEntries"></a>QGLColormap::setEntries ( int count, const QRgb * colors, int base = 0 ) +</h3> +Set an array of cells in this colormap. <em>count</em> is the number of +colors that should be set, <em>colors</em> is the array of colors, and +<em>base</em> is the starting index. + +<h3 class=fn>void <a name="setEntry"></a>QGLColormap::setEntry ( int idx, QRgb color ) +</h3> +Set cell at index <em>idx</em> in the colormap to color <em>color</em>. + +<h3 class=fn>void <a name="setEntry-2"></a>QGLColormap::setEntry ( int idx, const <a href="qcolor.html">QColor</a> & color ) +</h3> +This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +<p> Set the cell with index <em>idx</em> in the colormap to color <em>color</em>. + +<h3 class=fn>int <a name="size"></a>QGLColormap::size () const +</h3> +Returns the number of colorcells in the colormap. + +<!-- eof --> +<hr><p> +This file is part of the <a href="index.html">Qt toolkit</a>. +Copyright © 1995-2007 +<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center> +<table width=100% cellspacing=0 border=0><tr> +<td>Copyright © 2007 +<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a> +<td align=right><div align=right>Qt 3.3.8</div> +</table></div></address></body> +</html> |