xScal Scaleform API 0.4.34

Engine graphics

Published by the Fallout76 NX plugin (Fallout76_DLSSFrameGen.dll) through xScal's plugin callback ABI. If the plugin is missing or rejected, these names do not exist. Setters return false when the feature cannot be enabled in the active renderer session.

Engine.EnableDLSSFrameGen

Enable DLSS frame generation

__SFCodeObj.call("Engine.EnableDLSSFrameGen"):Boolean

No arguments.

Returns Boolean

Enables it in an active NVIDIA session. If DLSS is the saved provider but the renderer started with frame generation off, saves the request for the next renderer restart.

Engine.DisableDLSSFrameGen

Disable DLSS frame generation

__SFCodeObj.call("Engine.DisableDLSSFrameGen"):Boolean

No arguments.

Returns Boolean

Disables the active or saved request without changing FSR.

Engine.EnableFSRFrameGen

Enable FSR frame generation

__SFCodeObj.call("Engine.EnableFSRFrameGen"):Boolean

No arguments.

Returns Boolean

Enables it in an active FSR session. If FSR is the saved provider but the renderer started with frame generation off, saves the request for the next renderer restart.

Engine.DisableFSRFrameGen

Disable FSR frame generation

__SFCodeObj.call("Engine.DisableFSRFrameGen"):Boolean

No arguments.

Returns Boolean

Disables the active or saved request without changing DLSS.

Engine.EnableReflex

Save Reflex On

__SFCodeObj.call("Engine.EnableReflex"):Boolean

No arguments.

Returns Boolean

Accepted when the active Streamline session has Reflex and PCL support.

Engine.DisableReflex

Save Reflex Off

__SFCodeObj.call("Engine.DisableReflex"):Boolean

No arguments.

Returns Boolean

Accepted before renderer initialization too.

Engine.AvailableUpscalers

Providers the active renderer supports

__SFCodeObj.call("Engine.AvailableUpscalers"):String

No arguments.

Returns String (JSON)

FieldTypeDescription
DLSSBoolean
FSRBoolean

Sample result

{"DLSS":true,"FSR":false}

Engine.GetUpscalerState

Requested frame-generation backend and applied Reflex mode

__SFCodeObj.call("Engine.GetUpscalerState"):String

No arguments.

Returns String (JSON)

FieldTypeDescription
DLSSBoolean
FSRBoolean
ReflexBoolean

Sample result

{"DLSS":false,"FSR":true,"Reflex":true}

A provider stays false until it owns the renderer session, even when it was enabled for the next restart.

Engine.SetFramegenProvider

Save the frame-generation backend for the next session

__SFCodeObj.call("Engine.SetFramegenProvider", provider:String):Boolean

Arguments

NameTypeDescription
providerStringOne of DLSS, FSR, Off.

Returns Boolean

Example

var available:Object = JSON.parse(__SFCodeObj.call("Engine.AvailableUpscalers"));
if (available.FSR) {
    __SFCodeObj.call("Engine.SetFramegenProvider", "FSR");
}