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    /** Offset to this miptree level, used in computing x_offset. */
  66    GLuint level_x;
  67    /** Offset to this miptree level, used in computing y_offset. */
  68    GLuint level_y;
  69    GLuint width;
  70    GLuint height;
  71    /** Depth of the mipmap at this level: 1 for 1D/2D/CUBE, n for 3D. */
  72    GLuint depth;
  73    /** Number of images at this level: 1 for 1D/2D, 6 for CUBE, depth for 3D */
  74    GLuint nr_images;
  75
  76    /** @{
  77     * offsets from level_[xy] to the image for each cube face or depth
  78     * level.
  79     *
  80     * Pretty much have to accept that hardware formats
  81     * are going to be so diverse that there is no unified way to
  82     * compute the offsets of depth/cube images within a mipmap level,
  83     * so have to store them as a lookup table.
  84     */
  85    GLuint *x_offset, *y_offset;
  86    /** @} */
  87 };
  88
  89 struct intel_mipmap_tree
  90 {
  91    /* Effectively the key:
  92     */
  93    GLenum target;
  94    GLenum internal_format;
  95
  96    GLuint levels;
  97
  98    GLuint width0, height0, depth0; /**< Level zero image dimensions */
  99    GLuint cpp;
 100    GLboolean compressed;
 101
 102    /* Derived from the above:
 103     */
 104    GLuint total_width;
 105    GLuint total_height;
 106
 107    /* Includes image offset tables:
 108     */
 109    struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
 110
 111    /* The data is held here:
 112     */
 113    struct intel_region *region;
 114
 115    /* These are also refcounted:
 116     */
 117    GLuint refcount;
 118 };
 119
 120
 121
 122 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
 123                                                GLenum target,
 124                                                GLenum base_format,
 125                                                GLenum internal_format,
 126                                                GLuint levels,
 127                                                GLuint width0,
 128                                                GLuint height0,
 129                                                GLuint depth0,
 130                                                GLuint cpp,
 131                                                GLuint compress_byte,
 132                                                GLboolean expect_accelerated_upload);
 133
 134 struct intel_mipmap_tree *
 135 intel_miptree_create_for_region(struct intel_context *intel,
 136                                 GLenum target,
 137                                 GLenum internal_format,
 138                                 struct intel_region *region,
 139                                 GLuint depth0,
 140                                 GLuint compress_byte);
 141
 142 int intel_miptree_pitch_align (struct intel_context *intel,
 143                                struct intel_mipmap_tree *mt,
 144                                uint32_t tiling,
 145                                int pitch);
 146
 147 void intel_miptree_reference(struct intel_mipmap_tree **dst,
 148                              struct intel_mipmap_tree *src);
 149
 150 void intel_miptree_release(struct intel_context *intel,
 151                            struct intel_mipmap_tree **mt);
 152
 153 /* Check if an image fits an existing mipmap tree layout
 154  */
 155 GLboolean intel_miptree_match_image(struct intel_mipmap_tree *mt,
 156                                     struct gl_texture_image *image);
 157
 158 /* Return a pointer to an image within a tree.  Return image stride as
 159  * well.
 160  */
 161 GLubyte *intel_miptree_image_map(struct intel_context *intel,
 162                                  struct intel_mipmap_tree *mt,
 163                                  GLuint face,
 164                                  GLuint level,
 165                                  GLuint * row_stride, GLuint * image_stride);
 166
 167 void intel_miptree_image_unmap(struct intel_context *intel,
 168                                struct intel_mipmap_tree *mt);
 169
 170 void
 171 intel_miptree_get_image_offset(struct intel_mipmap_tree *mt,
 172                                GLuint level, GLuint face, GLuint depth,
 173                                GLuint *x, GLuint *y);
 174
 175 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
 176                                   GLuint level,
 177                                   GLuint nr_images,
 178                                   GLuint x, GLuint y,
 179                                   GLuint w, GLuint h, GLuint d);
 180
 181 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
 182                                     GLuint level,
 183                                     GLuint img, GLuint x, GLuint y);
 184
 185 /* Upload an image into a tree
 186  */
 187 void intel_miptree_image_data(struct intel_context *intel,
 188                               struct intel_mipmap_tree *dst,
 189                               GLuint face,
 190                               GLuint level,
 191                               void *src,
 192                               GLuint src_row_pitch, GLuint src_image_pitch);
 193
 194 /* Copy an image between two trees
 195  */
 196 void intel_miptree_image_copy(struct intel_context *intel,
 197                               struct intel_mipmap_tree *dst,
 198                               GLuint face, GLuint level,
 199                               struct intel_mipmap_tree *src);
 200
 201 /* i915_mipmap_tree.c:
 202  */
 203 GLboolean i915_miptree_layout(struct intel_context *intel,
 204                               struct intel_mipmap_tree *mt,
 205                               uint32_t tiling);
 206 GLboolean i945_miptree_layout(struct intel_context *intel,
 207                               struct intel_mipmap_tree *mt,
 208                               uint32_t tiling);
 209 GLboolean brw_miptree_layout(struct intel_context *intel,
 210                              struct intel_mipmap_tree *mt,
 211                              uint32_t tiling);
 212
 213 #endif