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

Interface MaterialFinder

All Superinterfaces:

MaterialView

public interface MaterialFinder
extends MaterialView

Finds standard RenderMaterial instances used to communicate quad rendering characteristics to a RenderContext.

Must be obtained via Renderer.materialFinder().

Method Summary

Modifier and Type	Method	Description
MaterialFinder	ambientOcclusion(TriState mode)	Controls whether vertex colors should be modified for ambient occlusion.
default MaterialFinder	blendMode(int spriteIndex, BlendMode blendMode)	Deprecated. Use blendMode(BlendMode) instead.
default MaterialFinder	blendMode(int spriteIndex, RenderLayer renderLayer)	Deprecated. Use blendMode(BlendMode) instead.
MaterialFinder	blendMode(BlendMode blendMode)	Controls how sprite pixels should be blended with the scene.
MaterialFinder	clear()	Resets this instance to default values.
MaterialFinder	copyFrom(MaterialView material)	Copies all properties from the given MaterialView to this material finder.
default MaterialFinder	disableAo(int spriteIndex, boolean disable)	Deprecated. Use ambientOcclusion(TriState) instead.
MaterialFinder	disableColorIndex(boolean disable)	Controls whether vertex colors should be modified for quad coloring.
default MaterialFinder	disableColorIndex(int spriteIndex, boolean disable)	Deprecated. Use disableColorIndex(boolean) instead.
MaterialFinder	disableDiffuse(boolean disable)	Controls whether vertex colors should be modified for diffuse shading.
default MaterialFinder	disableDiffuse(int spriteIndex, boolean disable)	Deprecated. Use disableDiffuse(boolean) instead.
MaterialFinder	emissive(boolean isEmissive)	When true, sprite texture and color will be rendered at full brightness.
default MaterialFinder	emissive(int spriteIndex, boolean isEmissive)	Deprecated. Use emissive(boolean) instead.
RenderMaterial	find()	Returns the standard material encoding all of the current settings in this finder.
MaterialFinder	glint(TriState mode)	Controls whether glint should be applied.
default MaterialFinder	shadeMode(ShadeMode mode)	A hint to the renderer about how the quad is intended to be shaded, for example through ambient occlusion and diffuse shading.
default MaterialFinder	spriteDepth(int depth)	Deprecated.

Methods inherited from interface net.fabricmc.fabric.api.renderer.v1.material.MaterialView

ambientOcclusion, blendMode, disableColorIndex, disableDiffuse, emissive, glint, shadeMode

Method Details

blendMode

MaterialFinder blendMode(BlendMode blendMode)

Controls how sprite pixels should be blended with the scene.

The default value is BlendMode.DEFAULT.

See Also:

• BlendMode

disableColorIndex

MaterialFinder disableColorIndex(boolean disable)

Controls whether vertex colors should be modified for quad coloring. This property is inverted, so a value of false means that quad coloring will be applied.

The default value is false.

emissive

MaterialFinder emissive(boolean isEmissive)

When true, sprite texture and color will be rendered at full brightness. Lightmap values provided via QuadView.lightmap(int) will be ignored.

This is the preferred method for emissive lighting effects. Some renderers with advanced lighting pipelines may not use block lightmaps and this method will allow per-sprite emissive lighting in future extensions that support overlay sprites.

Note that color will still be modified by diffuse shading and ambient occlusion, unless disabled via disableDiffuse(boolean) and ambientOcclusion(TriState).

The default value is false.

disableDiffuse

MaterialFinder disableDiffuse(boolean disable)

Controls whether vertex colors should be modified for diffuse shading. This property is inverted, so a value of false means that diffuse shading will be applied.

The default value is false.

This property is guaranteed to be respected in block contexts. Some renderers may also respect it in item contexts, but this is not guaranteed.

ambientOcclusion

MaterialFinder ambientOcclusion(TriState mode)

Controls whether vertex colors should be modified for ambient occlusion.

If set to TriState.DEFAULT, ambient occlusion will be used if the model uses ambient occlusion and the block state has a luminance of 0. Set to TriState.TRUE or TriState.FALSE to override this behavior. TriState.TRUE will not have an effect if ambient occlusion is disabled globally.

The default value is TriState.DEFAULT.

This property is respected only in block contexts. It will not have an effect in other contexts.

glint

MaterialFinder glint(TriState mode)

Controls whether glint should be applied.

If set to TriState.DEFAULT, glint will be applied in item contexts if the item stack has glint. Set to TriState.TRUE or TriState.FALSE to override this behavior.

The default value is TriState.DEFAULT.

This property is guaranteed to be respected in item contexts. Some renderers may also respect it in block contexts, but this is not guaranteed.

shadeMode

default MaterialFinder shadeMode(ShadeMode mode)

A hint to the renderer about how the quad is intended to be shaded, for example through ambient occlusion and diffuse shading. The renderer is free to ignore this hint.

The default value is ShadeMode.ENHANCED.

This property is respected only in block contexts. It will not have an effect in other contexts.

See Also:

• ShadeMode

API Note:

The default implementation will be removed in the next breaking release.

copyFrom

MaterialFinder copyFrom(MaterialView material)

Copies all properties from the given MaterialView to this material finder.

clear

MaterialFinder clear()

Resets this instance to default values. Values will match those in effect when an instance is newly obtained via Renderer.materialFinder().

find

RenderMaterial find()

Returns the standard material encoding all of the current settings in this finder. The settings in this finder are not changed.

Resulting instances can and should be re-used to prevent needless memory allocation. Renderer implementations may or may not cache standard material instances.

blendMode

@Deprecated
default MaterialFinder blendMode(int spriteIndex,
 RenderLayer renderLayer)

Deprecated.

Use blendMode(BlendMode) instead.

blendMode

@Deprecated
default MaterialFinder blendMode(int spriteIndex,
 BlendMode blendMode)

Deprecated.

Use blendMode(BlendMode) instead.

disableColorIndex

@Deprecated
default MaterialFinder disableColorIndex(int spriteIndex,
 boolean disable)

Deprecated.

Use disableColorIndex(boolean) instead.

emissive

@Deprecated
default MaterialFinder emissive(int spriteIndex,
 boolean isEmissive)

Deprecated.

Use emissive(boolean) instead.

disableDiffuse

@Deprecated
default MaterialFinder disableDiffuse(int spriteIndex,
 boolean disable)

Deprecated.

Use disableDiffuse(boolean) instead.

disableAo

@Deprecated
default MaterialFinder disableAo(int spriteIndex,
 boolean disable)

Deprecated.

Use ambientOcclusion(TriState) instead.

spriteDepth

@Deprecated
default MaterialFinder spriteDepth(int depth)

Deprecated.

Do not use. Does nothing.