Skip to content

API Reference / @gtkx/gl / readPixels

Function: readPixels() ​

readPixels(x, y, width, height, format, type, pixels): void

Defined in: packages/gl/src/generated/commands.ts:6416

void glReadPixels(GLint x, GLint y, GLsizei width, GLsizei height, GLenum format, GLenum type, void *pixels)

Provided by GL_VERSION_1_0. GLX single opcode 111.

Parameters ​

x ​

number

GLint, kind WinCoord. This parameter represents a window coordinate.

y ​

number

GLint, kind WinCoord. This parameter represents a window coordinate.

width ​

number

GLsizei

height ​

number

GLsizei

format ​

number

PixelFormat

type ​

number

PixelType

pixels ​

GLpointer | ArrayBufferView<ArrayBufferLike> | null

ArrayBufferView | GLpointer | null, length COMPSIZE(format,type,width,height)

Returns ​

void