API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfacePixelReaderOptions

@codexo/exojs / rendering / stable

Options for RenderingContext.createPixelReader.

2
props
0
methods
0
events
Import
import { PixelReaderOptions } from '@codexo/exojs'

Options for RenderingContext.createPixelReader.

Properties2
region?: ReadonlyRectangleRead-only view of a Rectangle: every accessor and non-mutating query a rectangle offers, with none of its writers. Returned by APIs that hand out a LIVE intern…
Sub-rectangle to read, in pixels from the texture's top-left corner. Defaults to the whole texture.
slots?: number
Staging slots, each holding one read's pixels until it is released. Defaults to 2: one read in flight while the previous result is still held. Every slot costs width * height * 4 bytes for the reader's lifetime, so size this from how many reads the consumer keeps outstanding, not generously.
Source
src/rendering/texture/PixelReader.ts