Class ClipMask

Hierarchy

ClipMask

Index

Properties

rect

rect: Rect

`Optional` src_url

src_url?: string

file path of the source image, or base64 data uri
if a base64 data uri is provided, then once it has been turned trasnparent and converted into this.data_uri, this.src_url will be deleted
at any given time, one of either this.src_url or this.data_blob will be present

`Optional` data_blob

data_blob?: Blob

Constructors

constructor

new ClipMask(src_url?: string, rect?: Partial<Rect>): ClipMask
Parameters
- Optional src_url: string
- Optional rect: Partial<Rect>
Returns ClipMask
- Defined in mod.ts:45

Methods

fromURL

fromURL(src_url: string, rect: Partial<Rect>): Promise<void>
load an image from a local path or url, such as: "./bitmasks/juice.png" or "https://picsum.photos/200/300?grayscale"
Parameters
- src_url: string
- rect: Partial<Rect>
Returns Promise<void>
- Defined in mod.ts:51

fromDataURI

fromDataURI(data_uri: string, rect: Partial<Rect>): Promise<void>
load an image from a string of data uri, such as: "data:image/gif;base64,R0l..."
Parameters
- data_uri: string
- rect: Partial<Rect>
Returns Promise<void>
- Defined in mod.ts:71

fromBuffer

fromBuffer(buf: Uint8Array | Uint8ClampedArray, rect: {
    x?: number;
    y?: number;
    width: number;
    height: number;
}): Promise<void>
load an image from a Uint8Array of RGBA pixels. the width and height must be defined in the passed rect
Parameters
- buf: Uint8Array | Uint8ClampedArray
- rect: {
      x?: number;
      y?: number;
      width: number;
      height: number;
  }
  - Optional x?: number
  - Optional y?: number
  - width: number
  - height: number
Returns Promise<void>
- Defined in mod.ts:76

`Static` turnTransparent

turnTransparent(buf: Uint8Array | Uint8ClampedArray): Uint8ClampedArray
turn the provided buffer of pixels to become transparent where a black pixel is present
Parameters
- buf: Uint8Array | Uint8ClampedArray
Returns Uint8ClampedArray
- Defined in mod.ts:90

clearDataBlob

clearDataBlob(): undefined
Returns undefined
- Defined in mod.ts:96

clipImage

clipImage(img: CanvasImageSource): Promise<OffscreenCanvas>
Parameters
- img: CanvasImageSource
Returns Promise<OffscreenCanvas>
- Defined in mod.ts:98

Class ClipMask

Hierarchy

Index

Properties

Constructors

Methods

Properties

rect

Optional src_url

Optional data_blob

Constructors

constructor

Parameters

Optional src_url: string

Optional rect: Partial<Rect>

Returns ClipMask

Methods

fromURL

Parameters

src_url: string

rect: Partial<Rect>

Returns Promise<void>

fromDataURI

Parameters

data_uri: string

rect: Partial<Rect>

Returns Promise<void>

fromBuffer

Parameters

buf: Uint8Array | Uint8ClampedArray

rect: { x?: number; y?: number; width: number; height: number; }

Optional x?: number

Optional y?: number

width: number

height: number

Returns Promise<void>

Static turnTransparent

Parameters

buf: Uint8Array | Uint8ClampedArray

Returns Uint8ClampedArray

clearDataBlob

Returns undefined

clipImage

Parameters

img: CanvasImageSource

Returns Promise<OffscreenCanvas>

Settings

Member Visibility

Theme

`Optional` src_url

`Optional` data_blob

`Optional` src_url: string

`Optional` rect: Partial<Rect>

rect: {
x?: number;
y?: number;
width: number;
height: number;
}

`Optional` x?: number

`Optional` y?: number

`Static` turnTransparent