Get started with Arm Accuracy Super Resolution (Arm ASR)
Introduction
What is Arm Accuracy Super Resolution?
Using Arm ASR in Unreal Engine
Using Arm ASR in a Custom Engine using the Generic Library
Acknowledgements, Licensing, and Additional Resources
Next Steps

  Log an issue

  Fork and edit

  Discuss on Discord

Objective

This Learning Path describes how to get started with Arm® Accuracy Super Resolution™ (Arm ASR) using an example project in Unreal Engine.

It is for Unreal Engine developers who want to apply upscaling techniques to their projects.

You will walk through the processes of installing Arm ASR performing some of the common setup tasks.

Before you begin

It is recommended that you use Unreal Engine versions 5.3-5.5 through this tutorial.

Installing the Arm ASR plugin

Follow these steps to install the Arm ASR plugin in Unreal Engine:

  1. Open the Unreal Engine project you plan to use with Arm ASR.

The Third Person pack is available as an example, see below:

Image Alt Text:Third Person packThird Person pack

  1. Download the Arm ASR plugin by cloning the repository:

        

        
        
git clone https://github.com/arm/accuracy-super-resolution-for-unreal

  2. Navigate to the UE directory in the cloned repository.

    The repository base contains directories containing the plugin for each supported version of Unreal Engine. Navigate to the folder corresponding to your version. For example, use 550 for Unreal Engine 5.5.

  3. From the directory for your version of Unreal Engine, copy the Arm ASR plugin into the Plugins folder in the game directory.

    See below:

Image Alt Text:Plugin folderPlugin folder

Image Alt Text:Copied Arm ASR pluginCopied Arm ASR plugin

  1. Navigate back to your Unreal Engine project.

  2. When the pop-up window opens prompting you to build Arm ASR, select Yes.

    Image Alt Text:Arm ASR pop-up windowArm ASR pop-up window

Enable and configure Arm ASR

After reopening the Unreal Engine project, ensure that the Arm ASR plugin is enabled.

  1. Go to Edit > Plugins, search for Arm ASR, and make sure that it is checked.

    Image Alt Text:Verify the pluginVerify the plugin

    Image Alt Text:Plugin screenPlugin screen

  2. To enable Arm ASR upscaling, open Project Settings and set the Anti-Aliasing Method to Temporal Anti-Aliasing.

    Tip

    Mobile Anti-Aliasing Method is used for the mobile renderer, however this Learning Path uses the desktop renderer. For information about other available renderers, see the README.md in the accuracy-super-resolution-for-unreal repository.

    Image Alt Text:Change Anti-Aliasing MethodSet the Anti-Aliasing Method

  3. To verify that Arm ASR is enabled and active, use the ShowFlag.VisualizeTemporalUpscaler 1 console command.

    Tip

    The debug views produced by this command are generated by Unreal Engine’s TAA, not directly by Arm ASR.

If Arm ASR is active, you will see Arm ASR listed as the ThirdParty TemporalUpscaler in the console window.

Image Alt Text:Visualize console commandVisualize console command

  1. If Arm ASR is not shown here, use the r.ArmASR.Enable 1 console command to enable upscaling.

    Image Alt Text:Arm ASR.Enable 1 commandArmASR.Enable 1 command

Further Configuration Settings

You can configure Arm ASR further in two ways:

  1. Using the UI:
  • Go to Edit > Project Settings > Plugins > Arm ASR.

Image Alt Text:Configure settings using UIConfigure settings using UI

  1. Through the console:
  • Type r.ArmASR. into the console window to see configuration options.

Image Alt Text:Configuration optionsConfiguration options

For example, you can change the upscaling ratio by modifying the ScreenPercentage, through the command option r.ScreenPercentage. A value of 50.0 means frames are upscaled by a factor of 2.

You can configure Arm ASR’s behavior through the following plugin-specific console variables:

Console VariableDefault ValueValue RangeDetails
r.ArmASR.Enable10, 1Enable / disable Arm ASR.
r.ArmASR.AutoExposure00, 1Set to 1 to use Arm ASR’s own auto-exposure, otherwise the engine’s auto-exposure value is used.
r.ArmASR.Sharpness00-1If greater than 0 this enables Robust Contrast Adaptive Sharpening Filter to sharpen the output image.
r.ArmASR.ShaderQuality11, 2, 3Select shader quality preset: 1 - Quality, 2 - Balanced, 3 - Performance.
r.ArmASR.CreateReactiveMask10-1Create the reactive mask.
r.ArmASR.ReactiveMaskReflectionScale0.40-1Range from 0.0 to 1.0, scales the Unreal Engine reflection contribution to the reactive mask, which can be used to control the amount of aliasing on reflective surfaces.
r.ArmASR.ReactiveMaskRoughnessScale0.150-1Range from 0.0 to 1.0, scales the GBuffer roughness to provide a fallback value for the reactive mask when screenspace & planar reflections are disabled or don’t affect a pixel.
r.ArmASR.ReactiveMaskRoughnessBias0.250-1Range from 0.0 to 1.0, biases the reactive mask value when screenspace/planar reflections are weak with the GBuffer roughness to account for reflection environment captures.
r.ArmASR.ReactiveMaskRoughnessMaxDistance6000-Maximum distance in world units for using material roughness to contribute to the reactive mask, the maximum of this value and View.FurthestReflectionCaptureDistance will be used.
r.ArmASR.ReactiveMaskRoughnessForceMaxDistance0-Enable to force the maximum distance in world units for using material roughness to contribute to the reactive mask rather than using View.FurthestReflectionCaptureDistance.
r.ArmASR.ReactiveMaskReflectionLumaBias00-1Range from 0.0 to 1.0, biases the reactive mask by the luminance of the reflection. Use to balance aliasing against ghosting on brightly lit reflective surfaces.
r.ArmASR.ReactiveHistoryTranslucencyBias0.50-1Range from 0.0 to 1.0, scales how much translucency suppresses history via the reactive mask. Higher values will make translucent materials more reactive which can reduce smearing.
r.ArmASR.ReactiveHistoryTranslucencyLumaBias00-1Range from 0.0 to 1.0, biases how much the translucency suppresses history via the reactive mask by the luminance of the transparency. Higher values will make bright translucent materials more reactive which can reduce smearing.
r.ArmASR.ReactiveMaskTranslucencyBias10-1Range from 0.0 to 1.0, scales how much contribution translucency makes to the reactive mask. Higher values will make translucent materials more reactive which can reduce smearing.
r.ArmASR.ReactiveMaskTranslucencyLumaBias00-1Range from 0.0 to 1.0, biases the translucency contribution to the reactive mask by the luminance of the transparency. Higher values will make bright translucent materials more reactive which can reduce smearing.
r.ArmASR.ReactiveMaskTranslucencyMaxDistance500000-Maximum distance in world units for using translucency to contribute to the reactive mask. This is a way to remove sky-boxes and other back-planes from the reactive mask, at the expense of nearer translucency not being reactive.
r.ArmASR.ReactiveMaskForceReactiveMaterialValue00, 1Force the reactive mask value for Reactive Shading Model materials, when > 0 this value can be used to override the value supplied in the Material Graph.
r.ArmASR.ReactiveMaskReactiveShadingModelIDMSM_NUM-Treat the specified shading model as reactive, taking the CustomData0.x value as the reactive value to write into the mask.

Next steps

You are now ready to use Arm ASR in your Unreal Engine projects.

You can use Arm Performance Studio tools to measure the performance of your game as it runs on a mobile device, allowing you to monitor the effect of Arm ASR.

Back
Next