Unreal Engine 5 Documentation has been moved to the Epic Developer Community

Gathering PSO Data

Taking a look at how to gather the PSO data from a compiled UE4 project.

Choose your operating system:

Windows

macOS

Linux

Part of the data that is used for Pipeline State Object (PSO) caching has to be generated while the project is running on one of its target devices. In the following How-To, we will take a look at how you can use Device Profiles and the Project Launcher to create and deploy a version of your Unreal Engine 4 (UE4) project that will enable PSO data to be generated and captured.

Steps

  1. From the Main Toolbar , click the white arrow icon next to Launch , then select Project Launcher .

    Open_UE4_Project_Launcher.png

    Click for full image.

  2. In the Project Launcher, locate the Custom Launch Profiles section and press the plus sign icon to add a new Custom Launch Profile .

    Create_New_Custom_Launch_Profile.png

    Click for full image.

    You can rename the profile by double-clicking on the existing profile name and inputting the name you want in the box.

  3. In the Project section, click on the Project dropdown and select the project that you want this profile to be associated with. Since we are using ActionRPG to demonstrate this workflow, the Project is set to ActionRPG .

    Project_Launcher_Used_Project.png

    Click for full image.

  4. Under the Cook section, set the How would you like to cook the content option, to By the Book .

    Project_Launcher_Cook_Type.png

    Click for full image.

    For more information on what the various cooking options do, check out the Build Operations: Cook, Package, Deploy, and Run documentation pages.

  5. In the Cooked Platforms section, you can select which platform and texture formats this profile should use. Since we are using ActionRPG to demonstrate this workflow, make sure that Android and Android_ETC1 are checked.

    Project_Launcher_Cooked_Platforms.png

    Click for full image.

  6. In the Cooked Maps section, make sure that Show All is selected and then select all of the maps you want this profile to be associated with. Since we are using ActionRPG to demonstrate this workflow, make sure that all available maps have a checkmark next to them.

    Project_Launcher_Cooked_Maps.png

    Click for full image.

  7. Under the Launch section, set the Initial Map to a level that is used when your project loads. Since we are using ActionRPG to demonstrate this workflow, the Initial Map is set to ActionRPG_Main which is the Level that has the starting UI screen in it.

    Project_Launcher_Go_Back.png

    Click for full image.

  8. Then, under Additional Command Line Parameters , input -logPSO to make sure that PSO logging is enabled when the project is run.

    If your project keeps crashing when trying to collect the PSO data, add -NoVerifyGC to the command line to disable garbage collection.

    Project_Launcher_AdditionalCommandLineParams.png

    Click for full image.

  9. Press the Back button on the top right of the Project Launcher to go back to the Custom Launch Profiles menu.

    Project_Launcher_Go_Back.png

    Click for full image.

  10. From the Custom Launch Profiles section, press the Launch this Profile button to start the cooking and deployment process.

    Project_Launcher_Start_Cook_And_Deploy.png

    Click for full image.

    Before pressing the Launch this Profile button, make sure that you have your target device setup and connected to your development PC as this process will not only build and cook your project, it will also deploy and start it.

  11. Once you have started the cooking and deployment process, the following window will be displayed that will show the progress of the build and any error should they occur.

    Project_Launcher_Completed.png

    Click for full image.

    You will know the process was successful when the Output Log says BUILD SUCCESSFUL .

  12. Once the build is completed and deployed to your target device, you will then need to play through all of your project's available Levels. The goal is to try to load every single piece of content that is used in the game so that the Shaders that the Materials use are captured.

    You will want to repeat this process a few times to make sure that all of the used content is loaded.

  13. After you have played through your project a few times, you can retrieve the rec.upipelinecache file. You can find this file by going to the following location on your target device: UE4Game\NameOfProject\NameOfProject\Saved\CollectedPSOs

    PSO_FIle_On_Device.png

    Click for full image.

    If you do not see a Saved or CollectedPSOs folder, you will need to create both folders manually on your target device and then re-run through the content in your project so that the correct files are generated.

End Results

With the needed PSO data now generated, next we will need to combine all of the various rec.upipelinecache files that were generated into a single PSO cache that can then be used when your UE4 project is built.

For more information about how to build a PSO Cache, check out the Building the PSO Cache How-To .

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss