UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlateTextureRenderTarget2DResource Class Reference

#include <SlateTextures.h>

+ Inheritance diagram for FSlateTextureRenderTarget2DResource:

Public Member Functions

ENGINE_API FSlateTextureRenderTarget2DResource (const FLinearColor &InClearColor, int32 InTargetSizeX, int32 InTargetSizeY, uint8 InFormat, ESamplerFilter InFilter, TextureAddress InAddressX, TextureAddress InAddressY, float InTargetGamma)
 
virtual void SetSize (int32 InSizeX, int32 InSizeY)
 
virtual void ClampSize (int32 SizeX, int32 SizeY) override
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
virtual uint32 GetSizeX () const override
 
virtual uint32 GetSizeY () const override
 
virtual FIntPoint GetSizeXY () const override
 
virtual float GetDisplayGamma () const override
 
- Public Member Functions inherited from FTextureRenderTargetResource
 FTextureRenderTargetResource ()
 
virtual const FTextureRHIRefGetShaderResourceTexture () const override
 
virtual class FTextureRenderTarget2DResourceGetTextureRenderTarget2DResource ()
 
virtual class FTextureRenderTarget2DArrayResourceGetTextureRenderTarget2DArrayResource ()
 
virtual class FTextureRenderTargetVolumeResourceGetTextureRenderTargetVolumeResource ()
 
virtual class FTextureRenderTargetCubeResourceGetTextureRenderTargetCubeResource ()
 
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 FTexture2DResourceGetTexture2DResource ()
 
virtual FTexture3DResourceGetTexture3DResource ()
 
virtual FTexture2DArrayResourceGetTexture2DArrayResource ()
 
virtual FStreamableTextureResourceGetStreamableTextureResource ()
 
virtual FVirtualTexture2DResourceGetVirtualTexture2DResource ()
 
virtual const FTexture2DResourceGetTexture2DResource () const
 
virtual const FTexture3DResourceGetTexture3DResource () const
 
virtual const FTexture2DArrayResourceGetTexture2DArrayResource () const
 
virtual const FStreamableTextureResourceGetStreamableTextureResource () const
 
virtual const FVirtualTexture2DResourceGetVirtualTexture2DResource () const
 
int32 GetCurrentMipCount () const
 
bool IsTextureRHIPartiallyResident () const
 
FRHITextureGetTexture2DRHI () const
 
FRHITextureGetTexture3DRHI () const
 
FRHITextureGetTexture2DArrayRHI () const
 
void SetTextureReference (FRHITextureReference *TextureReference)
 
FRHITextureReferenceGetTextureReference () 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 FTextureoperator= (const FTexture &Other)
 
RENDERCORE_API FTextureoperator= (FTexture &&Other)
 
const FTextureRHIRefGetTextureRHI ()
 
virtual RENDERCORE_API uint32 GetSizeZ () const
 
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 FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
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 FTextureRHIRefGetRenderTargetTexture () const
 
virtual ENGINE_API FUnorderedAccessViewRHIRef GetRenderTargetUAV () const
 
virtual ENGINE_API FRDGTextureRef GetRenderTargetTexture (FRDGBuilder &GraphBuilder) const
 
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 ()
 

Protected Member Functions

virtual void UpdateDeferredResource (FRHICommandListImmediate &RHICmdList, bool bClearRenderTarget=true) override
 
- Protected Member Functions inherited from FTextureRenderTargetResource
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
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 }
 
- Static Public Member Functions inherited from FTextureRenderTargetResource
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 ()
 
- 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 FRHISamplerStateGetOrCreateSamplerState (const FSamplerStateInitializerRHI &Initializer)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 
- Protected Attributes inherited from FTextureResource
FTextureReferenceRHIRef TextureReferenceRHI
 
- Protected Attributes inherited from FRenderTarget
FTextureRHIRef RenderTargetTextureRHI
 

Constructor & Destructor Documentation

◆ FSlateTextureRenderTarget2DResource()

FSlateTextureRenderTarget2DResource::FSlateTextureRenderTarget2DResource ( const FLinearColor InClearColor,
int32  InTargetSizeX,
int32  InTargetSizeY,
uint8  InFormat,
ESamplerFilter  InFilter,
TextureAddress  InAddressX,
TextureAddress  InAddressY,
float  InTargetGamma 
)

Constructor

Member Function Documentation

◆ ClampSize()

void FSlateTextureRenderTarget2DResource::ClampSize ( int32  SizeX,
int32  SizeY 
)
overridevirtual

Reimplemented from FTextureRenderTargetResource.

◆ GetDisplayGamma()

float FSlateTextureRenderTarget2DResource::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 FTextureRenderTargetResource.

◆ GetSizeX()

uint32 FSlateTextureRenderTarget2DResource::GetSizeX ( ) const
overridevirtual

Returns the width of the texture in pixels.

Implements FTextureRenderTargetResource.

◆ GetSizeXY()

FIntPoint FSlateTextureRenderTarget2DResource::GetSizeXY ( ) const
overridevirtual

Implements FRenderTarget.

◆ GetSizeY()

uint32 FSlateTextureRenderTarget2DResource::GetSizeY ( ) const
overridevirtual

Returns the height of the texture in pixels.

Implements FTextureRenderTargetResource.

◆ InitRHI()

void FSlateTextureRenderTarget2DResource::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ ReleaseRHI()

void FSlateTextureRenderTarget2DResource::ReleaseRHI ( )
overridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FTexture.

◆ SetSize()

void FSlateTextureRenderTarget2DResource::SetSize ( int32  InSizeX,
int32  InSizeY 
)
virtual

Resizes the render target

◆ UpdateDeferredResource()

void FSlateTextureRenderTarget2DResource::UpdateDeferredResource ( FRHICommandListImmediate RHICmdList,
bool  bClearRenderTarget = true 
)
overrideprotectedvirtual

Updates (resolves) the render target texture. Optionally clears the contents of the render target to green. This is only called by the rendering thread.

Implements FDeferredUpdateResource.


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