Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Gif

Hierarchy

  • Gif

Implements

Index

Constructors

constructor

  • new Gif(skipDefault?: undefined | false | true): Gif
  • Gif

    Parameters

    • Optional skipDefault: undefined | false | true

    Returns Gif

Properties

bgColorIndex

bgColorIndex: number

colorResolution

colorResolution: number

frameIndex1

frameIndex1: number = 0

frameIndex2

frameIndex2: number = 0

frames

frames: GifFrame[]

isLoop

isLoop: boolean

pixelAspectRatio

pixelAspectRatio: number

sortFlag

sortFlag: boolean

Accessors

globalColorTable

  • get globalColorTable(): Uint8Array
  • set globalColorTable(bytes: Uint8Array): void
  • Returns Uint8Array

  • Parameters

    • bytes: Uint8Array

    Returns void

globalTableSize

  • get globalTableSize(): number
  • Returns number

height

  • get height(): number
  • set height(height: number): void
  • Returns number

  • Parameters

    • height: number

    Returns void

loopCount

  • get loopCount(): number
  • set loopCount(loopCount: number): void
  • Returns number

  • Parameters

    • loopCount: number

    Returns void

version

  • Returns GifVersion

  • Parameters

    Returns void

width

  • get width(): number
  • set width(width: number): void
  • Returns number

  • Parameters

    • width: number

    Returns void

Methods

playback

  • playback(overwrite: boolean): Gif
  • Playback the animated GIF image.

    Parameters

    • overwrite: boolean

    Returns Gif

    Gif object

split

  • split(overwrite: boolean): Gif[]
  • Split the animated GIF image.

    Parameters

    • overwrite: boolean

    Returns Gif[]

    array of Gif object

versionName

  • versionName(): string
  • Returns string

writeToArray

  • writeToArray(): number[]
  • TODO

    Returns number[]

writeToArrayBuffer

  • writeToArrayBuffer(): Uint8Array[]
  • Returns Uint8Array[]

Static compressWithLZW

  • compressWithLZW(actualCodes: Uint8Array, numBits: number): number[]
  • Parameters

    • actualCodes: Uint8Array
    • numBits: number

    Returns number[]

Static parse

  • parse(buffer: ArrayBuffer): Gif
  • Parse Gif image from ArrayBuffer.

    Parameters

    • buffer: ArrayBuffer

    Returns Gif

    parsed gif object

Static writeToArrayBuffer

  • writeToArrayBuffer(gif: Gif): Uint8Array[]
  • Convert Gif to Uint8Array[].

    Parameters

    Returns Uint8Array[]

    array of Uint8Array