Class

Gjs ▶ gjs/cairo ▶ default ▶ ImageSurface

A surface that uses in-memory image data buffers

Hierarchy (View Summary)

Index

Constructors

constructor

Methods

getFormat getHeight getWidth writeToPNG createFromPNG

Methods - Inherited from gjs/cairo.default.Surface

finish flush get_user_data getDeviceOffset getDeviceScale set_user_data setDeviceOffset setDeviceScale

Constructors

  • Creates a new image surface

    Parameters

    • format: Format

      The format of pixels in the surface

    • width: number

      Width of the surface in pixels

    • height: number

      Height of the surface in pixels

    Returns ImageSurface

Methods

  • Gets the format of the surface

    Returns Format

    The format of the surface

  • Gets the height of the surface in pixels

    Returns number

    The height of the surface

  • Gets the width of the surface in pixels

    Returns number

    The width of the surface

  • Writes the contents of the surface to a PNG file

    Parameters

    • filename: string

      Path to the PNG file to write

    Returns void

Methods - Inherited from gjs/cairo.default.Surface

  • Gets the device scale of the surface

    Returns [number, number]

    An array with [x, y] device scale

  • Attaches user data to the surface (C API: cairo_surface_set_user_data)

    Parameters

    • key: UserDataKey

      Key for the user data

    • userData: unknown

      Data to attach

    • Optionaldestroy: (data: unknown) => void

      Optional callback when the surface is destroyed or data is replaced

    Returns Status

  • Sets the device offset of the surface

    Parameters

    • x: number

      X offset

    • y: number

      Y offset

    Returns void

  • Sets the device scale of the surface

    Parameters

    • x: number

      X scale factor

    • y: number

      Y scale factor

    Returns void