RenderDemand
Defined in: sdk/src/render/renderDemand.ts:52
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RenderDemand():
RenderDemand
Returns
Section titled “Returns”RenderDemand
Accessors
Section titled “Accessors”enabled
Section titled “enabled”Get Signature
Section titled “Get Signature”get enabled():
boolean
Defined in: sdk/src/render/renderDemand.ts:65
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get stats():
object
Defined in: sdk/src/render/renderDemand.ts:67
Frames drawn and frames left out since this was turned on.
Returns
Section titled “Returns”object
drawn:
number
skipped
Section titled “skipped”skipped:
number
Methods
Section titled “Methods”disable()
Section titled “disable()”disable():
void
Defined in: sdk/src/render/renderDemand.ts:76
Returns
Section titled “Returns”void
enable()
Section titled “enable()”enable(
options?):void
Defined in: sdk/src/render/renderDemand.ts:69
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”void
hold()
Section titled “hold()”hold(): () =>
void
Defined in: sdk/src/render/renderDemand.ts:89
Draw every frame until the returned function is called: for what moves on its own (a tween, a video, an animation). Holds add up, so two owners do not release each other’s.
Returns
Section titled “Returns”() => void
request()
Section titled “request()”request():
void
Defined in: sdk/src/render/renderDemand.ts:81
Draw the next frame (and the tail after it): something changed that the engine could not see.
Returns
Section titled “Returns”void
shouldRender()
Section titled “shouldRender()”shouldRender(
probe):boolean
Defined in: sdk/src/render/renderDemand.ts:101
Asked once per frame, by the frame that would draw. False leaves the frame out; the screen keeps the last picture.
Parameters
Section titled “Parameters”RenderDemandProbe
Returns
Section titled “Returns”boolean