Options
All
  • Public
  • Public/Protected
  • All
Menu

fcanvas

Index

Type aliases

Reactive

Reactive<T>: T

Type parameters

  • T = object

Properties

hypot

hypot: (...values: number[]) => number

Type declaration

    • (...values: number[]): number
    • Returns the square root of the sum of squares of its arguments.

      Parameters

      • Rest ...values: number[]

        Values to compute the square root for. If no arguments are passed, the result is +0. If there is only one argument, the result is the absolute value. If any argument is +Infinity or -Infinity, the result is +Infinity. If any argument is NaN, the result is NaN. If all arguments are either +0 or −0, the result is +0.

      Returns number

Variables

Colors

Colors: { aliceblue: number[]; antiquewhite: number[]; aqua: number[]; aquamarine: number[]; azure: number[]; beige: number[]; bisque: number[]; black: number[]; blanchedalmond: number[]; blue: number[]; blueviolet: number[]; brown: number[]; burlywood: number[]; cadetblue: number[]; chartreuse: number[]; chocolate: number[]; coral: number[]; cornflowerblue: number[]; cornsilk: number[]; crimson: number[]; cyan: number[]; darkblue: number[]; darkcyan: number[]; darkgoldenrod: number[]; darkgray: number[]; darkgreen: number[]; darkgrey: number[]; darkkhaki: number[]; darkmagenta: number[]; darkolivegreen: number[]; darkorange: number[]; darkorchid: number[]; darkred: number[]; darksalmon: number[]; darkseagreen: number[]; darkslateblue: number[]; darkslategray: number[]; darkslategrey: number[]; darkturquoise: number[]; darkviolet: number[]; deeppink: number[]; deepskyblue: number[]; dimgray: number[]; dimgrey: number[]; dodgerblue: number[]; firebrick: number[]; floralwhite: number[]; forestgreen: number[]; fuchsia: number[]; gainsboro: number[]; ghostwhite: number[]; gold: number[]; goldenrod: number[]; gray: number[]; green: number[]; greenyellow: number[]; grey: number[]; honeydew: number[]; hotpink: number[]; indianred: number[]; indigo: number[]; ivory: number[]; khaki: number[]; lavender: number[]; lavenderblush: number[]; lawngreen: number[]; lemonchiffon: number[]; lightblue: number[]; lightcoral: number[]; lightcyan: number[]; lightgoldenrodyellow: number[]; lightgray: number[]; lightgreen: number[]; lightgrey: number[]; lightpink: number[]; lightsalmon: number[]; lightseagreen: number[]; lightskyblue: number[]; lightslategray: number[]; lightslategrey: number[]; lightsteelblue: number[]; lightyellow: number[]; lime: number[]; limegreen: number[]; linen: number[]; magenta: number[]; maroon: number[]; mediumaquamarine: number[]; mediumblue: number[]; mediumorchid: number[]; mediumpurple: number[]; mediumseagreen: number[]; mediumslateblue: number[]; mediumspringgreen: number[]; mediumturquoise: number[]; mediumvioletred: number[]; midnightblue: number[]; mintcream: number[]; mistyrose: number[]; moccasin: number[]; navajowhite: number[]; navy: number[]; oldlace: number[]; olive: number[]; olivedrab: number[]; orange: number[]; orangered: number[]; orchid: number[]; palegoldenrod: number[]; palegreen: number[]; paleturquoise: number[]; palevioletred: number[]; papayawhip: number[]; peachpuff: number[]; peru: number[]; pink: number[]; plum: number[]; powderblue: number[]; purple: number[]; rebeccapurple: number[]; red: number[]; rosybrown: number[]; royalblue: number[]; saddlebrown: number[]; salmon: number[]; sandybrown: number[]; seagreen: number[]; seashell: number[]; sienna: number[]; silver: number[]; skyblue: number[]; slateblue: number[]; slategray: number[]; slategrey: number[]; snow: number[]; springgreen: number[]; steelblue: number[]; tan: number[]; teal: number[]; thistle: number[]; tomato: number[]; transparent: number[]; turquoise: number[]; violet: number[]; wheat: number[]; white: number[]; whitesmoke: number[]; yellow: number[]; yellowgreen: number[] } = ...

Type declaration

  • aliceblue: number[]
  • antiquewhite: number[]
  • aqua: number[]
  • aquamarine: number[]
  • azure: number[]
  • beige: number[]
  • bisque: number[]
  • black: number[]
  • blanchedalmond: number[]
  • blue: number[]
  • blueviolet: number[]
  • brown: number[]
  • burlywood: number[]
  • cadetblue: number[]
  • chartreuse: number[]
  • chocolate: number[]
  • coral: number[]
  • cornflowerblue: number[]
  • cornsilk: number[]
  • crimson: number[]
  • cyan: number[]
  • darkblue: number[]
  • darkcyan: number[]
  • darkgoldenrod: number[]
  • darkgray: number[]
  • darkgreen: number[]
  • darkgrey: number[]
  • darkkhaki: number[]
  • darkmagenta: number[]
  • darkolivegreen: number[]
  • darkorange: number[]
  • darkorchid: number[]
  • darkred: number[]
  • darksalmon: number[]
  • darkseagreen: number[]
  • darkslateblue: number[]
  • darkslategray: number[]
  • darkslategrey: number[]
  • darkturquoise: number[]
  • darkviolet: number[]
  • deeppink: number[]
  • deepskyblue: number[]
  • dimgray: number[]
  • dimgrey: number[]
  • dodgerblue: number[]
  • firebrick: number[]
  • floralwhite: number[]
  • forestgreen: number[]
  • fuchsia: number[]
  • gainsboro: number[]
  • ghostwhite: number[]
  • gold: number[]
  • goldenrod: number[]
  • gray: number[]
  • green: number[]
  • greenyellow: number[]
  • grey: number[]
  • honeydew: number[]
  • hotpink: number[]
  • indianred: number[]
  • indigo: number[]
  • ivory: number[]
  • khaki: number[]
  • lavender: number[]
  • lavenderblush: number[]
  • lawngreen: number[]
  • lemonchiffon: number[]
  • lightblue: number[]
  • lightcoral: number[]
  • lightcyan: number[]
  • lightgoldenrodyellow: number[]
  • lightgray: number[]
  • lightgreen: number[]
  • lightgrey: number[]
  • lightpink: number[]
  • lightsalmon: number[]
  • lightseagreen: number[]
  • lightskyblue: number[]
  • lightslategray: number[]
  • lightslategrey: number[]
  • lightsteelblue: number[]
  • lightyellow: number[]
  • lime: number[]
  • limegreen: number[]
  • linen: number[]
  • magenta: number[]
  • maroon: number[]
  • mediumaquamarine: number[]
  • mediumblue: number[]
  • mediumorchid: number[]
  • mediumpurple: number[]
  • mediumseagreen: number[]
  • mediumslateblue: number[]
  • mediumspringgreen: number[]
  • mediumturquoise: number[]
  • mediumvioletred: number[]
  • midnightblue: number[]
  • mintcream: number[]
  • mistyrose: number[]
  • moccasin: number[]
  • navajowhite: number[]
  • navy: number[]
  • oldlace: number[]
  • olive: number[]
  • olivedrab: number[]
  • orange: number[]
  • orangered: number[]
  • orchid: number[]
  • palegoldenrod: number[]
  • palegreen: number[]
  • paleturquoise: number[]
  • palevioletred: number[]
  • papayawhip: number[]
  • peachpuff: number[]
  • peru: number[]
  • pink: number[]
  • plum: number[]
  • powderblue: number[]
  • purple: number[]
  • rebeccapurple: number[]
  • red: number[]
  • rosybrown: number[]
  • royalblue: number[]
  • saddlebrown: number[]
  • salmon: number[]
  • sandybrown: number[]
  • seagreen: number[]
  • seashell: number[]
  • sienna: number[]
  • silver: number[]
  • skyblue: number[]
  • slateblue: number[]
  • slategray: number[]
  • slategrey: number[]
  • snow: number[]
  • springgreen: number[]
  • steelblue: number[]
  • tan: number[]
  • teal: number[]
  • thistle: number[]
  • tomato: number[]
  • transparent: number[]
  • turquoise: number[]
  • violet: number[]
  • wheat: number[]
  • white: number[]
  • whitesmoke: number[]
  • yellow: number[]
  • yellowgreen: number[]

Functions

aspect

  • aspect(__namedParameters: ReadonlySize, ratio: number): ReadonlySize

Const cancelAnimationFrame

  • cancelAnimationFrame(handle: number): void

changeSize

  • changeSize(callback: (ev: Event) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: Event) => void
        • (ev: Event): void
        • Parameters

          • ev: Event

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

computed

  • computed<T>(options: SetterGetter<any> | (() => any)): ComputedRef<T>

constrain

  • constrain(value: number, min: number, max: number): number

createAnimate

  • createAnimate<State>(state: State, duration?: number, easing?: AnimateType): AnimateClass<State> & State
  • Type parameters

    • State: readonly number[] | {}

    Parameters

    • state: State
    • Optional duration: number
    • Optional easing: AnimateType

    Returns AnimateClass<State> & State

createCamera

  • createCamera(canvas: default, x: number, y: number, width: number, height: number): Camera

createCanvas

  • createCanvas(): default
  • createCanvas(width: number, height: number): default
  • createCanvas(element?: string | HTMLCanvasElement): default
  • createCanvas(element: string | HTMLCanvasElement, width?: number, height?: number): default

createOneTimeEvent

  • createOneTimeEvent<States>(states: States): OneTimeEvent<States>

createVector

  • createVector(x?: number, y?: number, z?: number): Vector

cutImage

  • cutImage(image: CanvasImageSource, x?: number, y?: number, width?: number, height?: number, rotate?: number): HTMLCanvasElement
  • Parameters

    • image: CanvasImageSource
    • x: number = 0
    • y: number = 0
    • width: number = ...
    • height: number = ...
    • rotate: number = 0

    Returns HTMLCanvasElement

defineBlock

  • defineBlock<RawBindings, D, E, C, M>(options: ComponentOptionsWithoutProps<unknown, RawBindings, D, E, C, M>): XProxy<unknown, RawBindings, D, E, C, M>
  • defineBlock<PropNames, RawBindings, D, E, C, M>(options: ComponentOptionsWithArrayProps<PropNames, RawBindings, D, E, C, M, Readonly<{ readonly [ key in string]?: any }>>): XProxy<Readonly<{ readonly [ key in PropNames]?: any }>, RawBindings, D, E, C, M>
  • defineBlock<Props, RawBindings, D, E, C, M, PropsOptions>(options: HasDefined<Props> extends true ? ComponentOptionsWithProps<PropsOptions, RawBindings, D, E, C, M, Props> : ComponentOptionsWithProps<PropsOptions, RawBindings, D, E, C, M, ExtractPropTypes<PropsOptions>>): XProxy<PropsOptions, RawBindings, D, E, C, M>
  • Type parameters

    • RawBindings

    • D = Data

    • E: ObjectEmitsOptions = {}

    • C: ComputedOptions = {}

    • M: MethodOptions = {}

    Parameters

    • options: ComponentOptionsWithoutProps<unknown, RawBindings, D, E, C, M>

    Returns XProxy<unknown, RawBindings, D, E, C, M>

  • Type parameters

    • PropNames: string

    • RawBindings = Data

    • D = Data

    • E: ObjectEmitsOptions = {}

    • C: ComputedOptions = {}

    • M: MethodOptions = {}

    Parameters

    • options: ComponentOptionsWithArrayProps<PropNames, RawBindings, D, E, C, M, Readonly<{ readonly [ key in string]?: any }>>

    Returns XProxy<Readonly<{ readonly [ key in PropNames]?: any }>, RawBindings, D, E, C, M>

  • Type parameters

    • Props

    • RawBindings = Data

    • D = Data

    • E: ObjectEmitsOptions = {}

    • C: ComputedOptions = {}

    • M: MethodOptions = {}

    • PropsOptions: ComponentPropsOptions<Data> = ComponentPropsOptions<Data>

    Parameters

    • options: HasDefined<Props> extends true ? ComponentOptionsWithProps<PropsOptions, RawBindings, D, E, C, M, Props> : ComponentOptionsWithProps<PropsOptions, RawBindings, D, E, C, M, ExtractPropTypes<PropsOptions>>

    Returns XProxy<PropsOptions, RawBindings, D, E, C, M>

draw

  • draw(callback: Noop, canvas?: default): void

even

  • even(value: number, min: number, prevent: number): number

getCanvasInstance

  • getCanvasInstance(): default | null

getPowerDirection

  • getPowerDirection(el1: BlockSize, el2: BlockSize): number

intersectCirclePoint

  • intersectCirclePoint(circle: {} & { x: number; y: number } & { radius: number }, x: number, y: number): boolean

intersectCircleRect

  • intersectCircleRect(circle: {} & { x: number; y: number } & { radius: number }, rect: {} & { x: number; y: number } & { height: number; width: number }): boolean
  • Parameters

    • circle: {} & { x: number; y: number } & { radius: number }
    • rect: {} & { x: number; y: number } & { height: number; width: number }

    Returns boolean

intersectRectCircle

  • intersectRectCircle(rect: {} & { x: number; y: number } & { height: number; width: number }, circle: {} & { x: number; y: number } & { radius: number }): boolean
  • Parameters

    • rect: {} & { x: number; y: number } & { height: number; width: number }
    • circle: {} & { x: number; y: number } & { radius: number }

    Returns boolean

intersectRectPoint

  • intersectRectPoint(rect: {} & { x: number; y: number } & { height: number; width: number }, x: number, y: number): boolean
  • Parameters

    • rect: {} & { x: number; y: number } & { height: number; width: number }
    • x: number
    • y: number

    Returns boolean

intersectTwoCircles

  • intersectTwoCircles(circle1: {} & { x: number; y: number } & { radius: number }, circle2: {} & { x: number; y: number } & { radius: number }): boolean
  • Parameters

    • circle1: {} & { x: number; y: number } & { radius: number }
    • circle2: {} & { x: number; y: number } & { radius: number }

    Returns boolean

intersectTwoRects

  • intersectTwoRects(rect1: {} & { x: number; y: number } & { height: number; width: number }, rect2: {} & { x: number; y: number } & { height: number; width: number }): boolean
  • Parameters

    • rect1: {} & { x: number; y: number } & { height: number; width: number }
    • rect2: {} & { x: number; y: number } & { height: number; width: number }

    Returns boolean

isMobile

  • isMobile(): boolean

isRef

  • isRef(value: any): value is Ref<any>

isTouch

  • isTouch(): boolean

isUnlimited

  • isUnlimited(value: number, min: number, max: number): boolean

keyPressed

  • keyPressed(callback: (ev: KeyboardEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: KeyboardEvent) => void
        • (ev: KeyboardEvent): void
        • Parameters

          • ev: KeyboardEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

lerp

  • lerp(start: number, stop: number, amt: number): number

loadAudio

  • loadAudio(src: string): Promise<HTMLAudioElement>

loadImage

  • loadImage(src: string): Promise<HTMLImageElement>

loadTiles

  • loadTiles(url: string): Promise<Tiles>

map

  • map(value: number, start: number, stop: number, min: number, max: number): number
  • Parameters

    • value: number
    • start: number
    • stop: number
    • min: number
    • max: number

    Returns number

mouseClicked

  • mouseClicked(callback: (ev: MouseEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: MouseEvent) => void
        • (ev: MouseEvent): void
        • Parameters

          • ev: MouseEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

mouseMoved

  • mouseMoved(callback: (ev: MouseEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: MouseEvent) => void
        • (ev: MouseEvent): void
        • Parameters

          • ev: MouseEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

mousePressed

  • mousePressed(callback: (ev: MouseEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: MouseEvent) => void
        • (ev: MouseEvent): void
        • Parameters

          • ev: MouseEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

mouseWheel

  • mouseWheel(callback: (ev: WheelEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: WheelEvent) => void
        • (ev: WheelEvent): void
        • Parameters

          • ev: WheelEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

odd

  • odd(value: number, prevent: number, max: number): number

onewrite

  • onewrite<T>(value: T): Ref<T>

random

  • random(value: number): number
  • random<T>(array: readonly T[]): T
  • random(start: number, stop: number): number

randomColor

  • randomColor(): string

range

  • range(start: number, stop: number, step: number): number
  • range(start: string, stop: string, step: number): string

reactive

readonly

  • readonly<T>(value: T): Ref<T>

ref

  • ref<T>(value: T): Ref<T>

Const requestAnimationFrame

  • requestAnimationFrame(callback: FrameRequestCallback): number

setup

  • setup(callback: () => void | Promise<void>, canvas?: default): Promise<void>
  • Parameters

    • callback: () => void | Promise<void>
        • (): void | Promise<void>
        • Returns void | Promise<void>

    • Optional canvas: default

    Returns Promise<void>

shallowOnewrite

  • shallowOnewrite<T>(value: T): Ref<T>

shallowReactive

  • shallowReactive<T>(value: T): Reactive<T>

shallowReadonly

  • shallowReadonly<T>(value: T): Ref<T>

sleep

  • sleep(ms: number): Promise<void>

touchEnd

  • touchEnd(callback: (ev: TouchEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: TouchEvent) => void
        • (ev: TouchEvent): void
        • Parameters

          • ev: TouchEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

touchMove

  • touchMove(callback: (ev: TouchEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: TouchEvent) => void
        • (ev: TouchEvent): void
        • Parameters

          • ev: TouchEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

touchStart

  • touchStart(callback: (ev: TouchEvent) => void, element?: HTMLElement | Window): Noop
  • Parameters

    • callback: (ev: TouchEvent) => void
        • (ev: TouchEvent): void
        • Parameters

          • ev: TouchEvent

          Returns void

    • element: HTMLElement | Window = window

    Returns Noop

watch

  • watch<T>(proxy: T | Ref<T>, cb: (newValue: T, oldValue: T) => void, options?: { deep?: boolean; immediate?: boolean; path?: string }): () => void
  • Type parameters

    • T = any

    Parameters

    • proxy: T | Ref<T>
    • cb: (newValue: T, oldValue: T) => void
        • (newValue: T, oldValue: T): void
        • Parameters

          • newValue: T
          • oldValue: T

          Returns void

    • Optional options: { deep?: boolean; immediate?: boolean; path?: string }
      • Optional Readonly deep?: boolean
      • Optional Readonly immediate?: boolean
      • Optional Readonly path?: string

    Returns () => void

      • (): void
      • Returns void

Generated using TypeDoc