UnrealEngine4 - 获取UE4最后的渲染缓存数据BackBuffer
1 获取UE4最后的渲染缓存的思路
1.1 从官方插件PixelStreaming中得到的思路
PixelStreaming是UE_4.21开始支持的一项技术，简单来说就是能够将游戏跑在服务器上，你可以通过浏览器来玩，玩家端不需要额外操作，只需要一个浏览器，所有的逻辑处理和渲染都在“云”端执行。它不仅仅只是一个插件(虽然有PixelStreamingPlugin这个插件，但它只是PixelStreaming实现中的一环)，其实现具有一套独立与UE游戏的设计和组织方式。
而其中PixelStreamingPlugin主要提供渲染帧与音频数据的捕获与编码，并创建一个链接将音频和渲染帧的数据传递给WebRTC服务器，使用的是UE的插件方式编写和使用。
所以从UE4的源码中仔细看了下PixelStreaming插件的源码，发现了在PixelStreamingModule.cpp中的InitStreamer函数中有以下的调用：
// subscribe to engine delegates here for init / framebuffer creation / whatever
if (FSlateApplication::IsInitialized())
{
FSlateApplication::Get().GetRenderer()->OnBackBufferReadyToPresent().AddRaw(this, &FPixelStreamingModule::OnBackBufferReady_RenderThread);
}
而OnBackBufferReadyToPresent的委托的注释是：
/** Callback on the render thread after slate rendering finishes and right before present is called */
/** 在渲染窗口渲染完成之后并且在渲染之前位于渲染线程的回调函数，其中第一个参数为渲染窗口对象，第二参数为渲染窗口对应的渲染帧数据 */
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnBackBufferReadyToPresent, SWindow&, const FTexture2DRHIRef&);
FOnBackBufferReadyToPresent& OnBackBufferReadyToPresent() { return OnBackBufferReadyToPresentDelegate; }
并且在注册的委托函数OnBackBufferReady_RenderThread(SWindow& SlateWindow, const FTexture2DRHIRef& BackBuffer)发现了读取BackBuffer并且发送的代码:
void FPixelStreamingModule::OnBackBufferReady_RenderThread(SWindow& SlateWindow, const FTexture2DRHIRef& BackBuffer)
{
// enable streaming explicitly by providing `PixelStreamingIP` and `PixelStreamingPort` cmd-args
if (!Streamer)
{
return;
}
check(IsInRenderingThread());
if (!bFrozen)
{
Streamer->OnFrameBufferReady(BackBuffer);
}
// Check to see if we have been instructed to capture the back buffer as a
// freeze frame.
if (bCaptureNextBackBufferAndStream)
{
bCaptureNextBackBufferAndStream = false;
// Read the data out of the back buffer and send as a JPEG.
FRHICommandListImmediate& RHICmdList = FRHICommandListExecutor::GetImmediateCommandList();
FIntRect Rect(0, 0, BackBuffer->GetSizeX(), BackBuffer->GetSizeY());
TArray<FColor> Data;
RHICmdList.ReadSurfaceData(BackBuffer, Rect, Data, FReadSurfaceDataFlags());
SendJpeg(MoveTemp(Data), Rect);
}
}
1.2 思路总结
从上述的思路中我们可以看出：PixelStream插件实现了从UE引擎底层抓取渲染帧数据并且发送到远程的Web服务器，而我们只要实现获取UE4最后的渲染帧数据就可以了，那么只要注册OnBackBufferReadyToPresent的委托即可！注意，因为是最后的渲染帧数据，那么自然而然的包含了渲染窗口绘制的信息，这些信息里面自然包括了UE4中UI的信息。
2 获取UE4最后的渲染缓存的步骤
2.1 新建插件
自行百度如何在UE4中新建插件。
2.2 在插件中新建UObject类：UEVideoRecordImpl
2.3 修改插件中的xxxx.Build.cs文件
在PrivateDependencyModuleNames.AddRange中加入以下模块：
"Renderer",
"RenderCore",
"RHI"
整个PrivateDependencyModuleNames.AddRange如下图所示：
2.4 类UEVideoRecordImpl的实现
2.4.1 声明类对象
在类中声明类对象 FDelegateHandle m_OnBackBufferReadyToPresent;
用于存储委托句柄。
2.4.2 声明私有类成员函数
在类中声明类成员函数 void OnBackBufferReady_RenderThread(SWindow& SlateWindow, const FTexture2DRHIRef& BackBuffer);
作为FSlateApplication::Get().GetRenderer()->OnBackBufferReadyToPresent()绑定的回调函数。
2.4.3 绑定获取BackBuffer数据的回调函数和解绑获取BackBuffer数据的回调函数
- 声明私有类成员函数BindBackbufferCallback，函数功能是注册获取BackBuffer数据的回调函数
BindBackbufferCallback函数实现如下：
void UUEVideoRecordImpl::BindBackbufferCallback()
{
if (FSlateApplication::IsInitialized())
{
m_OnBackBufferReadyToPresent.Reset();
m_OnBackBufferReadyToPresent = FSlateApplication::Get().GetRenderer()->OnBackBufferReadyToPresent().AddUObject(this, &UUEVideoRecordImpl::OnBackBufferReady_RenderThread);
}
}
- 声明私有类成员函数UnBindBackbufferCallback，函数功能是解绑获取BackBuffer数据的回调函数
UnBindBackbufferCallback函数实现如下：
void UUEVideoRecordImpl::UnBindBackbufferCallback()
{
if (m_OnBackBufferReadyToPresent.IsValid())
{
FSlateApplication::Get().GetRenderer()->OnBackBufferReadyToPresent().Remove(m_OnBackBufferReadyToPresent);
}
}
2.4.4 实现获取BackBuffer缓存数据回调函数：OnBackBufferReady_RenderThread
OnBackBufferReady_RenderThread的函数实现如下：
void UUEVideoRecordImpl::OnBackBufferReady_RenderThread(SWindow& SlateWindow, const FTexture2DRHIRef& BackBuffer)
{
FTexture2DRHIRef GameBuffer = BackBuffer;
FRHICommandListImmediate& RHICmdList = FRHICommandListExecutor::GetImmediateCommandList();
FIntRect Rect(0, 0, GameBuffer->GetSizeX(), GameBuffer->GetSizeY());
TArray<FColor> outData;
RHICmdList.ReadSurfaceData(GameBuffer, Rect, outData, FReadSurfaceDataFlags(RCM_UNorm));
// 其中outData为拿到的整个渲染场景的图像数据
// 一定要将进行这一步，不然图像数据可能会为全透明图像数据，这个坑我
// 踩过了，希望后来人不要踩了
for (FColor& color : outData)
{
color.A = 255;
}
}
如果有兴趣，可以访问我的个站：http://www.stubbornhuang.com