FRenderTarget::ReadLinearColorPixels

Reads the viewport's displayed pixels into the given 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 ReadLinearColorPixels
(
    TArray< FLinearColor > & OutputBuffer,
    FReadSurfaceDataFlags InFlags,
    FIntRect InRect
)

Remarks

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

Returns

True if the read succeeded.

Parameters

Parameter

Description

OutputBuffer

Linear color array to store the value

CubeFace

optional cube face for when reading from a cube render target

OutImageData

LinearColor array to fill!

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