Type Alias IRenderer

type IRenderer = {
prototype: Addon;
new (metadata?: any): Addon & AllRendererCallbacks;
}

new IRenderer(metadata?: any): Addon & AllRendererCallbacks

Creates a new Renderer instance.

Parameters

Optionalmetadata: any
Any information that we would want to show/update inside a GUI application about this Renderer. This is not used by the API by default, but we can reprogram the Renderer's prototype to make use of this value if we want.

Returns Addon & AllRendererCallbacks

void.

Example

// If you are using require.js library or in node.js, 
// API might also be defined via var API = require("mooball");
function TestRenderer(API){
  const { Renderer } = API;
  Object.setPrototypeOf(this, Renderer.prototype);
  Renderer.call(this, {
    version: "0.1",
    author: "author",
    description: `This is a test renderer`
  });
  // Renderer codes here...
}

Index

Properties

Properties

prototype

prototype: Addon