ReadOptions | Brass Engine

Index

data?: null | T

An optional TypedArray which gets the result of reading the pixels. (Default: null, i.e. return a new TypedArray)

framebuffer?: Framebuffer

Sets the framebuffer to read pixels from. (Default: currently bound framebuffer)

height?: number

The height of the rectangle in pixels (Default: current framebuffer height)

width?: number

The width of the rectangle in pixels. (Default: current framebuffer width)

x?: number

The x-offset of the upper-left corner of the rectangle in pixels. (Default: 0)

y?: number

The y-offset of the upper-left corner of the rectangle in pixels. (Default: 0)