Package net.fabricmc.fabric.api.renderer.v1

Interface Renderer

public interface Renderer
Interface for rendering plug-ins that provide enhanced capabilities for model lighting, buffering and rendering. Such plug-ins implement the enhanced model rendering interfaces specified by the Fabric API.

  • Method Details

    • get

      static Renderer get()
      Access to the current Renderer for creating and retrieving mesh builders and materials.

    • register

      static void register(Renderer renderer)
      Rendering extension mods must implement Renderer and call this method during initialization.

      Only one Renderer plug-in can be active in any game instance. If a second mod attempts to register, this method will throw an UnsupportedOperationException.

    • mutableMesh

      MutableMesh mutableMesh()
      Obtain a new MutableMesh instance to build optimized meshes and create baked models with enhanced features.

      Renderer does not retain a reference to returned instances, so they should be re-used when possible to avoid memory allocation overhead.

    • materialFinder

      MaterialFinder materialFinder()
      Obtain a new MaterialFinder instance to retrieve standard RenderMaterial instances.

      Renderer does not retain a reference to returned instances, so they should be re-used for multiple materials when possible to avoid memory allocation overhead.

    • materialById

      @Nullable @Nullable RenderMaterial materialById(Identifier id)
      Return a material previously registered via registerMaterial(Identifier, RenderMaterial). Will return null if no material was found matching the given identifier.

    • registerMaterial

      boolean registerMaterial(Identifier id, RenderMaterial material)
      Register a material for re-use by other mods or models within a mod. The registry does not persist registrations - mods must create and register all materials at game initialization.

      Returns false if a material with the given identifier is already present, leaving the existing material intact.