DreamGUI
类参考

UDreamUICaptureLibrary

UDreamUICaptureLibrary

继承自 UBlueprintFunctionLibrary。

声明于 Public/DreamUICaptureLibrary.h。

将 DreamGUI 绘制的内容以 PNG 文件保存下来——无论是渲染目标、绘制到渲染目标中的画布,还是包含场景及其中所有面板的视口——这样 UI 就可以脱离绘制它的机器被查看:附加到错误报告中、在两个构建之间进行比较、由希望展示所见内容的自动化运行保存下来。

每次调用都会从 GPU 读回图像,因此会等待渲染线程完成已交给它的工作:这是一个用于查看的工具,而不是每帧都要执行的操作。在没有 GPU(-nullrhi)的情况下没有任何内容可读取;调用会在日志中说明这一点并返回 false。

控制台命令 DreamUI.Capture [Directory] 会为输入该命令所在的世界运行 CaptureAll。

函数

函数类型描述
TArray<FString> CaptureAll(UObject* InWorldContextObject, FString InDirectory)callable将 InWorldContextObject 的世界中所有可查看的内容保存到 InDirectory——当其为空时,会在捕获目录下新建一个带时间戳的目录:视口保存为 Viewport.png,每个绘制到目标中的根画布保存为 <its widget's name>.png。按该顺序返回写入的文件。
FString GetCaptureDirectory()pure/Saved/DreamUI/Captures,这些函数接收的相对路径以此为基准目录。
bool SaveCanvasToPng(UDreamCanvas* InCanvas, FString InFilePath)callable将 InCanvas 绘制的内容以 PNG 形式保存到 InFilePath:即绘制到渲染目标中的画布的目标。在屏幕或世界中绘制的画布没有自己的图像——它是视口图像的一部分,由 SaveViewportToPng 写入。
bool SaveRenderTargetToPng(UTextureRenderTarget2D* InTarget, FString InFilePath)callable将 InTarget 的像素以 PNG 形式保存到 InFilePath(当路径没有扩展名时会添加 .png)。目标的 alpha 会被保留,因此没有被绘制覆盖的部分在文件中保持透明。
bool SaveViewportToPng(UObject* InWorldContextObject, FString InFilePath)callable将 InWorldContextObject 的世界所显示在的视口——游戏的视口,或在编辑器中显示该世界的关卡视口——以 PNG 形式保存到 InFilePath:包含场景及其中所有面板,如同玩家所见。游戏的视口直接绘制到其窗口中,只有在绘制某一帧时才能读取,因此在游戏中此函数返回 false;在那里请使用引擎的截图请求来获取图像(HighResShot、FScreenshotRequest)。

本页目录