Package org.vivecraft.api.client.data

Enum Class RenderPass

java.lang.Object
java.lang.Enum<RenderPass>
org.vivecraft.api.client.data.RenderPass
All Implemented Interfaces:
Serializable, Comparable<RenderPass>, Constable
public enum RenderPass extends Enum<RenderPass>
A pass used to render things. What is rendered during a RenderPass depends on the pass, most are RenderPass that render the whole level, others, like the GUI pass only render the Gui/Hud.
More passes may be added in the future.
Since:
1.3.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CAMERA
    Renders the level from the view of the placeable Screenshot Camera
    CENTER
    Renders the level from the view of the First-Person Mirror
    GUI
    Renders the Gui/Hud to a RenderTarget to be rendered in the world in other passes.
    LEFT
    Renders the level from the view of the Left eye
    MIRROR
    Blits the mirror to the desktop screen
    RIGHT
    Renders the level from the view of the Right eye
    SCOPEL
    Renders the level from the view of the Spyglass, when held in the off-hand
    SCOPER
    Renders the level from the view of the Spyglass, when held in the main-hand
    THIRD
    Renders the level from the view of the Third-Person Mirror

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    isFirstPerson(RenderPass pass)
    Returns whether the provided RenderPass is rendered from the player's perspective.
    static boolean
    isThirdPerson(RenderPass pass)
    Returns whether the provided RenderPass is rendered from a third-person perspective.
    static boolean
    renderPlayer(RenderPass pass)
    Returns whether the RenderPass is supposed to render the player model.
    static RenderPass
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static RenderPass[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • LEFT

      public static final RenderPass LEFT
      Renders the level from the view of the Left eye
      Since:
      1.3.0

    • CENTER

      public static final RenderPass CENTER
      Renders the level from the view of the First-Person Mirror
      Since:
      1.3.0

    • THIRD

      public static final RenderPass THIRD
      Renders the level from the view of the Third-Person Mirror
      Since:
      1.3.0

    • GUI

      public static final RenderPass GUI
      Renders the Gui/Hud to a RenderTarget to be rendered in the world in other passes.
      Since:
      1.3.0

    • SCOPER

      public static final RenderPass SCOPER
      Renders the level from the view of the Spyglass, when held in the main-hand
      Since:
      1.3.0

    • SCOPEL

      public static final RenderPass SCOPEL
      Renders the level from the view of the Spyglass, when held in the off-hand
      Since:
      1.3.0

    • CAMERA

      public static final RenderPass CAMERA
      Renders the level from the view of the placeable Screenshot Camera
      Since:
      1.3.0

    • MIRROR

      public static final RenderPass MIRROR
      Blits the mirror to the desktop screen
      Since:
      1.3.0

  • Method Details

    • values

      public static RenderPass[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RenderPass valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isFirstPerson

      public static boolean isFirstPerson(RenderPass pass)
      Returns whether the provided RenderPass is rendered from the player's perspective.
      Parameters:
      pass - The RenderPass in question.
      Returns:
      Whether the provided RenderPass is from the player's first-person perspective.

    • isThirdPerson

      public static boolean isThirdPerson(RenderPass pass)
      Returns whether the provided RenderPass is rendered from a third-person perspective.
      Parameters:
      pass - The RenderPass in question.
      Returns:
      Whether the provided RenderPass is from a third-person perspective relative to the player.

    • renderPlayer

      public static boolean renderPlayer(RenderPass pass)
      Returns whether the RenderPass is supposed to render the player model.
      Parameters:
      pass - The RenderPass in question.
      Returns:
      Whether the provided RenderPass is supposed to render the player.