mesa: Restore 78-column wrapping of license text in C-style comments.
[mesa.git] / src / mesa / math / m_translate.h
index a109dfa721b790ddbc135f36f5e05d03a4dd1951..eeb947f292aca2718cea7d195bc36dea2d341e31 100644 (file)
-/* $Id: m_translate.h,v 1.2 2000/11/17 21:01:49 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  3.1
- * 
- * Copyright (C) 1999  Brian Paul   All Rights Reserved.
- * 
+ * Version:  6.5.1
+ *
+ * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  * to deal in the Software without restriction, including without limitation
  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  * and/or sell copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included
  * in all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
- * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
- * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
  */
 
 
 #ifndef _M_TRANSLATE_H_
 #define _M_TRANSLATE_H_
 
-#include "config.h"
-
-
-typedef void (*trans_1f_func)(GLfloat *to,
-                             CONST void *ptr,
-                             GLuint stride,
-                             GLuint start, 
-                             GLuint n );
-
-typedef void (*trans_1ui_func)(GLuint *to,
-                              CONST void *ptr,
-                              GLuint stride,
-                              GLuint start, 
-                              GLuint n );
+#include "main/compiler.h"
+#include "main/glheader.h"
+#include "main/mtypes.h"               /* hack for GLchan */
+#include "swrast/s_chan.h"
+
+/**
+ * Array translation.
+ * For example, convert array of GLushort[3] to GLfloat[4].
+ * The function name specifies the destination format/size.
+ * \param  to  the destination address
+ * \param  ptr  the source address
+ * \param  stride  the source stride (in bytes) between elements
+ * \param  type  the source datatype (GL_SHORT, GL_UNSIGNED_INT, etc)
+ * \param  size  number of values per element in source array (1,2,3 or 4)
+ * \param  start  first element in source array to convert
+ * \param  n  number of elements to convert
+ *
+ * Note: "element" means a tuple like GLfloat[3] or GLubyte[4].
+ */
 
-typedef void (*trans_1ub_func)(GLubyte *to,
-                              CONST void *ptr,
-                              GLuint stride,
-                              GLuint start,
-                              GLuint n );
 
-typedef void (*trans_4ub_func)(GLubyte (*to)[4],
-                              CONST void *ptr,
+extern void _math_trans_1f(GLfloat *to,
+                          const void *ptr,
+                          GLuint stride,
+                          GLenum type,
+                          GLuint start,
+                          GLuint n );
+
+extern void _math_trans_1ui(GLuint *to,
+                           const void *ptr,
+                           GLuint stride,
+                           GLenum type,
+                           GLuint start,
+                           GLuint n );
+
+extern void _math_trans_1ub(GLubyte *to,
+                           const void *ptr,
+                           GLuint stride,
+                           GLenum type,
+                           GLuint start,
+                           GLuint n );
+
+extern void _math_trans_4ub(GLubyte (*to)[4],
+                           const void *ptr,
+                           GLuint stride,
+                           GLenum type,
+                           GLuint size,
+                           GLuint start,
+                           GLuint n );
+
+extern void _math_trans_4chan( GLchan (*to)[4],
+                              const void *ptr,
                               GLuint stride,
+                              GLenum type,
+                              GLuint size,
                               GLuint start,
                               GLuint n );
 
-typedef void (*trans_4f_func)(GLfloat (*to)[4],
-                             CONST void *ptr,
-                             GLuint stride,
-                             GLuint start, 
-                             GLuint n );
-
-typedef void (*trans_3f_func)(GLfloat (*to)[3],
-                             CONST void *ptr,
-                             GLuint stride,
-                             GLuint start, 
-                             GLuint n );
-
-
-
-
-/* Translate GL_UNSIGNED_BYTE, etc to the indexes used in the arrays
- * below.
- */
-#define TYPE_IDX(t) ((t) & 0xf)
-
-#define MAX_TYPES TYPE_IDX(GL_DOUBLE)+1      /* 0xa + 1 */
-
-/* Only useful combinations are defined, thus there is no function to
- * translate eg, ubyte->float or ubyte->ubyte, which are never used.  
- */
-extern trans_1f_func gl_trans_1f_tab[MAX_TYPES];
-extern trans_1ui_func gl_trans_1ui_tab[MAX_TYPES];
-extern trans_1ub_func gl_trans_1ub_tab[MAX_TYPES];
-extern trans_3f_func  gl_trans_3f_tab[MAX_TYPES];
-extern trans_4ub_func gl_trans_4ub_tab[5][MAX_TYPES];
-extern trans_4f_func  gl_trans_4f_tab[5][MAX_TYPES];
-
-
-
-extern void 
-_math_init_translate( void );
+extern void _math_trans_4us(GLushort (*to)[4],
+                           const void *ptr,
+                           GLuint stride,
+                           GLenum type,
+                           GLuint size,
+                           GLuint start,
+                           GLuint n );
+
+/** Convert to floats w/out normalization (i.e. just cast) */
+extern void _math_trans_4f(GLfloat (*to)[4],
+                          const void *ptr,
+                          GLuint stride,
+                          GLenum type,
+                          GLuint size,
+                          GLuint start,
+                          GLuint n );
+
+/** Convert to normalized floats in [0,1] or [-1, 1] */
+extern void _math_trans_4fn(GLfloat (*to)[4],
+                           const void *ptr,
+                           GLuint stride,
+                           GLenum type,
+                           GLuint size,
+                           GLuint start,
+                           GLuint n );
+
+extern void _math_trans_3fn(GLfloat (*to)[3],
+                          const void *ptr,
+                          GLuint stride,
+                          GLenum type,
+                          GLuint start,
+                          GLuint n );
+
+extern void _math_init_translate( void );
 
 
 #endif