gluBuild1DMipmaps function

The gluBuild1DMipmaps function creates 1-D mipmaps.

Syntax

void WINAPI gluBuild1DMipmaps(
         GLenum target,
         GLint  components,
         GLint  width,
         GLenum format,
         GLenum type,
   const void   *data
);

Parameters

target

The target texture. Must be GL_TEXTURE_1D.

components

The number of color components in the texture. Must be 1, 2, 3, or 4.

width

The width of the texture image.

format

The format of the pixel data. The following values are valid: GL_COLOR_INDEX, GL_RED, GL_GREEN, GL_BLUE, GL_ALPHA, GL_RGB, GL_RGBA, GL_BGR_EXT, GL_BGRA_EXT, GL_LUMINANCE, or GL_LUMINANCE_ALPHA.

type

The data type for data. The following values are valid: GL_UNSIGNED_BYTE, GL_BYTE, GL_BITMAP, GL_UNSIGNED_SHORT, GL_SHORT, GL_UNSIGNED_INT, GL_INT, or GL_FLOAT.

data

A pointer to the image data in memory.

Return value

This function does not return a value.

Remarks

The gluBuild1DMipmaps function obtains the input image and generates all mipmap images (using gluScaleImage) so that the input image can be used as a mipmapped texture image. The glTexImage1D function is then called to load each of the images. If the width of the input image is not a power of two, then the image is scaled to the nearest power of two before the mipmaps are generated.

A return value of zero indicates success. Otherwise, a GLU error code is returned (see gluErrorString).

For a description of the acceptable values for the format parameter, see glTexImage1D. For a description of the acceptable values for the type parameter, see glDrawPixels.

Requirements

See also

glDrawPixels

glTexImage1D

gluBuild2DMipmaps

gluScaleImage