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"
36 /* A layer on top of the intel_regions code which adds:
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.
41 * - maybe able to remove refcounting from intel_region?
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
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.
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.
62 struct intel_resolve_map
;
63 struct intel_texture_image
;
65 struct intel_miptree_map
{
66 /** Bitfield of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT, GL_MAP_INVALIDATE_BIT */
68 /** Region of interest for the map. */
70 /** Possibly malloced temporary buffer for the mapping. */
72 /** Possible pointer to a BO temporary for the mapping. */
74 /** Pointer to the start of (map_x, map_y) returned by the mapping. */
76 /** Stride of the mapping. */
81 * Describes the location of each texture image within a texture region.
83 struct intel_mipmap_level
85 /** Offset to this miptree level, used in computing x_offset. */
87 /** Offset to this miptree level, used in computing y_offset. */
93 * \brief Number of 2D slices in this miplevel.
95 * The exact semantics of depth varies according to the texture target:
96 * - For GL_TEXTURE_CUBE_MAP, depth is 6.
97 * - For GL_TEXTURE_2D_ARRAY, depth is the number of array slices. It is
98 * identical for all miplevels in the texture.
99 * - For GL_TEXTURE_3D, it is the texture's depth at this miplevel. Its
100 * value, like width and height, varies with miplevel.
101 * - For other texture types, depth is 1.
106 * \brief List of 2D images in this mipmap level.
108 * This may be a list of cube faces, array slices in 2D array texture, or
109 * layers in a 3D texture. The list's length is \c depth.
111 struct intel_mipmap_slice
{
113 * \name Offset to slice
116 * Hardware formats are so diverse that that there is no unified way to
117 * compute the slice offsets, so we store them in this table.
119 * The (x, y) offset to slice \c s at level \c l relative the miptrees
122 * x = mt->level[l].slice[s].x_offset
123 * y = mt->level[l].slice[s].y_offset
130 * Pointer to mapping information, present across
131 * intel_tex_image_map()/unmap of the slice.
133 struct intel_miptree_map
*map
;
137 struct intel_mipmap_tree
139 /* Effectively the key:
144 * Generally, this is just the same as the gl_texture_image->TexFormat or
145 * gl_renderbuffer->Format.
147 * However, for textures and renderbuffers with packed depth/stencil formats
148 * on hardware where we want or need to use separate stencil, there will be
149 * two miptrees for storing the data. If the depthstencil texture or rb is
150 * MESA_FORMAT_Z32_FLOAT_X24S8, then mt->format will be
151 * MESA_FORMAT_Z32_FLOAT, otherwise for MESA_FORMAT_S8_Z24 objects it will be
152 * MESA_FORMAT_S8_Z24 (textures) or MESA_FORMAT_X8_Z24 (renderbuffers).
153 * mt->stencil_mt->format will always be MESA_FORMAT_S8.
158 * The X offset of each image in the miptree must be aligned to this. See
159 * the "Alignment Unit Size" section of the BSpec.
161 unsigned int align_w
;
162 unsigned int align_h
; /**< \see align_w */
167 GLuint width0
, height0
, depth0
; /**< Level zero image dimensions */
171 /* Derived from the above:
176 /* Includes image offset tables:
178 struct intel_mipmap_level level
[MAX_TEXTURE_LEVELS
];
180 /* The data is held here:
182 struct intel_region
*region
;
187 * This is non-null only if HiZ is enabled for this miptree.
189 * \see intel_miptree_alloc_hiz()
191 struct intel_mipmap_tree
*hiz_mt
;
194 * \brief Map of miptree slices to needed resolves.
196 * This is used only when the miptree has a child HiZ miptree.
198 * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
199 * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
200 * mt->hiz_mt->hiz_map, is unused.
202 struct intel_resolve_map hiz_map
;
205 * \brief Stencil miptree for depthstencil textures.
207 * This miptree is used for depthstencil textures and renderbuffers that
208 * require separate stencil. It always has the true copy of the stencil
209 * bits, regardless of mt->format.
211 * \see intel_miptree_map_depthstencil()
212 * \see intel_miptree_unmap_depthstencil()
214 struct intel_mipmap_tree
*stencil_mt
;
216 /* These are also refcounted:
223 struct intel_mipmap_tree
*intel_miptree_create(struct intel_context
*intel
,
231 bool expect_accelerated_upload
);
233 struct intel_mipmap_tree
*
234 intel_miptree_create_for_region(struct intel_context
*intel
,
237 struct intel_region
*region
);
240 * Create a miptree appropriate as the storage for a non-texture renderbuffer.
241 * The miptree has the following properties:
242 * - The target is GL_TEXTURE_2D.
243 * - There are no levels other than the base level 0.
246 struct intel_mipmap_tree
*
247 intel_miptree_create_for_renderbuffer(struct intel_context
*intel
,
254 /** \brief Assert that the level and layer are valid for the miptree. */
256 intel_miptree_check_level_layer(struct intel_mipmap_tree
*mt
,
260 assert(level
>= mt
->first_level
);
261 assert(level
<= mt
->last_level
);
262 assert(layer
< mt
->level
[level
].depth
);
265 int intel_miptree_pitch_align (struct intel_context
*intel
,
266 struct intel_mipmap_tree
*mt
,
270 void intel_miptree_reference(struct intel_mipmap_tree
**dst
,
271 struct intel_mipmap_tree
*src
);
273 void intel_miptree_release(struct intel_mipmap_tree
**mt
);
275 /* Check if an image fits an existing mipmap tree layout
277 bool intel_miptree_match_image(struct intel_mipmap_tree
*mt
,
278 struct gl_texture_image
*image
);
281 intel_miptree_get_image_offset(struct intel_mipmap_tree
*mt
,
282 GLuint level
, GLuint face
, GLuint depth
,
283 GLuint
*x
, GLuint
*y
);
286 intel_miptree_get_dimensions_for_image(struct gl_texture_image
*image
,
287 int *width
, int *height
, int *depth
);
289 void intel_miptree_set_level_info(struct intel_mipmap_tree
*mt
,
292 GLuint w
, GLuint h
, GLuint d
);
294 void intel_miptree_set_image_offset(struct intel_mipmap_tree
*mt
,
296 GLuint img
, GLuint x
, GLuint y
);
299 intel_miptree_copy_teximage(struct intel_context
*intel
,
300 struct intel_texture_image
*intelImage
,
301 struct intel_mipmap_tree
*dst_mt
);
304 * Copy the stencil data from \c mt->stencil_mt->region to \c mt->region for
305 * the given miptree slice.
307 * \see intel_mipmap_tree::stencil_mt
310 intel_miptree_s8z24_scatter(struct intel_context
*intel
,
311 struct intel_mipmap_tree
*mt
,
316 * Copy the stencil data in \c mt->stencil_mt->region to \c mt->region for the
317 * given miptree slice.
319 * \see intel_mipmap_tree::stencil_mt
322 intel_miptree_s8z24_gather(struct intel_context
*intel
,
323 struct intel_mipmap_tree
*mt
,
328 * \name Miptree HiZ functions
331 * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
332 * functions on a miptree without HiZ. In that case, each function is a no-op.
336 * \brief Allocate the miptree's embedded HiZ miptree.
337 * \see intel_mipmap_tree:hiz_mt
338 * \return false if allocation failed
342 intel_miptree_alloc_hiz(struct intel_context
*intel
,
343 struct intel_mipmap_tree
*mt
);
346 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree
*mt
,
350 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree
*mt
,
354 intel_miptree_all_slices_set_need_hiz_resolve(struct intel_mipmap_tree
*mt
);
357 intel_miptree_all_slices_set_need_depth_resolve(struct intel_mipmap_tree
*mt
);
360 * \return false if no resolve was needed
363 intel_miptree_slice_resolve_hiz(struct intel_context
*intel
,
364 struct intel_mipmap_tree
*mt
,
369 * \return false if no resolve was needed
372 intel_miptree_slice_resolve_depth(struct intel_context
*intel
,
373 struct intel_mipmap_tree
*mt
,
378 * \return false if no resolve was needed
381 intel_miptree_all_slices_resolve_hiz(struct intel_context
*intel
,
382 struct intel_mipmap_tree
*mt
);
385 * \return false if no resolve was needed
388 intel_miptree_all_slices_resolve_depth(struct intel_context
*intel
,
389 struct intel_mipmap_tree
*mt
);
393 /* i915_mipmap_tree.c:
395 void i915_miptree_layout(struct intel_mipmap_tree
*mt
);
396 void i945_miptree_layout(struct intel_mipmap_tree
*mt
);
397 void brw_miptree_layout(struct intel_context
*intel
,
398 struct intel_mipmap_tree
*mt
);
401 intel_miptree_map(struct intel_context
*intel
,
402 struct intel_mipmap_tree
*mt
,
414 intel_miptree_unmap(struct intel_context
*intel
,
415 struct intel_mipmap_tree
*mt
,