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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback