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