Classes - Annotated - Tree - Functions - Home - Structure

QGLColormap Class Reference

The QGLColormap class is used for installing custom colormaps into QGLWidgets. More...

#include <qglcolormap.h>

List of all member functions.

Public Members


Detailed Description

The QGLColormap class is used for installing custom colormaps into QGLWidgets.

QGLColormap provides a platform independent way of specifying and installing indexed colormaps into QGLWidgets. QGLColormap is especially useful when using the OpenGL color-index mode.

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

Under Windows the size of the colormap is always set to 256 colors. Note that under Windows you are allowed to install colormaps into child widgets.

This class uses explicit sharing (see Shared Classes).

Example of use:

  #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->setRgb( i, qRgb( i, i, i ) );
          
      widget.setColormap( colormap );
      widget.show();
      return a.exec();
  }
  

See also QGLWidget::setColormap() and QGLWidget::colormap().


Member Function Documentation

QGLColormap::QGLColormap ()

Construct a QGLColormap.

QGLColormap::QGLColormap ( const QGLColormap & map )

Construct a shallow copy of map.

QGLColormap::~QGLColormap ()

Dereferences the QGLColormap and deletes it if this was the last reference.

void QGLColormap::detach ()

Detaches this QGLColormap from the shared block.

QColor QGLColormap::entryColor ( int idx ) const

Returns the QRgb value in the colorcell with index idx.

QRgb QGLColormap::entryRgb ( int idx ) const

Returns the QRgb value in the colorcell with index idx.

bool QGLColormap::isEmpty () const

Returns TRUE if the colormap is valid, otherwise FALSE.

The most common reason for a colormap to be invalid under X11, is that the X server does not support the visual class that is needed for a read/write colormap. An empty colormap (no color values set) is also considered to be invalid.

QGLColormap & QGLColormap::operator= ( const QGLColormap & map )

Assign a shallow copy of map to this QGLColormap.

void QGLColormap::setEntries ( int base, int count, const QRgb * colors )

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

void QGLColormap::setEntry ( int idx, QRgb color )

Set cell idx in the colormap to color.

void QGLColormap::setEntry ( int idx, const QColor & color )

Set cell with index idx in the colormap to color color.

int QGLColormap::size () const

Returns the number of colorcells in the colormap.

Search the documentation, FAQ, qt-interest archive and more (uses www.trolltech.com):


This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.


Copyright © 2001 TrolltechTrademarks
Qt version 3.0.0-beta1-beta1