src/mesa/drivers/dri/intel/intel_mipmap_tree.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 INTEL_MIPMAP_TREE_H
  29 #define INTEL_MIPMAP_TREE_H
  30
  31 #include <assert.h>
  32
  33 #include "intel_regions.h"
  34 #include "intel_resolve_map.h"
  35
  36 /* A layer on top of the intel_regions code which adds:
  37  *
  38  * - Code to size and layout a region to hold a set of mipmaps.
  39  * - Query to determine if a new image fits in an existing tree.
  40  * - More refcounting
  41  *     - maybe able to remove refcounting from intel_region?
  42  * - ?
  43  *
  44  * The fixed mipmap layout of intel hardware where one offset
  45  * specifies the position of all images in a mipmap hierachy
  46  * complicates the implementation of GL texture image commands,
  47  * compared to hardware where each image is specified with an
  48  * independent offset.
  49  *
  50  * In an ideal world, each texture object would be associated with a
  51  * single bufmgr buffer or 2d intel_region, and all the images within
  52  * the texture object would slot into the tree as they arrive.  The
  53  * reality can be a little messier, as images can arrive from the user
  54  * with sizes that don't fit in the existing tree, or in an order
  55  * where the tree layout cannot be guessed immediately.
  56  *
  57  * This structure encodes an idealized mipmap tree.  The GL image
  58  * commands build these where possible, otherwise store the images in
  59  * temporary system buffers.
  60  */
  61
  62 struct intel_resolve_map;
  63 struct intel_texture_image;
  64
  65 /**
  66  * Describes the location of each texture image within a texture region.
  67  */
  68 struct intel_mipmap_level
  69 {
  70    /** Offset to this miptree level, used in computing x_offset. */
  71    GLuint level_x;
  72    /** Offset to this miptree level, used in computing y_offset. */
  73    GLuint level_y;
  74    GLuint width;
  75    GLuint height;
  76
  77    /**
  78     * \brief Number of 2D slices in this miplevel.
  79     *
  80     * The exact semantics of depth varies according to the texture target:
  81     *    - For GL_TEXTURE_CUBE_MAP, depth is 6.
  82     *    - For GL_TEXTURE_2D_ARRAY, depth is the number of array slices. It is
  83     *      identical for all miplevels in the texture.
  84     *    - For GL_TEXTURE_3D, it is the texture's depth at this miplevel. Its
  85     *      value, like width and height, varies with miplevel.
  86     *    - For other texture types, depth is 1.
  87     */
  88    GLuint depth;
  89
  90    /**
  91     * \brief List of 2D images in this mipmap level.
  92     *
  93     * This may be a list of cube faces, array slices in 2D array texture, or
  94     * layers in a 3D texture. The list's length is \c depth.
  95     */
  96    struct intel_mipmap_slice {
  97       /**
  98        * \name Offset to slice
  99        * \{
 100        *
 101        * Hardware formats are so diverse that that there is no unified way to
 102        * compute the slice offsets, so we store them in this table.
 103        *
 104        * The (x, y) offset to slice \c s at level \c l relative the miptrees
 105        * base address is
 106        * \code
 107        *     x = mt->level[l].slice[s].x_offset
 108        *     y = mt->level[l].slice[s].y_offset
 109        */
 110       GLuint x_offset;
 111       GLuint y_offset;
 112       /** \} */
 113    } *slice;
 114 };
 115
 116 struct intel_mipmap_tree
 117 {
 118    /* Effectively the key:
 119     */
 120    GLenum target;
 121    gl_format format;
 122
 123    /**
 124     * The X offset of each image in the miptree must be aligned to this. See
 125     * the "Alignment Unit Size" section of the BSpec.
 126     */
 127    unsigned int align_w;
 128    unsigned int align_h; /**< \see align_w */
 129
 130    GLuint first_level;
 131    GLuint last_level;
 132
 133    GLuint width0, height0, depth0; /**< Level zero image dimensions */
 134    GLuint cpp;
 135    bool compressed;
 136
 137    /* Derived from the above:
 138     */
 139    GLuint total_width;
 140    GLuint total_height;
 141
 142    /* Includes image offset tables:
 143     */
 144    struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
 145
 146    /* The data is held here:
 147     */
 148    struct intel_region *region;
 149
 150    /**
 151     * \brief HiZ miptree
 152     *
 153     * This is non-null only if HiZ is enabled for this miptree.
 154     *
 155     * \see intel_miptree_alloc_hiz()
 156     */
 157    struct intel_mipmap_tree *hiz_mt;
 158
 159    /**
 160     * \brief Map of miptree slices to needed resolves.
 161     *
 162     * This is used only when the miptree has a child HiZ miptree.
 163     *
 164     * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
 165     * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
 166     * mt->hiz_mt->hiz_map, is unused.
 167     */
 168    struct intel_resolve_map hiz_map;
 169
 170    /**
 171     * \brief Stencil miptree for depthstencil textures.
 172     *
 173     * This miptree is used for depthstencil textures that require separate
 174     * stencil. The stencil miptree's data is the golden copy of the
 175     * parent miptree's stencil bits. When necessary, we scatter/gather the
 176     * stencil bits between the parent miptree and the stencil miptree.
 177     *
 178     * \see intel_miptree_s8z24_scatter()
 179     * \see intel_miptree_s8z24_gather()
 180     */
 181    struct intel_mipmap_tree *stencil_mt;
 182
 183    /* These are also refcounted:
 184     */
 185    GLuint refcount;
 186 };
 187
 188
 189
 190 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
 191                                                GLenum target,
 192                                                gl_format format,
 193                                                GLuint first_level,
 194                                                GLuint last_level,
 195                                                GLuint width0,
 196                                                GLuint height0,
 197                                                GLuint depth0,
 198                                                bool expect_accelerated_upload);
 199
 200 struct intel_mipmap_tree *
 201 intel_miptree_create_for_region(struct intel_context *intel,
 202                                 GLenum target,
 203                                 gl_format format,
 204                                 struct intel_region *region);
 205
 206 /**
 207  * Create a miptree appropriate as the storage for a non-texture renderbuffer.
 208  * The miptree has the following properties:
 209  *     - The target is GL_TEXTURE_2D.
 210  *     - There are no levels other than the base level 0.
 211  *     - Depth is 1.
 212  */
 213 struct intel_mipmap_tree*
 214 intel_miptree_create_for_renderbuffer(struct intel_context *intel,
 215                                       gl_format format,
 216                                       uint32_t tiling,
 217                                       uint32_t cpp,
 218                                       uint32_t width,
 219                                       uint32_t height);
 220
 221 /** \brief Assert that the level and layer are valid for the miptree. */
 222 static inline void
 223 intel_miptree_check_level_layer(struct intel_mipmap_tree *mt,
 224                                 uint32_t level,
 225                                 uint32_t layer)
 226 {
 227    assert(level >= mt->first_level);
 228    assert(level <= mt->last_level);
 229    assert(layer < mt->level[level].depth);
 230 }
 231
 232 int intel_miptree_pitch_align (struct intel_context *intel,
 233                                struct intel_mipmap_tree *mt,
 234                                uint32_t tiling,
 235                                int pitch);
 236
 237 void intel_miptree_reference(struct intel_mipmap_tree **dst,
 238                              struct intel_mipmap_tree *src);
 239
 240 void intel_miptree_release(struct intel_mipmap_tree **mt);
 241
 242 /* Check if an image fits an existing mipmap tree layout
 243  */
 244 bool intel_miptree_match_image(struct intel_mipmap_tree *mt,
 245                                     struct gl_texture_image *image);
 246
 247 void
 248 intel_miptree_get_image_offset(struct intel_mipmap_tree *mt,
 249                                GLuint level, GLuint face, GLuint depth,
 250                                GLuint *x, GLuint *y);
 251
 252 void
 253 intel_miptree_get_dimensions_for_image(struct gl_texture_image *image,
 254                                        int *width, int *height, int *depth);
 255
 256 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
 257                                   GLuint level,
 258                                   GLuint x, GLuint y,
 259                                   GLuint w, GLuint h, GLuint d);
 260
 261 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
 262                                     GLuint level,
 263                                     GLuint img, GLuint x, GLuint y);
 264
 265 void
 266 intel_miptree_copy_teximage(struct intel_context *intel,
 267                             struct intel_texture_image *intelImage,
 268                             struct intel_mipmap_tree *dst_mt);
 269
 270 /**
 271  * Copy the stencil data from \c mt->stencil_mt->region to \c mt->region for
 272  * the given miptree slice.
 273  *
 274  * \see intel_mipmap_tree::stencil_mt
 275  */
 276 void
 277 intel_miptree_s8z24_scatter(struct intel_context *intel,
 278                             struct intel_mipmap_tree *mt,
 279                             uint32_t level,
 280                             uint32_t slice);
 281
 282 /**
 283  * Copy the stencil data in \c mt->stencil_mt->region to \c mt->region for the
 284  * given miptree slice.
 285  *
 286  * \see intel_mipmap_tree::stencil_mt
 287  */
 288 void
 289 intel_miptree_s8z24_gather(struct intel_context *intel,
 290                            struct intel_mipmap_tree *mt,
 291                            uint32_t level,
 292                            uint32_t layer);
 293
 294 /**
 295  * \name Miptree HiZ functions
 296  * \{
 297  *
 298  * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
 299  * functions on a miptree without HiZ. In that case, each function is a no-op.
 300  */
 301
 302 /**
 303  * \brief Allocate the miptree's embedded HiZ miptree.
 304  * \see intel_mipmap_tree:hiz_mt
 305  * \return false if allocation failed
 306  */
 307
 308 bool
 309 intel_miptree_alloc_hiz(struct intel_context *intel,
 310                         struct intel_mipmap_tree *mt);
 311
 312 void
 313 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree *mt,
 314                                           uint32_t level,
 315                                           uint32_t depth);
 316 void
 317 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree *mt,
 318                                             uint32_t level,
 319                                             uint32_t depth);
 320 void
 321 intel_miptree_all_slices_set_need_hiz_resolve(struct intel_mipmap_tree *mt);
 322
 323 void
 324 intel_miptree_all_slices_set_need_depth_resolve(struct intel_mipmap_tree *mt);
 325
 326 /**
 327  * \return false if no resolve was needed
 328  */
 329 bool
 330 intel_miptree_slice_resolve_hiz(struct intel_context *intel,
 331                                 struct intel_mipmap_tree *mt,
 332                                 unsigned int level,
 333                                 unsigned int depth);
 334
 335 /**
 336  * \return false if no resolve was needed
 337  */
 338 bool
 339 intel_miptree_slice_resolve_depth(struct intel_context *intel,
 340                                   struct intel_mipmap_tree *mt,
 341                                   unsigned int level,
 342                                   unsigned int depth);
 343
 344 /**
 345  * \return false if no resolve was needed
 346  */
 347 bool
 348 intel_miptree_all_slices_resolve_hiz(struct intel_context *intel,
 349                                      struct intel_mipmap_tree *mt);
 350
 351 /**
 352  * \return false if no resolve was needed
 353  */
 354 bool
 355 intel_miptree_all_slices_resolve_depth(struct intel_context *intel,
 356                                        struct intel_mipmap_tree *mt);
 357
 358 /**\}*/
 359
 360 /* i915_mipmap_tree.c:
 361  */
 362 void i915_miptree_layout(struct intel_mipmap_tree *mt);
 363 void i945_miptree_layout(struct intel_mipmap_tree *mt);
 364 void brw_miptree_layout(struct intel_context *intel,
 365                         struct intel_mipmap_tree *mt);
 366
 367 #endif