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

> Unreal Engine API Reference > Runtime > RHI > FDynamicRHI > RHIReadSurfaceData > FDynamicRHI::RHIReadSurfaceData

Light Theme

Dark Theme

FDynamicRHI::RHIReadSurfaceData

FlushType: Flush Immediate (seems wrong)

Windows

MacOS

Linux

Override Hierarchy

FDynamicRHI::RHIReadSurfaceData()

	FVulkanDynamicRHI::RHIReadSurfaceData()
	FOpenGLDynamicRHI::RHIReadSurfaceData()
	FNullDynamicRHI::RHIReadSurfaceData()

References

Module	RHI
Header	/Engine/Source/Runtime/RHI/Public/DynamicRHI.h
Include	#include "DynamicRHI.h"

Syntax

void RHIReadSurfaceData
(
    FRHITexture * Texture,
    FIntRect Rect,
    TArray< FColor > & OutData,
    FReadSurfaceDataFlags InFlags
)

Remarks

Reads the contents of a texture to an output buffer (non MSAA and MSAA) and returns it as a FColor array. If the format or texture type is unsupported the OutData array will be size 0

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

Take our survey

Dismiss