Class: Materials
Defined in: packages/minerender/src/Materials.ts:13
Creates Minecraft model, entity, and GUI materials, with shared caches for image materials.
Constructors
Constructor
new Materials(): Materials;Returns
Materials
Accessors
MISSING_TEXTURE
Get Signature
get static MISSING_TEXTURE(): Material;Defined in: packages/minerender/src/Materials.ts:16
Shared checkerboard material, created on first access.
Returns
Material
Methods
createBasicCanvasMaterial()
static createBasicCanvasMaterial(
canvas,
transparent?,
shade?
): Material;Defined in: packages/minerender/src/Materials.ts:36
Parameters
| Parameter | Type | Default value |
|---|---|---|
canvas | HTMLCanvasElement | undefined |
transparent | boolean | false |
shade | boolean | false |
Returns
Material
createEntityCanvasMaterial()
static createEntityCanvasMaterial(
canvas,
mode?,
tint?
): MeshBasicMaterial;Defined in: packages/minerender/src/Materials.ts:72
Entity material for one of vanilla's render types. Entities are unlit here, so the lit and full-bright modes differ only in blending and depth state. Culling is not a material property: entityModeCulls decides whether the geometry gets inward faces.
Parameters
| Parameter | Type | Default value |
|---|---|---|
canvas | HTMLCanvasElement | undefined |
mode | EntityRenderMode | "cutout" |
tint? | ColorRepresentation | undefined |
Returns
MeshBasicMaterial
createGuiCanvasMaterial()
static createGuiCanvasMaterial(canvas): MeshBasicMaterial;Defined in: packages/minerender/src/Materials.ts:133
Creates an unlit, transparent GUI material without depth writes or tone mapping.
Parameters
| Parameter | Type |
|---|---|
canvas | HTMLCanvasElement |
Returns
MeshBasicMaterial
createImage()
static createImage(key): Material;Defined in: packages/minerender/src/Materials.ts:23
Parameters
| Parameter | Type |
|---|---|
key | MaterialKey |
Returns
Material
createShadedCanvasMaterial()
static createShadedCanvasMaterial(
canvas,
transparent?,
shade?,
boundUvs?
): Material;Defined in: packages/minerender/src/Materials.ts:158
Parameters
| Parameter | Type | Default value |
|---|---|---|
canvas | HTMLCanvasElement | undefined |
transparent | boolean | false |
shade | boolean | false |
boundUvs | boolean | false |
Returns
Material
entityModeCulls()
static entityModeCulls(mode?): boolean;Defined in: packages/minerender/src/Materials.ts:56
Whether vanilla's render type for the mode culls back faces.
Parameters
| Parameter | Type | Default value |
|---|---|---|
mode | EntityRenderMode | "cutout" |
Returns
boolean
entityModeScroll()
static entityModeScroll(mode?): [number, number] | undefined;Defined in: packages/minerender/src/Materials.ts:61
UV offset per tick of entity age for the scrolling modes, as vanilla's texture matrix applies it.
Parameters
| Parameter | Type | Default value |
|---|---|---|
mode | EntityRenderMode | "cutout" |
Returns
[number, number] | undefined
getImage()
static getImage(key): Material;Defined in: packages/minerender/src/Materials.ts:310
Returns a shared image material. Use createImage for a separate material instance.
Parameters
| Parameter | Type |
|---|---|
key | MaterialKey |
Returns
Material
needsUpdate()
static needsUpdate(mat): void;Defined in: packages/minerender/src/Materials.ts:321
Parameters
| Parameter | Type |
|---|---|
mat | Material |
Returns
void