Package com.io7m.jptbox.core

Interface JPTextImageType

All Known Implementing Classes:
JPTextImage
public interface JPTextImageType
The type of text images.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    get(int x, int y)
    Retrieve a character in the image.
    int
    getSilent(int x, int y, int v)
    Retrieve a character in the image.
    int
    height()
     
    boolean
    isInside(int x, int y)
     
    void
    put(int x, int y, int value)
    Set the character at (x, y) to value
    void
    putSilent(int x, int y, int value)
    Set the character at (x, y) to value.
    int
    width()
     

  • Method Details

    • isInside

      boolean isInside(int x, int y)
      Parameters:
      x - The x coordinate
      y - The y coordinate
      Returns:
      true iff the given coordinates are inside the image

    • put

      void put(int x, int y, int value)
      Set the character at (x, y) to value
      Parameters:
      x - The X coordinate (0 <= x < width must hold)
      y - The Y coordinate (0 <= y < height must hold)
      value - The character value

    • putSilent

      void putSilent(int x, int y, int value)
      Set the character at (x, y) to value. If x or y is outside of the bounds of the image, no setting is performed and no exceptions are raised.
      Parameters:
      x - The X coordinate
      y - The Y coordinate
      value - The character value

    • width

      int width()
      Returns:
      The width of the image

    • height

      int height()
      Returns:
      The height of the image

    • get

      int get(int x, int y)
      Retrieve a character in the image.
      Parameters:
      x - The X coordinate (0 <= x < width must hold)
      y - The Y coordinate (0 <= y < height must hold)
      Returns:
      The character at (x, y)

    • getSilent

      int getSilent(int x, int y, int v)
      Retrieve a character in the image.
      Parameters:
      x - The X coordinate
      y - The Y coordinate
      v - The default value
      Returns:
      The character at (x, y), or v iff the coordinates are outside of the image