glTexEnviv function

The glTexEnviv function sets a texture environment parameter.

Syntax

void WINAPI glTexEnviv(
         GLenum target,
         GLenum pname,
   const GLint  *params
);

Parameters

target

A texture environment. Must be GL_TEXTURE_ENV.

pname

The symbolic name of a single-valued texture environment parameter. Accepted values are GL_TEXTURE_ENV_MODE and GL_TEXTURE_ENV_COLOR.

params

A pointer to an array of parameters: either a single symbolic constant or an RGBA color.

Return value

This function does not return a value.

Error codes

The following error codes can be retrieved by the glGetError function.

Name Meaning
GL_INVALID_ENUM
target or pname was not one of the accepted defined values, or when params should have had a defined constant value (based on the value of pname) and did not.
GL_INVALID_OPERATION
The function was called between a call to glBegin and the corresponding call to glEnd.

Remarks

A texture environment specifies how texture values are interpreted when a fragment is textured. The target parameter must be GL_TEXTURE_ENV. The pname parameter can be either GL_TEXTURE_ENV_MODE or GL_TEXTURE_ENV_COLOR.

If pname is GL_TEXTURE_ENV_MODE, then params is (or points to) the symbolic name of a texture function. Three texture functions are defined: GL_MODULATE, GL_DECAL, and GL_BLEND.

A texture function acts on the fragment to be textured using the texture image value that applies to the fragment (see glTexParameter) and produces an RGBA color for that fragment. The following table shows how the RGBA color is produced for each of the three texture functions that can be chosen. C is a triple of color values (RGB) and A is the associated alpha value. RGBA values extracted from a texture image are in the range [0, 1]. The subscript f refers to the incoming fragment, the subscript t to the texture image, the subscript c to the texture environment color, and subscript v indicates a value produced by the texture function.

A texture image can have up to four components per texture element (see glTexImage1D and glTexImage2D). In a one-component image, Lt indicates that single component. A two-component image uses L? and A? . A three-component image has only a color value, C? . A four-component image has both a color value C? and an alpha value A? .

Number of components GL_MODULATE GL_DECAL GL_BLEND
1${REMOVE}$
Cv = L? Cf undefined${REMOVE}$
Cv = (1 - L? )Cf + L? Cc
Av = Af Av = Af
2${REMOVE}$
Cv = L? Cf undefined${REMOVE}$
Cv = (1 - L? )Cf + L? Cc
Av = Af Av = Af
3${REMOVE}$
Cv = C? Cf Cv = C? undefined${REMOVE}$
Av = Af Av = Af
4${REMOVE}$
Cv = C? Cf Cv = (1 - A? )Cf + A? C? undefined${REMOVE}$
Av = A? Af Av = Af

If pname is GL_TEXTURE_ENV_COLOR, params is a pointer to an array that holds an RGBA color consisting of four values. Integer color components are interpreted linearly such that the most positive integer maps to 1.0, and the most negative integer maps to -1.0. The values are clamped to the range [0, 1] when they are specified. Cc takes these four values.

GL_TEXTURE_ENV_MODE defaults to GL_MODULATE and GL_TEXTURE_ENV_COLOR defaults to (0, 0, 0, 0).

The following function retrieves information related to glTexEnviv:

glTexGetEnviv

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Gl.h
Library
Opengl32.lib
DLL
Opengl32.dll

See also

glBegin

glEnd

glTexImage1D

glTexImage2D

glTexParameter