/ comp / gb.opengl / gl / blendfunc
Gl.BlendFunc (gb.opengl)
Syntax

    STATIC SUB BlendFunc ( SrcFactor AS Integer, DstFactor AS Integer )

### Specify pixel arithmetic

#### Parameters

- SrcFactor specifies how the red, green, blue, and alpha source-blending factors are computed. Nine symbolic constants are accepted: Gl.GL_ZERO, GL_ZERO, Gl.GL_DST_COLOR, Gl.GL_ONE_MINUS_DST_COLOR, Gl.GL_SRC_ALPHA, Gl.GL_ONE_MINUS_SRC_ALPHA, Gl.GL_DST_ALPHA, Gl.GL_ONE_MINUS_DST_ALPHA, and Gl.GL_SRC_ALPHA_SATURATE.

- DstFactor specifies how the red, green, blue, and alpha destination blending factors are computed. Eight symbolic constants are accepted: Gl.GL_ZERO, Gl.GL_ONE, Gl.GL_SRC_COLOR, Gl.GL_ONE_MINUS_SRC_COLOR, Gl.GL_SRC_ALPHA, Gl.GL_ONE_MINUS_SRC_ALPHA, Gl.GL_DST_ALPHA, and Gl.GL_ONE_MINUS_DST_ALPHA.

#### Description

In RGB mode, pixels can be drawn using a function that blends the incoming (source) RGBA values with the RGBA values that are already in the frame buffer (the destination values). By default, blending is disabled. Use Gl.Enable and Gl.Disable with argument Gl.GL_BLEND to enable and disable blending.

Gl.BlendFunc defines the operation of blending when it is enabled. SrcFactor specifies which of nine methods is used to scale the source color components. DstFactor specifies which of eight methods is used to scale the destination color components. The eleven possible methods are described in the table below. Each method defines four scale factors, one each for red, green, blue, and alpha.

In the table and in subsequent equations, source and destination color components are referred to as (R s , G s , B s , A s ) and (R d , G d , B d , A d ). They are understood to have integer values between zero and (k R , k G , k B , k A ), where K c = 2 mc - 1 and (m R , m G , m B , m A ) is the number of red, green, blue, and alpha bitplanes.

Source and destination scale factors are referred to as (s R , s G , s B , s A ) and (d R , d G , d B , d A ). The scale factors described in the table, denoted (f R , f G , f B , f A ), represent either source or destination factors. All scale factors have range [0, 1].

Parameter | (f R , f G , f B , fA )
--- | ---
GL.GL_ZERO | (0, 0, 0, 0)
Gl.GL_ONE | (1, 1, 1, 1)
Gl.GL_SRC_COLOR | (R s / k R , G s / k G, B s / k B , A s / k A )
Gl.GL_ONE_MINUS_SRC_COLOR | (1, 1, 1, 1) - (R s / k R , G s / k G, B s / k B , A s / k A )
Gl.GL_DST_COLOR | (R d / k R , G d / k G , B d / k B , A d / k A )
Gl.GL_ONE_MINUS_DST_COLOR | (1, 1, 1, 1) - (R d / k R , G d / k G , B d / k B , A d / k A )
Gl.GL_SRC_ALPHA | (A s / k A , A s / k A , A s / k A , A s / k A )
Gl.GL_ONE_MINUS_SRC_ALPHA | (1, 1, 1, 1) - (A s / k A , A s / k A , A s / k A , A s / k A )
Gl.GL_DST_ALPHA | (A d / k A , A d / k A , A d / k A , A d / k A )
Gl.GL_ONE_MINUS_DST_ALPHA | (1, 1, 1, 1) - (A d / k A , A d / k A , A d / k A , A d / k A )
Gl.GL_SRC_ALPHA_SATURATE | (i, i, i, 1 ) With i = min (A s , k A - A d ) / k A

To determine the blended RGBA values of a pixel when drawing in RGB mode, the system uses the following equations:

- Rd = min ( kR , RssR + RddR )
- Gd = min ( kG , GssG + GddG )
- Bd = min ( kB , BssB + BddB )
- Ad = min ( kA , AssA + AddA )

Despite the apparent precision of the above equations, blending arithmetic is not exactly specified, because blending operates with imprecise integer color values. However, a blend factor that should be equal to one is guaranteed not to modify its multiplicand, and a blend factor equal to zero reduces its multiplicand to zero. Thus, for example, when SrcFactor is Gl.GL_SRC_ALPHA, DstFactor is Gl.GL_ONE_MINUS_SRC_ALPHA, and As is equal to kA, the equations reduce to simple replacement:

- Rd = Rs
- Gd = Gs
- Bd = Bs
- Ad = As

#### Examples

Transparency is best implemented using blend function (Gl.GL_SRC_ALPHA, Gl.GL_ONE_MINUS_SRC_ALPHA) with primitives sorted from farthest to nearest. Note that this transparency calculation does not require the presence of alpha bitplanes in the frame buffer.

Blend function (Gl.GL_SRC_ALPHA, Gl.GL_ONE_MINUS_SRC_ALPHA) is also useful for rendering antialiased points and lines in arbitrary order. Polygon antialiasing is optimized using blend function (Gl.GL_SRC_ALPHA_SATURATE, Gl.GL_ONE) with polygons sorted from nearest to farthest. (See the Gl.Enable , Gl.Disable reference page and the Gl.GL_POLYGON_SMOOTH argument for information on polygon antialiasing) Destination alpha bitplanes, which must be present for this blend function to operate correctly, store the accumulated coverage.

| Incoming (source) alpha is correctly thought of as a material opacity, ranging from 1.0 (KA), representing complete opacity, to 0.0 (0), representing completely transparency. When more than one color buffer is enabled for drawing, blending is done separately for each enabled buffer, using for destination color the contents of that buffer. (See Gl.DrawBuffer ) Blending affects only RGB rendering. It is ignored by color index renderers.

#### Errors

Gl.GL_INVALID_ENUM is generated if either SrcFactor or DstFactor is not an accepted value.
Gl.GL_INVALID_OPERATION is generated if Gl.BlendFunc is called between a call to Gl.Begin and the corresponding call to Gl.End.

#### Associated Gets

Gl.GetBlendSrc
Gl.GetBlendDst
Gl.IsEnabled with argument Gl.GL_BLEND

### See also

Gl.AlphaFunc , Gl.Clear , Gl.DrawBuffer, Gl.Enable, Gl.LogicOp, Gl.StencilFunc