Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > SlateCore > Rendering > FSlateRenderer

Light Theme

Dark Theme

FSlateRenderer

Abstract base class for Slate renderers.

Choose your operating system:

Windows

macOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Rendering/SlateRenderer.h
Include	#include "Rendering/SlateRenderer.h"

Syntax

class FSlateRenderer

Remarks

Abstract base class for Slate renderers.

Variables

	Name	Description
FOnBackBufferRe...	OnBackBufferReadyToPresentDelegate
FOnSlateWindowD...	OnSlateWindowDestroyedDelegate
FOnPostResizeWi...	PostResizeBackBufferDelegate
FOnPreResizeWin...	PreResizeBackBufferDelegate
FCriticalSectio...	ResourceCriticalSection	Necessary to grab before flushing the resource pool, as it may be being accessed by multiple threads when loading.
TSharedPtr< FSl...	SlateFontServices	The font services used by this renderer when drawing text
FOnSlateWindowR...	SlateWindowRendered	Callback that fires after Slate has rendered each window, each frame

Constructors

	Name	Description
	FSlateRenderer ( const TSharedRef< FSlateFontService... )	Constructor.

Destructors

	Name	Description
	~FSlateRenderer()	Virtual destructor.

Functions

	Name	Description
void	AddWidgetRendererUpdate ( const FRenderThreadUpdateContext& ..., bool bDeferredRenderTargetUpdate )	Lets the renderer know that we need to render some widgets to a render target.
bool	AreShadersInitialized()	Returns whether shaders that Slate depends on have been compiled.
void	BeginFrame()	Indicates the start of a new frame to the Renderer.
bool	CanRenderResource ( UObject& InResourceObject )	The default implementation assumes all things are renderable.
void	ClearScenes()	Reset the internal Scene tracking.
void	CopyWindowsToVirtualScreenBuffer ( const TArray< FString >& KeypressB... )	Copies all slate windows out to a buffer at half resolution with debug information like the mouse cursor and any keypresses.
FSlateUpdata...	CreateSharedHandleTexture ( void* SharedHandle )	Create an updatable texture that can receive new data via a shared handle
FSlateUpdata...	CreateUpdatableTexture ( uint32 Width, uint32 Height )	Create an updatable texture that can receive new data dynamically
void	CreateViewport ( const TSharedRef< SWindow > InWindo... )	Creates a rendering viewport
void	Destroy()
void	DestroyCachedFastPathElementData ( FSlateCachedElementData* Eleme... )
void	DestroyCachedFastPathRenderingData ( FSlateCachedFastPathRenderingData&... )
void	DrawWindows ( FSlateDrawBuffer& InWindowDrawBuff... )	Creates necessary resources to render a window and sends draw commands to the rendering thread
void	EndFrame()	Indicates the end of the current frame to the Renderer.
void	FlushCommands()	Gives the renderer a chance to wait for any render commands to be completed before returning/
void	FlushFontCache ( const FString& FlushReason )	Flushes all cached data from the font cache for the current thread
bool	GenerateDynamicImageResource ( FName ResourceName, uint32 Width, uint32 Height, const TArray< uint8 >& Bytes )	Creates a dynamic image resource
bool	GenerateDynamicImageResource ( FName ResourceName, FSlateTextureDataRef TextureData )
FIntPoint	GenerateDynamicImageResource ( const FName InTextureName )	Creates a dynamic image resource and returns its size
int32	GetCurrentSceneIndex()	Get the currently registered scene index (set by RegisterCurrentScene)
FSlateDrawBu...	GetDrawBuffer()	Returns a draw buffer that can be used by Slate windows to draw window elements
ISlateAtlasP...	GetFontAtlasProvider()	Returns the way to access the font atlas information for this renderer
TSharedRef< ...	GetFontCache()	Get the font cache to use for the current thread
TSharedRef< ...	GetFontMeasureService()	Get access to the font measure service (game thread only!)
TSharedRef< ...	GetFontServices()	Get access to the font services used by this renderer
FCriticalSec...	GetResourceCriticalSection()	Necessary to grab before flushing the resource pool, as it may be being accessed by multiple threads when loading.
FSlateResour...	GetResourceHandle ( const FSlateBrush& Brush )	Creates a handle to a Slate resource A handle is used as fast path for looking up a rendering resource for a given brush when adding Slate draw elements This can be cached and stored safely in code.
FSlateResour...	GetResourceHandle ( const FSlateBrush& Brush, FVector2D LocalSize, float DrawScale )	Creates a resource handle with a specific size and scale (for brushes with dynamic resizing such as vector art) A handle is used as fast path for looking up a rendering resource for a given brush when adding Slate draw elements This can be cached and stored safely in code.
EPixelFormat	GetSlateRecommendedColorFormat()
ISlateAtlasP...	GetTextureAtlasProvider()	Returns the way to access the texture atlas information for this renderer
void *	GetViewportResource ( const SWindow& Window )	Returns the viewport rendering resource (backbuffer) for the provided window
bool	HasLostDevice()
bool	Initialize()
void	InvalidateAllViewports()	Removes references to FViewportRHI's.
bool	IsViewportFullscreen ( const SWindow& Window )	Returns whether or not a viewport should be in fullscreen The window to check for fullscreen
void	LoadStyleResources ( const ISlateStyle& Style )	Loads all the resources used by the specified SlateStyle
void	MapVirtualScreenBuffer ( FMappedTextureBuffer* OutImage... )	Allows and disallows access to the crash tracker buffer data on the CPU
FOnBackBuffe...	OnBackBufferReadyToPresent()
FOnPostResiz...	OnPostResizeWindowBackBuffer()
FOnPreResize...	OnPreResizeWindowBackBuffer()
FOnSlateWind...	OnSlateWindowDestroyed()
FOnSlateWind...	OnSlateWindowRendered()
void	OnWindowDestroyed ( const TSharedRef< SWindow >& InWin... )	Called when a window is destroyed to give the renderer a chance to free resources
void	OnWindowFinishReshaped ( const TSharedPtr< SWindow >& InWin... )	Called when a window is finished being reshaped
void	PrepareToTakeScreenshot ( const FIntRect& Rect, TArray< FColor >* OutColorData, SWindow* InScreenshotWindow )	Prepares the renderer to take a screenshot of the UI.
int32	RegisterCurrentScene ( FSceneInterface* Scene )	Register the active scene pointer with the renderer.
void	ReleaseAccessedResources ( bool bImmediatelyFlush )	A renderer may need to keep a cache of accessed garbage collectible objects alive for the duration of their usage.
void	ReleaseDynamicResource ( const FSlateBrush& Brush )	Releases a specific resource.
void	ReleaseUpdatableTexture ( FSlateUpdatableTexture* Textur... )	Return an updatable texture to the renderer for release
void	ReloadTextureResources()	Reloads all texture resources from disk
void	RemoveDynamicBrushResource ( TSharedPtr< FSlateDynamicImageBrush... )	Queues a dynamic brush for removal when it is safe.
void	RequestResize ( const TSharedPtr< SWindow >& InWin..., uint32 NewSizeX, uint32 NewSizeY )	Requests that a rendering viewport be resized
void	RestoreSystemResolution ( const TSharedRef< SWindow > InWindo... )	Restore the given window to the resolution settings currently cached by the engine
void	SetColorVisionDeficiencyType ( EColorVisionDeficiency Type, int32 Severity, bool bCorrectDeficiency, bool bShowCorrectionWithDeficiency )	Sets which color vision filter to use
void	SetSystemResolution ( uint32 Width, uint32 Height )	Set the resolution cached by the engine
void	SetWindowRenderTarget ( const SWindow& Window, IViewportRenderTargetProvider*... )	Pushes the rendering of the specified window to the specified render target
void	Sync()	Gives the renderer a chance to synchronize with another thread in the event that the renderer runs in a multi-threaded environment.
void	UnmapVirtualScreenBuffer()
void	UpdateFullscreenState ( const TSharedRef< SWindow > InWindo..., uint32 OverrideResX, uint32 OverrideResY )	Sets fullscreen state on the window's rendering viewport

Typedefs

Name	Description
FOnBackBufferReadyToPresent	Callback on the render thread after slate rendering finishes and right before present is called
FOnPostResizeWindowBackbuffer	Called on the game thread right after a window backbuffer has been resized
FOnPreResizeWindowBackbuffer	Called on the game thread right before a window backbuffer is about to be resized
FOnSlateWindowDestroyed	Called on the game thread right before the slate window handle is destroyed.
FOnSlateWindowRendered	Callback that fires after Slate has rendered each window, each frame