Gambas Documentation - /comp/gb.opengl/gl/accum

/comp/gb.opengl/gl/accum

# Gl.Accum (gb.opengl)

Static Sub Accum ( Operation As Integer, Value As Float )

Operate on the accumulation buffer.

### Parameters

op

  Specifies the accumulation buffer operation. Symbolic constants Gl.ACCUM, Gl.LOAD, Gl.ADD, Gl.MULT, and Gl.RETURN are accepted.

value

  Specifies a floating-point value used in the accumulation buffer operation. op determines how value is used.

### Description

The accumulation buffer is an extended-range color buffer. Images are not rendered into it. Rather, images rendered into one of the color buffers are added to the contents of the accumulation buffer after rendering. Effects such as antialiasing (of points, lines, and polygons), motion blur, and depth of field can be created by accumulating images generated with different transformation matrices.

Each pixel in the accumulation buffer consists of red, green, blue, and alpha values. The number of bits per component in the accumulation buffer depends on the implementation. You can examine this number by calling Gl.GetIntegerv four times, with arguments Gl.ACCUM_RED_BITS, Gl.ACCUM_GREEN_BITS, Gl.ACCUM_BLUE_BITS, and Gl.ACCUM_ALPHA_BITS. Regardless of the number of bits per component, the range of values stored by each component is -1 1 . The accumulation buffer pixels are mapped one-to-one with frame buffer pixels.

Gl.Accum operates on the accumulation buffer. The first argument, op, is a symbolic constant that selects an accumulation buffer operation. The second argument, value, is a floating-point value to be used in that operation. Five operations are specified: Gl.ACCUM, Gl.LOAD, Gl.ADD, Gl.MULT, and Gl.RETURN.

All accumulation buffer operations are limited to the area of the current scissor box and applied identically to the red, green, blue, and alpha components of each pixel. If a Gl.Accum operation results in a value outside the range -1 1 , the contents of an accumulation buffer pixel component are undefined.

The operations are as follows:

Gl.ACCUM

  Obtains R, G, B, and A values from the buffer currently selected for reading (see Gl.ReadBuffer). Each component value is divided by 2 n - 1 , where n is the number of bits allocated to each color component in the currently selected buffer. The result is a floating-point value in the range 0 1 , which is multiplied by value and added to the corresponding pixel component in the accumulation buffer, thereby updating the accumulation buffer.

Gl.LOAD

  Similar to Gl.ACCUM, except that the current value in the accumulation buffer is not used in the calculation of the new value. That is, the R, G, B, and A values from the currently selected buffer are divided by 2 n - 1 , multiplied by value, and then stored in the corresponding accumulation buffer cell, overwriting the current value.

Gl.ADD

  Adds value to each R, G, B, and A in the accumulation buffer.

Gl.MULT

  Multiplies each R, G, B, and A in the accumulation buffer by value and returns the scaled component to its corresponding accumulation buffer location.

Gl.RETURN

  Transfers accumulation buffer values to the color buffer or buffers currently selected for writing. Each R, G, B, and A component is multiplied by value, then multiplied by 2 n - 1 , clamped to the range 0 2 n - 1 , and stored in the corresponding display buffer cell. The only fragment operations that are applied to this transfer are pixel ownership, scissor, dithering, and color writemasks.

To clear the accumulation buffer, call Gl.ClearAccum with R, G, B, and A values to set it to, then call Gl.Clear with the accumulation buffer enabled.

### Notes

Only pixels within the current scissor box are updated by a Gl.Accum operation.

### Errors

Gl.INVALID_ENUM is generated if op is not an accepted value.

Gl.INVALID_OPERATION is generated if there is no accumulation buffer.

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

### Associated Gets

Gl.Get with argument Gl.ACCUM_RED_BITS

Gl.Get with argument Gl.ACCUM_GREEN_BITS

Gl.Get with argument Gl.ACCUM_BLUE_BITS

Gl.Get with argument Gl.ACCUM_ALPHA_BITS

### See also

- Gl.Clear,

- Gl.ClearAccum,

- Gl.CopyPixels,

- Gl.DrawBuffer,

Gl.Get, Gl.ReadBuffer, Gl.ReadPixels, Gl.Scissor, Gl.StencilOp

See original documentation on OpenGL website