WebGLRenderingContext: метод getUniformLocation()

Как часть API WebGL, метод WebGLRenderingContext getUniformLocation() возвращает расположение конкретной переменной uniform, которая входит в состав заданной WebGLProgram.

Переменная uniform возвращается как объект WebGLUniformLocation, который представляет собой некий идентификатор, используемый для указания места в памяти графического процессора, где расположена переменная uniform.

После получения расположения uniform, вы можете получить доступ к самой uniform, используя один из других методов доступа к uniform, передав расположение uniform в качестве одного из входных параметров:

getUniform()

Возвращает значение uniform в заданном расположении.

WebGLRenderingContext.uniform[1234][fi][v]()

Устанавливает значение uniform в указанное значение, которое может быть одним плавающим или целым числом, или вектором с 2-4 компонентами, указанным либо как список значений, либо как Float32Array или Int32Array.

WebGLRenderingContext.uniformMatrix[234][fv]()

Устанавливает значение uniform в указанную матрицу, возможно с транспонированием. Значение представлено как последовательность GLfloat значений или как Float32Array.

Сама uniform объявляется в программе шейдера с помощью GLSL.

program

WebGLProgram программа, в которой необходимо найти указанную переменную uniform.

name

Строка, определяющая имя переменной uniform, расположение которой требуется вернуть. Имя не может содержать пробелы, и вы не можете использовать эту функцию для получения расположения uniform, начинающихся со зарезервированной строки "gl_", так как они являются внутренними для уровня WebGL.

Возможные значения соответствуют именам uniform, возвращаемым функцией getActiveUniform; см. эту функцию для получения подробностей о том, как объявленные uniform сопоставляются с именами расположений uniform.

Кроме того, для uniform, объявленных как массивы, также допустимы следующие имена:

• Имя uniform без суффикса [0]. Например, расположение, возвращаемое для arrayUniform, эквивалентно расположению для arrayUniform[0].
• Имя uniform с индексом целого числа. Например, расположение, возвращаемое для arrayUniform[2], указывает непосредственно на третий элемент uniform arrayUniform.

Значение WebGLUniformLocation, указывающее на расположение переменной, если она существует. Если указанная переменная не найдена, возвращается null.

WebGLUniformLocation — это непрозрачное значение, используемое для уникальной идентификации расположения в памяти графического процессора, где расположена переменная uniform. Имея это значение, вы можете вызвать другие методы WebGL для доступа к значению переменной uniform.

Могут возникнуть следующие ошибки; чтобы проверить наличие ошибок после того, как getUniformLocation() вернёт результат, вызовите getError().

GL_INVALID_VALUE

Параметр program не является значением или объектом, сгенерированным WebGL.

GL_INVALID_OPERATION

Параметр program не соответствует программе GLSL, сгенерированной WebGL, или указанная программа не была успешно связана.

В этом примере, взятом из метода animateScene() в статье Пример анимации 2D WebGL, получаются расположения трёх uniform из программы шейдеров, а затем устанавливаются значения каждой из трёх uniform.

gl.useProgram(shaderProgram);

uScalingFactor = gl.getUniformLocation(shaderProgram, "uScalingFactor");
uGlobalColor = gl.getUniformLocation(shaderProgram, "uGlobalColor");
uRotationVector = gl.getUniformLocation(shaderProgram, "uRotationVector");

gl.uniform2fv(uScalingFactor, currentScale);
gl.uniform2fv(uRotationVector, currentRotation);
gl.uniform4fv(uGlobalColor, [0.1, 0.7, 0.2, 1.0]);

После установки текущей программы шейдеров на shaderProgram, этот код извлекает три uniform "uScalingFactor", "uGlobalColor", и "uRotationVector", вызывая getUniformLocation() один раз для каждой uniform.

Затем устанавливаются значения трёх uniform:

• Uniform uScalingFactor — 2-компонентный вершинный параметр — получает горизонтальный и вертикальный масштабные множители из переменной currentScale.
• Uniform uRotationVector устанавливается в содержимое переменной currentRotation. Это также 2-компонентный вершинный параметр.
• Наконец, uniform uGlobalColor устанавливается в цвет [0.1, 0.7, 0.2, 1.0], компоненты этого 4-компонентного вектора представляют значения красного, зеленого, синего и альфа-каналов соответственно.

После этого, при следующем вызове функций шейдеров, их собственные переменные с именами uScalingFactor, uGlobalColor, и uRotationVector будут иметь значения, заданные кодом JavaScript.

• WebGLRenderingContext.getAttribLocation()
• WebGLRenderingContext.getActiveUniform()
• WebGLUniformLocation