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
31 #include "intel_regions.h"
33 /* A layer on top of the intel_regions code which adds:
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.
38 * - maybe able to remove refcounting from intel_region?
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
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.
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.
59 struct intel_texture_image
;
62 * Describes the location of each texture image within a texture region.
64 struct intel_mipmap_level
66 /** Offset to this miptree level, used in computing x_offset. */
68 /** Offset to this miptree level, used in computing y_offset. */
72 /** Depth of the mipmap at this level: 1 for 1D/2D/CUBE, n for 3D. */
74 /** Number of images at this level: 1 for 1D/2D, 6 for CUBE, depth for 3D */
78 * offsets from level_[xy] to the image for each cube face or depth
81 * Pretty much have to accept that hardware formats
82 * are going to be so diverse that there is no unified way to
83 * compute the offsets of depth/cube images within a mipmap level,
84 * so have to store them as a lookup table.
86 GLuint
*x_offset
, *y_offset
;
90 struct intel_mipmap_tree
92 /* Effectively the key:
100 GLuint width0
, height0
, depth0
; /**< Level zero image dimensions */
102 GLboolean compressed
;
104 /* Derived from the above:
109 /* Includes image offset tables:
111 struct intel_mipmap_level level
[MAX_TEXTURE_LEVELS
];
113 /* The data is held here:
115 struct intel_region
*region
;
118 * This points to an auxillary hiz region if all of the following hold:
119 * 1. The texture has been attached to an FBO as a depthbuffer.
120 * 2. The texture format is hiz compatible.
121 * 3. The intel context supports hiz.
123 * When a texture is attached to multiple FBO's, a separate renderbuffer
124 * wrapper is created for each attachment. This necessitates storing the
125 * hiz region in the texture itself instead of the renderbuffer wrapper.
127 * \see intel_fbo.c:intel_wrap_texture()
129 struct intel_region
*hiz_region
;
131 /* These are also refcounted:
138 struct intel_mipmap_tree
*intel_miptree_create(struct intel_context
*intel
,
146 GLboolean expect_accelerated_upload
);
148 struct intel_mipmap_tree
*
149 intel_miptree_create_for_region(struct intel_context
*intel
,
152 struct intel_region
*region
);
154 int intel_miptree_pitch_align (struct intel_context
*intel
,
155 struct intel_mipmap_tree
*mt
,
159 void intel_miptree_reference(struct intel_mipmap_tree
**dst
,
160 struct intel_mipmap_tree
*src
);
162 void intel_miptree_release(struct intel_mipmap_tree
**mt
);
164 /* Check if an image fits an existing mipmap tree layout
166 GLboolean
intel_miptree_match_image(struct intel_mipmap_tree
*mt
,
167 struct gl_texture_image
*image
);
170 intel_miptree_get_image_offset(struct intel_mipmap_tree
*mt
,
171 GLuint level
, GLuint face
, GLuint depth
,
172 GLuint
*x
, GLuint
*y
);
174 void intel_miptree_set_level_info(struct intel_mipmap_tree
*mt
,
178 GLuint w
, GLuint h
, GLuint d
);
180 void intel_miptree_set_image_offset(struct intel_mipmap_tree
*mt
,
182 GLuint img
, GLuint x
, GLuint y
);
185 intel_miptree_copy_teximage(struct intel_context
*intel
,
186 struct intel_texture_image
*intelImage
,
187 struct intel_mipmap_tree
*dst_mt
);
189 /* i915_mipmap_tree.c:
191 void i915_miptree_layout(struct intel_mipmap_tree
*mt
);
192 void i945_miptree_layout(struct intel_mipmap_tree
*mt
);
193 void brw_miptree_layout(struct intel_context
*intel
,
194 struct intel_mipmap_tree
*mt
);