Class: HorizonCanvasLayer<P, C>

A layer which uses a canvas to draw graphics.

Type parameters

Name	Type
P	extends HorizonCanvasLayerProps = HorizonCanvasLayerProps
C	extends HorizonCanvasLayerCanvasInstance = HorizonCanvasLayerCanvasInstance

Hierarchy

• HorizonLayer<P>

  ↳ HorizonCanvasLayer

  ↳↳ HorizonSyncedCanvasLayer

Constructors

constructor

• new HorizonCanvasLayer<P, C>(props): HorizonCanvasLayer<P, C>

Creates an instance of a DisplayComponent.

Type parameters

Name	Type
P	extends HorizonCanvasLayerProps = HorizonCanvasLayerProps
C	extends HorizonCanvasLayerCanvasInstance = HorizonCanvasLayerCanvasInstance

Parameters

Name	Type	Description
props	P	The propertis of the component.

Returns

HorizonCanvasLayer<P, C>

Inherited from

HorizonLayer.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

HorizonLayer.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

HorizonLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

isInit

• Protected isInit: boolean = false

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:82

---

props

• props: P & ComponentProps

The properties of the component.

Inherited from

HorizonLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Accessors

buffer

• get buffer(): C

Gets this layer's buffer canvas instance.

Returns

C

This layer's buffer canvas instance.

Throws

Error if this layer's buffer canvas instance has not been initialized.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:102

---

display

• get display(): C

Gets this layer's display canvas instance.

Returns

C

This layer's display canvas instance.

Throws

Error if this layer's display canvas instance has not been initialized.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:89

Methods

copyBufferToDisplay

▸ copyBufferToDisplay(): void

Copies the contents of the buffer to the display. Has no effect if this layer does not have a buffer.

Returns

void

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:175

---

createCanvasInstance

▸ createCanvasInstance(canvas, context, isDisplayed): C

Creates a canvas instance.

Parameters

Name	Type	Description
canvas	HTMLCanvasElement	The canvas element.
context	CanvasRenderingContext2D	The canvas 2D rendering context.
isDisplayed	boolean	Whether the canvas is displayed.

Returns

C

a canvas instance.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:226

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

HorizonLayer.destroy

Defined in

src/sdk/components/FSComponent.ts:98

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

HorizonLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

getHeight

▸ getHeight(): number

Gets the height of the canvas element, in pixels.

Returns

number

the height of the canvas element.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:138

---

getWidth

▸ getWidth(): number

Gets the width of the canvas element, in pixels.

Returns

number

the width of the canvas element.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:130

---

isAttached

▸ isAttached(): boolean

Checks whether this layer is attached to a horizon component.

Returns

boolean

Whether this layer is attached to a horizon component.

Inherited from

HorizonLayer.isAttached

Defined in

src/sdk/components/horizon/HorizonLayer.ts:31

---

isVisible

▸ isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

HorizonLayer.isVisible

Defined in

src/sdk/components/horizon/HorizonLayer.ts:39

---

onAfterRender

▸ onAfterRender(): void

A callback called after the component renders.

Returns

void

Overrides

HorizonLayer.onAfterRender

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:186

---

onAttached

▸ onAttached(): void

This method is called when this layer is attached to its parent horizon component.

Returns

void

Overrides

HorizonLayer.onAttached

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:198

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

HorizonLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onDetached

▸ onDetached(): void

This method is called when this layer is detached from its parent horizon component.

Returns

void

Inherited from

HorizonLayer.onDetached

Defined in

src/sdk/components/horizon/HorizonLayer.ts:115

---

onProjectionChanged

▸ onProjectionChanged(projection, changeFlags): void

This method is called when this layer's horizon projection changes.

Parameters

Name	Type	Description
projection	HorizonProjection	This layer's horizon projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

Inherited from

HorizonLayer.onProjectionChanged

Defined in

src/sdk/components/horizon/HorizonLayer.ts:98

---

onSleep

▸ onSleep(): void

This method is called when this layer's parent horizon component is put to sleep.

Returns

void

Inherited from

HorizonLayer.onSleep

Defined in

src/sdk/components/horizon/HorizonLayer.ts:88

---

onUpdated

▸ onUpdated(time, elapsed): void

This method is called once every update cycle.

Parameters

Name	Type	Description
time	number	The current time as a UNIX timestamp in milliseconds.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

HorizonLayer.onUpdated

Defined in

src/sdk/components/horizon/HorizonLayer.ts:108

---

onVisibilityChanged

▸ onVisibilityChanged(): void

This method is called when this layer's visibility changes.

Returns

void

Overrides

HorizonLayer.onVisibilityChanged

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:191

---

onWake

▸ onWake(): void

This method is called when this layer's parent horizon component is awakened.

Returns

void

Inherited from

HorizonLayer.onWake

Defined in

src/sdk/components/horizon/HorizonLayer.ts:81

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

HorizonLayer.render

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:255

---

setHeight

▸ setHeight(height): void

Sets the height of the canvas element, in pixels.

Parameters

Name	Type	Description
height	number	The new height.

Returns

void

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:161

---

setVisible

▸ setVisible(val): void

Sets this layer's visibility.

Parameters

Name	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

HorizonLayer.setVisible

Defined in

src/sdk/components/horizon/HorizonLayer.ts:47

---

setWidth

▸ setWidth(width): void

Sets the width of the canvas element, in pixels.

Parameters

Name	Type	Description
width	number	The new width.

Returns

void

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:146

---

tryGetBuffer

▸ tryGetBuffer(): undefined | C

Attempts to get this layer's buffer canvas instance.

Returns

undefined | C

This layer's buffer canvas instance, or undefined if it has not been initialized.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:122

---

tryGetDisplay

▸ tryGetDisplay(): undefined | C

Attempts to get this layer's display canvas instance.

Returns

undefined | C

This layer's display canvas instance, or undefined if it has not been initialized.

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:114

---

updateCanvasSize

▸ updateCanvasSize(): void

Updates the canvas element's size.

Returns

void

Defined in

src/sdk/components/horizon/layers/HorizonCanvasLayer.tsx:233