gluBuild3DMipmapLevels(3g)

1GLUBUILD3DMIPMAPLEVE(3G)         OpenGL Manual        GLUBUILD3DMIPMAPLEVE(3G)
2
3
4

NAME

6       gluBuild3DMipmapLevels - builds a subset of three-dimensional mipmap
7       levels
8

C SPECIFICATION

10       GLint gluBuild3DMipmapLevels(GLenum target, GLint internalFormat,
11                                    GLsizei width, GLsizei height,
12                                    GLsizei depth, GLenum format, GLenum type,
13                                    GLint level, GLint base, GLint max,
14                                    const void * data);
15

PARAMETERS

17       target
18           Specifies the target texture. Must be GLU_TEXTURE_3D.
19
20       internalFormat
21           Requests the internal storage format of the texture image. The most
22           current version of the SGI implementation of GLU does not check
23           this value for validity before passing it on to the underlying
24           OpenGL implementation. A value that is not accepted by the OpenGL
25           implementation will lead to an OpenGL error. The benefit of not
26           checking this value at the GLU level is that OpenGL extensions can
27           add new internal texture formats without requiring a revision of
28           the GLU implementation. Older implementations of GLU check this
29           value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
30           the following symbolic constants: GLU_ALPHA, GLU_ALPHA4,
31           GLU_ALPHA8, GLU_ALPHA12, GLU_ALPHA16, GLU_LUMINANCE,
32           GLU_LUMINANCE4, GLU_LUMINANCE8, GLU_LUMINANCE12, GLU_LUMINANCE16,
33           GLU_LUMINANCE_ALPHA, GLU_LUMINANCE4_ALPHA4, GLU_LUMINANCE6_ALPHA2,
34           GLU_LUMINANCE8_ALPHA8, GLU_LUMINANCE12_ALPHA4,
35           GLU_LUMINANCE12_ALPHA12, GLU_LUMINANCE16_ALPHA16, GLU_INTENSITY,
36           GLU_INTENSITY4, GLU_INTENSITY8, GLU_INTENSITY12, GLU_INTENSITY16,
37           GLU_RGB, GLU_R3_G3_B2, GLU_RGB4, GLU_RGB5, GLU_RGB8, GLU_RGB10,
38           GLU_RGB12, GLU_RGB16, GLU_RGBA, GLU_RGBA2, GLU_RGBA4, GLU_RGB5_A1,
39           GLU_RGBA8, GLU_RGB10_A2, GLU_RGBA12, or GLU_RGBA16.
40
41       width, height, depth
42           Specifies in pixels the width, height and depth respectively, of
43           the texture image. These should be a power of 2.
44
45       format
46           Specifies the format of the pixel data. Must be one of
47           GLU_COLOR_INDEX, GLU_DEPTH_COMPONENT, GLU_RED, GLU_GREEN, GLU_BLUE,
48           GLU_ALPHA, GLU_RGB, GLU_RGBA, GLU_BGR, GLU_BGRA, GLU_LUMINANCE, or
49           GLU_LUMINANCE_ALPHA.
50
51       type
52           Specifies the data type for data. Must be one of GLU_UNSIGNED_BYTE,
53           GLU_BYTE, GLU_BITMAP, GLU_UNSIGNED_SHORT, GLU_SHORT,
54           GLU_UNSIGNED_INT, GLU_INT, GLU_FLOAT, GLU_UNSIGNED_BYTE_3_3_2,
55           GLU_UNSIGNED_BYTE_2_3_3_REV, GLU_UNSIGNED_SHORT_5_6_5,
56           GLU_UNSIGNED_SHORT_5_6_5_REV, GLU_UNSIGNED_SHORT_4_4_4_4,
57           GLU_UNSIGNED_SHORT_4_4_4_4_REV, GLU_UNSIGNED_SHORT_5_5_5_1,
58           GLU_UNSIGNED_SHORT_1_5_5_5_REV, GLU_UNSIGNED_INT_8_8_8_8,
59           GLU_UNSIGNED_INT_8_8_8_8_REV, GLU_UNSIGNED_INT_10_10_10_2, or
60           GLU_UNSIGNED_INT_2_10_10_10_REV.
61
62       level
63           Specifies the mipmap level of the image data.
64
65       base
66           Specifies the minimum mipmap level to pass to glTexImage3D().
67
68       max
69           Specifies the maximum mipmap level to pass to glTexImage3D().
70
71       data
72           Specifies a pointer to the image data in memory.
73

DESCRIPTION

75       gluBuild3DMipmapLevels builds a subset of prefiltered three-dimensional
76       texture maps of decreasing resolutions called a mipmap. This is used
77       for the antialiasing of texture mapped primitives.
78
79       A return value of zero indicates success, otherwise a GLU error code is
80       returned (see gluErrorString()).
81
82       A series of mipmap levels from base to max is built by decimating data
83       in half along both dimensions until size 1 × 1 × 1 is reached. At each
84       level, each texel in the halved mipmap level is an average of the
85       corresponding eight texels in the larger mipmap level. (If exactly one
86       of the dimensions is 1, four texels are averaged. If exactly two of the
87       dimensions are 1, two texels are averaged.)  glTexImage3D() is called
88       to load these mipmap levels from base to max. If max is larger than the
89       highest mipmap level for the texture of the specified size, then a GLU
90       error code is returned (see gluErrorString()) and nothing is loaded.
91
92       For example, if level is 2 and width is 16, height is 8 and depth is 4,
93       the following levels are possible: 16 × 8 × 4, 8 × 4 × 2, 4 × 2 × 1, 2
94       × 1 × 1, 1 × 1 × 1. These correspond to levels 2 through 6
95       respectively. If base is 3 and max is 5, then only mipmap levels 8 × 4
96       × 2, 4 × 2 × 1, and 2 × 1 × 1 are loaded. However, if max is 7, then an
97       error is returned and nothing is loaded, since max is larger than the
98       highest mipmap level which is, in this case, 6.
99
100       The highest mipmap level can be derived from the formula log 2 ⁡ max ⁡
101       width height depth × 2 level.
102
103       See the glTexImage1D() reference page for a description of the
104       acceptable values for format parameter. See the glDrawPixels()
105       reference page for a description of the acceptable values for type
106       parameter.
107

NOTES

109       gluBuild3DMipmapLevels is only available if the GLU version is 1.3 or
110       greater.
111
112       Formats GLU_BGR, and GLU_BGRA, and types GLU_UNSIGNED_BYTE_3_3_2,
113       GLU_UNSIGNED_BYTE_2_3_3_REV, GLU_UNSIGNED_SHORT_5_6_5,
114       GLU_UNSIGNED_SHORT_5_6_5_REV, GLU_UNSIGNED_SHORT_4_4_4_4,
115       GLU_UNSIGNED_SHORT_4_4_4_4_REV, GLU_UNSIGNED_SHORT_5_5_5_1,
116       GLU_UNSIGNED_SHORT_1_5_5_5_REV, GLU_UNSIGNED_INT_8_8_8_8,
117       GLU_UNSIGNED_INT_8_8_8_8_REV, GLU_UNSIGNED_INT_10_10_10_2, and
118       GLU_UNSIGNED_INT_2_10_10_10_REV are only available if the GL version is
119       1.2 or greater.
120

ERRORS

122       GLU_INVALID_VALUE is returned if level > base, base < 0, max < base, or
123       max is > the highest mipmap level for data.
124
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

COPYRIGHT

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

AUTHORS

165       opengl.org
166
167
168
169opengl.org                        06/10/2014          GLUBUILD3DMIPMAPLEVE(3G)