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::ReadFloat16Pixels

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 ReadFloat16Pixels
(
FFloat16Color * OutImageBytes,
ECubeFace CubeFace
)

Remarks

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

Returns

True if the read succeeded.

Parameters

Parameter	Description
OutImageBytes	RGBA16F values will be stored in this buffer. Buffer must be preallocated with the correct size!
CubeFace	optional cube face for when reading from a cube render target

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

Take our survey

Dismiss