Package foundry.veil.api.client.imgui

Class VeilImGuiUtil

java.lang.Object
foundry.veil.api.client.imgui.VeilImGuiUtil
public class VeilImGuiUtil extends Object
Extra components and helpers for ImGui.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final net.minecraft.resources.ResourceLocation
    ICON_FONT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    VeilImGuiUtil()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    colorOf(String modid)
    Obtains the color of the modid
    static void
    component(net.minecraft.network.chat.FormattedText text)
    Deprecated.
    Use ImGuiMC.component(FormattedText) instead
    static void
    component(net.minecraft.network.chat.FormattedText text, float wrapWidth)
    Deprecated.
    Use ImGuiMC.component(FormattedText, float) instead
    static int
    getColor(int color)
    Deprecated.
    Use ImGuiMC.getColor(int) instead
    static net.minecraft.client.StringSplitter
    getStringSplitter()
    Deprecated.
    Use ImGuiMC.getStringSplitter() instead
    static imgui.ImFont
    getStyleFont(net.minecraft.network.chat.Style style)
    Deprecated.
    Use ImGuiMC.getStyleFont(Style) instead
    static void
    icon(int code)
    Renders an icon with the remixicon font
    static void
    icon(int code, int color)
    Renders an icon with the remixicon font and a color
    static int
    renderArea(int width, int height, Consumer<AdvancedFbo> renderer)
    Creates a rendering area of the specified size.
    static void
    resourceLocation(net.minecraft.resources.ResourceLocation loc)
    Displays a resource location with a dimmed namespace
    static void
    setTooltip(net.minecraft.network.chat.FormattedText text)
    Sets the tooltip to the specified component
    static void
    textCentered(String text, float width)
    Helper to draw centered text.
    static void
    tooltip(String text)
    Displays a (?) with a hover tooltip.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ICON_FONT

      public static final net.minecraft.resources.ResourceLocation ICON_FONT

  • Constructor Details

    • VeilImGuiUtil

      public VeilImGuiUtil()

  • Method Details

    • tooltip

      public static void tooltip(String text)
      Displays a (?) with a hover tooltip. Useful for example information.
      Parameters:
      text - The tooltip text

    • setTooltip

      public static void setTooltip(net.minecraft.network.chat.FormattedText text)
      Sets the tooltip to the specified component
      Parameters:
      text - The text to render

    • component

      @ScheduledForRemoval(inVersion="5.0.0") @Deprecated public static void component(net.minecraft.network.chat.FormattedText text)
      Deprecated.
      Use ImGuiMC.component(FormattedText) instead
      Fully renders Minecraft text into ImGui.
      Parameters:
      text - The text to render

    • component

      @ScheduledForRemoval(inVersion="5.0.0") @Deprecated public static void component(net.minecraft.network.chat.FormattedText text, float wrapWidth)
      Deprecated.
      Use ImGuiMC.component(FormattedText, float) instead
      Fully renders wrapped Minecraft text into ImGui.
      Parameters:
      text - The text to render
      wrapWidth - The width to wrap to

    • icon

      public static void icon(int code)
      Renders an icon with the remixicon font
      Parameters:
      code - The icon code (ex. )

    • icon

      public static void icon(int code, int color)
      Renders an icon with the remixicon font and a color
      Parameters:
      code - The icon code (ex. )
      color - The color of the icon

    • textCentered

      public static void textCentered(String text, float width)
      Helper to draw centered text.
      Parameters:
      text - The text to render
      width - The width of the area to center on

    • resourceLocation

      public static void resourceLocation(net.minecraft.resources.ResourceLocation loc)
      Displays a resource location with a dimmed namespace
      Parameters:
      loc - The resource location

    • renderArea

      public static int renderArea(int width, int height, Consumer<AdvancedFbo> renderer)
      Creates a rendering area of the specified size.
      Parameters:
      width - The width of the area
      height - The height of the area
      renderer - The renderer inside the area
      Returns:
      A texture ID that can be displayed in ImGui

    • colorOf

      public static int colorOf(String modid)
      Obtains the color of the modid
      Parameters:
      modid - The modid to get the color of
      Returns:
      color The color based on the hash of the modid

    • getStyleFont

      @ScheduledForRemoval(inVersion="5.0.0") @Deprecated public static imgui.ImFont getStyleFont(net.minecraft.network.chat.Style style)
      Deprecated.
      Use ImGuiMC.getStyleFont(Style) instead
      Retrieves the ImGui font to use for the specified Minecraft style.
      Parameters:
      style - The style to get the font for
      Returns:
      The ImFont to use

    • getColor

      @ScheduledForRemoval(inVersion="5.0.0") @Deprecated public static int getColor(int color)
      Deprecated.
      Use ImGuiMC.getColor(int) instead
      Retrieves the ARGB color for the specified ImGui style color.
      Parameters:
      color - The ImGui color index
      Returns:
      The ARGB ImGui color

    • getStringSplitter

      @ScheduledForRemoval(inVersion="5.0.0") @Deprecated public static net.minecraft.client.StringSplitter getStringSplitter()
      Deprecated.
      Use ImGuiMC.getStringSplitter() instead
      Returns:
      A string splitter for ImGui fonts