Class HologramEffect

A shader effect that simulates a holographic projection with horizontal scan lines, color shift, and flickering. Commonly used for sci-fi UI, ghost/spirit characters, or tech displays. The time uniform should be updated each frame for animation.

See

Renderable.shader for usage

Example

const holo = new HologramEffect(renderer);
mySprite.shader = holo;
// update each frame
holo.setTime(performance.now() / 1000);

Hierarchy (View Summary)

ShaderEffect
- HologramEffect

Index

Constructors

constructor

new HologramEffect(
renderer: WebGLRenderer,
options?: { color?: number[]; intensity?: number },
): HologramEffect
Parameters
- renderer: WebGLRenderer
  the current renderer instance
- Optionaloptions: { color?: number[]; intensity?: number } = {}
  effect options
  - Optionalcolor?: number[]
    hologram tint color [r, g, b]
  - Optionalintensity?: number
    effect intensity (0.0–1.0)
Returns HologramEffect
Overrides ShaderEffect.constructor
- Defined in packages/melonjs/src/video/webgl/effects/hologram.js:23

Properties

enabled

enabled: boolean = false

whether this effect is active (false in Canvas mode)

Methods

destroy

destroy(): void
destroy this shader effect

Returns void
Inherited from ShaderEffect.destroy
- Defined in packages/melonjs/src/video/webgl/shadereffect.js:141

setColor

setColor(color: number[]): void
set the hologram tint color
Parameters
- color: number[]
  color as [r, g, b] (0.0–1.0)
Returns void
- Defined in packages/melonjs/src/video/webgl/effects/hologram.js:61

setTime

setTime(time: number): void
set the current time (call each frame for animation)
Parameters
- time: number
  time in seconds
Returns void
- Defined in packages/melonjs/src/video/webgl/effects/hologram.js:53

setUniform

setUniform(name: string, value: object | Float32Array<ArrayBufferLike>): void
Set the uniform to the given value
Parameters
- name: string
  the uniform name
- value: object | Float32Array<ArrayBufferLike>
  the value to assign to that uniform
Returns void
Inherited from ShaderEffect.setUniform
- Defined in packages/melonjs/src/video/webgl/shadereffect.js:88

Class HologramEffect

See

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

`Optional`color?: number[]

`Optional`intensity?: number

Returns HologramEffect

Properties

enabled

Methods

destroy

Returns void

setColor

Parameters

Returns void

setTime

Parameters

Returns void

setUniform

Parameters

Returns void

Settings

On This Page

Class HologramEffect

See

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalcolor?: number[]

Optionalintensity?: number

Returns HologramEffect

Properties

enabled

Methods

destroy

Returns void

setColor

Parameters

Returns void

setTime

Parameters

Returns void

setUniform

Parameters

Returns void

Settings

On This Page

`Optional`color?: number[]

`Optional`intensity?: number