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.
61 * Describes the location of each texture image within a texture region.
63 struct intel_mipmap_level
65 /** Offset to this miptree level, used in computing x_offset. */
67 /** Offset to this miptree level, used in computing y_offset. */
71 /** Depth of the mipmap at this level: 1 for 1D/2D/CUBE, n for 3D. */
73 /** Number of images at this level: 1 for 1D/2D, 6 for CUBE, depth for 3D */
77 * offsets from level_[xy] to the image for each cube face or depth
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.
85 GLuint
*x_offset
, *y_offset
;
89 struct intel_mipmap_tree
91 /* Effectively the key:
94 GLenum internal_format
;
98 GLuint width0
, height0
, depth0
; /**< Level zero image dimensions */
100 GLboolean compressed
;
102 /* Derived from the above:
107 /* Includes image offset tables:
109 struct intel_mipmap_level level
[MAX_TEXTURE_LEVELS
];
111 /* The data is held here:
113 struct intel_region
*region
;
115 /* These are also refcounted:
122 struct intel_mipmap_tree
*intel_miptree_create(struct intel_context
*intel
,
125 GLenum internal_format
,
131 GLuint compress_byte
,
132 GLboolean expect_accelerated_upload
);
134 struct intel_mipmap_tree
*
135 intel_miptree_create_for_region(struct intel_context
*intel
,
137 GLenum internal_format
,
138 struct intel_region
*region
,
140 GLuint compress_byte
);
142 int intel_miptree_pitch_align (struct intel_context
*intel
,
143 struct intel_mipmap_tree
*mt
,
147 void intel_miptree_reference(struct intel_mipmap_tree
**dst
,
148 struct intel_mipmap_tree
*src
);
150 void intel_miptree_release(struct intel_context
*intel
,
151 struct intel_mipmap_tree
**mt
);
153 /* Check if an image fits an existing mipmap tree layout
155 GLboolean
intel_miptree_match_image(struct intel_mipmap_tree
*mt
,
156 struct gl_texture_image
*image
);
158 /* Return a pointer to an image within a tree. Return image stride as
161 GLubyte
*intel_miptree_image_map(struct intel_context
*intel
,
162 struct intel_mipmap_tree
*mt
,
165 GLuint
* row_stride
, GLuint
* image_stride
);
167 void intel_miptree_image_unmap(struct intel_context
*intel
,
168 struct intel_mipmap_tree
*mt
);
171 intel_miptree_get_image_offset(struct intel_mipmap_tree
*mt
,
172 GLuint level
, GLuint face
, GLuint depth
,
173 GLuint
*x
, GLuint
*y
);
175 void intel_miptree_set_level_info(struct intel_mipmap_tree
*mt
,
179 GLuint w
, GLuint h
, GLuint d
);
181 void intel_miptree_set_image_offset(struct intel_mipmap_tree
*mt
,
183 GLuint img
, GLuint x
, GLuint y
);
185 /* Upload an image into a tree
187 void intel_miptree_image_data(struct intel_context
*intel
,
188 struct intel_mipmap_tree
*dst
,
192 GLuint src_row_pitch
, GLuint src_image_pitch
);
194 /* Copy an image between two trees
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
);
201 /* i915_mipmap_tree.c:
203 GLboolean
i915_miptree_layout(struct intel_context
*intel
,
204 struct intel_mipmap_tree
*mt
,
206 GLboolean
i945_miptree_layout(struct intel_context
*intel
,
207 struct intel_mipmap_tree
*mt
,
209 GLboolean
brw_miptree_layout(struct intel_context
*intel
,
210 struct intel_mipmap_tree
*mt
,