src/mesa/state_tracker/st_context.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2003 VMware, Inc.
   4  * 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
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #ifndef ST_CONTEXT_H
  29 #define ST_CONTEXT_H
  30
  31 #include "main/mtypes.h"
  32 #include "state_tracker/st_api.h"
  33 #include "main/fbobject.h"
  34 #include "state_tracker/st_atom.h"
  35 #include "util/u_inlines.h"
  36
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42
  43 struct dd_function_table;
  44 struct draw_context;
  45 struct draw_stage;
  46 struct gen_mipmap_state;
  47 struct st_context;
  48 struct st_fragment_program;
  49 struct st_perf_monitor_group;
  50 struct u_upload_mgr;
  51
  52
  53 /** For drawing quads for glClear, glDraw/CopyPixels, glBitmap, etc. */
  54 struct st_util_vertex
  55 {
  56    float x, y, z;
  57    float r, g, b, a;
  58    float s, t;
  59 };
  60
  61 struct st_bitmap_cache
  62 {
  63    /** Window pos to render the cached image */
  64    GLint xpos, ypos;
  65    /** Bounds of region used in window coords */
  66    GLint xmin, ymin, xmax, ymax;
  67
  68    GLfloat color[4];
  69
  70    /** Bitmap's Z position */
  71    GLfloat zpos;
  72
  73    struct pipe_resource *texture;
  74    struct pipe_transfer *trans;
  75
  76    GLboolean empty;
  77
  78    /** An I8 texture image: */
  79    ubyte *buffer;
  80 };
  81
  82 struct st_context
  83 {
  84    struct st_context_iface iface;
  85
  86    struct gl_context *ctx;
  87
  88    struct pipe_context *pipe;
  89
  90    struct draw_context *draw;  /**< For selection/feedback/rastpos only */
  91    struct draw_stage *feedback_stage;  /**< For GL_FEEDBACK rendermode */
  92    struct draw_stage *selection_stage;  /**< For GL_SELECT rendermode */
  93    struct draw_stage *rastpos_stage;  /**< For glRasterPos */
  94    GLboolean clamp_frag_color_in_shader;
  95    GLboolean clamp_vert_color_in_shader;
  96    boolean has_stencil_export; /**< can do shader stencil export? */
  97    boolean has_time_elapsed;
  98    boolean has_shader_model3;
  99    boolean has_etc1;
 100    boolean has_etc2;
 101    boolean prefer_blit_based_texture_transfer;
 102    boolean force_persample_in_shader;
 103    boolean has_shareable_shaders;
 104    boolean has_half_float_packing;
 105    boolean has_multi_draw_indirect;
 106    boolean has_user_constbuf;
 107
 108    /**
 109     * If a shader can be created when we get its source.
 110     * This means it has only 1 variant, not counting glBitmap and
 111     * glDrawPixels.
 112     */
 113    boolean shader_has_one_variant[MESA_SHADER_STAGES];
 114
 115    boolean needs_texcoord_semantic;
 116    boolean apply_texture_swizzle_to_border_color;
 117
 118    /* On old libGL's for linux we need to invalidate the drawables
 119     * on glViewpport calls, this is set via a option.
 120     */
 121    boolean invalidate_on_gl_viewport;
 122
 123    boolean vertex_array_out_of_memory;
 124
 125    /* Some state is contained in constant objects.
 126     * Other state is just parameter values.
 127     */
 128    struct {
 129       struct pipe_blend_state               blend;
 130       struct pipe_depth_stencil_alpha_state depth_stencil;
 131       struct pipe_rasterizer_state          rasterizer;
 132       struct pipe_sampler_state samplers[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 133       GLuint num_samplers[PIPE_SHADER_TYPES];
 134       struct pipe_sampler_view *sampler_views[PIPE_SHADER_TYPES][PIPE_MAX_SAMPLERS];
 135       GLuint num_sampler_views[PIPE_SHADER_TYPES];
 136       struct pipe_clip_state clip;
 137       struct {
 138          void *ptr;
 139          unsigned size;
 140       } constants[PIPE_SHADER_TYPES];
 141       struct pipe_framebuffer_state framebuffer;
 142       struct pipe_scissor_state scissor[PIPE_MAX_VIEWPORTS];
 143       struct pipe_viewport_state viewport[PIPE_MAX_VIEWPORTS];
 144       struct {
 145          unsigned num;
 146          boolean include;
 147          struct pipe_scissor_state rects[PIPE_MAX_WINDOW_RECTANGLES];
 148       } window_rects;
 149       unsigned sample_mask;
 150
 151       GLuint poly_stipple[32];  /**< In OpenGL's bottom-to-top order */
 152
 153       GLuint fb_orientation;
 154    } state;
 155
 156    char vendor[100];
 157    char renderer[100];
 158
 159    uint64_t dirty; /**< dirty states */
 160
 161    /** This masks out unused shader resources. Only valid in draw calls. */
 162    uint64_t active_states;
 163
 164    /* If true, further analysis of states is required to know if something
 165     * has changed. Used mainly for shaders.
 166     */
 167    bool gfx_shaders_may_be_dirty;
 168    bool compute_shader_may_be_dirty;
 169
 170    GLboolean vertdata_edgeflags;
 171    GLboolean edgeflag_culls_prims;
 172
 173    struct st_vertex_program *vp;    /**< Currently bound vertex program */
 174    struct st_fragment_program *fp;  /**< Currently bound fragment program */
 175    struct st_geometry_program *gp;  /**< Currently bound geometry program */
 176    struct st_tessctrl_program *tcp; /**< Currently bound tess control program */
 177    struct st_tesseval_program *tep; /**< Currently bound tess eval program */
 178    struct st_compute_program *cp;   /**< Currently bound compute program */
 179
 180    struct st_vp_variant *vp_variant;
 181    struct st_fp_variant *fp_variant;
 182    struct st_basic_variant *gp_variant;
 183    struct st_basic_variant *tcp_variant;
 184    struct st_basic_variant *tep_variant;
 185    struct st_basic_variant *cp_variant;
 186
 187    struct {
 188       struct pipe_resource *pixelmap_texture;
 189       struct pipe_sampler_view *pixelmap_sampler_view;
 190    } pixel_xfer;
 191
 192    /** for glBitmap */
 193    struct {
 194       struct pipe_rasterizer_state rasterizer;
 195       struct pipe_sampler_state sampler;
 196       struct pipe_sampler_state atlas_sampler;
 197       enum pipe_format tex_format;
 198       void *vs;
 199       struct st_bitmap_cache cache;
 200    } bitmap;
 201
 202    /** for glDraw/CopyPixels */
 203    struct {
 204       void *zs_shaders[4];
 205       void *vert_shaders[2];   /**< ureg shaders */
 206    } drawpix;
 207
 208    struct {
 209       GLsizei width, height;
 210       GLenum format, type;
 211       const void *user_pointer;  /**< Last user 'pixels' pointer */
 212       void *image;               /**< Copy of the glDrawPixels image data */
 213       struct pipe_resource *texture;
 214    } drawpix_cache;
 215
 216    /** for glReadPixels */
 217    struct {
 218       struct pipe_resource *src;
 219       struct pipe_resource *cache;
 220       enum pipe_format dst_format;
 221       unsigned level;
 222       unsigned layer;
 223       unsigned hits;
 224    } readpix_cache;
 225
 226    /** for glClear */
 227    struct {
 228       struct pipe_rasterizer_state raster;
 229       struct pipe_viewport_state viewport;
 230       void *vs;
 231       void *fs;
 232       void *vs_layered;
 233       void *gs_layered;
 234    } clear;
 235
 236    /* For gl(Compressed)Tex(Sub)Image */
 237    struct {
 238       struct pipe_rasterizer_state raster;
 239       struct pipe_blend_state upload_blend;
 240       void *vs;
 241       void *gs;
 242       void *upload_fs[3];
 243       void *download_fs[3][PIPE_MAX_TEXTURE_TYPES];
 244       bool upload_enabled;
 245       bool download_enabled;
 246       bool rgba_only;
 247       bool layers;
 248       bool use_gs;
 249    } pbo;
 250
 251    /** for drawing with st_util_vertex */
 252    struct pipe_vertex_element util_velems[3];
 253
 254    void *passthrough_fs;  /**< simple pass-through frag shader */
 255
 256    enum pipe_texture_target internal_target;
 257
 258    struct cso_context *cso_context;
 259
 260    void *winsys_drawable_handle;
 261
 262    /* The number of vertex buffers from the last call of validate_arrays. */
 263    unsigned last_num_vbuffers;
 264
 265    int32_t draw_stamp;
 266    int32_t read_stamp;
 267
 268    struct st_config_options options;
 269
 270    struct st_perf_monitor_group *perfmon;
 271
 272    enum pipe_reset_status reset_status;
 273 };
 274
 275
 276 /* Need this so that we can implement Mesa callbacks in this module.
 277  */
 278 static inline struct st_context *st_context(struct gl_context *ctx)
 279 {
 280    return ctx->st;
 281 }
 282
 283
 284 /**
 285  * Wrapper for struct gl_framebuffer.
 286  * This is an opaque type to the outside world.
 287  */
 288 struct st_framebuffer
 289 {
 290    struct gl_framebuffer Base;
 291    void *Private;
 292
 293    struct st_framebuffer_iface *iface;
 294    enum st_attachment_type statts[ST_ATTACHMENT_COUNT];
 295    unsigned num_statts;
 296    int32_t stamp;
 297    int32_t iface_stamp;
 298 };
 299
 300
 301 extern void st_init_driver_functions(struct pipe_screen *screen,
 302                                      struct dd_function_table *functions);
 303
 304 void st_invalidate_state(struct gl_context * ctx, GLbitfield new_state);
 305
 306 /* Invalidate the readpixels cache to ensure we don't read stale data.
 307  */
 308 static inline void
 309 st_invalidate_readpix_cache(struct st_context *st)
 310 {
 311    if (unlikely(st->readpix_cache.src)) {
 312       pipe_resource_reference(&st->readpix_cache.src, NULL);
 313       pipe_resource_reference(&st->readpix_cache.cache, NULL);
 314    }
 315 }
 316
 317
 318 #define Y_0_TOP 1
 319 #define Y_0_BOTTOM 2
 320
 321 static inline GLuint
 322 st_fb_orientation(const struct gl_framebuffer *fb)
 323 {
 324    if (fb && _mesa_is_winsys_fbo(fb)) {
 325       /* Drawing into a window (on-screen buffer).
 326        *
 327        * Negate Y scale to flip image vertically.
 328        * The NDC Y coords prior to viewport transformation are in the range
 329        * [y=-1=bottom, y=1=top]
 330        * Hardware window coords are in the range [y=0=top, y=H-1=bottom] where
 331        * H is the window height.
 332        * Use the viewport transformation to invert Y.
 333        */
 334       return Y_0_TOP;
 335    }
 336    else {
 337       /* Drawing into user-created FBO (very likely a texture).
 338        *
 339        * For textures, T=0=Bottom, so by extension Y=0=Bottom for rendering.
 340        */
 341       return Y_0_BOTTOM;
 342    }
 343 }
 344
 345
 346 static inline enum pipe_shader_type
 347 st_shader_stage_to_ptarget(gl_shader_stage stage)
 348 {
 349    switch (stage) {
 350    case MESA_SHADER_VERTEX:
 351       return PIPE_SHADER_VERTEX;
 352    case MESA_SHADER_FRAGMENT:
 353       return PIPE_SHADER_FRAGMENT;
 354    case MESA_SHADER_GEOMETRY:
 355       return PIPE_SHADER_GEOMETRY;
 356    case MESA_SHADER_TESS_CTRL:
 357       return PIPE_SHADER_TESS_CTRL;
 358    case MESA_SHADER_TESS_EVAL:
 359       return PIPE_SHADER_TESS_EVAL;
 360    case MESA_SHADER_COMPUTE:
 361       return PIPE_SHADER_COMPUTE;
 362    }
 363
 364    assert(!"should not be reached");
 365    return PIPE_SHADER_VERTEX;
 366 }
 367
 368 static inline bool
 369 st_user_clip_planes_enabled(struct gl_context *ctx)
 370 {
 371    return (ctx->API == API_OPENGL_COMPAT ||
 372            ctx->API == API_OPENGLES) && /* only ES 1.x */
 373           ctx->Transform.ClipPlanesEnabled;
 374 }
 375
 376 /** clear-alloc a struct-sized object, with casting */
 377 #define ST_CALLOC_STRUCT(T)   (struct T *) calloc(1, sizeof(struct T))
 378
 379
 380 extern struct st_context *
 381 st_create_context(gl_api api, struct pipe_context *pipe,
 382                   const struct gl_config *visual,
 383                   struct st_context *share,
 384                   const struct st_config_options *options);
 385
 386 extern void
 387 st_destroy_context(struct st_context *st);
 388
 389 uint64_t
 390 st_get_active_states(struct gl_context *ctx);
 391
 392
 393 #ifdef __cplusplus
 394 }
 395 #endif
 396
 397 #endif