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 #include "util/list.h"
  37 #include "vbo/vbo.h"
  38
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44
  45 struct dd_function_table;
  46 struct draw_context;
  47 struct draw_stage;
  48 struct gen_mipmap_state;
  49 struct st_context;
  50 struct st_fragment_program;
  51 struct st_perf_monitor_group;
  52 struct u_upload_mgr;
  53
  54
  55 /** For drawing quads for glClear, glDraw/CopyPixels, glBitmap, etc. */
  56 struct st_util_vertex
  57 {
  58    float x, y, z;
  59    float r, g, b, a;
  60    float s, t;
  61 };
  62
  63 struct st_bitmap_cache
  64 {
  65    /** Window pos to render the cached image */
  66    GLint xpos, ypos;
  67    /** Bounds of region used in window coords */
  68    GLint xmin, ymin, xmax, ymax;
  69
  70    GLfloat color[4];
  71
  72    /** Bitmap's Z position */
  73    GLfloat zpos;
  74
  75    struct pipe_resource *texture;
  76    struct pipe_transfer *trans;
  77
  78    GLboolean empty;
  79
  80    /** An I8 texture image: */
  81    ubyte *buffer;
  82 };
  83
  84 struct st_bound_handles
  85 {
  86    unsigned num_handles;
  87    uint64_t *handles;
  88 };
  89
  90
  91 #define NUM_DRAWPIX_CACHE_ENTRIES 4
  92
  93 struct drawpix_cache_entry
  94 {
  95    GLsizei width, height;
  96    GLenum format, type;
  97    const void *user_pointer;  /**< Last user 'pixels' pointer */
  98    void *image;               /**< Copy of the glDrawPixels image data */
  99    struct pipe_resource *texture;
 100    unsigned age;
 101 };
 102
 103
 104 struct st_context
 105 {
 106    struct st_context_iface iface;
 107
 108    struct gl_context *ctx;
 109
 110    struct pipe_context *pipe;
 111
 112    struct draw_context *draw;  /**< For selection/feedback/rastpos only */
 113    struct draw_stage *feedback_stage;  /**< For GL_FEEDBACK rendermode */
 114    struct draw_stage *selection_stage;  /**< For GL_SELECT rendermode */
 115    struct draw_stage *rastpos_stage;  /**< For glRasterPos */
 116    GLboolean clamp_frag_color_in_shader;
 117    GLboolean clamp_vert_color_in_shader;
 118    boolean has_stencil_export; /**< can do shader stencil export? */
 119    boolean has_time_elapsed;
 120    boolean has_shader_model3;
 121    boolean has_etc1;
 122    boolean has_etc2;
 123    boolean has_astc_2d_ldr;
 124    boolean prefer_blit_based_texture_transfer;
 125    boolean force_persample_in_shader;
 126    boolean has_shareable_shaders;
 127    boolean has_half_float_packing;
 128    boolean has_multi_draw_indirect;
 129    boolean can_bind_const_buffer_as_vertex;
 130
 131    /**
 132     * If a shader can be created when we get its source.
 133     * This means it has only 1 variant, not counting glBitmap and
 134     * glDrawPixels.
 135     */
 136    boolean shader_has_one_variant[MESA_SHADER_STAGES];
 137
 138    boolean needs_texcoord_semantic;
 139    boolean apply_texture_swizzle_to_border_color;
 140
 141    /* On old libGL's for linux we need to invalidate the drawables
 142     * on glViewpport calls, this is set via a option.
 143     */
 144    boolean invalidate_on_gl_viewport;
 145    boolean draw_needs_minmax_index;
 146    boolean vertex_array_out_of_memory;
 147    boolean has_hw_atomics;
 148
 149    /* Some state is contained in constant objects.
 150     * Other state is just parameter values.
 151     */
 152    struct {
 153       struct pipe_blend_state               blend;
 154       struct pipe_depth_stencil_alpha_state depth_stencil;
 155       struct pipe_rasterizer_state          rasterizer;
 156       struct pipe_sampler_state frag_samplers[PIPE_MAX_SAMPLERS];
 157       GLuint num_frag_samplers;
 158       struct pipe_sampler_view *frag_sampler_views[PIPE_MAX_SAMPLERS];
 159       GLuint num_sampler_views[PIPE_SHADER_TYPES];
 160       struct pipe_clip_state clip;
 161       struct {
 162          void *ptr;
 163          unsigned size;
 164       } constants[PIPE_SHADER_TYPES];
 165       unsigned fb_width;
 166       unsigned fb_height;
 167       unsigned fb_num_samples;
 168       unsigned fb_num_layers;
 169       unsigned fb_num_cb;
 170       unsigned num_viewports;
 171       struct pipe_scissor_state scissor[PIPE_MAX_VIEWPORTS];
 172       struct pipe_viewport_state viewport[PIPE_MAX_VIEWPORTS];
 173       struct {
 174          unsigned num;
 175          boolean include;
 176          struct pipe_scissor_state rects[PIPE_MAX_WINDOW_RECTANGLES];
 177       } window_rects;
 178
 179       GLuint poly_stipple[32];  /**< In OpenGL's bottom-to-top order */
 180
 181       GLuint fb_orientation;
 182
 183       bool enable_sample_locations;
 184       unsigned sample_locations_samples;
 185       uint8_t sample_locations[
 186          PIPE_MAX_SAMPLE_LOCATION_GRID_SIZE *
 187          PIPE_MAX_SAMPLE_LOCATION_GRID_SIZE * 32];
 188    } state;
 189
 190    uint64_t dirty; /**< dirty states */
 191
 192    /** This masks out unused shader resources. Only valid in draw calls. */
 193    uint64_t active_states;
 194
 195    /* If true, further analysis of states is required to know if something
 196     * has changed. Used mainly for shaders.
 197     */
 198    bool gfx_shaders_may_be_dirty;
 199    bool compute_shader_may_be_dirty;
 200
 201    GLboolean vertdata_edgeflags;
 202    GLboolean edgeflag_culls_prims;
 203
 204    struct st_vertex_program *vp;    /**< Currently bound vertex program */
 205    struct st_fragment_program *fp;  /**< Currently bound fragment program */
 206    struct st_common_program *gp;  /**< Currently bound geometry program */
 207    struct st_common_program *tcp; /**< Currently bound tess control program */
 208    struct st_common_program *tep; /**< Currently bound tess eval program */
 209    struct st_compute_program *cp;   /**< Currently bound compute program */
 210
 211    struct st_vp_variant *vp_variant;
 212
 213    struct {
 214       struct pipe_resource *pixelmap_texture;
 215       struct pipe_sampler_view *pixelmap_sampler_view;
 216    } pixel_xfer;
 217
 218    /** for glBitmap */
 219    struct {
 220       struct pipe_rasterizer_state rasterizer;
 221       struct pipe_sampler_state sampler;
 222       struct pipe_sampler_state atlas_sampler;
 223       enum pipe_format tex_format;
 224       void *vs;
 225       struct st_bitmap_cache cache;
 226    } bitmap;
 227
 228    /** for glDraw/CopyPixels */
 229    struct {
 230       void *zs_shaders[4];
 231       void *vert_shaders[2];   /**< ureg shaders */
 232    } drawpix;
 233
 234    /** Cache of glDrawPixels images */
 235    struct {
 236       struct drawpix_cache_entry entries[NUM_DRAWPIX_CACHE_ENTRIES];
 237       unsigned age;
 238    } drawpix_cache;
 239
 240    /** for glReadPixels */
 241    struct {
 242       struct pipe_resource *src;
 243       struct pipe_resource *cache;
 244       enum pipe_format dst_format;
 245       unsigned level;
 246       unsigned layer;
 247       unsigned hits;
 248    } readpix_cache;
 249
 250    /** for glClear */
 251    struct {
 252       struct pipe_rasterizer_state raster;
 253       struct pipe_viewport_state viewport;
 254       void *vs;
 255       void *fs;
 256       void *vs_layered;
 257       void *gs_layered;
 258    } clear;
 259
 260    /* For gl(Compressed)Tex(Sub)Image */
 261    struct {
 262       struct pipe_rasterizer_state raster;
 263       struct pipe_blend_state upload_blend;
 264       void *vs;
 265       void *gs;
 266       void *upload_fs[3];
 267       void *download_fs[3][PIPE_MAX_TEXTURE_TYPES];
 268       bool upload_enabled;
 269       bool download_enabled;
 270       bool rgba_only;
 271       bool layers;
 272       bool use_gs;
 273    } pbo;
 274
 275    /** for drawing with st_util_vertex */
 276    struct pipe_vertex_element util_velems[3];
 277
 278    void *passthrough_fs;  /**< simple pass-through frag shader */
 279
 280    enum pipe_texture_target internal_target;
 281
 282    struct cso_context *cso_context;
 283
 284    void *winsys_drawable_handle;
 285
 286    /* The number of vertex buffers from the last call of validate_arrays. */
 287    unsigned last_num_vbuffers;
 288
 289    int32_t draw_stamp;
 290    int32_t read_stamp;
 291
 292    struct st_config_options options;
 293
 294    struct st_perf_monitor_group *perfmon;
 295
 296    enum pipe_reset_status reset_status;
 297
 298    /* Array of bound texture/image handles which are resident in the context.
 299     */
 300    struct st_bound_handles bound_texture_handles[PIPE_SHADER_TYPES];
 301    struct st_bound_handles bound_image_handles[PIPE_SHADER_TYPES];
 302
 303    /* Winsys buffers */
 304    struct list_head winsys_buffers;
 305 };
 306
 307
 308 /* Need this so that we can implement Mesa callbacks in this module.
 309  */
 310 static inline struct st_context *st_context(struct gl_context *ctx)
 311 {
 312    return ctx->st;
 313 }
 314
 315
 316 /**
 317  * Wrapper for struct gl_framebuffer.
 318  * This is an opaque type to the outside world.
 319  */
 320 struct st_framebuffer
 321 {
 322    struct gl_framebuffer Base;
 323
 324    struct st_framebuffer_iface *iface;
 325    enum st_attachment_type statts[ST_ATTACHMENT_COUNT];
 326    unsigned num_statts;
 327    int32_t stamp;
 328    int32_t iface_stamp;
 329    uint32_t iface_ID;
 330
 331    /* list of framebuffer objects */
 332    struct list_head head;
 333 };
 334
 335
 336 extern void st_init_driver_functions(struct pipe_screen *screen,
 337                                      struct dd_function_table *functions);
 338
 339 void
 340 st_invalidate_buffers(struct st_context *st);
 341
 342 /* Invalidate the readpixels cache to ensure we don't read stale data.
 343  */
 344 static inline void
 345 st_invalidate_readpix_cache(struct st_context *st)
 346 {
 347    if (unlikely(st->readpix_cache.src)) {
 348       pipe_resource_reference(&st->readpix_cache.src, NULL);
 349       pipe_resource_reference(&st->readpix_cache.cache, NULL);
 350    }
 351 }
 352
 353
 354 #define Y_0_TOP 1
 355 #define Y_0_BOTTOM 2
 356
 357 static inline GLuint
 358 st_fb_orientation(const struct gl_framebuffer *fb)
 359 {
 360    if (fb && _mesa_is_winsys_fbo(fb)) {
 361       /* Drawing into a window (on-screen buffer).
 362        *
 363        * Negate Y scale to flip image vertically.
 364        * The NDC Y coords prior to viewport transformation are in the range
 365        * [y=-1=bottom, y=1=top]
 366        * Hardware window coords are in the range [y=0=top, y=H-1=bottom] where
 367        * H is the window height.
 368        * Use the viewport transformation to invert Y.
 369        */
 370       return Y_0_TOP;
 371    }
 372    else {
 373       /* Drawing into user-created FBO (very likely a texture).
 374        *
 375        * For textures, T=0=Bottom, so by extension Y=0=Bottom for rendering.
 376        */
 377       return Y_0_BOTTOM;
 378    }
 379 }
 380
 381
 382 static inline bool
 383 st_user_clip_planes_enabled(struct gl_context *ctx)
 384 {
 385    return (ctx->API == API_OPENGL_COMPAT ||
 386            ctx->API == API_OPENGLES) && /* only ES 1.x */
 387           ctx->Transform.ClipPlanesEnabled;
 388 }
 389
 390 /** clear-alloc a struct-sized object, with casting */
 391 #define ST_CALLOC_STRUCT(T)   (struct T *) calloc(1, sizeof(struct T))
 392
 393
 394 extern struct st_context *
 395 st_create_context(gl_api api, struct pipe_context *pipe,
 396                   const struct gl_config *visual,
 397                   struct st_context *share,
 398                   const struct st_config_options *options,
 399                   bool no_error);
 400
 401 extern void
 402 st_destroy_context(struct st_context *st);
 403
 404 uint64_t
 405 st_get_active_states(struct gl_context *ctx);
 406
 407
 408 #ifdef __cplusplus
 409 }
 410 #endif
 411
 412 #endif