import GuiRender from 'minerender/src/gui/index.js'

public class | source

GuiRender

Render → GuiRender

A renderer for Minecraft GUIs

Constructor Summary

Public Constructor
public	constructor(options: Object, element: HTMLElement)

Public Methods
public	render(layers: string[] \| Object[], cb: function) Does the actual rendering

From class Render
public	element: HTMLElement DOM Element to attach the renderer to
public	options: { Combined options
public	renderType: string
public	addToScene(toAdd: *) Adds an object to the scene & sets userData.renderType to this renderer's type
public	clearScene(onlySelfType: , filterFn: ) Clears the scene
public	dispose()
public	toGLTF(exportOptions: *): Promise<any> Export the current scene content in the .gltf format (geometries + textures)
public	toImage(trim: boolean, mime: string): string
public	toObj(): string Export the current scene content in the .obj format (only geometries, no textures)
public	toPLY(exportOptions: ):
protected	initScene(renderCb: , doNotAnimate: ): boolean Initializes the scene

Name	Type	Attribute	Description
options	Object	optional	The options for this renderer, see defaultOptions
options.assetRoot	string	optional default: DEFAULT_ROOT	root to get asset files from
element	HTMLElement	optional default: document.body	DOM Element to attach the renderer to - defaults to document.body

Does the actual rendering

Name	Type	Attribute	Description
layers	string[] \| Object[]		Array of GUI layers - either strings or objects
layers[].texture	string		path to the layer's texture (starting at assets/minecraft/textures/), e.g. '/items/apple'
layers[].textureScale	number	optional default: 1	scale of the given texture, can be used to get different sized textures aligned proerly
layers[].uv	number[]	optional	[x1,y1,x2,y2] array UV mapping of the texture
layers[].pos	number[]	optional default: [0,0]	[x,y] array position of the layer
cb	function	optional	Callback when rendering finished