ui

ui

Data-driven UI layout system built on PIXI.js: http://www.pixijs.com/.

Supports animated elements via pixi-spine, font loading via webfontloader and sounds via pixi-sound.

@quicksave/ui

Namespaces

• easing
• font
• html
• image
• resource
• schema
• validate

Enumerations

• DirtyFlag
• FlipFlags

Classes

• AnimatedSprite
• Application
• BitmapText
• Container
• Custom
• Element
• EventCanceled
• Frame
• Grid
• IFrame
• Input
• InvalidState
• LayoutInstance
• LayoutRef
• LayoutResource
• LayoutTemplate
• LinearGradient
• Link
• ParticleEmitter
• RadialGradient
• SoundResource
• SoundSpriteResource
• SoundSpriteWrapper
• Spine
• SpineResource
• Sprite
• SpritesheetResource
• Text
• TextureResource
• TilingSprite

Interfaces

• ApplicationCreateOptions
• ApplicationLoadOptions
• ApplicationStartOptions
• LayoutCreateOptions
• LayoutPrepareInfo
• LayoutPrepareOptions
• RendererUpdateOptions
• RendererUpdateStats
• SafeArea
• Size

Type Aliases

AnimationCallback

Ƭ AnimationCallback: (time: number) => void

Type declaration

▸ (time): void

Parameters

Name	Type
time	number

Returns

void

---

Event

Ƭ Event: string | number | EventCallback | EventCallbackAsync | Promise<any>

---

EventCallback

Ƭ EventCallback: () => void

Type declaration

▸ (): void

Returns

void

---

EventCallbackAsync

Ƭ EventCallbackAsync: () => Promise<any>

Type declaration

▸ (): Promise<any>

Returns

Promise<any>

---

EventEmitter

Ƭ EventEmitter: PIXIUtils.EventEmitter & { adjustCount?: number ; layouts?: LayoutInstance[] ; newScreenSize?: Size ; refs?: EventEmitter[] ; screenSize?: Size }

---

EventParams

Ƭ EventParams: EventParamsLoop | EventParamsNoLoop

---

EventStateCallback

Ƭ EventStateCallback: (state: string, cancelFunction?: () => void) => Promise<void> | void

Type declaration

▸ (state, cancelFunction?): Promise<void> | void

Parameters

Name	Type
state	string
cancelFunction?	() => void

Returns

Promise<void> | void

---

FlipMask

Ƭ FlipMask: number

---

LayoutRenderer

Ƭ LayoutRenderer: Renderer<HTMLCanvasElement> | RenderTexture | EventEmitter

---

PixiApplicationOptions

Ƭ PixiApplicationOptions: ConstructorParameters<typeof PIXIApp.Application>[0]

---

RenderTexture

Ƭ RenderTexture: PIXICore.RenderTexture & { adjustCount?: number ; layouts?: LayoutInstance[] ; refs?: EventEmitter[] }

---

Renderer

Ƭ Renderer<VIEW>: PIXICore.IRenderer<VIEW> & { adjustCount?: number ; layouts?: LayoutInstance[] ; refs?: EventEmitter[] ; screenSize?: Size }

Type parameters

Name	Type
VIEW	extends PIXICore.ICanvas = PIXICore.ICanvas

---

ResizeCallback

Ƭ ResizeCallback: (size: Size) => void

Type declaration

▸ (size): void

Parameters

Name	Type
size	Size

Returns

void

---

Sound

Ƭ Sound: PIXISound.Sound | SoundSpriteWrapper

Union type for standard PIXI Sound and ui package’s SoundSpriteWrapper. Using the union type ensures that only features supported by both are used.

Variables

DEADZONE

• DEADZONE: 20

---

LoaderResource

• LoaderResource: typeof LoaderResource

---

XhrLoader

• XhrLoader: typeof XhrLoader

---

blob

• blob: blob

---

bundle

• bundle: bundle

---

xhr

• xhr: xhr

Functions

getScreenSize

▸ getScreenSize(renderer): Size

Parameters

Name	Type
renderer	LayoutRenderer

Returns

Size

---

incrementAdjustCount

▸ incrementAdjustCount(renderer, adjustCount?): void

Parameters

Name	Type	Default value
renderer	LayoutRenderer	undefined
adjustCount	number	1

Returns

void

---

logicalToScreenSize

▸ logicalToScreenSize(realScreenSize, logicalScreenSize, size): number

Parameters

Name	Type
realScreenSize	Size
logicalScreenSize	Size
size	number

Returns

number

▸ logicalToScreenSize(realScreenSize, logicalScreenSize, size): Size

Parameters

Name	Type
realScreenSize	Size
logicalScreenSize	Size
size	Size

Returns

Size

---

offDirtyUpdate

▸ offDirtyUpdate(renderer, callback): void

Parameters

Name	Type
renderer	LayoutRenderer
callback	ResizeCallback

Returns

void

---

onDirtyUpdate

▸ onDirtyUpdate(renderer, callback): void

Parameters

Name	Type
renderer	LayoutRenderer
callback	ResizeCallback

Returns

void

---

registerCustomTypes

▸ registerCustomTypes(types): void

Parameters

Name	Type
types	Object

Returns

void

---

registerLayout

▸ registerLayout(renderer, layout): void

Parameters

Name	Type
renderer	LayoutRenderer
layout	LayoutInstance

Returns

void

---

registerRef

▸ registerRef(renderer, ref): void

Parameters

Name	Type
renderer	LayoutRenderer
ref	EventEmitter

Returns

void

---

screenToLogicalSize

▸ screenToLogicalSize(realScreenSize, logicalScreenSize, size): number

Parameters

Name	Type
realScreenSize	Size
logicalScreenSize	Size
size	number

Returns

number

▸ screenToLogicalSize(realScreenSize, logicalScreenSize, size): Size

Parameters

Name	Type
realScreenSize	Size
logicalScreenSize	Size
size	Size

Returns

Size

---

unregisterLayout

▸ unregisterLayout(renderer, layout): void

Parameters

Name	Type
renderer	LayoutRenderer
layout	LayoutInstance

Returns

void

---

unregisterRef

▸ unregisterRef(renderer, ref): void

Parameters

Name	Type
renderer	LayoutRenderer
ref	EventEmitter

Returns

void

---

updateRenderer

▸ updateRenderer(renderer, screenSize, resizeCallback?): RendererUpdateStats

Parameters

Name	Type
renderer	LayoutRenderer
screenSize	Size
resizeCallback?	ResizeCallback

Returns

RendererUpdateStats

▸ updateRenderer(renderer, screenSize, options?): RendererUpdateStats

Parameters

Name	Type
renderer	LayoutRenderer
screenSize	Size
options?	RendererUpdateOptions

Returns

RendererUpdateStats