NAME

       icetGLSetReadBuffer -- set OpenGL buffer for images

Synopsis

       #include <IceTGL.h>

       void icetGLSetReadBuffer(   GLenum   mode  );

Description

       Set  the  OpenGL  buffer  from  which to read images to composite. After the draw callback
       (specified by icetGLDrawCallback) returns, IceT grabs the rendered image from  the  OpenGL
       buffer  specified by mode.  This buffer is also used to write back fully composited images
       if the ICET_GL_DISPLAY option is on.

       mode is an OpenGL value that specifies the  buffer.  It  is  passed  to  glReadBuffer  and
       glDrawBuffer.   Accepted  values  are GL_FRONT, GL_BACK, GL_LEFT, GL_RIGHT, GL_FRONT_LEFT,
       GL_FRONT_RIGHT, GL_BACK_LEFT, GL_BACK_RIGHT, and any of the GL_AUXi identifiers.

       The current read buffer used is stored in  the  ICET_GL_READ_BUFFER  state  variable.  The
       default value is GL_BACK.

Errors

       ICET_INVALID_OPERATION
               icetGLInitialize has not been called for this IceT context.

       ICET_INVALID_ENUM
               mode is not a known OpenGL buffer identifier.

Warnings

       None.

Bugs

       The  check of mode is perfunctory. It just checks mode against a list of known buffers. It
       does not check to see if the buffer actually exists or for any other buffers that might be
       defined in an OpenGL extension.

Copyright

       Copyright (C)2010 Sandia Corporation

       Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government
       retains certain rights in this software.

       This source code is released under the New BSD License.

See Also

       icetGLDrawCallback(3)

IceT Reference                           August  9, 2010                   icetGLSetReadBuffer(3)