Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IPixelBuffer<T, P>

Type parameters

  • T: TypedArray = TypedArray

  • P = any

Hierarchy

  • IPixelBuffer

Implemented by

Index

Properties

Readonly format

format: IABGRConvert<any>

Readonly height

height: number

Readonly pixels

pixels: T

Readonly stride

stride: number

Readonly width

width: number

Methods

getAt

  • getAt(x: number, y: number): P
  • Returns pixel value at given position. If pos is outside the defined region, returns a suitable zero value.

    Parameters

    • x: number

      -

    • y: number

      -

    Returns P

getRegion

  • getRegion(x: number, y: number, width: number, height: number): IPixelBuffer<T, P>
  • Extracts region as new pixel buffer in same format.

    Parameters

    • x: number

      -

    • y: number

      -

    • width: number

      -

    • height: number

      -

    Returns IPixelBuffer<T, P>

setAt

  • Writes pixel value at given position. Has no effect if outside of the defined region.

    Parameters

    • x: number

      -

    • y: number

      -

    • col: P

      -

    Returns IPixelBuffer<T, P>

Generated using TypeDoc