src/mesa/drivers/common/meta.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 #ifndef META_H
  27 #define META_H
  28
  29 #include "main/mtypes.h"
  30
  31 /**
  32  * \name Flags for meta operations
  33  * \{
  34  *
  35  * These flags are passed to _mesa_meta_begin().
  36  */
  37 #define MESA_META_ALL                      ~0x0
  38 #define MESA_META_ALPHA_TEST                0x1
  39 #define MESA_META_BLEND                     0x2  /**< includes logicop */
  40 #define MESA_META_COLOR_MASK                0x4
  41 #define MESA_META_DEPTH_TEST                0x8
  42 #define MESA_META_FOG                      0x10
  43 #define MESA_META_PIXEL_STORE              0x20
  44 #define MESA_META_PIXEL_TRANSFER           0x40
  45 #define MESA_META_RASTERIZATION            0x80
  46 #define MESA_META_SCISSOR                 0x100
  47 #define MESA_META_SHADER                  0x200
  48 #define MESA_META_STENCIL_TEST            0x400
  49 #define MESA_META_TRANSFORM               0x800 /**< modelview/projection matrix state */
  50 #define MESA_META_TEXTURE                0x1000
  51 #define MESA_META_VERTEX                 0x2000
  52 #define MESA_META_VIEWPORT               0x4000
  53 #define MESA_META_CLAMP_FRAGMENT_COLOR   0x8000
  54 #define MESA_META_CLAMP_VERTEX_COLOR    0x10000
  55 #define MESA_META_CONDITIONAL_RENDER    0x20000
  56 #define MESA_META_CLIP                  0x40000
  57 #define MESA_META_SELECT_FEEDBACK       0x80000
  58 #define MESA_META_MULTISAMPLE          0x100000
  59 #define MESA_META_FRAMEBUFFER_SRGB     0x200000
  60 #define MESA_META_OCCLUSION_QUERY      0x400000
  61 /**\}*/
  62
  63 /**
  64  * State which we may save/restore across meta ops.
  65  * XXX this may be incomplete...
  66  */
  67 struct save_state
  68 {
  69    GLbitfield SavedState;  /**< bitmask of MESA_META_* flags */
  70
  71    /* Always saved/restored with meta. */
  72    gl_api API;
  73
  74    /** MESA_META_CLEAR (and others?) */
  75    struct gl_query_object *CurrentOcclusionObject;
  76
  77    /** MESA_META_ALPHA_TEST */
  78    GLboolean AlphaEnabled;
  79    GLenum AlphaFunc;
  80    GLclampf AlphaRef;
  81
  82    /** MESA_META_BLEND */
  83    GLbitfield BlendEnabled;
  84    GLboolean ColorLogicOpEnabled;
  85
  86    /** MESA_META_COLOR_MASK */
  87    GLubyte ColorMask[MAX_DRAW_BUFFERS][4];
  88
  89    /** MESA_META_DEPTH_TEST */
  90    struct gl_depthbuffer_attrib Depth;
  91
  92    /** MESA_META_FOG */
  93    GLboolean Fog;
  94
  95    /** MESA_META_PIXEL_STORE */
  96    struct gl_pixelstore_attrib Pack, Unpack;
  97
  98    /** MESA_META_PIXEL_TRANSFER */
  99    GLfloat RedBias, RedScale;
 100    GLfloat GreenBias, GreenScale;
 101    GLfloat BlueBias, BlueScale;
 102    GLfloat AlphaBias, AlphaScale;
 103    GLfloat DepthBias, DepthScale;
 104    GLboolean MapColorFlag;
 105
 106    /** MESA_META_RASTERIZATION */
 107    GLenum FrontPolygonMode, BackPolygonMode;
 108    GLboolean PolygonOffset;
 109    GLboolean PolygonSmooth;
 110    GLboolean PolygonStipple;
 111    GLboolean PolygonCull;
 112
 113    /** MESA_META_SCISSOR */
 114    struct gl_scissor_attrib Scissor;
 115
 116    /** MESA_META_SHADER */
 117    GLboolean VertexProgramEnabled;
 118    struct gl_vertex_program *VertexProgram;
 119    GLboolean FragmentProgramEnabled;
 120    struct gl_fragment_program *FragmentProgram;
 121    GLboolean ATIFragmentShaderEnabled;
 122    struct gl_shader_program *Shader[MESA_SHADER_STAGES];
 123    struct gl_shader_program *ActiveShader;
 124    struct gl_pipeline_object   *_Shader;
 125    struct gl_pipeline_object   *Pipeline;
 126
 127    /** MESA_META_STENCIL_TEST */
 128    struct gl_stencil_attrib Stencil;
 129
 130    /** MESA_META_TRANSFORM */
 131    GLenum MatrixMode;
 132    GLfloat ModelviewMatrix[16];
 133    GLfloat ProjectionMatrix[16];
 134    GLfloat TextureMatrix[16];
 135
 136    /** MESA_META_CLIP */
 137    GLbitfield ClipPlanesEnabled;
 138
 139    /** MESA_META_TEXTURE */
 140    GLuint ActiveUnit;
 141    GLuint ClientActiveUnit;
 142    /** for unit[0] only */
 143    struct gl_texture_object *CurrentTexture[NUM_TEXTURE_TARGETS];
 144    /** mask of TEXTURE_2D_BIT, etc */
 145    GLbitfield TexEnabled[MAX_TEXTURE_UNITS];
 146    GLbitfield TexGenEnabled[MAX_TEXTURE_UNITS];
 147    GLuint EnvMode;  /* unit[0] only */
 148
 149    /** MESA_META_VERTEX */
 150    struct gl_vertex_array_object *VAO;
 151    struct gl_buffer_object *ArrayBufferObj;
 152
 153    /** MESA_META_VIEWPORT */
 154    GLfloat ViewportX, ViewportY, ViewportW, ViewportH;
 155    GLclampd DepthNear, DepthFar;
 156
 157    /** MESA_META_CLAMP_FRAGMENT_COLOR */
 158    GLenum ClampFragmentColor;
 159
 160    /** MESA_META_CLAMP_VERTEX_COLOR */
 161    GLenum ClampVertexColor;
 162
 163    /** MESA_META_CONDITIONAL_RENDER */
 164    struct gl_query_object *CondRenderQuery;
 165    GLenum CondRenderMode;
 166
 167    /** MESA_META_SELECT_FEEDBACK */
 168    GLenum RenderMode;
 169    struct gl_selection Select;
 170    struct gl_feedback Feedback;
 171
 172    /** MESA_META_MULTISAMPLE */
 173    struct gl_multisample_attrib Multisample;
 174
 175    /** MESA_META_FRAMEBUFFER_SRGB */
 176    GLboolean sRGBEnabled;
 177
 178    /** Miscellaneous (always disabled) */
 179    GLboolean Lighting;
 180    GLboolean RasterDiscard;
 181    GLboolean TransformFeedbackNeedsResume;
 182
 183    GLuint DrawBufferName, ReadBufferName, RenderbufferName;
 184 };
 185
 186 /**
 187  * Temporary texture used for glBlitFramebuffer, glDrawPixels, etc.
 188  * This is currently shared by all the meta ops.  But we could create a
 189  * separate one for each of glDrawPixel, glBlitFramebuffer, glCopyPixels, etc.
 190  */
 191 struct temp_texture
 192 {
 193    GLuint TexObj;
 194    GLenum Target;         /**< GL_TEXTURE_2D or GL_TEXTURE_RECTANGLE */
 195    GLsizei MinSize;       /**< Min texture size to allocate */
 196    GLsizei MaxSize;       /**< Max possible texture size */
 197    GLboolean NPOT;        /**< Non-power of two size OK? */
 198    GLsizei Width, Height; /**< Current texture size */
 199    GLenum IntFormat;
 200    GLfloat Sright, Ttop;  /**< right, top texcoords */
 201 };
 202
 203 /**
 204  * State for GLSL texture sampler which is used to generate fragment
 205  * shader in _mesa_meta_generate_mipmap().
 206  */
 207 struct blit_shader {
 208    const char *type;
 209    const char *func;
 210    const char *texcoords;
 211    GLuint shader_prog;
 212 };
 213
 214 /**
 215  * Table of all sampler types and shaders for accessing them.
 216  */
 217 struct blit_shader_table {
 218    struct blit_shader sampler_1d;
 219    struct blit_shader sampler_2d;
 220    struct blit_shader sampler_3d;
 221    struct blit_shader sampler_rect;
 222    struct blit_shader sampler_cubemap;
 223    struct blit_shader sampler_1d_array;
 224    struct blit_shader sampler_2d_array;
 225    struct blit_shader sampler_cubemap_array;
 226 };
 227
 228 /**
 229  * Indices in the blit_state->msaa_shaders[] array
 230  *
 231  * Note that setup_glsl_msaa_blit_shader() assumes that the _INT enums are one
 232  * more than the non-_INT version and _UINT is one beyond that.
 233  */
 234 enum blit_msaa_shader {
 235    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE,
 236    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE_INT,
 237    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE_UINT,
 238    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY,
 239    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY_INT,
 240    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY_UINT,
 241    BLIT_MSAA_SHADER_2D_MULTISAMPLE_DEPTH_RESOLVE,
 242    BLIT_MSAA_SHADER_2D_MULTISAMPLE_DEPTH_COPY,
 243    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE,
 244    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE_INT,
 245    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE_UINT,
 246    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY,
 247    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY_INT,
 248    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY_UINT,
 249    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_DEPTH_RESOLVE,
 250    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_DEPTH_COPY,
 251    BLIT_MSAA_SHADER_COUNT,
 252 };
 253
 254 /**
 255  * State for glBlitFramebufer()
 256  */
 257 struct blit_state
 258 {
 259    GLuint VAO;
 260    GLuint VBO;
 261    struct blit_shader_table shaders;
 262    GLuint msaa_shaders[BLIT_MSAA_SHADER_COUNT];
 263    struct temp_texture depthTex;
 264    bool no_ctsi_fallback;
 265 };
 266
 267
 268 /**
 269  * State for glClear()
 270  */
 271 struct clear_state
 272 {
 273    GLuint VAO;
 274    GLuint VBO;
 275    GLuint ShaderProg;
 276    GLint ColorLocation;
 277    GLint LayerLocation;
 278
 279    GLuint IntegerShaderProg;
 280    GLint IntegerColorLocation;
 281    GLint IntegerLayerLocation;
 282 };
 283
 284
 285 /**
 286  * State for glCopyPixels()
 287  */
 288 struct copypix_state
 289 {
 290    GLuint VAO;
 291    GLuint VBO;
 292 };
 293
 294
 295 /**
 296  * State for glDrawPixels()
 297  */
 298 struct drawpix_state
 299 {
 300    GLuint VAO;
 301    GLuint VBO;
 302
 303    GLuint StencilFP;  /**< Fragment program for drawing stencil images */
 304    GLuint DepthFP;  /**< Fragment program for drawing depth images */
 305 };
 306
 307
 308 /**
 309  * State for glBitmap()
 310  */
 311 struct bitmap_state
 312 {
 313    GLuint VAO;
 314    GLuint VBO;
 315    struct temp_texture Tex;  /**< separate texture from other meta ops */
 316 };
 317
 318 /**
 319  * State for _mesa_meta_generate_mipmap()
 320  */
 321 struct gen_mipmap_state
 322 {
 323    GLuint VAO;
 324    GLuint VBO;
 325    GLuint FBO;
 326    GLuint Sampler;
 327
 328    struct blit_shader_table shaders;
 329 };
 330
 331 /**
 332  * State for texture decompression
 333  */
 334 struct decompress_state
 335 {
 336    GLuint VAO;
 337    GLuint VBO, FBO, RBO, Sampler;
 338    GLint Width, Height;
 339
 340    struct blit_shader_table shaders;
 341 };
 342
 343 /**
 344  * State for glDrawTex()
 345  */
 346 struct drawtex_state
 347 {
 348    GLuint VAO;
 349    GLuint VBO;
 350 };
 351
 352 #define MAX_META_OPS_DEPTH      8
 353 /**
 354  * All per-context meta state.
 355  */
 356 struct gl_meta_state
 357 {
 358    /** Stack of state saved during meta-ops */
 359    struct save_state Save[MAX_META_OPS_DEPTH];
 360    /** Save stack depth */
 361    GLuint SaveStackDepth;
 362
 363    struct temp_texture TempTex;
 364
 365    struct blit_state Blit;    /**< For _mesa_meta_BlitFramebuffer() */
 366    struct clear_state Clear;  /**< For _mesa_meta_Clear() */
 367    struct copypix_state CopyPix;  /**< For _mesa_meta_CopyPixels() */
 368    struct drawpix_state DrawPix;  /**< For _mesa_meta_DrawPixels() */
 369    struct bitmap_state Bitmap;    /**< For _mesa_meta_Bitmap() */
 370    struct gen_mipmap_state Mipmap;    /**< For _mesa_meta_GenerateMipmap() */
 371    struct decompress_state Decompress;  /**< For texture decompression */
 372    struct drawtex_state DrawTex;  /**< For _mesa_meta_DrawTex() */
 373 };
 374
 375 struct vertex {
 376    GLfloat x, y, z, tex[4];
 377    GLfloat r, g, b, a;
 378 };
 379
 380 extern void
 381 _mesa_meta_init(struct gl_context *ctx);
 382
 383 extern void
 384 _mesa_meta_free(struct gl_context *ctx);
 385
 386 extern void
 387 _mesa_meta_begin(struct gl_context *ctx, GLbitfield state);
 388
 389 extern void
 390 _mesa_meta_end(struct gl_context *ctx);
 391
 392 extern GLboolean
 393 _mesa_meta_in_progress(struct gl_context *ctx);
 394
 395 extern void
 396 _mesa_meta_BlitFramebuffer(struct gl_context *ctx,
 397                            GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
 398                            GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
 399                            GLbitfield mask, GLenum filter);
 400
 401 extern void
 402 _mesa_meta_Clear(struct gl_context *ctx, GLbitfield buffers);
 403
 404 extern void
 405 _mesa_meta_glsl_Clear(struct gl_context *ctx, GLbitfield buffers);
 406
 407 extern void
 408 _mesa_meta_CopyPixels(struct gl_context *ctx, GLint srcx, GLint srcy,
 409                       GLsizei width, GLsizei height,
 410                       GLint dstx, GLint dsty, GLenum type);
 411
 412 extern void
 413 _mesa_meta_DrawPixels(struct gl_context *ctx,
 414                       GLint x, GLint y, GLsizei width, GLsizei height,
 415                       GLenum format, GLenum type,
 416                       const struct gl_pixelstore_attrib *unpack,
 417                       const GLvoid *pixels);
 418
 419 extern void
 420 _mesa_meta_Bitmap(struct gl_context *ctx,
 421                   GLint x, GLint y, GLsizei width, GLsizei height,
 422                   const struct gl_pixelstore_attrib *unpack,
 423                   const GLubyte *bitmap);
 424
 425 extern void
 426 _mesa_meta_GenerateMipmap(struct gl_context *ctx, GLenum target,
 427                           struct gl_texture_object *texObj);
 428
 429 extern void
 430 _mesa_meta_CopyTexSubImage(struct gl_context *ctx, GLuint dims,
 431                            struct gl_texture_image *texImage,
 432                            GLint xoffset, GLint yoffset, GLint slice,
 433                            struct gl_renderbuffer *rb,
 434                            GLint x, GLint y,
 435                            GLsizei width, GLsizei height);
 436
 437 extern void
 438 _mesa_meta_GetTexImage(struct gl_context *ctx,
 439                        GLenum format, GLenum type, GLvoid *pixels,
 440                        struct gl_texture_image *texImage);
 441
 442 extern void
 443 _mesa_meta_DrawTex(struct gl_context *ctx, GLfloat x, GLfloat y, GLfloat z,
 444                    GLfloat width, GLfloat height);
 445
 446 /* meta-internal functions */
 447 GLuint
 448 _mesa_meta_compile_shader_with_debug(struct gl_context *ctx, GLenum target,
 449                                      const GLcharARB *source);
 450
 451
 452 GLuint
 453 _mesa_meta_link_program_with_debug(struct gl_context *ctx, GLuint program);
 454
 455 GLboolean
 456 _mesa_meta_alloc_texture(struct temp_texture *tex,
 457                          GLsizei width, GLsizei height, GLenum intFormat);
 458
 459 void
 460 _mesa_meta_setup_texture_coords(GLenum faceTarget,
 461                                 GLint slice,
 462                                 GLint width,
 463                                 GLint height,
 464                                 GLint depth,
 465                                 GLfloat coords0[4],
 466                                 GLfloat coords1[4],
 467                                 GLfloat coords2[4],
 468                                 GLfloat coords3[4]);
 469
 470 struct temp_texture *
 471 _mesa_meta_get_temp_texture(struct gl_context *ctx);
 472
 473 struct temp_texture *
 474 _mesa_meta_get_temp_depth_texture(struct gl_context *ctx);
 475
 476 void
 477 _mesa_meta_setup_vertex_objects(GLuint *VAO, GLuint *VBO,
 478                                 bool use_generic_attributes,
 479                                 unsigned vertex_size, unsigned texcoord_size,
 480                                 unsigned color_size);
 481
 482 void
 483 _mesa_meta_setup_ff_tnl_for_blit(GLuint *VAO, GLuint *VBO,
 484                                  unsigned texcoord_size);
 485
 486 void
 487 _mesa_meta_setup_drawpix_texture(struct gl_context *ctx,
 488                                  struct temp_texture *tex,
 489                                  GLboolean newTex,
 490                                  GLsizei width, GLsizei height,
 491                                  GLenum format, GLenum type,
 492                                  const GLvoid *pixels);
 493
 494 void
 495 _mesa_meta_setup_copypix_texture(struct gl_context *ctx,
 496                                  struct temp_texture *tex,
 497                                  GLint srcX, GLint srcY,
 498                                  GLsizei width, GLsizei height,
 499                                  GLenum intFormat,
 500                                  GLenum filter);
 501
 502 void
 503 _mesa_meta_setup_blit_shader(struct gl_context *ctx,
 504                              GLenum target,
 505                              struct blit_shader_table *table);
 506
 507 void
 508 _mesa_meta_glsl_blit_cleanup(struct blit_state *blit);
 509
 510 void
 511 _mesa_meta_blit_shader_table_cleanup(struct blit_shader_table *table);
 512
 513 void
 514 _mesa_meta_glsl_generate_mipmap_cleanup(struct gen_mipmap_state *mipmap);
 515
 516 void
 517 _mesa_meta_bind_fbo_image(GLenum attachment,
 518                           struct gl_texture_image *texImage, GLuint layer);
 519
 520 #endif /* META_H */