Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

PainterPixels

Pixel read/write: `await painter.pixels.getData(…)`, `.setData`, `.manipulate`, `.getColor`, `.setColor`.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/painter-facets.ts (opens in a new tab)

Signature

TypeScript
export interface PainterPixels {
    getData(canvasBuffer: CanvasResults | Buffer, options?: {
        x?: number;
        y?: number;
        width?: number;
        height?: number;
    }): Promise<PixelData>;
    setData(canvasBuffer: CanvasResults | Buffer, pixelData: PixelData, options?: {
        x?: number;
        y?: number;
        dirtyX?: number;
        dirtyY?: number;
        dirtyWidth?: number;
        dirtyHeight?: number;
    }): Promise<Buffer>;
    manipulate(canvasBuffer: CanvasResults | Buffer, options: PixelManipulationOptions): Promise<Buffer>;
    getColor(canvasBuffer: CanvasResults | Buffer, x: number, y: number): Promise<{
        r: number;
        g: number;
        b: number;
        a: number;
    }>;
    setColor(canvasBuffer: CanvasResults | Buffer, x: number, y: number, color: {
        r: number;
        g: number;
        b: number;
        a?: number;
    }): Promise<Buffer>;
}

Related APIs

No explicit related API metadata.

Next steps