_stream_.stream.md

@ericrabil/phea.js

Globals / "stream" / Stream

Class: Stream

Manages the framerate for refreshing

Hierarchy

• Stream

Index

Constructors

• constructor

Properties

• options
• running

Methods

• renderSingleFrame
• renderThread

Constructors

constructor

+ new Stream(options: StreamOptions): Stream

Defined in src/stream.ts:29

Parameters:

Name	Type
options	StreamOptions

Returns: Stream

Properties

options

• options: StreamOptions

Defined in src/stream.ts:31

---

running

• running: boolean = false

Defined in src/stream.ts:29

Methods

renderSingleFrame

▸ renderSingleFrame(): Promise<[void, void]>

Defined in src/stream.ts:60

Renders a single frame

Returns: Promise<[void, void]>

---

renderThread

▸ renderThread(): Promise<void>

Defined in src/stream.ts:38

Asynchronously runs the render loop

Returns: Promise<void>