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 "intel_regions.h"
  32
  33 /* A layer on top of the intel_regions code which adds:
  34  *
  35  * - Code to size and layout a region to hold a set of mipmaps.
  36  * - Query to determine if a new image fits in an existing tree.
  37  * - More refcounting
  38  *     - maybe able to remove refcounting from intel_region?
  39  * - ?
  40  *
  41  * The fixed mipmap layout of intel hardware where one offset
  42  * specifies the position of all images in a mipmap hierachy
  43  * complicates the implementation of GL texture image commands,
  44  * compared to hardware where each image is specified with an
  45  * independent offset.
  46  *
  47  * In an ideal world, each texture object would be associated with a
  48  * single bufmgr buffer or 2d intel_region, and all the images within
  49  * the texture object would slot into the tree as they arrive.  The
  50  * reality can be a little messier, as images can arrive from the user
  51  * with sizes that don't fit in the existing tree, or in an order
  52  * where the tree layout cannot be guessed immediately.
  53  *
  54  * This structure encodes an idealized mipmap tree.  The GL image
  55  * commands build these where possible, otherwise store the images in
  56  * temporary system buffers.
  57  */
  58
  59
  60 /**
  61  * Describes the location of each texture image within a texture region.
  62  */
  63 struct intel_mipmap_level
  64 {
  65    /**
  66     * Byte offset to the base of this level.
  67     *
  68     * This is used for mipmap levels of 1D/2D/3D textures.  However, CUBE
  69     * layouts spread images around the whole tree, so the level offset is
  70     * always zero in that case.
  71     */
  72    GLuint level_offset;
  73    GLuint width;
  74    GLuint height;
  75    /** Depth of the mipmap at this level: 1 for 1D/2D/CUBE, n for 3D. */
  76    GLuint depth;
  77    /** Number of images at this level: 1 for 1D/2D, 6 for CUBE, depth for 3D */
  78    GLuint nr_images;
  79
  80    /**
  81     * Byte offset from level_offset to the image for each cube face or depth
  82     * level.
  83     *
  84     * Pretty much have to accept that hardware formats
  85     * are going to be so diverse that there is no unified way to
  86     * compute the offsets of depth/cube images within a mipmap level,
  87     * so have to store them as a lookup table.
  88     */
  89    GLuint *image_offset;
  90 };
  91
  92 struct intel_mipmap_tree
  93 {
  94    /* Effectively the key:
  95     */
  96    GLenum target;
  97    GLenum internal_format;
  98
  99    GLuint first_level;
 100    GLuint last_level;
 101
 102    GLuint width0, height0, depth0; /**< Level zero image dimensions */
 103    GLuint cpp;
 104    GLboolean compressed;
 105
 106    /* Derived from the above:
 107     */
 108    GLuint pitch;
 109    GLuint depth_pitch;          /* per-image on i945? */
 110    GLuint total_height;
 111
 112    /* Includes image offset tables:
 113     */
 114    struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
 115
 116    /* The data is held here:
 117     */
 118    struct intel_region *region;
 119
 120    /* These are also refcounted:
 121     */
 122    GLuint refcount;
 123 };
 124
 125
 126
 127 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
 128                                                GLenum target,
 129                                                GLenum internal_format,
 130                                                GLuint first_level,
 131                                                GLuint last_level,
 132                                                GLuint width0,
 133                                                GLuint height0,
 134                                                GLuint depth0,
 135                                                GLuint cpp,
 136                                                GLuint compress_byte);
 137
 138 struct intel_mipmap_tree *
 139 intel_miptree_create_for_region(struct intel_context *intel,
 140                                 GLenum target,
 141                                 GLenum internal_format,
 142                                 GLuint first_level,
 143                                 GLuint last_level,
 144                                 struct intel_region *region,
 145                                 GLuint depth0,
 146                                 GLuint compress_byte);
 147
 148 int intel_miptree_pitch_align (struct intel_context *intel,
 149                                struct intel_mipmap_tree *mt,
 150                                int pitch);
 151
 152 void intel_miptree_reference(struct intel_mipmap_tree **dst,
 153                              struct intel_mipmap_tree *src);
 154
 155 void intel_miptree_release(struct intel_context *intel,
 156                            struct intel_mipmap_tree **mt);
 157
 158 /* Check if an image fits an existing mipmap tree layout
 159  */
 160 GLboolean intel_miptree_match_image(struct intel_mipmap_tree *mt,
 161                                     struct gl_texture_image *image,
 162                                     GLuint face, GLuint level);
 163
 164 /* Return a pointer to an image within a tree.  Return image stride as
 165  * well.
 166  */
 167 GLubyte *intel_miptree_image_map(struct intel_context *intel,
 168                                  struct intel_mipmap_tree *mt,
 169                                  GLuint face,
 170                                  GLuint level,
 171                                  GLuint * row_stride, GLuint * image_stride);
 172
 173 void intel_miptree_image_unmap(struct intel_context *intel,
 174                                struct intel_mipmap_tree *mt);
 175
 176
 177 /* Return the linear offset of an image relative to the start of the
 178  * tree:
 179  */
 180 GLuint intel_miptree_image_offset(struct intel_mipmap_tree *mt,
 181                                   GLuint face, GLuint level);
 182
 183 /* Return pointers to each 2d slice within an image.  Indexed by depth
 184  * value.
 185  */
 186 const GLuint *intel_miptree_depth_offsets(struct intel_mipmap_tree *mt,
 187                                           GLuint level);
 188
 189
 190 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
 191                                   GLuint level,
 192                                   GLuint nr_images,
 193                                   GLuint x, GLuint y,
 194                                   GLuint w, GLuint h, GLuint d);
 195
 196 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
 197                                     GLuint level,
 198                                     GLuint img, GLuint x, GLuint y);
 199
 200
 201 /* Upload an image into a tree
 202  */
 203 void intel_miptree_image_data(struct intel_context *intel,
 204                               struct intel_mipmap_tree *dst,
 205                               GLuint face,
 206                               GLuint level,
 207                               void *src,
 208                               GLuint src_row_pitch, GLuint src_image_pitch);
 209
 210 /* Copy an image between two trees
 211  */
 212 void intel_miptree_image_copy(struct intel_context *intel,
 213                               struct intel_mipmap_tree *dst,
 214                               GLuint face, GLuint level,
 215                               struct intel_mipmap_tree *src);
 216
 217 /* i915_mipmap_tree.c:
 218  */
 219 GLboolean i915_miptree_layout(struct intel_context *intel,
 220                               struct intel_mipmap_tree *mt);
 221 GLboolean i945_miptree_layout(struct intel_context *intel,
 222                               struct intel_mipmap_tree *mt);
 223 GLboolean brw_miptree_layout(struct intel_context *intel,
 224                              struct intel_mipmap_tree *mt);
 225
 226 #endif