FTextureRenderTargetResource Class Reference

#include <TextureResource.h>

Inheritance diagram for FTextureRenderTargetResource:

Public Member Functions
	FTextureRenderTargetResource ()
virtual const FTextureRHIRef &	GetShaderResourceTexture () const override
virtual class FTextureRenderTarget2DResource *	GetTextureRenderTarget2DResource ()
virtual class FTextureRenderTarget2DArrayResource *	GetTextureRenderTarget2DArrayResource ()
virtual class FTextureRenderTargetVolumeResource *	GetTextureRenderTargetVolumeResource ()
virtual class FTextureRenderTargetCubeResource *	GetTextureRenderTargetCubeResource ()
virtual void	ClampSize (int32 SizeX, int32 SizeY)
virtual uint32	GetSizeX () const override=0
virtual uint32	GetSizeY () const override=0
virtual float	GetDisplayGamma () const override
virtual FRHIGPUMask	GetGPUMask (FRHICommandListImmediate &RHICmdList) const final override
void	SetActiveGPUMask (FRHIGPUMask InGPUMask)
Public Member Functions inherited from FTextureResource
	FTextureResource ()
virtual	~FTextureResource ()
virtual bool	IsProxy () const
virtual FTexture2DResource *	GetTexture2DResource ()
virtual FTexture3DResource *	GetTexture3DResource ()
virtual FTexture2DArrayResource *	GetTexture2DArrayResource ()
virtual FStreamableTextureResource *	GetStreamableTextureResource ()
virtual FVirtualTexture2DResource *	GetVirtualTexture2DResource ()
virtual const FTexture2DResource *	GetTexture2DResource () const
virtual const FTexture3DResource *	GetTexture3DResource () const
virtual const FTexture2DArrayResource *	GetTexture2DArrayResource () const
virtual const FStreamableTextureResource *	GetStreamableTextureResource () const
virtual const FVirtualTexture2DResource *	GetVirtualTexture2DResource () const
int32	GetCurrentMipCount () const
bool	IsTextureRHIPartiallyResident () const
FRHITexture *	GetTexture2DRHI () const
FRHITexture *	GetTexture3DRHI () const
FRHITexture *	GetTexture2DArrayRHI () const
void	SetTextureReference (FRHITextureReference *TextureReference)
FRHITextureReference *	GetTextureReference () const
Public Member Functions inherited from FTexture
RENDERCORE_API	FTexture ()
virtual RENDERCORE_API	~FTexture ()
RENDERCORE_API	FTexture (const FTexture &)
RENDERCORE_API	FTexture (FTexture &&)
RENDERCORE_API FTexture &	operator= (const FTexture &Other)
RENDERCORE_API FTexture &	operator= (FTexture &&Other)
const FTextureRHIRef &	GetTextureRHI ()
virtual RENDERCORE_API uint32	GetSizeZ () const
virtual RENDERCORE_API void	ReleaseRHI () override
virtual RENDERCORE_API FString	GetFriendlyName () const override
Public Member Functions inherited from FRenderResource
RENDERCORE_API	FRenderResource ()
RENDERCORE_API	FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
RENDERCORE_API	FRenderResource (const FRenderResource &)
RENDERCORE_API	FRenderResource (FRenderResource &&)
RENDERCORE_API FRenderResource &	operator= (const FRenderResource &Other)
RENDERCORE_API FRenderResource &	operator= (FRenderResource &&Other)
virtual RENDERCORE_API	~FRenderResource ()
virtual void	InitRHI (FRHICommandListBase &RHICmdList)
virtual RENDERCORE_API void	InitResource (FRHICommandListBase &RHICmdList)
virtual RENDERCORE_API void	ReleaseResource ()
RENDERCORE_API void	UpdateRHI (FRHICommandListBase &RHICmdList)
bool	IsInitialized () const
int32	GetListIndex () const
EInitPhase	GetInitPhase () const
void	SetOwnerName (FName InOwnerName)
FName	GetOwnerName () const
void	SetResourceName (FName InResourceName)
FName	GetResourceName () const
Public Member Functions inherited from FRenderTarget
ENGINE_API	FRenderTarget ()
virtual ENGINE_API	~FRenderTarget ()
virtual ENGINE_API const FTextureRHIRef &	GetRenderTargetTexture () const
virtual ENGINE_API FUnorderedAccessViewRHIRef	GetRenderTargetUAV () const
virtual ENGINE_API FRDGTextureRef	GetRenderTargetTexture (FRDGBuilder &GraphBuilder) const
virtual FIntPoint	GetSizeXY () const =0
virtual EDisplayColorGamut	GetDisplayColorGamut () const
virtual EDisplayOutputFormat	GetDisplayOutputFormat () const
virtual bool	GetSceneHDREnabled () const
virtual void	ProcessToggleFreezeCommand ()
virtual bool	HasToggleFreezeCommand ()
virtual ENGINE_API bool	ReadPixels (TArray< FColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadPixelsPtr (FColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, ECubeFace CubeFace)
virtual ENGINE_API bool	ReadFloat16Pixels (TArray< FFloat16Color > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_UNorm, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
virtual ENGINE_API bool	ReadLinearColorPixels (TArray< FLinearColor > &OutImageData, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
ENGINE_API bool	ReadLinearColorPixelsPtr (FLinearColor *OutImageBytes, FReadSurfaceDataFlags InFlags=FReadSurfaceDataFlags(RCM_MinMax, CubeFace_MAX), FIntRect InSrcRect=FIntRect(0, 0, 0, 0))
Public Member Functions inherited from FDeferredUpdateResource
	FDeferredUpdateResource ()
ENGINE_API void	FlushDeferredResourceUpdate (FRHICommandListImmediate &RHICmdList)
ENGINE_API void	ResetSceneTextureExtentsHistory ()

Static Public Member Functions
static ENGINE_API bool	IsSupportedFormat (EPixelFormat Format)
Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void	ReleaseRHIForAllResources ()
static RENDERCORE_API void	InitPreRHIResources ()
static RENDERCORE_API void	ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
static RENDERCORE_API FName	SetScopeName (FName Name)
Static Public Member Functions inherited from FRenderTarget
static float	GetEngineDisplayGamma ()
Static Public Member Functions inherited from FDeferredUpdateResource
static ENGINE_API void	UpdateResources (FRHICommandListImmediate &RHICmdList)
static void	ResetNeedsUpdate ()
static bool	IsUpdateNeeded ()

Protected Member Functions
void	SetGPUMask (FRHIGPUMask InGPUMask)
Protected Member Functions inherited from FRenderResource
void	SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
const FStaticFeatureLevel	GetFeatureLevel () const
bool	HasValidFeatureLevel () const
template<typename T >
FBufferRHIRef	CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
void	SetInitPhase (EInitPhase InInitPhase)
Protected Member Functions inherited from FDeferredUpdateResource
virtual void	UpdateDeferredResource (FRHICommandListImmediate &RHICmdList, bool bClearRenderTarget=true)=0
ENGINE_API void	AddToDeferredUpdateList (bool OnlyUpdateOnce)
ENGINE_API void	RemoveFromDeferredUpdateList ()

Additional Inherited Members
Public Types inherited from FRenderResource
enum class	EInitPhase : uint8 { Pre , Default , MAX }
Public Attributes inherited from FTexture
FTextureRHIRef	TextureRHI
FSamplerStateRHIRef	SamplerStateRHI
FSamplerStateRHIRef	DeferredPassSamplerStateRHI
double	LastRenderTime = -FLT_MAX
FMipBiasFade	MipBiasFade
bool	bGreyScaleFormat = false
bool	bIgnoreGammaConversions = false
bool	bSRGB = false
Public Attributes inherited from FRenderResource
ERenderResourceState	ResourceState = ERenderResourceState::Default
Static Protected Member Functions inherited from FTexture
static RENDERCORE_API FRHISamplerState *	GetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBase &	GetImmediateCommandList ()
Protected Attributes inherited from FTextureResource
FTextureReferenceRHIRef	TextureReferenceRHI
Protected Attributes inherited from FRenderTarget
FTextureRHIRef	RenderTargetTextureRHI

Detailed Description

FTextureResource type for render target textures.

Constructor & Destructor Documentation

FTextureRenderTargetResource()

FTextureRenderTargetResource::FTextureRenderTargetResource ( )

inline

Constructor, initializing ClearLink.

Member Function Documentation

ClampSize()

virtual void FTextureRenderTargetResource::ClampSize ( int32  SizeX, int32  SizeY  )

inlinevirtual

Reimplemented in FSlateTextureRenderTarget2DResource, and FTextureRenderTarget2DResource.

GetDisplayGamma()

float FTextureRenderTargetResource::GetDisplayGamma ( ) const

overridevirtual

Render target resource should be sampled in linear color space

Returns

display gamma expected for rendering to this render target

Reimplemented from FRenderTarget.

Reimplemented in FSlateTextureRenderTarget2DResource, FTextureRenderTarget2DArrayResource, FTextureRenderTargetVolumeResource, FTextureRenderTarget2DResource, and FTextureRenderTargetCubeResource.

GetGPUMask()

virtual FRHIGPUMask FTextureRenderTargetResource::GetGPUMask ( FRHICommandListImmediate &  RHICmdList ) const

inlinefinaloverridevirtual

Returns the GPU nodes on which to render this render target.

Reimplemented from FRenderTarget.

GetShaderResourceTexture()

const FTextureRHIRef & FTextureRenderTargetResource::GetShaderResourceTexture ( ) const

overridevirtual

Accessor for the surface RHI to use when reading the reading target (may differ from GetRenderTargetTexture() for some implementations like cubemaps)

Returns

surface RHI resource

Reimplemented from FRenderTarget.

GetSizeX()

virtual uint32 FTextureRenderTargetResource::GetSizeX ( ) const

overridepure virtual

Returns the width of the texture in pixels.

Reimplemented from FTexture.

Implemented in FSlateTextureRenderTarget2DResource, FTextureRenderTarget2DArrayResource, FTextureRenderTargetVolumeResource, FTextureRenderTarget2DResource, and FTextureRenderTargetCubeResource.

GetSizeY()

virtual uint32 FTextureRenderTargetResource::GetSizeY ( ) const

overridepure virtual

Returns the height of the texture in pixels.

Reimplemented from FTexture.

Implemented in FSlateTextureRenderTarget2DResource, FTextureRenderTarget2DArrayResource, FTextureRenderTargetVolumeResource, FTextureRenderTarget2DResource, and FTextureRenderTargetCubeResource.

GetTextureRenderTarget2DArrayResource()

virtual class FTextureRenderTarget2DArrayResource * FTextureRenderTargetResource::GetTextureRenderTarget2DArrayResource ( )

inlinevirtual

Reimplemented in FTextureRenderTarget2DArrayResource.

GetTextureRenderTarget2DResource()

virtual class FTextureRenderTarget2DResource * FTextureRenderTargetResource::GetTextureRenderTarget2DResource ( )

inlinevirtual

Reimplemented in FTextureRenderTarget2DResource.

GetTextureRenderTargetCubeResource()

virtual class FTextureRenderTargetCubeResource * FTextureRenderTargetResource::GetTextureRenderTargetCubeResource ( )

inlinevirtual

Reimplemented in FTextureRenderTargetCubeResource.

GetTextureRenderTargetVolumeResource()

virtual class FTextureRenderTargetVolumeResource * FTextureRenderTargetResource::GetTextureRenderTargetVolumeResource ( )

inlinevirtual

Reimplemented in FTextureRenderTargetVolumeResource.

IsSupportedFormat()

bool FTextureRenderTargetResource::IsSupportedFormat ( EPixelFormat  Format )

static

Return true if a render target of the given format is allowed for creation

SetActiveGPUMask()

void FTextureRenderTargetResource::SetActiveGPUMask ( FRHIGPUMask  InGPUMask )

inline

SetGPUMask()

void FTextureRenderTargetResource::SetGPUMask ( FRHIGPUMask  InGPUMask )

inlineprotected

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/TextureResource.h
• Engine/Source/Runtime/Engine/Private/TextureRenderTarget.cpp