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

FRenderTarget::ReadPixels

Reads the viewport's displayed pixels into a preallocated color buffer.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/UnrealClient.h
Include	#include "UnrealClient.h"
Source	/Engine/Source/Runtime/Engine/Private/UnrealClient.cpp

Syntax

bool ReadPixels
(
    TArray< FColor > & OutImageData,
    FReadSurfaceDataFlags InFlags,
    FIntRect InRect
)

Remarks

Reads the viewport's displayed pixels into a preallocated color buffer. Reads the viewport's displayed pixels into a preallocated color buffer.

Returns

True if the read succeeded.

Parameters

Parameter	Description
OutImageData	RGBA8 values will be stored in this buffer
InRect	source rect of the image to capture
OutImageData	RGBA8 values will be stored in this buffer
TopLeftX	Top left X pixel to capture
TopLeftY	Top left Y pixel to capture
Width	Width of image in pixels to capture
Height	Height of image in pixels to capture

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

Take our survey

Dismiss