Package io.github.somesourcecode.someguiapi.scene

Interface Background

public interface Background
Represents a background for a node or scene.
Since:
1.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Pixel
    backgroundAt(int layoutX, int layoutY)
    Returns the item stack that should be displayed at the given layout coordinates.
    static Background
    checkerboard(Pixel primary, Pixel secondary)
    Creates a checkerboard background with the given primary and secondary pixels.
    static Background
    fill(Pixel pixel)
    Creates a background that fills the background with the given pixel.

  • Method Details

    • backgroundAt

      Pixel backgroundAt(int layoutX, int layoutY)
      Returns the item stack that should be displayed at the given layout coordinates.
      Parameters:
      layoutX - the x coordinate of the layout
      layoutY - the y coordinate of the layout
      Returns:
      the item stack that should be displayed at the given layout coordinates
      Since:
      2.0.0

    • fill

      static Background fill(Pixel pixel)
      Creates a background that fills the background with the given pixel.
      Parameters:
      pixel - the item to fill the background with
      Returns:
      the background
      Since:
      2.0.0

    • checkerboard

      static Background checkerboard(Pixel primary, Pixel secondary)
      Creates a checkerboard background with the given primary and secondary pixels.
      Parameters:
      primary - the primary item
      secondary - the secondary item
      Returns:
      the background
      Since:
      2.0.0