Documentation/Helpers
module

Helpers

Helpers.js:1
function

getAlpha

Helpers.js:46
getAlpha(colour)

Parameters

NameTypeDescription
colournumber
function

getBlue

Helpers.js:70
getBlue(colour)

Parameters

NameTypeDescription
colournumber
function

getGreen

Helpers.js:62
getGreen(colour)

Parameters

NameTypeDescription
colournumber
function

getRed

Helpers.js:54
getRed(colour)

Parameters

NameTypeDescription
colournumber
function

Point2Pixel

Helpers.js:5
Point2Pixel(pt, dpi)

Convert Point size to Pixel size (useful in gdi.Font and such)

Parameters

NameTypeDescription
ptnumber
dpinumber
function

pos2vol

Helpers.js:126
pos2vol(pos)

Based on human hearing curve 0 <= pos <= 1 return a value value: -100 <= vol <= 0

Parameters

NameTypeDescription
volumefloat

Returns

float
function

RGB

Helpers.js:26
RGB(r, g, b)

Parameters

NameTypeDescription
rnumber
gnumber
bnumber
function

RGBA

Helpers.js:15
RGBA(r, g, b, a)

Parameters

NameTypeDescription
rnumber
gnumber
bnumber
anumber
function

setAlpha

Helpers.js:78
setAlpha(colour, a)

Parameters

NameTypeDescription
colournumber
anumber
function

setBlue

Helpers.js:105
setBlue(colour, b)

Parameters

NameTypeDescription
colournumber
bnumber
function

setGreen

Helpers.js:96
setGreen(colour, g)

Parameters

NameTypeDescription
colournumber
gnumber
function

setRed

Helpers.js:87
setRed(colour, r)

Parameters

NameTypeDescription
colournumber
rnumber
function

StringFormat

Helpers.js:114
StringFormat(h_align = 0, v_align = 0, trimming = 0, flags = 0)

Helper function for DrawString and MeasureString

Parameters

NameTypeDescription
h_alignnumber
v_alignnumber
trimmingnumber
flagsnumber
function

toRGB

Helpers.js:36
toRGB(color)

Returns an array like [192, 0, 0]

Parameters

NameTypeDescription
colournumber
function

vol2pos

Helpers.js:138
vol2pos(volume)

Inverse function of pos2vol()

Parameters

NameTypeDescription
volumefloat

Returns

float
object

colours

Helpers.js:148

pre-calculated colours