WebGLRenderingContext.pixelStorei()

The WebGLRenderingContext.pixelStorei() method of the WebGL API specifies the pixel storage modes.

Syntax

void gl.pixelStorei(pname, param);

Parameters

pname

A Glenum specifying which parameter to set. See below for possible values.

param

A GLint specifying a value to set the pname parameter to. See below for possible values.

Return value

None.

Pixel storage parameters

When using a WebGL 2 context, the following values are available additionally:

Examples

Setting the pixel storage mode affects the WebGLRenderingContext.readPixels() operations, as well as unpacking of textures with the WebGLRenderingContext.texImage2D() and WebGLRenderingContext.texSubImage2D() methods.

var tex = gl.createTexture();
gl.bindTexture(gl.TEXTURE_2D, tex);
gl.pixelStorei(gl.PACK_ALIGNMENT, 4);

To check the values for packing and unpacking of pixel data, you can query the same pixel storage parameters with WebGLRenderingContext.getParameter().

gl.getParameter(gl.PACK_ALIGNMENT);
gl.getParameter(gl.UNPACK_ALIGNMENT);

Specifications

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

See also

• WebGLRenderingContext.readPixels()
• WebGLRenderingContext.texImage2D()
• WebGLRenderingContext.texSubImage2D()