FRenderTarget

A render target.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/UnrealClient.h

Include

#include "UnrealClient.h"

Syntax

class FRenderTarget

Remarks

A render target.

Variables

Name Description

Protected variable

FTexture2DRHIRe...

 

RenderTargetTextureRHI

Destructors

Name Description

Public function Virtual

~FRenderTarget()

Destructor.

Functions

Name Description

Public function Virtual Const

float

 

GetDisplayGamma()

Public function Virtual Const

FRHIGPUMask

 

GetGPUMask

(
    FRHICommandListImmediate& RHICmdLi...
)

Returns the GPU nodes on which to render this rendertarget.

Public function Virtual Const

const FTextu...

 

GetRenderTargetTexture()

Accessor for the surface RHI when setting this render target

Public function Virtual Const

FUnorderedAc...

 

GetRenderTargetUAV()

Public function Const

FIntPoint

 

GetSizeXY()

Properties.

Public function Virtual

bool

 

HasToggleFreezeCommand()

Returns if there is a command to toggle freezerendering

Public function Virtual

void

 

ProcessToggleFreezeCommand()

Handles freezing/unfreezing of rendering

Public function

bool

 

ReadFloat16Pixels

(
    TArray< FFloat16Color >& OutputBuf...,
    ECubeFace CubeFace
)

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

Protected function

bool

 

ReadFloat16Pixels

(
    FFloat16Color* OutImageBytes,
    ECubeFace CubeFace
)

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

Public function

bool

 

ReadLinearColorPixels

(
    TArray< FLinearColor >& OutputBuff...,
    FReadSurfaceDataFlags InFlags,
    FIntRect InRect
)

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

Public function

bool

 

ReadLinearColorPixelsPtr

(
    FLinearColor* OutImageBytes,
    FReadSurfaceDataFlags InFlags,
    FIntRect InRect
)

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

Public function

bool

 

ReadPixels

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

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

Public function

bool

 

ReadPixelsPtr

(
    FColor* OutImageBytes,
    FReadSurfaceDataFlags InFlags,
    FIntRect InSrcRect
)

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

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