WebGLRenderingContext.clear()

Метод WebGLRenderingContext.clear() из библиотеки WebGL API очищает буфер заданными значениями.

Заданные значения могут быть установлены clearColor(), clearDepth() (en-US) или clearStencil() (en-US).

The scissor box, dithering, and buffer writemasks can affect the clear() method.

Синтаксис

void gl.clear(mask);

Параметры

mask
Побитовая маска ИЛИ GLbitfield (en-US) указывает какие конкретно буферы нужно очистить. Возможные значения:
  • gl.COLOR_BUFFER_BIT
  • gl.DEPTH_BUFFER_BIT
  • gl.STENCIL_BUFFER_BIT

Возвращаемое значение

Ничего.

Исключения

Если mask не является ни одним из перечисленных значений, то генерируется ошибка gl.INVALID_ENUM.

Примеры

Метод clear() принимает несколько значений.

gl.clear(gl.DEPTH_BUFFER_BIT);
gl.clear(gl.DEPTH_BUFFER_BIT | gl.COLOR_BUFFER_BIT);

Чтобы получить текущее значение очистки буфера, нужно воспользоваться следующими константами: COLOR_CLEAR_VALUE, DEPTH_CLEAR_VALUE, и STENCIL_CLEAR_VALUE.

gl.getParameter(gl.COLOR_CLEAR_VALUE);
gl.getParameter(gl.DEPTH_CLEAR_VALUE);
gl.getParameter(gl.STENCIL_CLEAR_VALUE);

Спецификации

Спецификация Статус Комментарии
WebGL 1.0
Определение 'clear' в этой спецификации.
Рекомендация Изначальное определение
OpenGL ES 2.0
Определение 'glClear' в этой спецификации.
Стандарт Справочная страница OpenGL API.

Совместимость с браузерами

BCD tables only load in the browser

Смотрите также