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

/comp/gb.opengl/gl/clearindex

# Gl.ClearIndex (gb.opengl)

Static Sub ClearIndex ( Value As Float )

Specify the clear value for the color index buffers.

### Parameters

c

  Specifies the index used when the color index buffers are cleared. The initial value is 0.

### Description

Gl.ClearIndex specifies the index used by Gl.Clear to clear the color index buffers. c is not clamped. Rather, c is converted to a fixed-point value with unspecified precision to the right of the binary point. The integer part of this value is then masked with 2 m - 1 , where m is the number of bits in a color index stored in the frame buffer.

### Errors

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

### Associated Gets

Gl.Get with argument Gl.INDEX_CLEAR_VALUE

Gl.Get with argument Gl.INDEX_BITS

### See also

- Gl.Clear

See original documentation on OpenGL website