UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FSlateCanvasRenderTarget Class Reference
+ Inheritance diagram for FSlateCanvasRenderTarget:

Public Member Functions

virtual FIntPoint GetSizeXY () const
 
void SetRenderTargetTexture (FRDGTexture *InRDGTexture)
 
void ClearRenderTargetTexture ()
 
const FTextureRHIRef & GetRenderTargetTexture () const override
 
FRDGTextureRef GetRenderTargetTexture (FRDGBuilder &) const override
 
void SetViewRect (const FIntRect &InViewRect)
 
const FIntRect & GetViewRect () const
 
- Public Member Functions inherited from FRenderTarget
ENGINE_API FRenderTarget ()
 
virtual ENGINE_API ~FRenderTarget ()
 
virtual ENGINE_API FUnorderedAccessViewRHIRef GetRenderTargetUAV () const
 
virtual ENGINE_API const FTextureRHIRef & GetShaderResourceTexture () const
 
virtual ENGINE_API float GetDisplayGamma () 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))
 
virtual FRHIGPUMask GetGPUMask (FRHICommandListImmediate &RHICmdList) const
 

Additional Inherited Members

- Static Public Member Functions inherited from FRenderTarget
static float GetEngineDisplayGamma ()
 
- Protected Attributes inherited from FRenderTarget
FTextureRHIRef RenderTargetTextureRHI
 

Detailed Description

Simple representation of the backbuffer that the debug canvas renders to This class may only be accessed from the render thread

Member Function Documentation

◆ ClearRenderTargetTexture()

void FSlateCanvasRenderTarget::ClearRenderTargetTexture ( )
inline

Clears the render target texture

◆ GetRenderTargetTexture() [1/2]

const FTextureRHIRef & FSlateCanvasRenderTarget::GetRenderTargetTexture ( ) const
inlineoverridevirtual

Accessor for the surface RHI when setting this render target

Returns
render target surface RHI resource

Reimplemented from FRenderTarget.

◆ GetRenderTargetTexture() [2/2]

FRDGTextureRef FSlateCanvasRenderTarget::GetRenderTargetTexture ( FRDGBuilder &  GraphBuilder) const
inlineoverridevirtual

Returns a valid RDG texture for this render target.

Reimplemented from FRenderTarget.

◆ GetSizeXY()

virtual FIntPoint FSlateCanvasRenderTarget::GetSizeXY ( ) const
inlinevirtual

FRenderTarget interface

Implements FRenderTarget.

◆ GetViewRect()

const FIntRect & FSlateCanvasRenderTarget::GetViewRect ( ) const
inline

Gets the viewport rect for the render target

◆ SetRenderTargetTexture()

void FSlateCanvasRenderTarget::SetRenderTargetTexture ( FRDGTexture *  InRDGTexture)
inline

Sets the texture that this target renders to

◆ SetViewRect()

void FSlateCanvasRenderTarget::SetViewRect ( const FIntRect &  InViewRect)
inline
The documentation for this class was generated from the following file: