RenderDevice.java

package de.lessvoid.nifty.spi.render;

import de.lessvoid.nifty.render.BlendMode;
import de.lessvoid.nifty.tools.Color;
import de.lessvoid.nifty.tools.resourceloader.NiftyResourceLoader;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.IOException;

/**
 * Nifty RenderDevice.
 *
 * @author void
 * @author Martin Karing <nitram@illarion.org>
 */
public interface RenderDevice {
  /**
   * Gives this RenderDevice access to the NiftyResourceLoader.
   *
   * @param niftyResourceLoader NiftyResourceLoader
   */
  void setResourceLoader(@Nonnull NiftyResourceLoader niftyResourceLoader);

  /**
   * Create a new image for the renderer. This method is only called if the image is not already cached. The
   * implementation calling this method will take care for caching already loaded images as needed.
   *
   * @param filename     the filename of the image that needs to be load
   * @param filterLinear {@code true} in case a linear (and slower) rescaling filter is supposed to be applied
   * @return the created render image or {@code null} in case the image assigned to the filename is not found
   */
  @Nullable
  RenderImage createImage(@Nonnull String filename, boolean filterLinear);

  /**
   * Create a new font for the renderer. This method is only called if the font was not load before. Created fonts
   * will be cached by the implementation calling this method.
   *
   * @param filename the filename assigned to the font that needs to be load
   * @return the created render font or {@code null} in case no font was found using this name
   */
  @Nullable
  RenderFont createFont(@Nonnull String filename);

  /**
   * Get Width.
   *
   * @return width of display mode
   */
  int getWidth();

  /**
   * Get Height.
   *
   * @return height of display mode
   */
  int getHeight();

  /**
   * Called every begin frame.
   */
  void beginFrame();

  /**
   * Called every end frame.
   */
  void endFrame();

  /**
   * clear screen.
   */
  void clear();

  /**
   * Change the RenderMode to the given Mode.
   *
   * @param renderMode RenderMode
   */
  void setBlendMode(@Nonnull BlendMode renderMode);

  /**
   * Render a quad.
   */
  void renderQuad(int x, int y, int width, int height, @Nonnull Color color);

  /**
   * Render a quad with different colors at the vertices.
   */
  void renderQuad(
      int x,
      int y,
      int width,
      int height,
      @Nonnull Color topLeft,
      @Nonnull Color topRight,
      @Nonnull Color bottomRight,
      @Nonnull Color bottomLeft);

  /**
   * Render the image.
   */
  void renderImage(
      @Nonnull RenderImage image,
      int x,
      int y,
      int width,
      int height,
      @Nonnull Color color,
      float imageScale);

  /**
   * Render a sub image of this image.
   */
  void renderImage(
      @Nonnull RenderImage image,
      int x,
      int y,
      int w,
      int h,
      int srcX,
      int srcY,
      int srcW,
      int srcH,
      @Nonnull Color color,
      float scale,
      int centerX,
      int centerY);

  /**
   * Render the given text at the given position.
   */
  void renderFont(
      @Nonnull RenderFont font,
      @Nonnull String text,
      int x,
      int y,
      @Nonnull Color fontColor,
      float sizeX,
      float sizeY);

  /**
   * Enable clipping to the given region.
   */
  void enableClip(int x0, int y0, int x1, int y1);

  /**
   * Disable Clipping.
   */
  void disableClip();

  /**
   * Create a new mouse cursor. This method is called by a implementation that takes care for caching the result of
   * this call.
   *
   * @param filename the filename assigned to the mouse cursor that needs to be load
   * @param hotspotX hotspot x with 0 being left of the screen
   * @param hotspotY hotspot y with 0 being top of the screen
   * @return the newly created mouse cursor or {@code null} in case there is no matching cursor for this file name
   */
  @Nullable
  MouseCursor createMouseCursor(@Nonnull String filename, int hotspotX, int hotspotY) throws IOException;

  /**
   * Enable the given mouse cursor.
   *
   * @param mouseCursor the mouse cursor to enable
   */
  void enableMouseCursor(@Nonnull MouseCursor mouseCursor);

  /**
   * Disable the current mouse cursor.
   */
  void disableMouseCursor();
}