src/mesa/state_tracker/st_texture.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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_TEXTURE_H
  29 #define ST_TEXTURE_H
  30
  31
  32 #include "pipe/p_context.h"
  33 #include "util/u_sampler.h"
  34 #include "util/simple_mtx.h"
  35
  36 #include "main/mtypes.h"
  37
  38
  39 struct pipe_resource;
  40
  41
  42 struct st_texture_image_transfer {
  43    struct pipe_transfer *transfer;
  44
  45    /* For compressed texture fallback. */
  46    GLubyte *temp_data; /**< Temporary compressed texture storage. */
  47    unsigned temp_stride; /**< Stride of the compressed texture storage. */
  48    GLubyte *map; /**< Saved map pointer of the uncompressed transfer. */
  49 };
  50
  51
  52 /**
  53  * Container for one context's validated sampler view.
  54  */
  55 struct st_sampler_view {
  56    struct pipe_sampler_view *view;
  57
  58    /** The glsl version of the shader seen during validation */
  59    bool glsl130_or_later;
  60    /** Derived from the sampler's sRGBDecode state during validation */
  61    bool srgb_skip_decode;
  62 };
  63
  64
  65 /**
  66  * Container for per-context sampler views of a texture.
  67  */
  68 struct st_sampler_views {
  69    struct st_sampler_views *next;
  70    uint32_t max;
  71    uint32_t count;
  72    struct st_sampler_view views[0];
  73 };
  74
  75 /**
  76  * Subclass of gl_texure_image.
  77  */
  78 struct st_texture_image
  79 {
  80    struct gl_texture_image base;
  81
  82    /* If stImage->pt != NULL, image data is stored here.
  83     * Else there is no image data.
  84     */
  85    struct pipe_resource *pt;
  86
  87    /* List of transfers, allocated on demand.
  88     * transfer[layer] is a mapping for that layer.
  89     */
  90    struct st_texture_image_transfer *transfer;
  91    unsigned num_transfers;
  92
  93    /* For compressed images unsupported by the driver. Keep track of
  94     * the original data. This is necessary for mapping/unmapping,
  95     * as well as image copies.
  96     */
  97    GLubyte *compressed_data;
  98 };
  99
 100
 101 /**
 102  * Subclass of gl_texure_object.
 103  */
 104 struct st_texture_object
 105 {
 106    struct gl_texture_object base;       /* The "parent" object */
 107
 108    /* The texture must include at levels [0..lastLevel] once validated:
 109     */
 110    GLuint lastLevel;
 111
 112    unsigned int validated_first_level;
 113    unsigned int validated_last_level;
 114
 115    /* On validation any active images held in main memory or in other
 116     * textures will be copied to this texture and the old storage freed.
 117     */
 118    struct pipe_resource *pt;
 119
 120    /* Protect modifications of the sampler_views array */
 121    simple_mtx_t validate_mutex;
 122
 123    /* Container of sampler views (one per context) attached to this texture
 124     * object. Created lazily on first binding in context.
 125     *
 126     * Purely read-only accesses to the current context's own sampler view
 127     * require no locking. Another thread may simultaneously replace the
 128     * container object in order to grow the array, but the old container will
 129     * be kept alive.
 130     *
 131     * Writing to the container (even for modifying the current context's own
 132     * sampler view) always requires taking the validate_mutex to protect against
 133     * concurrent container switches.
 134     *
 135     * NULL'ing another context's sampler view is allowed only while
 136     * implementing an API call that modifies the texture: an application which
 137     * calls those while simultaneously reading the texture in another context
 138     * invokes undefined behavior. (TODO: a dubious violation of this rule is
 139     * st_finalize_texture, which is a lazy operation that corresponds to a
 140     * texture modification.)
 141     */
 142    struct st_sampler_views *sampler_views;
 143
 144    /* Old sampler views container objects that have not been freed yet because
 145     * other threads/contexts may still be reading from them.
 146     */
 147    struct st_sampler_views *sampler_views_old;
 148
 149    /* True if this texture comes from the window system. Such a texture
 150     * cannot be reallocated and the format can only be changed with a sampler
 151     * view or a surface.
 152     */
 153    GLboolean surface_based;
 154
 155    /* If surface_based is true, this format should be used for all sampler
 156     * views and surfaces instead of pt->format.
 157     */
 158    enum pipe_format surface_format;
 159
 160    /* When non-zero, samplers should use this level instead of the level
 161     * range specified by the GL state.
 162     *
 163     * This is used for EGL images, which may correspond to a single level out
 164     * of an imported pipe_resources with multiple mip levels.
 165     */
 166    uint level_override;
 167
 168    /* When non-zero, samplers should use this layer instead of the one
 169     * specified by the GL state.
 170     *
 171     * This is used for EGL images and VDPAU interop, where imported
 172     * pipe_resources may be cube, 3D, or array textures (containing layers
 173     * with different fields in the case of VDPAU) even though the GL state
 174     * describes one non-array texture per field.
 175     */
 176    uint layer_override;
 177
 178     /**
 179      * Set when the texture images of this texture object might not all be in
 180      * the pipe_resource *pt above.
 181      */
 182     bool needs_validation;
 183 };
 184
 185
 186 static inline struct st_texture_image *
 187 st_texture_image(struct gl_texture_image *img)
 188 {
 189    return (struct st_texture_image *) img;
 190 }
 191
 192 static inline const struct st_texture_image *
 193 st_texture_image_const(const struct gl_texture_image *img)
 194 {
 195    return (const struct st_texture_image *) img;
 196 }
 197
 198 static inline struct st_texture_object *
 199 st_texture_object(struct gl_texture_object *obj)
 200 {
 201    return (struct st_texture_object *) obj;
 202 }
 203
 204 static inline const struct st_texture_object *
 205 st_texture_object_const(const struct gl_texture_object *obj)
 206 {
 207    return (const struct st_texture_object *) obj;
 208 }
 209
 210
 211 static inline struct pipe_resource *
 212 st_get_texobj_resource(struct gl_texture_object *texObj)
 213 {
 214    struct st_texture_object *stObj = st_texture_object(texObj);
 215    return stObj ? stObj->pt : NULL;
 216 }
 217
 218
 219 static inline struct pipe_resource *
 220 st_get_stobj_resource(struct st_texture_object *stObj)
 221 {
 222    return stObj ? stObj->pt : NULL;
 223 }
 224
 225
 226 static inline struct st_texture_object *
 227 st_get_texture_object(struct gl_context *ctx,
 228                       const struct gl_program *prog,
 229                       unsigned unit)
 230 {
 231    const GLuint texUnit = prog->SamplerUnits[unit];
 232    struct gl_texture_object *texObj = ctx->Texture.Unit[texUnit]._Current;
 233
 234    if (!texObj)
 235       return NULL;
 236
 237    return st_texture_object(texObj);
 238 }
 239
 240 static inline enum pipe_format
 241 st_get_view_format(struct st_texture_object *stObj)
 242 {
 243    if (!stObj)
 244       return PIPE_FORMAT_NONE;
 245    return stObj->surface_based ? stObj->surface_format : stObj->pt->format;
 246 }
 247
 248
 249 extern struct pipe_resource *
 250 st_texture_create(struct st_context *st,
 251                   enum pipe_texture_target target,
 252                   enum pipe_format format,
 253                   GLuint last_level,
 254                   GLuint width0,
 255                   GLuint height0,
 256                   GLuint depth0,
 257                   GLuint layers,
 258                   GLuint nr_samples,
 259                   GLuint tex_usage );
 260
 261
 262 extern void
 263 st_gl_texture_dims_to_pipe_dims(GLenum texture,
 264                                 unsigned widthIn,
 265                                 uint16_t heightIn,
 266                                 uint16_t depthIn,
 267                                 unsigned *widthOut,
 268                                 uint16_t *heightOut,
 269                                 uint16_t *depthOut,
 270                                 uint16_t *layersOut);
 271
 272 /* Check if an image fits into an existing texture object.
 273  */
 274 extern GLboolean
 275 st_texture_match_image(struct st_context *st,
 276                        const struct pipe_resource *pt,
 277                        const struct gl_texture_image *image);
 278
 279 /* Return a pointer to an image within a texture.  Return image stride as
 280  * well.
 281  */
 282 extern GLubyte *
 283 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,
 284                      enum pipe_transfer_usage usage,
 285                      GLuint x, GLuint y, GLuint z,
 286                      GLuint w, GLuint h, GLuint d,
 287                      struct pipe_transfer **transfer);
 288
 289 extern void
 290 st_texture_image_unmap(struct st_context *st,
 291                        struct st_texture_image *stImage, unsigned slice);
 292
 293
 294 /* Return pointers to each 2d slice within an image.  Indexed by depth
 295  * value.
 296  */
 297 extern const GLuint *
 298 st_texture_depth_offsets(struct pipe_resource *pt, GLuint level);
 299
 300 /* Copy an image between two textures
 301  */
 302 extern void
 303 st_texture_image_copy(struct pipe_context *pipe,
 304                       struct pipe_resource *dst, GLuint dstLevel,
 305                       struct pipe_resource *src, GLuint srcLevel,
 306                       GLuint face);
 307
 308
 309 extern struct pipe_resource *
 310 st_create_color_map_texture(struct gl_context *ctx);
 311
 312 void
 313 st_destroy_bound_texture_handles(struct st_context *st);
 314
 315 void
 316 st_destroy_bound_image_handles(struct st_context *st);
 317
 318 bool
 319 st_compressed_format_fallback(struct st_context *st, mesa_format format);
 320
 321 void
 322 st_convert_image(const struct st_context *st, const struct gl_image_unit *u,
 323                  struct pipe_image_view *img, unsigned shader_access);
 324
 325 void
 326 st_convert_image_from_unit(const struct st_context *st,
 327                            struct pipe_image_view *img,
 328                            GLuint imgUnit,
 329                            unsigned shader_access);
 330
 331 void
 332 st_convert_sampler(const struct st_context *st,
 333                    const struct gl_texture_object *texobj,
 334                    const struct gl_sampler_object *msamp,
 335                    float tex_unit_lod_bias,
 336                    struct pipe_sampler_state *sampler);
 337
 338 void
 339 st_convert_sampler_from_unit(const struct st_context *st,
 340                              struct pipe_sampler_state *sampler,
 341                              GLuint texUnit);
 342
 343 void
 344 st_update_single_texture(struct st_context *st,
 345                          struct pipe_sampler_view **sampler_view,
 346                          GLuint texUnit, bool glsl130_or_later,
 347                          bool ignore_srgb_decode);
 348
 349 void
 350 st_make_bound_samplers_resident(struct st_context *st,
 351                                 struct gl_program *prog);
 352
 353 void
 354 st_make_bound_images_resident(struct st_context *st,
 355                               struct gl_program *prog);
 356
 357 #endif