Renderer
constRenderer:object
Defined in: renderer.ts:154
Type Declaration
Section titled “Type Declaration”begin()
Section titled “begin()”begin(
viewProjection,target?,clearFlags?,clearColor?,clearRect?):void
Begins the pass. The clear rides begin as a load-op: clearFlags bit 0 =
color, bit 1 = depth; clearColor is the color value; clearRect scopes the
clear to a viewport region (omitted = the whole target). No flags = load.
Parameters
Section titled “Parameters”viewProjection
Section titled “viewProjection”Float32Array
target?
Section titled “target?”number
clearFlags?
Section titled “clearFlags?”number = 0
clearColor?
Section titled “clearColor?”number
number
number
number
clearRect?
Section titled “clearRect?”number
number
number
number
Returns
Section titled “Returns”void
beginFrame()
Section titled “beginFrame()”beginFrame(
elapsedSec?):void
Parameters
Section titled “Parameters”elapsedSec?
Section titled “elapsedSec?”number = 0
Returns
Section titled “Returns”void
captureNextFrame()
Section titled “captureNextFrame()”captureNextFrame():
void
Returns
Section titled “Returns”void
createRenderTarget()
Section titled “createRenderTarget()”createRenderTarget(
width,height,flags?):number
Parameters
Section titled “Parameters”number
height
Section titled “height”number
flags?
Section titled “flags?”number = 1
Returns
Section titled “Returns”number
end():
void
Returns
Section titled “Returns”void
flush()
Section titled “flush()”flush():
void
Returns
Section titled “Returns”void
getCapturedData()
Section titled “getCapturedData()”getCapturedData():
FrameCaptureData|null
Returns
Section titled “Returns”FrameCaptureData | null
getSnapshotImageData()
Section titled “getSnapshotImageData()”getSnapshotImageData():
Promise<ImageData|null>
Resolves with the replay snapshot once its async readback lands (see frameCapture).
Returns
Section titled “Returns”Promise<ImageData | null>
getStats()
Section titled “getStats()”getStats():
RenderStats
Returns
Section titled “Returns”getTargetDepthTexture()
Section titled “getTargetDepthTexture()”getTargetDepthTexture(
handle):number
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”number
getTargetTexture()
Section titled “getTargetTexture()”getTargetTexture(
handle):number
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”number
hasCapturedData()
Section titled “hasCapturedData()”hasCapturedData():
boolean
Returns
Section titled “Returns”boolean
init()
Section titled “init()”init(
width,height):void
Parameters
Section titled “Parameters”number
height
Section titled “height”number
Returns
Section titled “Returns”void
measureBitmapText()
Section titled “measureBitmapText()”measureBitmapText(
fontHandle,text,fontSize,spacing):object
Parameters
Section titled “Parameters”fontHandle
Section titled “fontHandle”number
string
fontSize
Section titled “fontSize”number
spacing
Section titled “spacing”number
Returns
Section titled “Returns”object
height
Section titled “height”height:
number
width:
number
releaseRenderTarget()
Section titled “releaseRenderTarget()”releaseRenderTarget(
handle):void
Parameters
Section titled “Parameters”handle
Section titled “handle”number
Returns
Section titled “Returns”void
replayToDrawCall()
Section titled “replayToDrawCall()”replayToDrawCall(
drawCallIndex):void
Parameters
Section titled “Parameters”drawCallIndex
Section titled “drawCallIndex”number
Returns
Section titled “Returns”void
resize()
Section titled “resize()”resize(
width,height):void
Parameters
Section titled “Parameters”number
height
Section titled “height”number
Returns
Section titled “Returns”void
setClearColor()
Section titled “setClearColor()”setClearColor(
r,g,b,a):void
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”void
setStage()
Section titled “setStage()”setStage(
stage):void
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setTextureParams()
Section titled “setTextureParams()”setTextureParams(
textureId,minFilter,magFilter,wrapS,wrapT):void
Parameters
Section titled “Parameters”textureId
Section titled “textureId”number
minFilter
Section titled “minFilter”number
magFilter
Section titled “magFilter”number
number
number
Returns
Section titled “Returns”void
setViewport()
Section titled “setViewport()”setViewport(
x,y,w,h):void
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”void
setYSortLayers()
Section titled “setYSortLayers()”setYSortLayers(
mask):void
Layers (bits 0..31) that sort by world Y within the layer — top-down occlusion.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
submitAll()
Section titled “submitAll()”submitAll(
registry,skipFlags,vpX,vpY,vpW,vpH):void
Parameters
Section titled “Parameters”registry
Section titled “registry”skipFlags
Section titled “skipFlags”number
number
number
number
number
Returns
Section titled “Returns”void
updateTransforms()
Section titled “updateTransforms()”updateTransforms(
registry):void
Parameters
Section titled “Parameters”registry
Section titled “registry”Returns
Section titled “Returns”void