Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UnrealUSDWrapper::OpenStage

Opens a file as a root layer of an USD stage, and returns that stage.

Windows

MacOS

Linux

References

Module	UnrealUSDWrapper
Header	/Engine/Plugins/Importers/USDImporter/Source/UnrealUSDWrapper/Public/UnrealUSDWrapper.h
Include	#include "UnrealUSDWrapper.h"
Source	/Engine/Plugins/Importers/USDImporter/Source/UnrealUSDWrapper/Private/UnrealUSDWrapper.cpp

Syntax

static UE::FUsdStage OpenStage
(
    const TCHAR * Identifier,
    EUsdInitialLoadSet InitialLoadSet,
    bool bUseStageCache
)

Remarks

Opens a file as a root layer of an USD stage, and returns that stage.

Returns

The opened stage, which may be invalid.

Parameters

Parameter	Description
Identifier	Path to a file that the USD SDK can open (or the identifier of a root layer), which will become the root layer of the new stage
InitialLoadSet	How to handle USD payloads when opening this stage
bUseStageCache	If true, and the stage is already opened in the stage cache (or the layers are already loaded in the registry) then the file reading may be skipped, and the existing stage returned. When false, the stage and all its referenced layers will be re-read anew, and the stage will not be added to the stage cache.

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

Take our survey

Dismiss