com.github.kklisura.cdt.protocol.commands.HeadlessExperimental Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdt-java-client Show documentation
Chrome DevTools java client
There is a newer version: 4.0.0
package com.github.kklisura.cdt.protocol.commands;

/*-
 * #%L
 * cdt-java-client
 * %%
 * Copyright (C) 2018 - 2021 Kenan Klisura
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.github.kklisura.cdt.protocol.events.headlessexperimental.NeedsBeginFramesChanged;
import com.github.kklisura.cdt.protocol.support.annotations.EventName;
import com.github.kklisura.cdt.protocol.support.annotations.Experimental;
import com.github.kklisura.cdt.protocol.support.annotations.Optional;
import com.github.kklisura.cdt.protocol.support.annotations.ParamName;
import com.github.kklisura.cdt.protocol.support.types.EventHandler;
import com.github.kklisura.cdt.protocol.support.types.EventListener;
import com.github.kklisura.cdt.protocol.types.headlessexperimental.BeginFrame;
import com.github.kklisura.cdt.protocol.types.headlessexperimental.ScreenshotParams;

/** This domain provides experimental commands only supported in headless mode. */
@Experimental
public interface HeadlessExperimental {

  /**
   * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures
   * a screenshot from the resulting frame. Requires that the target was created with enabled
   * BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
   * https://goo.gl/3zHXhB for more background.
   */
  BeginFrame beginFrame();

  /**
   * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures
   * a screenshot from the resulting frame. Requires that the target was created with enabled
   * BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
   * https://goo.gl/3zHXhB for more background.
   *
   * @param frameTimeTicks Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of
   *     uptime). If not set, the current time will be used.
   * @param interval The interval between BeginFrames that is reported to the compositor, in
   *     milliseconds. Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
   * @param noDisplayUpdates Whether updates should not be committed and drawn onto the display.
   *     False by default. If true, only side effects of the BeginFrame will be run, such as layout
   *     and animations, but any visual updates may not be visible on the display or in screenshots.
   * @param screenshot If set, a screenshot of the frame will be captured and returned in the
   *     response. Otherwise, no screenshot will be captured. Note that capturing a screenshot can
   *     fail, for example, during renderer initialization. In such a case, no screenshot data will
   *     be returned.
   */
  BeginFrame beginFrame(
      @Optional @ParamName("frameTimeTicks") Double frameTimeTicks,
      @Optional @ParamName("interval") Double interval,
      @Optional @ParamName("noDisplayUpdates") Boolean noDisplayUpdates,
      @Optional @ParamName("screenshot") ScreenshotParams screenshot);

  /** Disables headless events for the target. */
  void disable();

  /** Enables headless events for the target. */
  void enable();

  /**
   * Issued when the target starts or stops needing BeginFrames. Deprecated. Issue beginFrame
   * unconditionally instead and use result from beginFrame to detect whether the frames were
   * suppressed.
   */
  @EventName("needsBeginFramesChanged")
  @Deprecated
  EventListener onNeedsBeginFramesChanged(EventHandler eventListener);
}