Function ImageScriptObject

src/app/script/api/image_script.cpp:18–58

class ImageScriptObject : public script::ScriptObject {
public:
  ImageScriptObject() {
    addProperty("width", [this]{return img()->width();})
      .doc("read-only. The width of the image.");

    addProperty("height", [this]{return img()->height();})
      .doc("read-only. The height of the image.");

    addProperty("stride", [this]{return img()->getRowStrideSize();})
      .doc("read-only. The number of bytes per image row.");

    addProperty("format", [this]{return (int) img()->pixelFormat();})
      .doc("read-only. The PixelFormat of the image.");

    addFunction("getPixel", [this](int x, int y){return img()->getPixel(x, y);})
      .doc("reads a color from the given coordinate of the image.")
      .docArg("x", "integer")
      .docArg("y", "integer")
      .docReturns("a color value");

    addMethod("putPixel", &ImageScriptObject::putPixel)
      .doc("writes the color onto the image at the the given coordinate.")
      .docArg("x", "integer")
      .docArg("y", "integer")
      .docArg("color", "a 32-bit color in 8888 RGBA format.");

    addMethod("clear", &ImageScriptObject::clear)
      .doc("clears the image with the specified color.")
      .docArg("color", "a 32-bit color in 8888 RGBA format.");

    addMethod("putImageData", &ImageScriptObject::putImageData)
      .doc("writes the given pixels onto the image. Must be the same size as the image.")
      .docArg("data", "All of the pixels in the image.");

    addMethod("getImageData", &ImageScriptObject::getImageData)
      .doc("creates an array containing all of the image's pixels.")
      .docReturns("All pixels in a Uint8Array");

    addMethod("getPNGData", &ImageScriptObject::getPNGData)
      .doc("Encodes the image as a PNG.")
      .docReturns("The image as a Base64-encoded PNG string.");
  }

  doc::Image* img() {
    auto img = handle<doc::Object, doc::Image>();