1 /**************************************************************************
3 * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #ifndef INTEL_MIPMAP_TREE_H
29 #define INTEL_MIPMAP_TREE_H
33 #include "intel_regions.h"
34 #include "intel_resolve_map.h"
40 /* A layer on top of the intel_regions code which adds:
42 * - Code to size and layout a region to hold a set of mipmaps.
43 * - Query to determine if a new image fits in an existing tree.
45 * - maybe able to remove refcounting from intel_region?
48 * The fixed mipmap layout of intel hardware where one offset
49 * specifies the position of all images in a mipmap hierachy
50 * complicates the implementation of GL texture image commands,
51 * compared to hardware where each image is specified with an
54 * In an ideal world, each texture object would be associated with a
55 * single bufmgr buffer or 2d intel_region, and all the images within
56 * the texture object would slot into the tree as they arrive. The
57 * reality can be a little messier, as images can arrive from the user
58 * with sizes that don't fit in the existing tree, or in an order
59 * where the tree layout cannot be guessed immediately.
61 * This structure encodes an idealized mipmap tree. The GL image
62 * commands build these where possible, otherwise store the images in
63 * temporary system buffers.
66 struct intel_resolve_map;
67 struct intel_texture_image;
69 struct intel_miptree_map {
70 /** Bitfield of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT, GL_MAP_INVALIDATE_BIT */
72 /** Region of interest for the map. */
74 /** Possibly malloced temporary buffer for the mapping. */
76 /** Possible pointer to a BO temporary for the mapping. */
78 /** Pointer to the start of (map_x, map_y) returned by the mapping. */
80 /** Stride of the mapping. */
85 * Describes the location of each texture image within a texture region.
87 struct intel_mipmap_level
89 /** Offset to this miptree level, used in computing x_offset. */
91 /** Offset to this miptree level, used in computing y_offset. */
97 * \brief Number of 2D slices in this miplevel.
99 * The exact semantics of depth varies according to the texture target:
100 * - For GL_TEXTURE_CUBE_MAP, depth is 6.
101 * - For GL_TEXTURE_2D_ARRAY, depth is the number of array slices. It is
102 * identical for all miplevels in the texture.
103 * - For GL_TEXTURE_3D, it is the texture's depth at this miplevel. Its
104 * value, like width and height, varies with miplevel.
105 * - For other texture types, depth is 1.
110 * \brief List of 2D images in this mipmap level.
112 * This may be a list of cube faces, array slices in 2D array texture, or
113 * layers in a 3D texture. The list's length is \c depth.
115 struct intel_mipmap_slice {
117 * \name Offset to slice
120 * Hardware formats are so diverse that that there is no unified way to
121 * compute the slice offsets, so we store them in this table.
123 * The (x, y) offset to slice \c s at level \c l relative the miptrees
126 * x = mt->level[l].slice[s].x_offset
127 * y = mt->level[l].slice[s].y_offset
134 * Pointer to mapping information, present across
135 * intel_tex_image_map()/unmap of the slice.
137 struct intel_miptree_map *map;
142 * Enum for keeping track of the different MSAA layouts supported by Gen7.
144 enum intel_msaa_layout
147 * Ordinary surface with no MSAA.
149 INTEL_MSAA_LAYOUT_NONE,
152 * Interleaved Multisample Surface. The additional samples are
153 * accommodated by scaling up the width and the height of the surface so
154 * that all the samples corresponding to a pixel are located at nearby
157 INTEL_MSAA_LAYOUT_IMS,
160 * Uncompressed Multisample Surface. The surface is stored as a 2D array,
161 * with array slice n containing all pixel data for sample n.
163 INTEL_MSAA_LAYOUT_UMS,
166 * Compressed Multisample Surface. The surface is stored as in
167 * INTEL_MSAA_LAYOUT_UMS, but there is an additional buffer called the MCS
168 * (Multisample Control Surface) buffer. Each pixel in the MCS buffer
169 * indicates the mapping from sample number to array slice. This allows
170 * the common case (where all samples constituting a pixel have the same
171 * color value) to be stored efficiently by just using a single array
174 INTEL_MSAA_LAYOUT_CMS,
177 struct intel_mipmap_tree
179 /* Effectively the key:
184 * Generally, this is just the same as the gl_texture_image->TexFormat or
185 * gl_renderbuffer->Format.
187 * However, for textures and renderbuffers with packed depth/stencil formats
188 * on hardware where we want or need to use separate stencil, there will be
189 * two miptrees for storing the data. If the depthstencil texture or rb is
190 * MESA_FORMAT_Z32_FLOAT_X24S8, then mt->format will be
191 * MESA_FORMAT_Z32_FLOAT, otherwise for MESA_FORMAT_S8_Z24 objects it will be
192 * MESA_FORMAT_X8_Z24.
197 * The X offset of each image in the miptree must be aligned to this. See
198 * the "Alignment Unit Size" section of the BSpec.
200 unsigned int align_w;
201 unsigned int align_h; /**< \see align_w */
206 GLuint width0, height0, depth0; /**< Level zero image dimensions */
212 * For 1D array, 2D array, cube, and 2D multisampled surfaces on Gen7: true
213 * if the surface only contains LOD 0, and hence no space is for LOD's
214 * other than 0 in between array slices.
216 * Corresponds to the surface_array_spacing bit in gen7_surface_state.
218 bool array_spacing_lod0;
221 * MSAA layout used by this buffer.
223 enum intel_msaa_layout msaa_layout;
225 /* Derived from the above:
230 /* The 3DSTATE_CLEAR_PARAMS value associated with the last depth clear to
231 * this depth mipmap tree, if any.
233 uint32_t depth_clear_value;
235 /* Includes image offset tables:
237 struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
239 /* The data is held here:
241 struct intel_region *region;
243 /* Offset into region bo where miptree starts:
250 * This is non-null only if HiZ is enabled for this miptree.
252 * \see intel_miptree_alloc_hiz()
254 struct intel_mipmap_tree *hiz_mt;
257 * \brief Map of miptree slices to needed resolves.
259 * This is used only when the miptree has a child HiZ miptree.
261 * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
262 * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
263 * mt->hiz_mt->hiz_map, is unused.
265 struct intel_resolve_map hiz_map;
268 * \brief Stencil miptree for depthstencil textures.
270 * This miptree is used for depthstencil textures and renderbuffers that
271 * require separate stencil. It always has the true copy of the stencil
272 * bits, regardless of mt->format.
274 * \see intel_miptree_map_depthstencil()
275 * \see intel_miptree_unmap_depthstencil()
277 struct intel_mipmap_tree *stencil_mt;
279 /* These are also refcounted:
286 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
294 bool expect_accelerated_upload,
296 enum intel_msaa_layout msaa_layout);
298 struct intel_mipmap_tree *
299 intel_miptree_create_for_region(struct intel_context *intel,
302 struct intel_region *region);
305 * Create a miptree appropriate as the storage for a non-texture renderbuffer.
306 * The miptree has the following properties:
307 * - The target is GL_TEXTURE_2D.
308 * - There are no levels other than the base level 0.
311 struct intel_mipmap_tree*
312 intel_miptree_create_for_renderbuffer(struct intel_context *intel,
316 uint32_t num_samples);
318 /** \brief Assert that the level and layer are valid for the miptree. */
320 intel_miptree_check_level_layer(struct intel_mipmap_tree *mt,
324 assert(level >= mt->first_level);
325 assert(level <= mt->last_level);
326 assert(layer < mt->level[level].depth);
329 int intel_miptree_pitch_align (struct intel_context *intel,
330 struct intel_mipmap_tree *mt,
334 void intel_miptree_reference(struct intel_mipmap_tree **dst,
335 struct intel_mipmap_tree *src);
337 void intel_miptree_release(struct intel_mipmap_tree **mt);
339 /* Check if an image fits an existing mipmap tree layout
341 bool intel_miptree_match_image(struct intel_mipmap_tree *mt,
342 struct gl_texture_image *image);
345 intel_miptree_get_image_offset(struct intel_mipmap_tree *mt,
346 GLuint level, GLuint face, GLuint depth,
347 GLuint *x, GLuint *y);
350 intel_miptree_get_dimensions_for_image(struct gl_texture_image *image,
351 int *width, int *height, int *depth);
353 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
356 GLuint w, GLuint h, GLuint d);
358 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
360 GLuint img, GLuint x, GLuint y);
363 intel_miptree_copy_teximage(struct intel_context *intel,
364 struct intel_texture_image *intelImage,
365 struct intel_mipmap_tree *dst_mt);
368 * Copy the stencil data from \c mt->stencil_mt->region to \c mt->region for
369 * the given miptree slice.
371 * \see intel_mipmap_tree::stencil_mt
374 intel_miptree_s8z24_scatter(struct intel_context *intel,
375 struct intel_mipmap_tree *mt,
380 * Copy the stencil data in \c mt->stencil_mt->region to \c mt->region for the
381 * given miptree slice.
383 * \see intel_mipmap_tree::stencil_mt
386 intel_miptree_s8z24_gather(struct intel_context *intel,
387 struct intel_mipmap_tree *mt,
392 * \name Miptree HiZ functions
395 * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
396 * functions on a miptree without HiZ. In that case, each function is a no-op.
400 * \brief Allocate the miptree's embedded HiZ miptree.
401 * \see intel_mipmap_tree:hiz_mt
402 * \return false if allocation failed
406 intel_miptree_alloc_hiz(struct intel_context *intel,
407 struct intel_mipmap_tree *mt,
411 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree *mt,
415 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree *mt,
419 intel_miptree_all_slices_set_need_hiz_resolve(struct intel_mipmap_tree *mt);
422 intel_miptree_all_slices_set_need_depth_resolve(struct intel_mipmap_tree *mt);
425 * \return false if no resolve was needed
428 intel_miptree_slice_resolve_hiz(struct intel_context *intel,
429 struct intel_mipmap_tree *mt,
434 * \return false if no resolve was needed
437 intel_miptree_slice_resolve_depth(struct intel_context *intel,
438 struct intel_mipmap_tree *mt,
443 * \return false if no resolve was needed
446 intel_miptree_all_slices_resolve_hiz(struct intel_context *intel,
447 struct intel_mipmap_tree *mt);
450 * \return false if no resolve was needed
453 intel_miptree_all_slices_resolve_depth(struct intel_context *intel,
454 struct intel_mipmap_tree *mt);
458 /* i915_mipmap_tree.c:
460 void i915_miptree_layout(struct intel_mipmap_tree *mt);
461 void i945_miptree_layout(struct intel_mipmap_tree *mt);
462 void brw_miptree_layout(struct intel_context *intel,
463 struct intel_mipmap_tree *mt);
466 intel_miptree_map(struct intel_context *intel,
467 struct intel_mipmap_tree *mt,
479 intel_miptree_unmap(struct intel_context *intel,
480 struct intel_mipmap_tree *mt,
486 intel_hiz_exec(struct intel_context *intel, struct intel_mipmap_tree *mt,
487 unsigned int level, unsigned int layer, enum gen6_hiz_op op)
489 /* Stub on i915. It would be nice if we didn't execute resolve code at all
495 intel_hiz_exec(struct intel_context *intel, struct intel_mipmap_tree *mt,
496 unsigned int level, unsigned int layer, enum gen6_hiz_op op);