include/GL/osmesa.h

   1 /* $Id: osmesa.h,v 1.4 2000/01/18 17:29:18 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   6  *
   7  * Copyright (C) 1999-2000  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27
  28 /*
  29  * Mesa Off-Screen rendering interface.
  30  *
  31  * This is an operating system and window system independent interface to
  32  * Mesa which allows one to render images into a client-supplied buffer in
  33  * main memory.  Such images may manipulated or saved in whatever way the
  34  * client wants.
  35  *
  36  * These are the API functions:
  37  *   OSMesaCreateContext - create a new Off-Screen Mesa rendering context
  38  *   OSMesaMakeCurrent - bind an OSMesaContext to a client's image buffer
  39  *                       and make the specified context the current one.
  40  *   OSMesaDestroyContext - destroy an OSMesaContext
  41  *   OSMesaGetCurrentContext - return thread's current context ID
  42  *   OSMesaPixelStore - controls how pixels are stored in image buffer
  43  *   OSMesaGetIntegerv - return OSMesa state parameters
  44  *
  45  *
  46  * The limits on the width and height of an image buffer are MAX_WIDTH and
  47  * MAX_HEIGHT as defined in Mesa/src/config.h.  Defaults are 1280 and 1024.
  48  * You can increase them as needed but beware that many temporary arrays in
  49  * Mesa are dimensioned by MAX_WIDTH or MAX_HEIGHT.
  50  */
  51
  52
  53 #ifndef OSMESA_H
  54 #define OSMESA_H
  55
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61
  62 #include "GL/gl.h"
  63
  64
  65 #define OSMESA_MAJOR_VERSION 3
  66 #define OSMESA_MINOR_VERSION 3
  67
  68
  69
  70 /*
  71  * Values for the format parameter of OSMesaCreateContext()
  72  * New in version 2.0.
  73  */
  74 #define OSMESA_COLOR_INDEX      GL_COLOR_INDEX
  75 #define OSMESA_RGBA             GL_RGBA
  76 #define OSMESA_BGRA             0x1
  77 #define OSMESA_ARGB             0x2
  78 #define OSMESA_RGB              GL_RGB
  79 #define OSMESA_BGR              0x4
  80
  81
  82 /*
  83  * OSMesaPixelStore() parameters:
  84  * New in version 2.0.
  85  */
  86 #define OSMESA_ROW_LENGTH       0x10
  87 #define OSMESA_Y_UP             0x11
  88
  89
  90 /*
  91  * Accepted by OSMesaGetIntegerv:
  92  */
  93 #define OSMESA_WIDTH            0x20
  94 #define OSMESA_HEIGHT           0x21
  95 #define OSMESA_FORMAT           0x22
  96 #define OSMESA_TYPE             0x23
  97
  98
  99 /*
 100  * Accepted by OSMesaGetBooleanv:
 101  * New in version 3.3
 102  */
 103 /* This is based on the HP proposed extension */
 104 #define OSMESA_OCCLUSION_TEST_RESULT_HP 0x30
 105
 106
 107
 108 typedef struct osmesa_context *OSMesaContext;
 109
 110
 111 #if defined(__BEOS__) || defined(__QUICKDRAW__)
 112 #pragma export on
 113 #endif
 114
 115
 116 /*
 117  * Create an Off-Screen Mesa rendering context.  The only attribute needed is
 118  * an RGBA vs Color-Index mode flag.
 119  *
 120  * Input:  format - one of OSMESA_COLOR_INDEX, OSMESA_RGBA, OSMESA_BGRA,
 121  *                  OSMESA_ARGB, OSMESA_RGB, or OSMESA_BGR.
 122  *         sharelist - specifies another OSMesaContext with which to share
 123  *                     display lists.  NULL indicates no sharing.
 124  * Return:  an OSMesaContext or 0 if error
 125  */
 126 GLAPI OSMesaContext GLAPIENTRY OSMesaCreateContext( GLenum format,
 127                                                     OSMesaContext sharelist );
 128
 129
 130
 131
 132 /*
 133  * Destroy an Off-Screen Mesa rendering context.
 134  *
 135  * Input:  ctx - the context to destroy
 136  */
 137 GLAPI void GLAPIENTRY OSMesaDestroyContext( OSMesaContext ctx );
 138
 139
 140
 141 /*
 142  * Bind an OSMesaContext to an image buffer.  The image buffer is just a
 143  * block of memory which the client provides.  Its size must be at least
 144  * as large as width*height*sizeof(type).  Its address should be a multiple
 145  * of 4 if using RGBA mode.
 146  *
 147  * Image data is stored in the order of glDrawPixels:  row-major order
 148  * with the lower-left image pixel stored in the first array position
 149  * (ie. bottom-to-top).
 150  *
 151  * Since the only type initially supported is GL_UNSIGNED_BYTE, if the
 152  * context is in RGBA mode, each pixel will be stored as a 4-byte RGBA
 153  * value.  If the context is in color indexed mode, each pixel will be
 154  * stored as a 1-byte value.
 155  *
 156  * If the context's viewport hasn't been initialized yet, it will now be
 157  * initialized to (0,0,width,height).
 158  *
 159  * Input:  ctx - the rendering context
 160  *         buffer - the image buffer memory
 161  *         type - data type for pixel components, only GL_UNSIGNED_BYTE
 162  *                supported now
 163  *         width, height - size of image buffer in pixels, at least 1
 164  * Return:  GL_TRUE if success, GL_FALSE if error because of invalid ctx,
 165  *          invalid buffer address, type!=GL_UNSIGNED_BYTE, width<1, height<1,
 166  *          width>internal limit or height>internal limit.
 167  */
 168 GLAPI GLboolean GLAPIENTRY OSMesaMakeCurrent( OSMesaContext ctx,
 169                                               void *buffer, GLenum type,
 170                                               GLsizei width, GLsizei height );
 171
 172
 173
 174
 175 /*
 176  * Return the current Off-Screen Mesa rendering context handle.
 177  */
 178 GLAPI OSMesaContext GLAPIENTRY OSMesaGetCurrentContext( void );
 179
 180
 181
 182 /*
 183  * Set pixel store/packing parameters for the current context.
 184  * This is similar to glPixelStore.
 185  * Input:  pname - OSMESA_ROW_LENGTH
 186  *                    specify actual pixels per row in image buffer
 187  *                    0 = same as image width (default)
 188  *                 OSMESA_Y_UP
 189  *                    zero = Y coordinates increase downward
 190  *                    non-zero = Y coordinates increase upward (default)
 191  *         value - the value for the parameter pname
 192  *
 193  * New in version 2.0.
 194  */
 195 GLAPI void GLAPIENTRY OSMesaPixelStore( GLint pname, GLint value );
 196
 197
 198
 199 /*
 200  * Return an integer value like glGetIntegerv.
 201  * Input:  pname -
 202  *                 OSMESA_WIDTH  return current image width
 203  *                 OSMESA_HEIGHT  return current image height
 204  *                 OSMESA_FORMAT  return image format
 205  *                 OSMESA_TYPE  return color component data type
 206  *                 OSMESA_ROW_LENGTH return row length in pixels
 207  *                 OSMESA_Y_UP returns 1 or 0 to indicate Y axis direction
 208  *         value - pointer to integer in which to return result.
 209  */
 210 GLAPI void GLAPIENTRY OSMesaGetIntegerv( GLint pname, GLint *value );
 211
 212
 213
 214 /*
 215  * Return a boolean value like glGetBooleanv.
 216  * Input:  pname -
 217  *                 OSMESA_OCCLUSION_TEST_RESULT_HP  return current test result
 218  *         value - pointer to boolean in which to return result.
 219  */
 220 GLAPI void GLAPIENTRY OSMesaGetBooleanv( GLint pname, GLboolean *value );
 221
 222
 223
 224 /*
 225  * Return the depth buffer associated with an OSMesa context.
 226  * Input:  c - the OSMesa context
 227  * Output:  width, height - size of buffer in pixels
 228  *          bytesPerValue - bytes per depth value (2 or 4)
 229  *          buffer - pointer to depth buffer values
 230  * Return:  GL_TRUE or GL_FALSE to indicate success or failure.
 231  *
 232  * New in Mesa 2.4.
 233  */
 234 GLAPI GLboolean GLAPIENTRY OSMesaGetDepthBuffer( OSMesaContext c,
 235                                                  GLint *width, GLint *height,
 236                                                  GLint *bytesPerValue,
 237                                                  void **buffer );
 238
 239
 240
 241
 242 #if defined(__BEOS__) || defined(__QUICKDRAW__)
 243 #pragma export off
 244 #endif
 245
 246
 247 #ifdef __cplusplus
 248 }
 249 #endif
 250
 251
 252 #endif