mesa: include mtypes.h less
[mesa.git] / src / mesa / math / m_translate.h
index f15bb77e2d3730d142f90051810589bfb0de479c..62f676ca6d7bdf09b4d9708cdc2867beef56a45f 100644 (file)
@@ -1,10 +1,7 @@
-/* $Id: m_translate.h,v 1.6 2001/03/12 00:48:41 gareth Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  3.5
  *
- * Copyright (C) 1999-2001  Brian Paul   All Rights Reserved.
+ * 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"),
  * 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"
-#include "mtypes.h"            /* hack for GLchan */
-
+#include "main/glheader.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].
+ */
 
 
 extern void _math_trans_1f(GLfloat *to,
-                          CONST void *ptr,
+                          const void *ptr,
                           GLuint stride,
                           GLenum type,
                           GLuint start,
                           GLuint n );
 
 extern void _math_trans_1ui(GLuint *to,
-                           CONST void *ptr,
+                           const void *ptr,
                            GLuint stride,
                            GLenum type,
                            GLuint start,
                            GLuint n );
 
 extern void _math_trans_1ub(GLubyte *to,
-                           CONST void *ptr,
+                           const void *ptr,
                            GLuint stride,
                            GLenum type,
                            GLuint start,
                            GLuint n );
 
 extern void _math_trans_4ub(GLubyte (*to)[4],
-                           CONST void *ptr,
+                           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 );
-
 extern void _math_trans_4us(GLushort (*to)[4],
-                           CONST void *ptr,
+                           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,
+                          const void *ptr,
                           GLuint stride,
                           GLenum type,
                           GLuint size,
                           GLuint start,
                           GLuint n );
 
-extern void _math_trans_3f(GLfloat (*to)[3],
-                          CONST void *ptr,
+/** 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,