Class OCIF

constructor

• new OCIF(width: number, height: number, fill?: Partial<Pixel>): OCIF

  Creates a new OCIF image.

  Parameters

  • width: number

    The width of the image.

  • height: number

    The height of the image.

  • fill: Partial<Pixel> = {}

    Optional. A pixel for filling the image. Defaults to a black background, white foreground, and a space character.

  Returns OCIF

height

pixels

width

getPixel

• getPixel(x: number, y: number): Pixel | undefined

  Gets the pixel at the specified coordinates.

  Parameters

  • x: number

    The x-coordinate of the pixel.

  • y: number

    The y-coordinate of the pixel.

  Returns Pixel | undefined

  The pixel at the specified coordinates, or undefined if the coordinates are out of bounds.

setPixel

• setPixel(x: number, y: number, pixel: Pixel): void

  Sets the pixel at the specified coordinates.

  Parameters

  • x: number

    The x-coordinate of the pixel.

  • y: number

    The y-coordinate of the pixel.

  • pixel: Pixel

    The pixel to set.

  Returns void

toBuffer

• toBuffer(encodingMethod?: number): Buffer

  Saves the OCIF image to a buffer.

  Parameters

  • encodingMethod: number = 8

    The OCIF encoding method to use. Can be 5, 6, 7, or 8. Defaults to 8.

  Returns Buffer

  A buffer containing the OCIF image data.

toPNG

• toPNG(scale?: number): Buffer

  Converts the OCIF image to a PNG buffer.

  Parameters

  • scale: number = 1

    The scale factor for the output PNG. Defaults to 1.

  Returns Buffer

  A buffer containing the PNG image data.

StaticfromBuffer

• fromBuffer(buffer: Buffer): OCIF

  Loads an OCIF image from a buffer.

  Parameters

  • buffer: Buffer

    The buffer containing the OCIF image data.

  Returns OCIF

  A new OCIF instance.