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.

Renderers must ensure that terrain buffering supports

invalid reference

BlockStateModel#emitQuads

, which happens in SectionBuilder in vanilla; this code is not patched automatically. Renderers must also ensure that the following vanilla methods support

invalid reference

BlockStateModel#emitQuads

; these methods are not patched automatically.

• BlockModelRenderer.render(MatrixStack.Entry, VertexConsumer, BlockStateModel, float, float, float, int, int)
• BlockRenderManager.renderDamage(BlockState, BlockPos, BlockRenderView, MatrixStack, VertexConsumer)
• BlockRenderManager.renderBlockAsEntity(BlockState, MatrixStack, VertexConsumerProvider, int, int)

All other places in vanilla code that invoke BlockStateModel.addParts(Random, List), BlockStateModel.getParts(Random), or BlockModelRenderer.render(MatrixStack.Entry, VertexConsumer, BlockStateModel, float, float, float, int, int) are, where appropriate, patched automatically to invoke the corresponding method above or the corresponding method in FabricBlockModelRenderer or FabricBlockRenderManager.

Method Summary

Modifier and Type	Method	Description
default void	emitBlockModelPartQuads(BlockModelPart modelPart, QuadEmitter emitter, Predicate<@Nullable Direction> cullTest)
static Renderer	get()	Access to the current Renderer for creating and retrieving mesh builders and materials.
QuadEmitter	getLayerRenderStateEmitter(ItemRenderState.LayerRenderState layer)
@Nullable RenderMaterial	materialById(Identifier id)	Return a material previously registered via registerMaterial(Identifier, RenderMaterial).
MaterialFinder	materialFinder()	Obtain a new MaterialFinder instance to retrieve standard RenderMaterial instances.
MutableMesh	mutableMesh()	Obtain a new MutableMesh instance to build optimized meshes and create baked models with enhanced features.
static void	register(Renderer renderer)	Rendering extension mods must implement Renderer and call this method during initialization.
boolean	registerMaterial(Identifier id, RenderMaterial material)	Register a material for re-use by other mods or models within a mod.
void	render(BlockModelRenderer modelRenderer, BlockRenderView blockView, BlockStateModel model, BlockState state, BlockPos pos, MatrixStack matrices, VertexConsumerProvider vertexConsumers, boolean cull, long seed, int overlay)
void	render(MatrixStack.Entry matrices, VertexConsumerProvider vertexConsumers, BlockStateModel model, float red, float green, float blue, int light, int overlay, BlockRenderView blockView, BlockPos pos, BlockState state)
void	renderBlockAsEntity(BlockRenderManager renderManager, BlockState state, MatrixStack matrices, VertexConsumerProvider vertexConsumers, int light, int overlay, BlockRenderView blockView, BlockPos pos)

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.

render

@OverrideOnly
void render(BlockModelRenderer modelRenderer,
 BlockRenderView blockView,
 BlockStateModel model,
 BlockState state,
 BlockPos pos,
 MatrixStack matrices,
 VertexConsumerProvider vertexConsumers,
 boolean cull,
 long seed,
 int overlay)

See Also:

• FabricBlockModelRenderer.render(BlockRenderView, BlockStateModel, BlockState, BlockPos, MatrixStack, VertexConsumerProvider, boolean, long, int)

render

@OverrideOnly
void render(MatrixStack.Entry matrices,
 VertexConsumerProvider vertexConsumers,
 BlockStateModel model,
 float red,
 float green,
 float blue,
 int light,
 int overlay,
 BlockRenderView blockView,
 BlockPos pos,
 BlockState state)

See Also:

• FabricBlockModelRenderer.render(MatrixStack.Entry, VertexConsumerProvider, BlockStateModel, float, float, float, int, int, BlockRenderView, BlockPos, BlockState)

renderBlockAsEntity

@OverrideOnly
void renderBlockAsEntity(BlockRenderManager renderManager,
 BlockState state,
 MatrixStack matrices,
 VertexConsumerProvider vertexConsumers,
 int light,
 int overlay,
 BlockRenderView blockView,
 BlockPos pos)

See Also:

• FabricBlockRenderManager.renderBlockAsEntity(BlockState, MatrixStack, VertexConsumerProvider, int, int, BlockRenderView, BlockPos)

emitBlockModelPartQuads

@Experimental
@OverrideOnly
default void emitBlockModelPartQuads(BlockModelPart modelPart,
 QuadEmitter emitter,
 Predicate<@Nullable Direction> cullTest)

See Also:

• FabricBlockModelPart.emitQuads(QuadEmitter, Predicate)

getLayerRenderStateEmitter

@OverrideOnly
QuadEmitter getLayerRenderStateEmitter(ItemRenderState.LayerRenderState layer)

See Also:

• FabricLayerRenderState.emitter()