PostProcessAPI
此内容尚不支持你的语言。
Defined in: postprocess/PostProcessAPI.ts:212
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PostProcessAPI():
PostProcessAPI
Returns
Section titled “Returns”PostProcessAPI
Properties
Section titled “Properties”
readonlystate:PostProcessState
Defined in: postprocess/PostProcessAPI.ts:213
volumeShaders
Section titled “volumeShaders”
readonlyvolumeShaders:Map<string,number>
Defined in: postprocess/PostProcessAPI.ts:217
volumeStacks
Section titled “volumeStacks”
readonlyvolumeStacks:Map<number,PostProcessStack>
Defined in: postprocess/PostProcessAPI.ts:216
Volume-system bookkeeping (per-App): camera → the stack it created, and shared effect shaders.
Accessors
Section titled “Accessors”screenStack
Section titled “screenStack”Get Signature
Section titled “Get Signature”get screenStack():
PostProcessStack|null
Defined in: postprocess/PostProcessAPI.ts:240
Returns
Section titled “Returns”PostProcessStack | null
Methods
Section titled “Methods”_applyForCamera()
Section titled “_applyForCamera()”_applyForCamera(
camera):void
Defined in: postprocess/PostProcessAPI.ts:433
Parameters
Section titled “Parameters”camera
Section titled “camera”number
Returns
Section titled “Returns”void
_applyScreenStack()
Section titled “_applyScreenStack()”_applyScreenStack():
void
Defined in: postprocess/PostProcessAPI.ts:475
Returns
Section titled “Returns”void
_beginScreenCapture()
Section titled “_beginScreenCapture()”_beginScreenCapture():
void
Defined in: postprocess/PostProcessAPI.ts:459
Returns
Section titled “Returns”void
_endScreenCapture()
Section titled “_endScreenCapture()”_endScreenCapture():
void
Defined in: postprocess/PostProcessAPI.ts:467
Returns
Section titled “Returns”void
_executeScreenPasses()
Section titled “_executeScreenPasses()”_executeScreenPasses():
void
Defined in: postprocess/PostProcessAPI.ts:514
Returns
Section titled “Returns”void
_resetAfterCamera()
Section titled “_resetAfterCamera()”_resetAfterCamera():
void
Defined in: postprocess/PostProcessAPI.ts:449
Returns
Section titled “Returns”void
begin()
Section titled “begin()”begin():
void
Defined in: postprocess/PostProcessAPI.ts:397
Returns
Section titled “Returns”void
bind()
Section titled “bind()”bind(
camera,stack):void
Defined in: postprocess/PostProcessAPI.ts:252
Parameters
Section titled “Parameters”camera
Section titled “camera”number
Returns
Section titled “Returns”void
createStack()
Section titled “createStack()”createStack():
PostProcessStack
Defined in: postprocess/PostProcessAPI.ts:248
Returns
Section titled “Returns”end():
void
Defined in: postprocess/PostProcessAPI.ts:405
Returns
Section titled “Returns”void
getStack()
Section titled “getStack()”getStack(
camera):PostProcessStack|null
Defined in: postprocess/PostProcessAPI.ts:263
Parameters
Section titled “Parameters”camera
Section titled “camera”number
Returns
Section titled “Returns”PostProcessStack | null
hdrFormat()
Section titled “hdrFormat()”hdrFormat():
HdrFormat|null
Defined in: postprocess/PostProcessAPI.ts:374
The format decision the last frame COMMITTED to.
The frame’s own answer, not the device asked again. linear false is a
project that never asked for HDR, which is not a fallback. The names come
from the engine — a second spelling of the enum’s order is drift.
Returns
Section titled “Returns”HdrFormat | null
init()
Section titled “init()”init(
width,height):boolean
Defined in: postprocess/PostProcessAPI.ts:269
Parameters
Section titled “Parameters”number
height
Section titled “height”number
Returns
Section titled “Returns”boolean
isInitialized()
Section titled “isInitialized()”isInitialized():
boolean
Defined in: postprocess/PostProcessAPI.ts:294
Returns
Section titled “Returns”boolean
msaaCapability()
Section titled “msaaCapability()”msaaCapability():
object
Defined in: postprocess/PostProcessAPI.ts:348
What the scene target is ACTUALLY multisampled at, and the most this device can do.
Two numbers because a request and a capability are different facts: asking
for 8 where the backend allows 1 is not a typo, and only saying both tells
those apart. 0 means nothing here can answer.
Returns
Section titled “Returns”object
effective
Section titled “effective”effective:
number
max:
number
resize()
Section titled “resize()”resize(
width,height):void
Defined in: postprocess/PostProcessAPI.ts:286
Parameters
Section titled “Parameters”number
height
Section titled “height”number
Returns
Section titled “Returns”void
setBypass()
Section titled “setBypass()”setBypass(
bypass):void
Defined in: postprocess/PostProcessAPI.ts:304
Parameters
Section titled “Parameters”bypass
Section titled “bypass”boolean
Returns
Section titled “Returns”void
setMsaaSamples()
Section titled “setMsaaSamples()”setMsaaSamples(
samples):void
Defined in: postprocess/PostProcessAPI.ts:332
Multisampling the scene target should rasterise with; 1 turns it off. The device clamps it, so this is the project’s ASK, not what it gets — a backend with no MSAA answers 1 whatever is set here.
Parameters
Section titled “Parameters”samples
Section titled “samples”number
Returns
Section titled “Returns”void
setOutputTransform()
Section titled “setOutputTransform()”setOutputTransform(
transform):void
Defined in: postprocess/PostProcessAPI.ts:319
The curve the frame applies on its way to the display.
Applied to whatever the chain produced, so it also engages the capture: a project that asks for a curve gets one with an empty stack. See OutputTransform for which to want.
Parameters
Section titled “Parameters”transform
Section titled “transform”Returns
Section titled “Returns”void
setOutputViewport()
Section titled “setOutputViewport()”setOutputViewport(
x,y,w,h):void
Defined in: postprocess/PostProcessAPI.ts:423
Parameters
Section titled “Parameters”number
number
number
number
Returns
Section titled “Returns”void
setPresentRequired()
Section titled “setPresentRequired()”setPresentRequired(
required):void
Defined in: postprocess/PostProcessAPI.ts:415
Say the frame needs a present when the rects alone cannot: a 1x letterbox and a split-screen viewport are the same geometry and differ only in intent.
Parameters
Section titled “Parameters”required
Section titled “required”boolean
Returns
Section titled “Returns”void
setQualityFilter()
Section titled “setQualityFilter()”setQualityFilter(
profile):void
Defined in: postprocess/PostProcessAPI.ts:228
Parameters
Section titled “Parameters”profile
Section titled “profile”Readonly<QualityProfile> | null
Returns
Section titled “Returns”void
setScreenStack()
Section titled “setScreenStack()”setScreenStack(
stack):void
Defined in: postprocess/PostProcessAPI.ts:244
Parameters
Section titled “Parameters”PostProcessStack | null
Returns
Section titled “Returns”void
shutdown()
Section titled “shutdown()”shutdown():
void
Defined in: postprocess/PostProcessAPI.ts:278
Returns
Section titled “Returns”void
unbind()
Section titled “unbind()”unbind(
camera):void
Defined in: postprocess/PostProcessAPI.ts:259
Parameters
Section titled “Parameters”camera
Section titled “camera”number
Returns
Section titled “Returns”void