SignBoard

class SignBoard

WebGL-based LED SignBoard effect for image / video / text

Properties

Methods

src
initialized
contentType
contentAttribs
autoResize
autoInit
frameRate
tileSize
emission
dissipation
bulbSize
objectFit
textOptions
textPadding
scrollSpeed
initOnFontLoad

destroy
init
resize
start
stop
update

Constructor

new SignBoard(canvas, src, options)

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
canvas	string | HTMLElement			CSS query selector or canvas element
src	string			Source URL to the image / video
options	SignBoardOptions	✔️	{}	An options object

Properties

src

readonly

Current src of the image/video, or text string when the contentType is "text"

Type: string

initialized

readonly

Whether the SignBoard#init is called

Type: boolean

contentType

Current value of the contentType option

See:

• SignBoardOptions

contentAttribs

Current value of the contentAttribs option

See:

• SignBoardOptions

autoResize

Current value of the autoResize option

See:

• SignBoardOptions

autoInit

readonly

Current value of the autoInit option

See:

• SignBoardOptions

frameRate

Current value of the frameRate option

See:

• SignBoardOptions

tileSize

Current value of the tileSize option

See:

• SignBoardOptions

emission

Current value of the emission option

See:

• SignBoardOptions

dissipation

Current value of the dissipation option

See:

• SignBoardOptions

bulbSize

Current value of the bulbSize option

See:

• SignBoardOptions

objectFit

Current value of the objectFit option

See:

• SignBoardOptions

textOptions

Current value of the textOptions option

See:

• SignBoardOptions

textPadding

Current value of the textPadding option

See:

• SignBoardOptions

scrollSpeed

Current value of the scrollSpeed option

See:

• SignBoardOptions

initOnFontLoad

readonly

Current value of the initOnFontLoad option

See:

• SignBoardOptions

Methods

destroy

Destroy the current instance, and release all resources

Returns: void

init

async

Initialize SignBoard

Returns: Promise<SignBoard>

• The current instance

resize

Resize SignBoard with the latest size of the canvas

Returns: SignBoard

• The current instance

start

Start rendering

Returns: SignBoard

• The current instance

stop

Stop rendering

Returns: SignBoard

• The current instance

update

Update the texture

Returns: SignBoard

• The current instance

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
src	string	✔️		New src to the image/video or text string if contentType is "text"