_{Official ZPE/YASS documentation}Image

Represents and manipulates images.

Object functions

• base64_encode [1.8.7+]

  Return a base64 encoding of the image. Added in 1.7.8

• blend [1.14.11+]

  Blends another image into the current image.

• compare [1.14.8+]

  The `compare` operation for the Image object.

• construct [1.8.7+]

  The `construct` operation for the Image object.

• copy [1.14.11+]

  Returns an independent copy of the current image.

• darken [1.8.7+]

  The `darken` operation for the Image object.

• display [1.8.7+]

  Displays the image.

• draw_circle [1.14.11+]

  Draws a circle onto the current image.

• draw_line [1.14.11+]

  Draws a line onto the current image.

• draw_rectangle [1.14.11+]

  Draws a rectangle onto the current image.

• get_channels [1.14.11+]

  Returns the image’s supported channel names.

• get_format [1.14.11+]

  Returns the image’s internal pixel format.

• get_height [1.8.7+]

  Returns the height dimension of the image.

• get_pixel [1.8.7+]

  Returns a list which contains information about a single pixel. The list will contain the red (r), green (g), blue (b) and alpha data. If the associative variable is given a true value, the array will instead become an associative array: {r => red_value, g => green_value, b => blue_value, a => alpha_value}.

• get_width [1.8.7+]

  Returns the width dimension of the image.

• has_alpha [1.14.11+]

  Checks whether the image contains transparency.

• new_image [1.8.7+]

  Creates a new image and stores it within the object.

• open [1.8.7+]

  Opens an image from a specified file and puts in to the current object. The image can then be manipulated using the language functionalities. It will return false if the file could not be found.

• save [1.8.7+]

  Saves the image to a file path, file. The format is decided based on the extension.

• set_pixel [1.8.7+]

  This function sets a pixel in the image. If the set pixel operation fails, it returns the boolean value false. If the set pixel operation succeeds, it return the image. Any operation should be prepared for failure.

• thumbnail [1.14.11+]

  Returns a separate resized image.

• transform_brightness [1.14.11+]

  Adjusts the brightness of the current image.

• transform_contrast [1.14.11+]

  Adjusts the contrast of the current image.

• transform_crop [1.14.11+]

  Crops the current image to the specified rectangle.

• transform_flip_horizontal [1.14.11+]

  Flips the current image horizontally.

• transform_flip_vertical [1.14.11+]

  Flips the current image vertically.

• transform_greyscale [1.8.7+]

  Transforms the image with the greyscale filter.

• transform_invert_color [1.8.7+]

  Transforms the image with the inverted colour filter.

• transform_opacity [1.14.11+]

  Changes the opacity of the current image.

• transform_resize [1.8.7+]

  Resizes the image to the specified width and height parameters.

• transform_rotate [1.8.7+]

  Takes in an image and rotates the image to the specified degrees.

• transform_sepia [1.8.7+]

  Transforms the image with the sepia filter.

• transform_tint [1.14.11+]

  Blends a colour into the current image.