Method setFrame

src/image/p5.Image.js:1599–1614

* Sets the current frame in an animated GIF. * * @param {Number} index index of the frame to display. * * @example * let gif; * let frameSlider; * * async function setup() { * // Load the image. * gif = await loadImage('assets/arnott-wallace-eye-loop-forever.gif');

(index)

   * }
   */
  setFrame(index) {
    if (this.gifProperties) {
      const props = this.gifProperties;
      if (index < props.numFrames && index >= 0) {
        props.timeDisplayed = 0;
        props.lastChangeTime = 0;
        props.displayIndex = index;
        this.drawingContext.putImageData(props.frames[index].image, 0, 0);
      } else {
        this._friendlyError(
          'Cannot set GIF to a frame number that is higher than total number of frames or below zero.',
          'setFrame'
        );
      }
    }
  }

  /**
   * Returns the number of frames in an animated GIF.