X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fmesa%2Fmain%2Fcontext.h;h=c59a8b2118671c5ae06e4f81141a50d177b708a4;hb=c1f2f9090bcca309b9aeef7ae57acc280704db81;hp=23cd7e11047cf9e3065fd22f1529c7e7a0509ded;hpb=d09a1d8b29ae5841ae39b5c24c3f4693dd750559;p=mesa.git diff --git a/src/mesa/main/context.h b/src/mesa/main/context.h index 23cd7e11047..c59a8b21186 100644 --- a/src/mesa/main/context.h +++ b/src/mesa/main/context.h @@ -1,10 +1,29 @@ -/* $Id: context.h,v 1.31 2002/06/13 04:49:17 brianp Exp $ */ +/** + * \file context.h + * Mesa context/visual/framebuffer management functions. + * + * There are three Mesa data types 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 + * 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 data types. + */ /* * Mesa 3-D graphics library - * Version: 4.1 + * Version: 6.1 * - * Copyright (C) 1999-2001 Brian Paul All Rights Reserved. + * Copyright (C) 1999-2004 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"), @@ -30,31 +49,14 @@ #include "glapi.h" +#include "imports.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. - * - * These types should be encapsulated by corresponding device driver - * datatypes. 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. - */ - - -/* - * Create/destroy a GLvisual. - */ +/**********************************************************************/ +/** \name Create/destroy a GLvisual. */ +/*@{*/ + extern GLvisual * _mesa_create_visual( GLboolean rgbFlag, GLboolean dbFlag, @@ -93,11 +95,13 @@ _mesa_initialize_visual( GLvisual *v, extern void _mesa_destroy_visual( GLvisual *vis ); +/*@}*/ -/* - * Create/destroy a GLframebuffer. - */ +/**********************************************************************/ +/** \name Create/destroy a GLframebuffer. */ +/*@{*/ + extern GLframebuffer * _mesa_create_framebuffer( const GLvisual *visual, GLboolean softwareDepth, @@ -119,21 +123,25 @@ _mesa_free_framebuffer_data( GLframebuffer *buffer ); extern void _mesa_destroy_framebuffer( GLframebuffer *buffer ); +/*@}*/ -/* - * Create/destroy a GLcontext. - */ +/**********************************************************************/ +/** \name 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_free_context_data( GLcontext *ctx ); @@ -158,10 +166,21 @@ _mesa_make_current2( GLcontext *ctx, GLframebuffer *drawBuffer, extern GLcontext * _mesa_get_current_context(void); +/*@}*/ -/* - * Macros for fetching current context. +/** + * Macro for declaration and fetching the current context. + * + * \param C local variable which will hold the current context. + * + * It should be used in the variable declaration area of a function: + * \code + * ... + * { + * GET_CURRENT_CONTEXT(ctx); + * ... + * \endcode */ #ifdef THREADS @@ -175,7 +194,9 @@ _mesa_get_current_context(void); -/* OpenGL SI-style export functions. */ +/**********************************************************************/ +/** \name OpenGL SI-style export functions. */ +/*@{*/ extern GLboolean _mesa_destroyContext(__GLcontext *gc); @@ -213,40 +234,162 @@ _mesa_beginDispatchOverride(__GLcontext *gc); extern void _mesa_endDispatchOverride(__GLcontext *gc); +/*@}*/ + + +extern struct _glapi_table * +_mesa_get_dispatch(GLcontext *ctx); + +/**********************************************************************/ +/** \name Miscellaneous */ +/*@{*/ extern void -_mesa_swapbuffers(GLcontext *ctx); +_mesa_record_error( GLcontext *ctx, GLenum error ); -extern struct _glapi_table * -_mesa_get_dispatch(GLcontext *ctx); +extern void GLAPIENTRY +_mesa_Finish( void ); +extern void GLAPIENTRY +_mesa_Flush( void ); -/* - * Miscellaneous +/*@}*/ + + + +/**********************************************************************/ +/** \name Macros for contexts/flushing. */ +/*@{*/ + + +/** + * 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, "begin/end" ); \ + 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, "begin/end" ); \ + 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_problem( const GLcontext *ctx, const char *s ); -extern void -_mesa_warning( const GLcontext *ctx, const char *s ); +/*@}*/ -extern void -_mesa_error( GLcontext *ctx, GLenum error, const char *s ); -extern void -_mesa_debug( const char *fmtString, ... ); +/** + * Macros to help evaluate current state conditions + */ +/*@{*/ -extern void -_mesa_Finish( 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._Enabled && \ + ((CTX)->VertexProgram.Current->InputsRead & VERT_BIT_COLOR1)) \ + || ((CTX)->FragmentProgram._Enabled && \ + ((CTX)->FragmentProgram.Current->InputsRead & FRAG_BIT_COL1)) \ + ) + + +/** + * Is two-sided lighting in effect? + */ +#define NEED_TWO_SIDED_LIGHTING(CTX) \ + (ctx->Light.Enabled && ctx->Light.Model.TwoSide) -extern void -_mesa_Flush( void ); + +/*@}*/ #endif