love-typescript-definitions/typings/love.image/functions.d.ts

Write LÖVE 2D projects with TypeScript

/**
 * Provides an interface to decode encoded image data.
 *
 * @noResolution
 * @noSelf
 * @link [love.image](https://love2d.org/wiki/love.image)
 */
declare module "love.image" {
  import { FileData } from "love.filesystem";

  /**
   * Determines whether a file can be loaded as CompressedImageData.
   *
   * @param filename The filename of the potentially compressed image file.
   * @return compressed, Whether the file can be loaded as CompressedImageData or not.
   * @link [love.image.isCompressed](https://love2d.org/wiki/love.image.isCompressed)
   */
  function isCompressed(filename: string): boolean;

  /**
   * Determines whether a file can be loaded as CompressedImageData.
   *
   * @param fileData A FileData potentially containing a compressed image.
   * @return compressed, Whether the FileData can be loaded as CompressedImageData or not.
   * @link [love.image.](https://love2d.org/wiki/love.image.)
   */
  function isCompressed(fileData: FileData): boolean;

  /**
   * Create a new CompressedImageData object from a compressed image file. LÖVE
   * supports several compressed texture formats, enumerated in the
   * CompressedImageFormat page.
   *
   * @param filename The filename of the compressed image file.
   * @return compressedImageData, The new CompressedImageData object.
   * @link [love.image.newCompressedData](https://love2d.org/wiki/love.image.newCompressedData)
   */
  function newCompressedData(filename: string): CompressedImageData;

  /**
   * Create a new CompressedImageData object from a compressed image file. LÖVE
   * supports several compressed texture formats, enumerated in the
   * CompressedImageFormat page.
   *
   * @param fileData A FileData containing a compressed image.
   * @return compressedImageData, The new CompressedImageData object.
   * @link [love.image.newCompressedData](https://love2d.org/wiki/love.image.newCompressedData)
   */
  function newCompressedData(fileData: FileData): CompressedImageData;

  /**
   * Create a new ImageData object.
   *
   * @param width The width of the ImageData.
   * @param height The height of the ImageData.
   * @return imageData, The new blank ImageData object. Each pixel's color values, (including the alpha values!) will be set to zero.
   * @link [love.image.newImageData](https://love2d.org/wiki/love.image.newImageData)
   */
  function newImageData(width: number, height: number): ImageData;

  /**
   * Create a new ImageData object.
   *
   * @param width The width of the ImageData.
   * @param height The height of the ImageData.
   * @param data The data to load into the ImageData (RGBA bytes, left to right and top to bottom).
   * @return imageData, The new ImageData object.
   * @link [love.image.newImageData](https://love2d.org/wiki/love.image.newImageData)
   */
  function newImageData(width: number, height: number, data: string): ImageData;

  /**
   * Create a new ImageData object.
   *
   * @param filename The filename of the image file.
   * @return imageData, The new ImageData object.
   * @link [love.image.newImageData](https://love2d.org/wiki/love.image.newImageData)
   */
  function newImageData(filename: string): ImageData;

  /**
   * Create a new ImageData object.
   *
   * @param filedata The encoded file data to decode into image data.
   * @return imageData, The new ImageData object.
   * @link [love.image.newImageData](https://love2d.org/wiki/love.image.newImageData)
   */
  function newImageData(filedata: FileData): ImageData;
}