1GLUBUILD3DMIPMAPS(3G) OpenGL Manual GLUBUILD3DMIPMAPS(3G)
2
3
4
6 gluBuild3DMipmaps - builds a three-dimensional mipmap
7
9 GLint gluBuild3DMipmaps(GLenum target, GLint internalFormat,
10 GLsizei width, GLsizei height, GLsizei depth,
11 GLenum format, GLenum type, const void * data);
12
14 target
15 Specifies the target texture. Must be GLU_TEXTURE_3D.
16
17 internalFormat
18 Requests the internal storage format of the texture image. The most
19 current version of the SGI implementation of GLU does not check
20 this value for validity before passing it on to the underlying
21 OpenGL implementation. A value that is not accepted by the OpenGL
22 implementation will lead to an OpenGL error. The benefit of not
23 checking this value at the GLU level is that OpenGL extensions can
24 add new internal texture formats without requiring a revision of
25 the GLU implementation. Older implementations of GLU check this
26 value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
27 the following symbolic constants: GLU_ALPHA, GLU_ALPHA4,
28 GLU_ALPHA8, GLU_ALPHA12, GLU_ALPHA16, GLU_LUMINANCE,
29 GLU_LUMINANCE4, GLU_LUMINANCE8, GLU_LUMINANCE12, GLU_LUMINANCE16,
30 GLU_LUMINANCE_ALPHA, GLU_LUMINANCE4_ALPHA4, GLU_LUMINANCE6_ALPHA2,
31 GLU_LUMINANCE8_ALPHA8, GLU_LUMINANCE12_ALPHA4,
32 GLU_LUMINANCE12_ALPHA12, GLU_LUMINANCE16_ALPHA16, GLU_INTENSITY,
33 GLU_INTENSITY4, GLU_INTENSITY8, GLU_INTENSITY12, GLU_INTENSITY16,
34 GLU_RGB, GLU_R3_G3_B2, GLU_RGB4, GLU_RGB5, GLU_RGB8, GLU_RGB10,
35 GLU_RGB12, GLU_RGB16, GLU_RGBA, GLU_RGBA2, GLU_RGBA4, GLU_RGB5_A1,
36 GLU_RGBA8, GLU_RGB10_A2, GLU_RGBA12, or GLU_RGBA16.
37
38 width, height, depth
39 Specifies in pixels the width, height and depth respectively, in
40 pixels of the texture image.
41
42 format
43 Specifies the format of the pixel data. Must be one of
44 GLU_COLOR_INDEX, GLU_DEPTH_COMPONENT, GLU_RED, GLU_GREEN, GLU_BLUE,
45 GLU_ALPHA, GLU_RGB, GLU_RGBA, GLU_BGR, GLU_BGRA, GLU_LUMINANCE, or
46 GLU_LUMINANCE_ALPHA.
47
48 type
49 Specifies the data type for data. Must be one of:
50 GLU_UNSIGNED_BYTE, GLU_BYTE, GLU_BITMAP, GLU_UNSIGNED_SHORT,
51 GLU_SHORT, GLU_UNSIGNED_INT, GLU_INT, GLU_FLOAT,
52 GLU_UNSIGNED_BYTE_3_3_2, GLU_UNSIGNED_BYTE_2_3_3_REV,
53 GLU_UNSIGNED_SHORT_5_6_5, GLU_UNSIGNED_SHORT_5_6_5_REV,
54 GLU_UNSIGNED_SHORT_4_4_4_4, GLU_UNSIGNED_SHORT_4_4_4_4_REV,
55 GLU_UNSIGNED_SHORT_5_5_5_1, GLU_UNSIGNED_SHORT_1_5_5_5_REV,
56 GLU_UNSIGNED_INT_8_8_8_8, GLU_UNSIGNED_INT_8_8_8_8_REV,
57 GLU_UNSIGNED_INT_10_10_10_2, or GLU_UNSIGNED_INT_2_10_10_10_REV.
58
59 data
60 Specifies a pointer to the image data in memory.
61
63 gluBuild3DMipmaps builds a series of prefiltered three-dimensional
64 texture maps of decreasing resolutions called a mipmap. This is used
65 for the antialiasing of texture-mapped primitives.
66
67 A return value of zero indicates success, otherwise a GLU error code is
68 returned (see gluErrorString()).
69
70 Initially, the width, height and depth of data are checked to see if
71 they are a power of 2. If not, a copy of data is made and scaled up or
72 down to the nearest power of 2. (If width, height, or depth is exactly
73 between powers of 2, then the copy of data will scale upwards.) This
74 copy will be used for subsequent mipmapping operations described below.
75 For example, if width is 57, height is 23, and depth is 24, then a copy
76 of data will scale up to 64 in width, down to 16 in height, and up to
77 32 in depth before mipmapping takes place.
78
79 Then, proxy textures (see glTexImage3D()) are used to determine if the
80 implementation can fit the requested texture. If not, all three
81 dimensions are continually halved until it fits.
82
83 Next, a series of mipmap levels is built by decimating a copy of data
84 in half along all three dimensions until size 1 × 1 × 1 is reached. At
85 each level, each texel in the halved mipmap level is an average of the
86 corresponding eight texels in the larger mipmap level. (If exactly one
87 of the dimensions is 1, four texels are averaged. If exactly two of the
88 dimensions are 1, two texels are averaged.)
89
90 glTexImage3D() is called to load each of these mipmap levels. Level 0
91 is a copy of data. The highest level is log 2 max width height
92 depth. For example, if width is 64, height is 16, and depth is 32, and
93 the implementation can store a texture of this size, the following
94 mipmap levels are built: 64 × 16 × 32, 32 × 8 × 16, 16 × 4 × 8, 8 × 2 ×
95 4, 4 × 1 × 2, 2 × 1 × 1, and 1 × 1 × 1. These correspond to levels 0
96 through 6, respectively.
97
98 See the glTexImage1D() reference page for a description of the
99 acceptable values for format parameter. See the glDrawPixels()
100 reference page for a description of the acceptable values for type
101 parameter.
102
104 Note that there is no direct way of querying the maximum level. This
105 can be derived indirectly via glGetTexLevelParameter(). First, query
106 the width, height, and depth actually used at level 0. (The width,
107 height, and depth may not be equal to width, height, and depth
108 respectively since proxy textures might have scaled them to fit the
109 implementation.) Then the maximum level can be derived from the formula
110 log 2 max width height depth.
111
112 gluBuild3DMipmaps is only available if the GLU version is 1.3 or
113 greater.
114
115 Formats GLU_BGR, and GLU_BGRA, and types GLU_UNSIGNED_BYTE_3_3_2,
116 GLU_UNSIGNED_BYTE_2_3_3_REV, GLU_UNSIGNED_SHORT_5_6_5,
117 GLU_UNSIGNED_SHORT_5_6_5_REV, GLU_UNSIGNED_SHORT_4_4_4_4,
118 GLU_UNSIGNED_SHORT_4_4_4_4_REV, GLU_UNSIGNED_SHORT_5_5_5_1,
119 GLU_UNSIGNED_SHORT_1_5_5_5_REV, GLU_UNSIGNED_INT_8_8_8_8,
120 GLU_UNSIGNED_INT_8_8_8_8_REV, GLU_UNSIGNED_INT_10_10_10_2, and
121 GLU_UNSIGNED_INT_2_10_10_10_REV are only available if the GL version is
122 1.2 or greater.
123
125 GLU_INVALID_VALUE is returned if width, height, or depth is < 1.
126
127 GLU_INVALID_ENUM is returned if internalFormat, format, or type is not
128 legal.
129
130 GLU_INVALID_OPERATION is returned if type is GLU_UNSIGNED_BYTE_3_3_2 or
131 GLU_UNSIGNED_BYTE_2_3_3_REV and format is not GLU_RGB.
132
133 GLU_INVALID_OPERATION is returned if type is GLU_UNSIGNED_SHORT_5_6_5
134 or GLU_UNSIGNED_SHORT_5_6_5_REV and format is not GLU_RGB.
135
136 GLU_INVALID_OPERATION is returned if type is GLU_UNSIGNED_SHORT_4_4_4_4
137 or GLU_UNSIGNED_SHORT_4_4_4_4_REV and format is neither GLU_RGBA nor
138 GLU_BGRA.
139
140 GLU_INVALID_OPERATION is returned if type is GLU_UNSIGNED_SHORT_5_5_5_1
141 or GLU_UNSIGNED_SHORT_1_5_5_5_REV and format is neither GLU_RGBA nor
142 GLU_BGRA.
143
144 GLU_INVALID_OPERATION is returned if type is GLU_UNSIGNED_INT_8_8_8_8
145 or GLU_UNSIGNED_INT_8_8_8_8_REV and format is neither GLU_RGBA nor
146 GLU_BGRA.
147
148 GLU_INVALID_OPERATION is returned if type is
149 GLU_UNSIGNED_INT_10_10_10_2 or GLU_UNSIGNED_INT_2_10_10_10_REV and
150 format is neither GLU_RGBA nor GLU_BGRA.
151
153 gluBuild1DMipmapLevels(), gluBuild1DMipmaps(),
154 gluBuild2DMipmapLevels(), gluBuild3DMipmapLevels(), gluBuild3DMipmaps,
155 gluErrorString(), glDrawPixels(), glGetTexImage(),
156 glGetTexLevelParameter(), glTexImage1D(), glTexImage2D(),
157 glTexImage3D()
158
160 Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed
161 under the SGI Free Software B License. For details, see
162 http://oss.sgi.com/projects/FreeB/.
163
165 opengl.org
166
167
168
169opengl.org 07/13/2018 GLUBUILD3DMIPMAPS(3G)