Difference between revisions of "GLAPI/glBlendEquation"

From OpenGL Wiki
Jump to navigation Jump to search
m (Bot: Adding better formatting.)
(→‎Description: Clamping only for non-float-point or non-integral)
Line 22: Line 22:
 
These equations use the source and destination blend factors specified by either {{apifunc|glBlendFunc}} or {{apifunc|glBlendFuncSeparate}}. See {{apifunc|glBlendFunc}} or {{apifunc|glBlendFuncSeparate}} for a description of the various blend factors.
 
These equations use the source and destination blend factors specified by either {{apifunc|glBlendFunc}} or {{apifunc|glBlendFuncSeparate}}. See {{apifunc|glBlendFunc}} or {{apifunc|glBlendFuncSeparate}} for a description of the various blend factors.
  
In the equations that follow, source and destination color components are referred to as <math>(R_s, G_s, B_s, A_s)</math> and <math>(R_d, G_d, B_d, A_d)</math>, respectively. The result color is referred to as <math>(R_r, G_r, B_r, A_r)</math>. The source and destination blend factors are denoted <math>(s_R, s_G, s_B, s_A)</math> and <math>(d_R, d_G, d_B, d_A)</math>, respectively. For these equations all color components are understood to have values in the range [0, 1].  
+
In the equations that follow, source and destination color components are referred to as <math>(R_s, G_s, B_s, A_s)</math> and <math>(R_d, G_d, B_d, A_d)</math>, respectively. The result color is referred to as <math>(R_r, G_r, B_r, A_r)</math>. The source and destination blend factors are denoted <math>(s_R, s_G, s_B, s_A)</math> and <math>(d_R, d_G, d_B, d_A)</math>, respectively.
 +
For these equations all color components are understood to have values in the range [0, 1] if the target is neither floating-point nor integral.
  
 
{| class="wikitable" style="background-color:transparent;"
 
{| class="wikitable" style="background-color:transparent;"
Line 51: Line 52:
 
|}
 
|}
  
The results of these equations are clamped to the range [0, 1].
+
The results of these equations are clamped to the range [0, 1] if the target is neither floating-point nor integral.
  
 
The {{enum|GL_MIN}} and {{enum|GL_MAX}} equations are useful for applications that analyze image data (image thresholding against a constant color, for example). The {{enum|GL_FUNC_ADD}} equation is useful for antialiasing and transparency, among other things.
 
The {{enum|GL_MIN}} and {{enum|GL_MAX}} equations are useful for applications that analyze image data (image thresholding against a constant color, for example). The {{enum|GL_FUNC_ADD}} equation is useful for antialiasing and transparency, among other things.

Revision as of 08:10, 27 August 2012

glBlendEquation
Core in version 4.6
Core since version 1.0

glBlendEquation: specify the equation used for both the RGB blend equation and the Alpha blend equation

Function Definition

 void glBlendEquation(GLenum mode​);
 void glBlendEquationi(GLuint buf​, GLenum mode​);
buf
for glBlendEquationi, specifies the index of the draw buffer for which to set the blend equation.
mode
specifies how source and destination colors are combined. It must be GL_FUNC_ADD, GL_FUNC_SUBTRACT, GL_FUNC_REVERSE_SUBTRACT, GL_MIN, GL_MAX.

Description

The blend equations determine how a new pixel (the source color) is combined with a pixel already in the framebuffer (the destination color). This function sets both the RGB blend equation and the alpha blend equation to a single equation. glBlendEquationi specifies the blend equation for a single draw buffer whereas glBlendEquation sets the blend equation for all draw buffers.

These equations use the source and destination blend factors specified by either glBlendFunc or glBlendFuncSeparate. See glBlendFunc or glBlendFuncSeparate for a description of the various blend factors.

In the equations that follow, source and destination color components are referred to as and , respectively. The result color is referred to as . The source and destination blend factors are denoted and , respectively. For these equations all color components are understood to have values in the range [0, 1] if the target is neither floating-point nor integral.

Mode RGB Components Alpha Component
GL_FUNC_ADD
GL_FUNC_SUBTRACT
GL_FUNC_REVERSE_SUBTRACT
GL_MIN
GL_MAX

The results of these equations are clamped to the range [0, 1] if the target is neither floating-point nor integral.

The GL_MIN and GL_MAX equations are useful for applications that analyze image data (image thresholding against a constant color, for example). The GL_FUNC_ADD equation is useful for antialiasing and transparency, among other things.

Initially, both the RGB blend equation and the alpha blend equation are set to GL_FUNC_ADD.

Notes

The GL_MIN, and GL_MAX equations do not use the source or destination factors, only the source and destination colors.

Errors

GL_INVALID_ENUM is generated if mode​ is not one of GL_FUNC_ADD, GL_FUNC_SUBTRACT, GL_FUNC_REVERSE_SUBTRACT, GL_MAX, or GL_MIN.

GL_INVALID_VALUE is generated by glBlendEquationi if buf​ is greater than or equal to the value of GL_MAX_DRAW_BUFFERS.

Associated Gets

glGet with an argument of GL_BLEND_EQUATION_RGB

glGet with an argument of GL_BLEND_EQUATION_ALPHA

See Also

glBlendColor, glBlendFunc, glBlendFuncSeparate

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.