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

FTextureRenderTargetCubeResource::ReadPixels

Copy the texels of a single face of the cube into an array.

Windows

MacOS

Linux

References

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

Syntax

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

Remarks

Copy the texels of a single face of the cube into an array. Copy the texels of a single face of a cube texture into an array.

Returns

True if the read succeeded.

Parameters

Parameter	Description
OutImageData	float16 values will be stored in this array.
InFlags	read flags. ensure cubeface member has been set.
InRect	Rectangle of texels to copy.
OutImageData	float16 values will be stored in this array.
InFlags	read flags. ensure cubeface member has been set.
InRect	Rectangle of texels to copy. Empty InRect (0,0,0,0) defaults to the whole surface size.

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

Take our survey

Dismiss