updated comments for CHAN_BITS=16 or 32

This commit is contained in:
Brian Paul
2002-03-01 04:23:36 +00:00
parent aa24e9171a
commit 09a0cb464d

View File

@@ -1,4 +1,4 @@
/* $Id: osmesa.c,v 1.73 2002/01/30 16:53:03 brianp Exp $ */
/* $Id: osmesa.c,v 1.74 2002/03/01 04:23:36 brianp Exp $ */
/*
* Mesa 3-D graphics library
@@ -426,21 +426,19 @@ static void compute_row_addresses( OSMesaContext ctx )
* with the lower-left image pixel stored in the first array position
* (ie. bottom-to-top).
*
* Since the only type initially supported is GL_UNSIGNED_BYTE, if the
* context is in RGBA mode, each pixel will be stored as a 4-byte RGBA
* value. If the context is in color indexed mode, each pixel will be
* stored as a 1-byte value.
*
* If the context's viewport hasn't been initialized yet, it will now be
* initialized to (0,0,width,height).
*
* Input: ctx - the rendering context
* buffer - the image buffer memory
* type - data type for pixel components, only GL_UNSIGNED_BYTE
* and GL_UNSIGNED_SHORT_5_6_5 supported now.
* type - data type for pixel components
* Normally, only GL_UNSIGNED_BYTE and GL_UNSIGNED_SHORT_5_6_5
* are supported. But if Mesa's been compiled with CHAN_BITS==16
* then type must be GL_UNSIGNED_SHORT. And if Mesa's been build
* with CHAN_BITS==32 then type must be GL_FLOAT.
* width, height - size of image buffer in pixels, at least 1
* Return: GL_TRUE if success, GL_FALSE if error because of invalid ctx,
* invalid buffer address, type!=GL_UNSIGNED_BYTE, width<1, height<1,
* invalid buffer address, invalid type, width<1, height<1,
* width>internal limit or height>internal limit.
*/
GLAPI GLboolean GLAPIENTRY