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 #define MESA_META_DRAW_BUFFERS         0x800000
  62 /**\}*/
  63
  64 /**
  65  * State which we may save/restore across meta ops.
  66  * XXX this may be incomplete...
  67  */
  68 struct save_state
  69 {
  70    GLbitfield SavedState;  /**< bitmask of MESA_META_* flags */
  71
  72    /* Always saved/restored with meta. */
  73    gl_api API;
  74
  75    /** MESA_META_CLEAR (and others?) */
  76    struct gl_query_object *CurrentOcclusionObject;
  77
  78    /** MESA_META_ALPHA_TEST */
  79    GLboolean AlphaEnabled;
  80    GLenum AlphaFunc;
  81    GLclampf AlphaRef;
  82
  83    /** MESA_META_BLEND */
  84    GLbitfield BlendEnabled;
  85    GLboolean ColorLogicOpEnabled;
  86
  87    /** MESA_META_COLOR_MASK */
  88    GLubyte ColorMask[MAX_DRAW_BUFFERS][4];
  89
  90    /** MESA_META_DEPTH_TEST */
  91    struct gl_depthbuffer_attrib Depth;
  92
  93    /** MESA_META_FOG */
  94    GLboolean Fog;
  95
  96    /** MESA_META_PIXEL_STORE */
  97    struct gl_pixelstore_attrib Pack, Unpack;
  98
  99    /** MESA_META_PIXEL_TRANSFER */
 100    GLfloat RedBias, RedScale;
 101    GLfloat GreenBias, GreenScale;
 102    GLfloat BlueBias, BlueScale;
 103    GLfloat AlphaBias, AlphaScale;
 104    GLfloat DepthBias, DepthScale;
 105    GLboolean MapColorFlag;
 106
 107    /** MESA_META_RASTERIZATION */
 108    GLenum FrontPolygonMode, BackPolygonMode;
 109    GLboolean PolygonOffset;
 110    GLboolean PolygonSmooth;
 111    GLboolean PolygonStipple;
 112    GLboolean PolygonCull;
 113
 114    /** MESA_META_SCISSOR */
 115    struct gl_scissor_attrib Scissor;
 116
 117    /** MESA_META_SHADER */
 118    GLboolean VertexProgramEnabled;
 119    struct gl_vertex_program *VertexProgram;
 120    GLboolean FragmentProgramEnabled;
 121    struct gl_fragment_program *FragmentProgram;
 122    GLboolean ATIFragmentShaderEnabled;
 123    struct gl_shader_program *Shader[MESA_SHADER_STAGES];
 124    struct gl_shader_program *ActiveShader;
 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    /** MESA_META_DRAW_BUFFERS */
 186    GLenum ColorDrawBuffers[MAX_DRAW_BUFFERS];
 187 };
 188
 189 /**
 190  * Temporary texture used for glBlitFramebuffer, glDrawPixels, etc.
 191  * This is currently shared by all the meta ops.  But we could create a
 192  * separate one for each of glDrawPixel, glBlitFramebuffer, glCopyPixels, etc.
 193  */
 194 struct temp_texture
 195 {
 196    GLuint TexObj;
 197    GLenum Target;         /**< GL_TEXTURE_2D or GL_TEXTURE_RECTANGLE */
 198    GLsizei MinSize;       /**< Min texture size to allocate */
 199    GLsizei MaxSize;       /**< Max possible texture size */
 200    GLboolean NPOT;        /**< Non-power of two size OK? */
 201    GLsizei Width, Height; /**< Current texture size */
 202    GLenum IntFormat;
 203    GLfloat Sright, Ttop;  /**< right, top texcoords */
 204 };
 205
 206 /**
 207  * State for GLSL texture sampler which is used to generate fragment
 208  * shader in _mesa_meta_generate_mipmap().
 209  */
 210 struct blit_shader {
 211    const char *type;
 212    const char *func;
 213    const char *texcoords;
 214    GLuint shader_prog;
 215 };
 216
 217 /**
 218  * Table of all sampler types and shaders for accessing them.
 219  */
 220 struct blit_shader_table {
 221    struct blit_shader sampler_1d;
 222    struct blit_shader sampler_2d;
 223    struct blit_shader sampler_3d;
 224    struct blit_shader sampler_rect;
 225    struct blit_shader sampler_cubemap;
 226    struct blit_shader sampler_1d_array;
 227    struct blit_shader sampler_2d_array;
 228    struct blit_shader sampler_cubemap_array;
 229 };
 230
 231 /**
 232  * Indices in the blit_state->msaa_shaders[] array
 233  *
 234  * Note that setup_glsl_msaa_blit_shader() assumes that the _INT enums are one
 235  * more than the non-_INT version and _UINT is one beyond that.
 236  */
 237 enum blit_msaa_shader {
 238    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE,
 239    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE_INT,
 240    BLIT_MSAA_SHADER_2D_MULTISAMPLE_RESOLVE_UINT,
 241    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY,
 242    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY_INT,
 243    BLIT_MSAA_SHADER_2D_MULTISAMPLE_COPY_UINT,
 244    BLIT_MSAA_SHADER_2D_MULTISAMPLE_DEPTH_RESOLVE,
 245    BLIT_MSAA_SHADER_2D_MULTISAMPLE_DEPTH_COPY,
 246    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE,
 247    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE_INT,
 248    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_RESOLVE_UINT,
 249    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY,
 250    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY_INT,
 251    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_COPY_UINT,
 252    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_DEPTH_RESOLVE,
 253    BLIT_MSAA_SHADER_2D_MULTISAMPLE_ARRAY_DEPTH_COPY,
 254    BLIT_MSAA_SHADER_COUNT,
 255 };
 256
 257 /**
 258  * State for glBlitFramebufer()
 259  */
 260 struct blit_state
 261 {
 262    GLuint VAO;
 263    GLuint VBO;
 264    struct blit_shader_table shaders;
 265    GLuint msaa_shaders[BLIT_MSAA_SHADER_COUNT];
 266    struct temp_texture depthTex;
 267    bool no_ctsi_fallback;
 268 };
 269
 270
 271 /**
 272  * State for glClear()
 273  */
 274 struct clear_state
 275 {
 276    GLuint VAO;
 277    GLuint VBO;
 278    GLuint ShaderProg;
 279    GLint ColorLocation;
 280    GLint LayerLocation;
 281
 282    GLuint IntegerShaderProg;
 283    GLint IntegerColorLocation;
 284    GLint IntegerLayerLocation;
 285 };
 286
 287
 288 /**
 289  * State for glCopyPixels()
 290  */
 291 struct copypix_state
 292 {
 293    GLuint VAO;
 294    GLuint VBO;
 295 };
 296
 297
 298 /**
 299  * State for glDrawPixels()
 300  */
 301 struct drawpix_state
 302 {
 303    GLuint VAO;
 304    GLuint VBO;
 305
 306    GLuint StencilFP;  /**< Fragment program for drawing stencil images */
 307    GLuint DepthFP;  /**< Fragment program for drawing depth images */
 308 };
 309
 310
 311 /**
 312  * State for glBitmap()
 313  */
 314 struct bitmap_state
 315 {
 316    GLuint VAO;
 317    GLuint VBO;
 318    struct temp_texture Tex;  /**< separate texture from other meta ops */
 319 };
 320
 321 /**
 322  * State for _mesa_meta_generate_mipmap()
 323  */
 324 struct gen_mipmap_state
 325 {
 326    GLuint VAO;
 327    GLuint VBO;
 328    GLuint FBO;
 329    GLuint Sampler;
 330
 331    struct blit_shader_table shaders;
 332 };
 333
 334 /**
 335  * State for texture decompression
 336  */
 337 struct decompress_state
 338 {
 339    GLuint VAO;
 340    GLuint VBO, FBO, RBO, Sampler;
 341    GLint Width, Height;
 342
 343    struct blit_shader_table shaders;
 344 };
 345
 346 /**
 347  * State for glDrawTex()
 348  */
 349 struct drawtex_state
 350 {
 351    GLuint VAO;
 352    GLuint VBO;
 353 };
 354
 355 #define MAX_META_OPS_DEPTH      8
 356 /**
 357  * All per-context meta state.
 358  */
 359 struct gl_meta_state
 360 {
 361    /** Stack of state saved during meta-ops */
 362    struct save_state Save[MAX_META_OPS_DEPTH];
 363    /** Save stack depth */
 364    GLuint SaveStackDepth;
 365
 366    struct temp_texture TempTex;
 367
 368    struct blit_state Blit;    /**< For _mesa_meta_BlitFramebuffer() */
 369    struct clear_state Clear;  /**< For _mesa_meta_Clear() */
 370    struct copypix_state CopyPix;  /**< For _mesa_meta_CopyPixels() */
 371    struct drawpix_state DrawPix;  /**< For _mesa_meta_DrawPixels() */
 372    struct bitmap_state Bitmap;    /**< For _mesa_meta_Bitmap() */
 373    struct gen_mipmap_state Mipmap;    /**< For _mesa_meta_GenerateMipmap() */
 374    struct decompress_state Decompress;  /**< For texture decompression */
 375    struct drawtex_state DrawTex;  /**< For _mesa_meta_DrawTex() */
 376 };
 377
 378 struct vertex {
 379    GLfloat x, y, z, tex[4];
 380    GLfloat r, g, b, a;
 381 };
 382
 383 extern void
 384 _mesa_meta_init(struct gl_context *ctx);
 385
 386 extern void
 387 _mesa_meta_free(struct gl_context *ctx);
 388
 389 extern void
 390 _mesa_meta_begin(struct gl_context *ctx, GLbitfield state);
 391
 392 extern void
 393 _mesa_meta_end(struct gl_context *ctx);
 394
 395 extern GLboolean
 396 _mesa_meta_in_progress(struct gl_context *ctx);
 397
 398 extern void
 399 _mesa_meta_BlitFramebuffer(struct gl_context *ctx,
 400                            GLint srcX0, GLint srcY0, GLint srcX1, GLint srcY1,
 401                            GLint dstX0, GLint dstY0, GLint dstX1, GLint dstY1,
 402                            GLbitfield mask, GLenum filter);
 403
 404 extern void
 405 _mesa_meta_Clear(struct gl_context *ctx, GLbitfield buffers);
 406
 407 extern void
 408 _mesa_meta_glsl_Clear(struct gl_context *ctx, GLbitfield buffers);
 409
 410 extern void
 411 _mesa_meta_CopyPixels(struct gl_context *ctx, GLint srcx, GLint srcy,
 412                       GLsizei width, GLsizei height,
 413                       GLint dstx, GLint dsty, GLenum type);
 414
 415 extern void
 416 _mesa_meta_DrawPixels(struct gl_context *ctx,
 417                       GLint x, GLint y, GLsizei width, GLsizei height,
 418                       GLenum format, GLenum type,
 419                       const struct gl_pixelstore_attrib *unpack,
 420                       const GLvoid *pixels);
 421
 422 extern void
 423 _mesa_meta_Bitmap(struct gl_context *ctx,
 424                   GLint x, GLint y, GLsizei width, GLsizei height,
 425                   const struct gl_pixelstore_attrib *unpack,
 426                   const GLubyte *bitmap);
 427
 428 extern void
 429 _mesa_meta_GenerateMipmap(struct gl_context *ctx, GLenum target,
 430                           struct gl_texture_object *texObj);
 431
 432 extern void
 433 _mesa_meta_CopyTexSubImage(struct gl_context *ctx, GLuint dims,
 434                            struct gl_texture_image *texImage,
 435                            GLint xoffset, GLint yoffset, GLint slice,
 436                            struct gl_renderbuffer *rb,
 437                            GLint x, GLint y,
 438                            GLsizei width, GLsizei height);
 439
 440 extern void
 441 _mesa_meta_GetTexImage(struct gl_context *ctx,
 442                        GLenum format, GLenum type, GLvoid *pixels,
 443                        struct gl_texture_image *texImage);
 444
 445 extern void
 446 _mesa_meta_DrawTex(struct gl_context *ctx, GLfloat x, GLfloat y, GLfloat z,
 447                    GLfloat width, GLfloat height);
 448
 449 /* meta-internal functions */
 450 GLuint
 451 _mesa_meta_compile_shader_with_debug(struct gl_context *ctx, GLenum target,
 452                                      const GLcharARB *source);
 453
 454
 455 GLuint
 456 _mesa_meta_link_program_with_debug(struct gl_context *ctx, GLuint program);
 457
 458 GLboolean
 459 _mesa_meta_alloc_texture(struct temp_texture *tex,
 460                          GLsizei width, GLsizei height, GLenum intFormat);
 461
 462 void
 463 _mesa_meta_setup_texture_coords(GLenum faceTarget,
 464                                 GLint slice,
 465                                 GLint width,
 466                                 GLint height,
 467                                 GLint depth,
 468                                 GLfloat coords0[4],
 469                                 GLfloat coords1[4],
 470                                 GLfloat coords2[4],
 471                                 GLfloat coords3[4]);
 472
 473 struct temp_texture *
 474 _mesa_meta_get_temp_texture(struct gl_context *ctx);
 475
 476 struct temp_texture *
 477 _mesa_meta_get_temp_depth_texture(struct gl_context *ctx);
 478
 479 void
 480 _mesa_meta_setup_vertex_objects(GLuint *VAO, GLuint *VBO,
 481                                 bool use_generic_attributes,
 482                                 unsigned vertex_size, unsigned texcoord_size,
 483                                 unsigned color_size);
 484
 485 void
 486 _mesa_meta_setup_ff_tnl_for_blit(GLuint *VAO, GLuint *VBO,
 487                                  unsigned texcoord_size);
 488
 489 void
 490 _mesa_meta_setup_drawpix_texture(struct gl_context *ctx,
 491                                  struct temp_texture *tex,
 492                                  GLboolean newTex,
 493                                  GLsizei width, GLsizei height,
 494                                  GLenum format, GLenum type,
 495                                  const GLvoid *pixels);
 496
 497 void
 498 _mesa_meta_setup_copypix_texture(struct gl_context *ctx,
 499                                  struct temp_texture *tex,
 500                                  GLint srcX, GLint srcY,
 501                                  GLsizei width, GLsizei height,
 502                                  GLenum intFormat,
 503                                  GLenum filter);
 504
 505 void
 506 _mesa_meta_setup_blit_shader(struct gl_context *ctx,
 507                              GLenum target,
 508                              struct blit_shader_table *table);
 509
 510 void
 511 _mesa_meta_glsl_blit_cleanup(struct blit_state *blit);
 512
 513 void
 514 _mesa_meta_blit_shader_table_cleanup(struct blit_shader_table *table);
 515
 516 void
 517 _mesa_meta_glsl_generate_mipmap_cleanup(struct gen_mipmap_state *mipmap);
 518
 519 void
 520 _mesa_meta_bind_fbo_image(GLenum attachment,
 521                           struct gl_texture_image *texImage, GLuint layer);
 522
 523 #endif /* META_H */