_{Official ZPE/YASS documentation}Graphics module

Module description

Creates native graphics windows and draws programmer-defined 2D scenes on macOS, Windows and Linux. A frame begins with Graphics::begin_frame, may contain individual drawing operations or a batched scene, and is presented with Graphics::end_frame.

ZPE 1.14.11 expands the module with filled ellipses, outlined rectangles and circles, arcs, pointer input, and runtime window title and size changes. The module also provides mutable cameras, circles and sprites, plus Sprite, Collision, Physics, Platformer and Async submodules for interactive scenes.

Graphics colours accept #RGB, #RGBA, #RRGGBB and #RRGGBBAA. Drawing coordinates use the normalized range -1 to 1 unless a function states otherwise.

Availability: ZPE 1.14.11 is the first version to support the Graphics module.

Module functions

The following is a list of all functions available in this module.

• begin_frame [1.14.10+]

  Starts a new frame and clears it with the specified background colour.

• close [1.14.10+]

  Closes a graphics window.

• create_camera [1.14.10+]

  Creates a mutable graphics camera.

• create_sprite [1.14.10+]

  Creates a mutable sprite object.

• create_window [1.14.10+]

  Creates and displays a native graphics window and returns a GraphicsWindow object.

• draw_arc [1.14.11+]

  Draws an arc with the requested radius, angular range, line width and colour.

• draw_circle [1.14.10+]

  Creates and draws a mutable circle object, or draws an existing circle object.

• draw_ellipse [1.14.11+]

  Draws a filled ellipse centred at <em>x</em> and <em>y</em> in the current frame.

• draw_line [1.14.10+]

  Draws a line using normalized coordinates.

• draw_outline_circle [1.14.11+]

  Draws a circular outline centred at <em>x</em> and <em>y</em>.

• draw_outline_rectangle [1.14.11+]

  Draws the outline of a rectangle in normalized -1 to 1 coordinates.

• draw_polygon [1.14.10+]

  Draws a filled polygon from a list of [x, y] points.

• draw_rectangle [1.14.10+]

  Draws a filled rectangle using normalized coordinates from -1 to 1.

• draw_scene [1.14.10+]

  Draws a complete programmer-defined scene from drawing commands.

• draw_sprite [1.14.10+]

  Draws a visible sprite object.

• draw_trail [1.14.10+]

  Draws a fading trail through a list of [x, y] points.

• end_frame [1.14.10+]

  Presents the current graphics frame.

• is_drawing [1.14.10+]

  Returns whether the graphics window is available for drawing.

• is_open [1.14.10+]

  Returns whether the graphics window is still open.

• key_down [1.14.10+]

  Returns whether a key is currently held in the graphics window.

• mouse_down [1.14.11+]

  Returns whether the requested pointer button is currently held in a graphics window.

• mouse_position [1.14.11+]

  Returns the current pointer position inside a graphics window.

• set_size [1.14.11+]

  Resizes the client area of a graphics window.

• set_title [1.14.11+]

  Changes the title displayed by a graphics window.

Module objects

• GraphicsCamera
• GraphicsCircle
• GraphicsSprite
• GraphicsWindow