mesa: update_arrays() depends on program state.
[mesa.git] / src / mesa / main / context.h
index 49555ff6e2c5e00bdf386570f17f82097d7f1362..09bf1777dabcfeaa31efcbdc7ce049849dd28c0a 100644 (file)
@@ -1,10 +1,8 @@
-/* $Id: context.h,v 1.29 2002/06/13 04:28:29 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  4.1
+ * Version:  6.5.1
  *
- * 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"),
  */
 
 
-#ifndef CONTEXT_H
-#define CONTEXT_H
-
-
-#include "glapi.h"
-#include "mtypes.h"
-
-
-/*
- * There are three Mesa datatypes which are meant to be used by device
- * drivers:
- *   GLcontext:  this contains the Mesa rendering state
- *   GLvisual:  this describes the color buffer (rgb vs. ci), whether
- *              or not there's a depth buffer, stencil buffer, etc.
- *   GLframebuffer:  contains pointers to the depth buffer, stencil
- *                   buffer, accum buffer and alpha buffers.
+/**
+ * \file context.h
+ * Mesa context and visual-related functions.
+ *
+ * There are three large Mesa data types/classes which are meant to be
+ * used by device drivers:
+ * - GLcontext: this contains the Mesa rendering state
+ * - GLvisual:  this describes the color buffer (RGB vs. ci), whether or not
+ *   there's a depth buffer, stencil buffer, etc.
+ * - GLframebuffer:  contains pointers to the depth buffer, stencil buffer,
+ *   accum buffer and alpha buffers.
  *
  * These types should be encapsulated by corresponding device driver
- * datatypes.  See xmesa.h and xmesaP.h for an example.
+ * data types.  See xmesa.h and xmesaP.h for an example.
  *
  * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
  * which the device driver must derive from.
  *
- * The following functions create and destroy these datatypes.
+ * The following functions create and destroy these data types.
  */
 
 
-/*
- * Create/destroy a GLvisual.
- */
+#ifndef CONTEXT_H
+#define CONTEXT_H
+
+
+#include "imports.h"
+#include "mtypes.h"
+
+
+struct _glapi_table;
+
+
+/** \name Visual-related functions */
+/*@{*/
 extern GLvisual *
-_mesa_create_visual( GLboolean rgbFlag,
-                     GLboolean dbFlag,
+_mesa_create_visual( GLboolean dbFlag,
                      GLboolean stereoFlag,
                      GLint redBits,
                      GLint greenBits,
                      GLint blueBits,
                      GLint alphaBits,
-                     GLint indexBits,
                      GLint depthBits,
                      GLint stencilBits,
                      GLint accumRedBits,
@@ -74,14 +76,12 @@ _mesa_create_visual( GLboolean rgbFlag,
 
 extern GLboolean
 _mesa_initialize_visual( GLvisual *v,
-                         GLboolean rgbFlag,
                          GLboolean dbFlag,
                          GLboolean stereoFlag,
                          GLint redBits,
                          GLint greenBits,
                          GLint blueBits,
                          GLint alphaBits,
-                         GLint indexBits,
                          GLint depthBits,
                          GLint stencilBits,
                          GLint accumRedBits,
@@ -93,47 +93,27 @@ _mesa_initialize_visual( GLvisual *v,
 extern void
 _mesa_destroy_visual( GLvisual *vis );
 
+/*@}*/
 
 
-/*
- * Create/destroy a GLframebuffer.
- */
-extern GLframebuffer *
-_mesa_create_framebuffer( const GLvisual *visual,
-                          GLboolean softwareDepth,
-                          GLboolean softwareStencil,
-                          GLboolean softwareAccum,
-                          GLboolean softwareAlpha );
+/** \name Context-related functions */
+/*@{*/
 
-extern void
-_mesa_initialize_framebuffer( GLframebuffer *fb,
-                              const GLvisual *visual,
-                              GLboolean softwareDepth,
-                              GLboolean softwareStencil,
-                              GLboolean softwareAccum,
-                              GLboolean softwareAlpha );
-
-extern void
-_mesa_free_framebuffer_data( GLframebuffer *buffer );
-
-extern void
-_mesa_destroy_framebuffer( GLframebuffer *buffer );
-
-
-
-/*
- * Create/destroy a GLcontext.
- */
 extern GLcontext *
 _mesa_create_context( const GLvisual *visual,
                       GLcontext *share_list,
-                      const __GLimports *imports );
+                      const struct dd_function_table *driverFunctions,
+                      void *driverContext );
 
 extern GLboolean
 _mesa_initialize_context( GLcontext *ctx,
                           const GLvisual *visual,
                           GLcontext *share_list,
-                          const __GLimports *imports );
+                          const struct dd_function_table *driverFunctions,
+                          void *driverContext );
+
+extern void
+_mesa_initialize_context_extra(GLcontext *ctx);
 
 extern void
 _mesa_free_context_data( GLcontext *ctx );
@@ -147,106 +127,186 @@ _mesa_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
 
 
 extern void
-_mesa_make_current( GLcontext *ctx, GLframebuffer *buffer );
-
+_mesa_check_init_viewport(GLcontext *ctx, GLuint width, GLuint height);
 
-extern void
-_mesa_make_current2( GLcontext *ctx, GLframebuffer *drawBuffer,
-                     GLframebuffer *readBuffer );
+extern GLboolean
+_mesa_make_current( GLcontext *ctx, GLframebuffer *drawBuffer,
+                    GLframebuffer *readBuffer );
 
+extern GLboolean
+_mesa_share_state(GLcontext *ctx, GLcontext *ctxToShare);
 
 extern GLcontext *
 _mesa_get_current_context(void);
 
+/*@}*/
 
 
-/*
- * Macros for fetching current context.
- */
-#ifdef THREADS
-
-#define GET_CURRENT_CONTEXT(C) GLcontext *C = (GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())
-
-#else
-
-#define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
-
-#endif
-
-
+extern void
+_mesa_notifySwapBuffers(__GLcontext *gc);
 
-/* OpenGL SI-style export functions. */
 
-extern GLboolean
-_mesa_destroyContext(__GLcontext *gc);
+extern struct _glapi_table *
+_mesa_get_dispatch(GLcontext *ctx);
 
-extern GLboolean
-_mesa_loseCurrent(__GLcontext *gc);
 
-extern GLboolean
-_mesa_makeCurrent(__GLcontext *gc);
+void
+_mesa_set_mvp_with_dp4( GLcontext *ctx,
+                        GLboolean flag );
 
-extern GLboolean
-_mesa_shareContext(__GLcontext *gc, __GLcontext *gcShare);
 
 extern GLboolean
-_mesa_copyContext(__GLcontext *dst, const __GLcontext *src, GLuint mask);
+_mesa_valid_to_render(GLcontext *ctx, const char *where);
 
-extern GLboolean
-_mesa_forceCurrent(__GLcontext *gc);
 
-extern GLboolean
-_mesa_notifyResize(__GLcontext *gc);
 
-extern void
-_mesa_notifyDestroy(__GLcontext *gc);
+/** \name Miscellaneous */
+/*@{*/
 
 extern void
-_mesa_notifySwapBuffers(__GLcontext *gc);
+_mesa_record_error( GLcontext *ctx, GLenum error );
 
-extern void
-_mesa_dispatchExec(__GLcontext *gc);
 
 extern void
-_mesa_beginDispatchOverride(__GLcontext *gc);
+_mesa_finish(GLcontext *ctx);
 
 extern void
-_mesa_endDispatchOverride(__GLcontext *gc);
-
-
+_mesa_flush(GLcontext *ctx);
 
 
-extern void
-_mesa_swapbuffers(GLcontext *ctx);
+extern void GLAPIENTRY
+_mesa_Finish( void );
 
-extern struct _glapi_table *
-_mesa_get_dispatch(GLcontext *ctx);
+extern void GLAPIENTRY
+_mesa_Flush( void );
 
+/*@}*/
 
 
-/*
- * Miscellaneous
+/**
+ * \name Macros for flushing buffered rendering commands before state changes,
+ * checking if inside glBegin/glEnd, etc.
  */
+/*@{*/
 
-extern void
-_mesa_problem( const GLcontext *ctx, const char *s );
-
-extern void
-_mesa_warning( const GLcontext *ctx, const char *s );
+/**
+ * Flush vertices.
+ *
+ * \param ctx GL context.
+ * \param newstate new state.
+ *
+ * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
+ * and calls dd_function_table::FlushVertices if so. Marks
+ * __GLcontextRec::NewState with \p newstate.
+ */
+#define FLUSH_VERTICES(ctx, newstate)                          \
+do {                                                           \
+   if (MESA_VERBOSE & VERBOSE_STATE)                           \
+      _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
+   if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)          \
+      ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES);   \
+   ctx->NewState |= newstate;                                  \
+} while (0)
+
+/**
+ * Flush current state.
+ *
+ * \param ctx GL context.
+ * \param newstate new state.
+ *
+ * Checks if dd_function_table::NeedFlush is marked to flush current state,
+ * and calls dd_function_table::FlushVertices if so. Marks
+ * __GLcontextRec::NewState with \p newstate.
+ */
+#define FLUSH_CURRENT(ctx, newstate)                           \
+do {                                                           \
+   if (MESA_VERBOSE & VERBOSE_STATE)                           \
+      _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION);        \
+   if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)           \
+      ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT);    \
+   ctx->NewState |= newstate;                                  \
+} while (0)
+
+/**
+ * Macro to assert that the API call was made outside the
+ * glBegin()/glEnd() pair, with return value.
+ * 
+ * \param ctx GL context.
+ * \param retval value to return value in case the assertion fails.
+ */
+#define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)              \
+do {                                                                   \
+   if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {   \
+      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");  \
+      return retval;                                                   \
+   }                                                                   \
+} while (0)
+
+/**
+ * Macro to assert that the API call was made outside the
+ * glBegin()/glEnd() pair.
+ * 
+ * \param ctx GL context.
+ */
+#define ASSERT_OUTSIDE_BEGIN_END(ctx)                                  \
+do {                                                                   \
+   if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {   \
+      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");  \
+      return;                                                          \
+   }                                                                   \
+} while (0)
+
+/**
+ * Macro to assert that the API call was made outside the
+ * glBegin()/glEnd() pair and flush the vertices.
+ * 
+ * \param ctx GL context.
+ */
+#define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx)                                \
+do {                                                                   \
+   ASSERT_OUTSIDE_BEGIN_END(ctx);                                      \
+   FLUSH_VERTICES(ctx, 0);                                             \
+} while (0)
+
+/**
+ * Macro to assert that the API call was made outside the
+ * glBegin()/glEnd() pair and flush the vertices, with return value.
+ * 
+ * \param ctx GL context.
+ * \param retval value to return value in case the assertion fails.
+ */
+#define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval)    \
+do {                                                                   \
+   ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval);                  \
+   FLUSH_VERTICES(ctx, 0);                                             \
+} while (0)
 
-extern void
-_mesa_error( GLcontext *ctx, GLenum error, const char *s );
+/*@}*/
 
-#ifdef DEBUG
-extern void
-_mesa_debug( const char *fmtString, ... );
-#endif
 
-extern void
-_mesa_Finish( void );
 
-extern void
-_mesa_Flush( void );
+/**
+ * Is the secondary color needed?
+ */
+#define NEED_SECONDARY_COLOR(CTX)                                      \
+   (((CTX)->Light.Enabled &&                                           \
+     (CTX)->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR)    \
+    || (CTX)->Fog.ColorSumEnabled                                      \
+    || ((CTX)->VertexProgram._Current &&                               \
+        ((CTX)->VertexProgram._Current != (CTX)->VertexProgram._TnlProgram) &&    \
+        ((CTX)->VertexProgram._Current->Base.InputsRead & VERT_BIT_COLOR1)) \
+    || ((CTX)->FragmentProgram._Current &&                             \
+        ((CTX)->FragmentProgram._Current != (CTX)->FragmentProgram._TexEnvProgram) &&  \
+        ((CTX)->FragmentProgram._Current->Base.InputsRead & FRAG_BIT_COL1)) \
+   )
+
+
+/**
+ * Is RGBA LogicOp enabled?
+ */
+#define RGBA_LOGICOP_ENABLED(CTX) \
+  ((CTX)->Color.ColorLogicOpEnabled || \
+   ((CTX)->Color.BlendEnabled && (CTX)->Color.BlendEquationRGB == GL_LOGIC_OP))
 
 
-#endif
+#endif /* CONTEXT_H */