Class DmdRenderer

constructor

• new DmdRenderer(dmdWidth, dmdHeight, screenWidth, screenHeight, pixelSize, dotSpace, dotShape, bgBrightness, brightness, canvas): DmdRenderer

• Parameters

  • dmdWidth: number
  • dmdHeight: number
  • screenWidth: number
  • screenHeight: number
  • pixelSize: number
  • dotSpace: number
  • dotShape: DotShape
  • bgBrightness: number
  • brightness: number
  • canvas: HTMLCanvasElement

  Returns DmdRenderer

renderFrame

dmdWidth

• get dmdWidth(): number

• Returns number

dmdHeight

• get dmdHeight(): number

• Returns number

visibleDotsX

• get visibleDotsX(): number

• Returns number

visibleDotsY

• get visibleDotsY(): number

• Returns number

dotSpace

• get dotSpace(): number

• Returns number

minDotSpace

• get minDotSpace(): number

• Returns number

bgHSP

• get bgHSP(): number

• Perceptual brightness (HSP) of the off-dot background color.

  Returns number

bgBrightness

• get bgBrightness(): number

• Raw brightness value of the off-dot background (0–255). Returns average of R/G/B channels.

  Returns number

offDotColor

• get offDotColor(): {
      r: number;
      g: number;
      b: number;
  }

• Get the current off-dot color (RGB, each component 0–1).

  Returns {
      r: number;
      g: number;
      b: number;
  }

  • r: number

  • g: number

  • b: number

dotSize

• get dotSize(): number

• Returns number

dotShape

• get dotShape(): DotShape

• Returns DotShape

brightness

• get brightness(): number

• Returns number

monochrome

• get monochrome(): boolean

• Returns boolean

monochromeColor

• get monochromeColor(): {
      r: number;
      g: number;
      b: number;
  }

• Returns {
      r: number;
      g: number;
      b: number;
  }

  • r: number

  • g: number

  • b: number

monoLevels

• get monoLevels(): number

• Returns number

canvasContext

• get canvasContext(): GPUCanvasContext

• Returns GPUCanvasContext

gpuFrameTime

• get gpuFrameTime(): number

• Last measured GPU compute pass execution time in milliseconds. Returns 0 if timestamp queries are not supported or no measurement is available yet.

  Returns number

init

• init(): Promise<void>

• Returns Promise<void>

setDotShape

• setDotShape(shape): void

• Change the dot shape at runtime. Enforces minimum dot size for the shape.

  Parameters

  • shape: DotShape

  Returns void

setDotSize

• setDotSize(size): void

• Change the dot size at runtime. Recalculates visible dot count. Layers stay at base resolution; the fragment shader rescales content.

  Parameters

  • size: number

  Returns void

setDotSpace

• setDotSpace(space): void

• Change dot spacing at runtime. Recalculates visible dot count.

  Parameters

  • space: number

  Returns void

setOffDotColor

• setOffDotColor(r, g, b): void

• Set the off-dot color (RGB, each component 0–1).

  Parameters

  • r: number
  • g: number
  • b: number

  Returns void

setBrightness

• setBrightness(b): void

• Set brightness of the dots between 0 and 1 (does not affect the background color) *

  Parameters

  • b: number

  Returns void

setMonochrome

• setMonochrome(enabled): void

• Enable or disable monochrome mode (16 brightness levels, single tint color).

  Parameters

  • enabled: boolean

  Returns void

setMonochromeColor

• setMonochromeColor(r, g, b): void

• Set the monochrome tint color (RGB, each component 0–1). Only affects rendering when monochrome mode is enabled.

  Parameters

  • r: number

    Red component (0–1)
  • g: number

    Green component (0–1)
  • b: number

    Blue component (0–1)

  Returns void

setMonoLevels

• setMonoLevels(levels): void

• Set the number of monochrome brightness levels (must be even, between 2 and 16).

  Parameters

  • levels: number

  Returns void