Gl.TexEnvi (gb.opengl)

Set texture environment parameters.

Parameters

target

Specifies a texture environment. May be Gl.TEXTURE_ENV, Gl.TEXTURE_FILTER_CONTROL or Gl.POINT_SPRITE.

pname

Specifies the symbolic name of a single-valued texture environment parameter. May be either Gl.TEXTURE_ENV_MODE, Gl.TEXTURE_LOD_BIAS, Gl.COMBINE_RGB, Gl.COMBINE_ALPHA, Gl.SRC0_RGB, Gl.SRC1_RGB, Gl.SRC2_RGB, Gl.SRC0_ALPHA, Gl.SRC1_ALPHA, Gl.SRC2_ALPHA, Gl.OPERAND0_RGB, Gl.OPERAND1_RGB, Gl.OPERAND2_RGB, Gl.OPERAND0_ALPHA, Gl.OPERAND1_ALPHA, Gl.OPERAND2_ALPHA, Gl.RGB_SCALE, Gl.ALPHA_SCALE, or Gl.COORD_REPLACE.

param

Specifies a single symbolic constant, one of Gl.ADD, Gl.ADD_SIGNED, Gl.INTERPOLATE, Gl.MODULATE, Gl.DECAL, Gl.BLEND, Gl.REPLACE, Gl.SUBTRACT, Gl.COMBINE, Gl.TEXTURE, Gl.CONSTANT, Gl.PRIMARY_COLOR, Gl.PREVIOUS, Gl.SRC_COLOR, Gl.ONE_MINUS_SRC_COLOR, Gl.SRC_ALPHA, Gl.ONE_MINUS_SRC_ALPHA, a single boolean value for the point sprite texture coordinate replacement, a single floating-point value for the texture level-of-detail bias, or 1.0, 2.0, or 4.0 when specifying the Gl.RGB_SCALE or Gl.ALPHA_SCALE.

C Specification

void glTexEnvfv(	GLenum target,
	GLenum pname,
	const GLfloat params);

 

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

 

Parameters

target

Specifies a texture environment. May be either Gl.TEXTURE_ENV, or Gl.TEXTURE_FILTER_CONTROL.

pname

Specifies the symbolic name of a texture environment parameter. Accepted values are Gl.TEXTURE_ENV_MODE, Gl.TEXTURE_ENV_COLOR, or Gl.TEXTURE_LOD_BIAS.

params

Specifies a pointer to a parameter array that contains either a single symbolic constant, single floating-point number, or an RGBA color.

Description

A texture environment specifies how texture values are interpreted when a fragment is textured. When target is Gl.TEXTURE_FILTER_CONTROL, pname must be Gl.TEXTURE_LOD_BIAS. When target is Gl.TEXTURE_ENV, pname can be Gl.TEXTURE_ENV_MODE, Gl.TEXTURE_ENV_COLOR, Gl.COMBINE_RGB, Gl.COMBINE_ALPHA, Gl.RGB_SCALE, Gl.ALPHA_SCALE, Gl.SRC0_RGB, Gl.SRC1_RGB, Gl.SRC2_RGB, Gl.SRC0_ALPHA, Gl.SRC1_ALPHA, or Gl.SRC2_ALPHA.

If pname is Gl.TEXTURE_ENV_MODE, then params is (or points to) the symbolic name of a texture function. Six texture functions may be specified: Gl.ADD, Gl.MODULATE, Gl.DECAL, Gl.BLEND, Gl.REPLACE, or Gl.COMBINE.

The following table shows the correspondence of filtered texture values ${\mathit{R}}_{\mathit{t}}$, ${\mathit{G}}_{\mathit{t}}$, ${\mathit{B}}_{\mathit{t}}$, ${\mathit{A}}_{\mathit{t}}$, ${\mathit{L}}_{\mathit{t}}$, ${\mathit{I}}_{\mathit{t}}$ to texture source components. ${\mathit{C}}_{\mathit{s}}$ and ${\mathit{A}}_{\mathit{s}}$ are used by the texture functions described below.

Texture Base Internal Format	${\mathit{C}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{s}}$
Gl.ALPHA	(0, 0, 0)	${\mathit{A}}_{\mathit{t}}$
Gl.LUMINANCE	( ${\mathit{L}}_{\mathit{t}}$, ${\mathit{L}}_{\mathit{t}}$, ${\mathit{L}}_{\mathit{t}}$ )	1
Gl.LUMINANCE_ALPHA	( ${\mathit{L}}_{\mathit{t}}$, ${\mathit{L}}_{\mathit{t}}$, ${\mathit{L}}_{\mathit{t}}$ )	${\mathit{A}}_{\mathit{t}}$
Gl.INTENSITY	( ${\mathit{I}}_{\mathit{t}}$, ${\mathit{I}}_{\mathit{t}}$, ${\mathit{I}}_{\mathit{t}}$ )	${\mathit{I}}_{\mathit{t}}$
Gl.RGB	( ${\mathit{R}}_{\mathit{t}}$, ${\mathit{G}}_{\mathit{t}}$, ${\mathit{B}}_{\mathit{t}}$ )	1
Gl.RGBA	( ${\mathit{R}}_{\mathit{t}}$, ${\mathit{G}}_{\mathit{t}}$, ${\mathit{B}}_{\mathit{t}}$ )	${\mathit{A}}_{\mathit{t}}$

A texture function acts on the fragment to be textured using the texture image value that applies to the fragment (see Gl.TexParameter) and produces an RGBA color for that fragment. The following table shows how the RGBA color is produced for each of the first five texture functions that can be chosen. $\mathit{C}$ is a triple of color values (RGB) and $\mathit{A}$ is the associated alpha value. RGBA values extracted from a texture image are in the range /wiki/0,1. The subscript $\mathit{p}$ refers to the color computed from the previous texture stage (or the incoming fragment if processing texture stage 0), the subscript $\mathit{s}$ to the texture source color, the subscript $\mathit{c}$ to the texture environment color, and the subscript $\mathit{v}$ indicates a value produced by the texture function.

Texture Base Internal Format	Value	Gl.REPLACE Function	Gl.MODULATE Function	Gl.DECAL Function	Gl.BLEND Function	Gl.ADD Function
Gl.ALPHA	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{p}}$	${\mathit{C}}_{\mathit{p}}$	undefined	${\mathit{C}}_{\mathit{p}}$	${\mathit{C}}_{\mathit{p}}$
	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$			${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$
Gl.LUMINANCE	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}{\mathit{C}}_{\mathit{s}}$	undefined	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{C}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{c}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}+{\mathit{C}}_{\mathit{s}}$
(or 1)	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$		${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$
Gl.LUMINANCE_ALPHA	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}{\mathit{C}}_{\mathit{s}}$	undefined	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{C}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{c}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}+{\mathit{C}}_{\mathit{s}}$
(or 2)	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$		${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$
Gl.INTENSITY	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}{\mathit{C}}_{\mathit{s}}$	undefined	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{C}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{c}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}+{\mathit{C}}_{\mathit{s}}$
	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$		${\mathit{A}}_{\mathit{p}}\left(1-{\mathit{A}}_{\mathit{s}}\right)+{\mathit{A}}_{\mathit{c}}{\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}+{\mathit{A}}_{\mathit{s}}$
Gl.RGB	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{C}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{c}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}+{\mathit{C}}_{\mathit{s}}$
(or 3)	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}$
Gl.RGBA	${\mathit{C}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{A}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{s}}{\mathit{A}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}\left(1-{\mathit{C}}_{\mathit{s}}\right)+{\mathit{C}}_{\mathit{c}}{\mathit{C}}_{\mathit{s}}$	${\mathit{C}}_{\mathit{p}}+{\mathit{C}}_{\mathit{s}}$
(or 4)	${\mathit{A}}_{\mathit{v}}<code\; style="white-space:nowrap;"></code>$	${\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$	${\mathit{A}}_{\mathit{p}}{\mathit{A}}_{\mathit{s}}$

If pname is Gl.TEXTURE_ENV_MODE, and params is Gl.COMBINE, the form of the texture function depends on the values of Gl.COMBINE_RGB and Gl.COMBINE_ALPHA.

The following describes how the texture sources, as specified by Gl.SRC0_RGB, Gl.SRC1_RGB, Gl.SRC2_RGB, Gl.SRC0_ALPHA, Gl.SRC1_ALPHA, and Gl.SRC2_ALPHA, are combined to produce a final texture color. In the following tables, Gl.SRC0_c is represented by $\mathit{Arg0}$, Gl.SRC1_c is represented by $\mathit{Arg1}$, and Gl.SRC2_c is represented by $\mathit{Arg2}$.

Gl.COMBINE_RGB accepts any of Gl.REPLACE, Gl.MODULATE, Gl.ADD, Gl.ADD_SIGNED, Gl.INTERPOLATE, Gl.SUBTRACT, Gl.DOT3_RGB, or Gl.DOT3_RGBA.

Gl.COMBINE_RGB	Texture Function
Gl.REPLACE	$\mathit{Arg0}$
Gl.MODULATE	$\mathit{Arg0}\times \mathit{Arg1}$
Gl.ADD	$\mathit{Arg0}+\mathit{Arg1}$
Gl.ADD_SIGNED	$\mathit{Arg0}+\mathit{Arg1}-0.5$
Gl.INTERPOLATE	$\mathit{Arg0}\times \mathit{Arg2}+\mathit{Arg1}\times \left(1-\mathit{Arg2}\right)$
Gl.SUBTRACT	$\mathit{Arg0}-\mathit{Arg1}$
Gl.DOT3_RGB or Gl.DOT3_RGBA	$4\times \left(\left(\left({\mathit{Arg0}}_{\mathit{r}}-0.5\right)\times \left({\mathit{Arg1}}_{\mathit{r}}-0.5\right)\right)+\left(\left({\mathit{Arg0}}_{\mathit{g}}-0.5\right)\times \left({\mathit{Arg1}}_{\mathit{g}}-0.5\right)\right)+\left(\left({\mathit{Arg0}}_{\mathit{b}}-0.5\right)\times \left({\mathit{Arg1}}_{\mathit{b}}-0.5\right)\right)\right)$

The scalar results for Gl.DOT3_RGB and Gl.DOT3_RGBA are placed into each of the 3 (RGB) or 4 (RGBA) components on output.

Likewise, Gl.COMBINE_ALPHA accepts any of Gl.REPLACE, Gl.MODULATE, Gl.ADD, Gl.ADD_SIGNED, Gl.INTERPOLATE, or Gl.SUBTRACT. The following table describes how alpha values are combined:

Gl.COMBINE_ALPHA	Texture Function
Gl.REPLACE	$\mathit{Arg0}$
Gl.MODULATE	$\mathit{Arg0}\times \mathit{Arg1}$
Gl.ADD	$\mathit{Arg0}+\mathit{Arg1}$
Gl.ADD_SIGNED	$\mathit{Arg0}+\mathit{Arg1}-0.5$
Gl.INTERPOLATE	$\mathit{Arg0}\times \mathit{Arg2}+\mathit{Arg1}\times \left(1-\mathit{Arg2}\right)$
Gl.SUBTRACT	$\mathit{Arg0}-\mathit{Arg1}$

In the following tables, the value ${\mathit{C}}_{\mathit{s}}$ represents the color sampled from the currently bound texture, ${\mathit{C}}_{\mathit{c}}$ represents the constant texture-environment color, ${\mathit{C}}_{\mathit{f}}$ represents the primary color of the incoming fragment, and ${\mathit{C}}_{\mathit{p}}$ represents the color computed from the previous texture stage or ${\mathit{C}}_{\mathit{f}}$ if processing texture stage 0. Likewise, ${\mathit{A}}_{\mathit{s}}$, ${\mathit{A}}_{\mathit{c}}$, ${\mathit{A}}_{\mathit{f}}$, and ${\mathit{A}}_{\mathit{p}}$ represent the respective alpha values.

The following table describes the values assigned to $\mathit{Arg0}$, $\mathit{Arg1}$, and $\mathit{Arg2}$ based upon the RGB sources and operands:

Gl.SRCn_RGB	Gl.OPERANDn_RGB	Argument Value
Gl.TEXTURE	Gl.SRC_COLOR	${\mathit{C}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_COLOR	$1-{\mathit{C}}_{\mathit{s}}$
	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{s}}$
Gl.TEXTUREn	Gl.SRC_COLOR	${\mathit{C}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_COLOR	$1-{\mathit{C}}_{\mathit{s}}$
	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{s}}$
Gl.CONSTANT	Gl.SRC_COLOR	${\mathit{C}}_{\mathit{c}}$
	Gl.ONE_MINUS_SRC_COLOR	$1-{\mathit{C}}_{\mathit{c}}$
	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{c}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{c}}$
Gl.PRIMARY_COLOR	Gl.SRC_COLOR	${\mathit{C}}_{\mathit{f}}$
	Gl.ONE_MINUS_SRC_COLOR	$1-{\mathit{C}}_{\mathit{f}}$
	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{f}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{f}}$
Gl.PREVIOUS	Gl.SRC_COLOR	${\mathit{C}}_{\mathit{p}}$
	Gl.ONE_MINUS_SRC_COLOR	$1-{\mathit{C}}_{\mathit{p}}$
	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{p}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{p}}$

For Gl.TEXTUREn sources, ${\mathit{C}}_{\mathit{s}}$ and ${\mathit{A}}_{\mathit{s}}$ represent the color and alpha, respectively, produced from texture stage $\mathit{n}$.

The follow table describes the values assigned to $\mathit{Arg0}$, $\mathit{Arg1}$, and $\mathit{Arg2}$ based upon the alpha sources and operands:

Gl.SRCn_ALPHA	Gl.OPERANDn_ALPHA	Argument Value
Gl.TEXTURE	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{s}}$
Gl.TEXTUREn	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{s}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{s}}$
Gl.CONSTANT	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{c}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{c}}$
Gl.PRIMARY_COLOR	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{f}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{f}}$
Gl.PREVIOUS	Gl.SRC_ALPHA	${\mathit{A}}_{\mathit{p}}$
	Gl.ONE_MINUS_SRC_ALPHA	$1-{\mathit{A}}_{\mathit{p}}$

The RGB and alpha results of the texture function are multipled by the values of Gl.RGB_SCALE and Gl.ALPHA_SCALE, respectively, and clamped to the range $\left.[/0,1\right]$.

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 /wiki/0,1 when they are specified. ${\mathit{C}}_{\mathit{c}}$ takes these four values.

If pname is Gl.TEXTURE_LOD_BIAS, the value specified is added to the texture level-of-detail parameter, that selects which mipmap, or mipmaps depending upon the selected Gl.TEXTURE_MIN_FILTER, will be sampled.

Gl.TEXTURE_ENV_MODE defaults to Gl.MODULATE and Gl.TEXTURE_ENV_COLOR defaults to (0, 0, 0, 0).

If target is Gl.POINT_SPRITE and pname is Gl.COORD_REPLACE, the boolean value specified is used to either enable or disable point sprite texture coordinate replacement. The default value is Gl.FALSE.

Notes

Gl.REPLACE may only be used if the GL version is 1.1 or greater.

Gl.TEXTURE_FILTER_CONTROL and Gl.TEXTURE_LOD_BIAS may only be used if the GL version is 1.4 or greater.

Gl.COMBINE mode and its associated constants may only be used if the GL version is 1.3 or greater.

Gl.TEXTUREn may only be used if the GL version is 1.4 or greater.

Internal formats other than 1, 2, 3, or 4 may only be used if the GL version is 1.1 or greater.

For OpenGL versions 1.3 and greater, or when the ARB_multitexture extension is supported, Gl.TexEnv controls the texture environment for the current active texture unit, selected by Gl.ActiveTexture.

Gl.POINT_SPRITE and Gl.COORD_REPLACE are available only if the GL version is 2.0 or greater.

Errors

Gl.INVALID_ENUM is generated when target or pname is not one of the accepted defined values, or when params should have a defined constant value (based on the value of pname) and does not.

Gl.INVALID_VALUE is generated if the params value for Gl.RGB_SCALE or Gl.ALPHA_SCALE are not one of 1.0, 2.0, or 4.0.

Gl.INVALID_OPERATION is generated if Gl.TexEnv is executed between the execution of Gl.Begin and the corresponding execution of Gl.End.

Associated Gets

Gl.GetTexEnv

See also

See original documentation on OpenGL website