PageTable
Defined in: sdk/src/terrain/pages.ts:115
Where the pages live: slots in a square atlas, given out and taken back by key.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PageTable(
atlasSize):PageTable
Defined in: sdk/src/terrain/pages.ts:122
Parameters
Section titled “Parameters”atlasSize
Section titled “atlasSize”number
Returns
Section titled “Returns”PageTable
Properties
Section titled “Properties”atlasSize
Section titled “atlasSize”
readonlyatlasSize:number
Defined in: sdk/src/terrain/pages.ts:122
capacity
Section titled “capacity”
readonlycapacity:number
Defined in: sdk/src/terrain/pages.ts:117
perRow
Section titled “perRow”
readonlyperRow:number
Defined in: sdk/src/terrain/pages.ts:116
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get size():
number
Defined in: sdk/src/terrain/pages.ts:195
Returns
Section titled “Returns”number
Methods
Section titled “Methods”claim()
Section titled “claim()”claim(
key,min,max):Page|null
Defined in: sdk/src/terrain/pages.ts:144
A slot for a new page under key: a free one, or the least recently drawn one not drawn this frame. Null when every slot is in use now.
Parameters
Section titled “Parameters”string
number
number
Returns
Section titled “Returns”Page | null
clear()
Section titled “clear()”clear():
void
Defined in: sdk/src/terrain/pages.ts:184
Forgets every page (the device lost the atlas, or the ground changed).
Returns
Section titled “Returns”void
forget()
Section titled “forget()”forget(
test):void
Defined in: sdk/src/terrain/pages.ts:162
Forgets the pages test names (the ground changed under them): they are made again as they are wanted.
Parameters
Section titled “Parameters”(key) => boolean
Returns
Section titled “Returns”void
get(
key):Page|undefined
Defined in: sdk/src/terrain/pages.ts:128
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Page | undefined
isStale()
Section titled “isStale()”isStale(
key):boolean
Defined in: sdk/src/terrain/pages.ts:179
Whether the page under key is out of date.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
markStale()
Section titled “markStale()”markStale(
test):void
Defined in: sdk/src/terrain/pages.ts:174
Marks the pages test names as out of date without taking them away: they go on being drawn as they were until each is made again
(claim on its key), so an edit never leaves a hole in the ground while its pages are rebuilt over the next frames.
Parameters
Section titled “Parameters”(key) => boolean
Returns
Section titled “Returns”void
origin()
Section titled “origin()”origin(
slot): [number,number]
Defined in: sdk/src/terrain/pages.ts:191
Where a slot’s page starts in the atlas, in texels.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”[number, number]
tick()
Section titled “tick()”tick():
void
Defined in: sdk/src/terrain/pages.ts:139
Moves the clock a frame on.
Returns
Section titled “Returns”void
touch()
Section titled “touch()”touch(
key):void
Defined in: sdk/src/terrain/pages.ts:133
Marks pages drawn this frame, so they are the last to be given up.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void