1. Epic GamesDeveloper
  3. FSlateRenderer

FSlateRenderer

Abstract base class for Slate renderers.

Unreal Engine C++ API Reference > Runtime > SlateCore > Rendering

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

  Type Name Description
Protected variable FOnBackBufferReadyToPresent OnBackBufferReadyToPresentDelegate  
Protected variable FOnSlateWindowDestroyed OnSlateWindowDestroyedDelegate  
Protected variable FOnPostResizeWindowBackbuffer PostResizeBackBufferDelegate  
Protected variable FOnPreResizeWindowBackbuffer PreResizeBackBufferDelegate  
Protected variable FCriticalSection ResourceCriticalSection Necessary to grab before flushing the resource pool, as it may be being accessed by multiple threads when loading.
Protected variable TSharedPtr< FSlateFontServices > SlateFontServices The font services used by this renderer when drawing text
Protected variable FOnSlateWindowRendered SlateWindowRendered Callback that fires after Slate has rendered each window, each frame

Constructors

  Type Name Description
Public function  

FSlateRenderer ( const TSharedRef< FSlateFontServices >& InSlateFontServices
)

 Constructor.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor.

Functions

  Type Name Description
Public function FSlateDrawBuffer & Returns a draw buffer that can be used by Slate windows to draw window elements
Public function Virtual void

AddWidgetRendererUpdate ( const FRenderThreadUpdateContext& Context,
bool bDeferredRenderTargetUpdate
)

 Lets the renderer know that we need to render some widgets to a render target.
Public function Virtual Const bool Returns whether shaders that Slate depends on have been compiled.
Public function Virtual Const void Indicates the start of a new frame to the Renderer.
Public function Virtual Const bool

CanRenderResource ( UObject& InResourceObject
)

 The default implementation assumes all things are renderable.
Public function void Reset the internal Scene tracking.
Public function Virtual void

CopyWindowsToVirtualScreenBuffer ( const TArray< FString >& KeypressBuffer
)

 Copies all slate windows out to a buffer at half resolution with debug information like the mouse cursor and any keypresses.
Public function FSlateUpdatableTexture *

CreateSharedHandleTexture ( void* SharedHandle
)

 Create an updatable texture that can receive new data via a shared handle
Public function FSlateUpdatableTexture *

CreateUpdatableTexture ( uint32 Width,
uint32 Height
)

 Create an updatable texture that can receive new data dynamically
Public function void

CreateViewport ( const TSharedRef< SWindow > InWindow
)

 Creates a rendering viewport
Public function void

Destroy ()

  
Public function Virtual void  
Public function Virtual void  
Public function void

DrawWindows ( FSlateDrawBuffer& InWindowDrawBuffer
)

 Creates necessary resources to render a window and sends draw commands to the rendering thread
Public function Virtual Const void Indicates the end of the current frame to the Renderer.
Public function Virtual Const void Gives the renderer a chance to wait for any render commands to be completed before returning/
Public function void

FlushFontCache ( const FString& FlushReason
)

 Flushes all cached data from the font cache for the current thread
Public function Virtual bool

GenerateDynamicImageResource ( FName ResourceName,
uint32 Width,
uint32 Height,
const TArray< uint8 >& Bytes
)

 Creates a dynamic image resource
Public function Virtual bool

GenerateDynamicImageResource ( FName ResourceName,
FSlateTextureDataRef TextureData
)

  
Public function Virtual FIntPoint

GenerateDynamicImageResource ( const FName InTextureName
)

 Creates a dynamic image resource and returns its size
Public function Const int32 Get the currently registered scene index (set by RegisterCurrentScene)
Public function Virtual ISlateAtlasProvider * Returns the way to access the font atlas information for this renderer
Public function Const TSharedRef< class FSlateFontCache > Get the font cache to use for the current thread
Public function Const TSharedRef< class FSlateFontMeasure > Get access to the font measure service (game thread only!)
Public function Const TSharedRef< FSlateFontServices > Get access to the font services used by this renderer
Public function FCriticalSection * Necessary to grab before flushing the resource pool, as it may be being accessed by multiple threads when loading.
Public function Virtual FSlateResourceHandle

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.
Public function FSlateResourceHandle

GetResourceHandle ( const FSlateBrush& Brush,
FVector2f LocalSize,
float DrawScale
)

  
Public function Virtual EPixelFormat  
Public function Virtual ISlateAtlasProvider * Returns the way to access the texture atlas information for this renderer
Public function Virtual void *

GetViewportResource ( const SWindow& Window
)

 Returns the viewport rendering resource (backbuffer) for the provided window
Public function Virtual Const bool  
Public function bool  
Public function Virtual void Removes references to FViewportRHI's.
Public function Const bool

IsViewportFullscreen ( const SWindow& Window
)

 Returns whether or not a viewport should be in fullscreenThe window to check for fullscreen
Public function Virtual void

LoadStyleResources ( const ISlateStyle& Style
)

 Loads all the resources used by the specified SlateStyle
Public function Virtual void Allows and disallows access to the crash tracker buffer data on the CPU
Public function FOnBackBufferReadyToPresent &  
Public function FOnPostResizeWindowBackbuffer &  
Public function FOnPreResizeWindowBackbuffer &  
Public function FOnSlateWindowDestroyed &  
Public function FOnSlateWindowRendered &  
Public function Virtual void

OnVirtualDesktopSizeChanged ( const FDisplayMetrics& NewDisplayMetric
)

  
Public function void

OnWindowDestroyed ( const TSharedRef< SWindow >& InWindow
)

 Called when a window is destroyed to give the renderer a chance to free resources
Public function Virtual void

OnWindowFinishReshaped ( const TSharedPtr< SWindow >& InWindow
)

 Called when a window is finished being reshaped
Public function Virtual void

PrepareToTakeHDRScreenshot ( const FIntRect& Rect,
TArray< FLinearColor >* OutColorData,
SWindow* InScreenshotWindow
)

 Prepares the renderer to take a screenshot of the UI.
Public function Virtual void

PrepareToTakeScreenshot ( const FIntRect& Rect,
TArray< FColor >* OutColorData,
SWindow* InScreenshotWindow
)

 Prepares the renderer to take a screenshot of the UI.
Public function int32 Register the active scene pointer with the renderer.
Public function Virtual void

ReleaseAccessedResources ( bool bImmediatelyFlush
)

 A renderer may need to keep a cache of accessed garbage collectible objects alive for the duration of their usage.
Public function void

ReleaseDrawBuffer ( FSlateDrawBuffer& InWindowDrawBuffer
)

 Return the previously acquired buffer.
Public function void Releases a specific resource.
Public function void Return an updatable texture to the renderer for release
Public function Virtual void Reloads all texture resources from disk
Public function void Queues a dynamic brush for removal when it is safe.
Public function void

RequestResize ( const TSharedPtr< SWindow >& InWindow,
uint32 NewSizeX,
uint32 NewSizeY
)

 Requests that a rendering viewport be resized
Public function void Restore the given window to the resolution settings currently cached by the engine
Public function Virtual void

SetColorVisionDeficiencyType ( EColorVisionDeficiency Type,
int32 Severity,
bool bCorrectDeficiency,
bool bShowCorrectionWithDeficiency
)

 Sets which color vision filter to use
Public function void

SetSystemResolution ( uint32 Width,
uint32 Height
)

 Set the resolution cached by the engine
Public function Virtual void Pushes the rendering of the specified window to the specified render target
Public function Virtual Const void

Sync ()

 Gives the renderer a chance to synchronize with another thread in the event that the renderer runs in a multi-threaded environment.
Public function Virtual void  
Public function void

UpdateFullscreenState ( const TSharedRef< SWindow > InWindow,
uint32 OverrideResX,
uint32 OverrideResY
)

 Sets fullscreen state on the window's rendering viewport

Classes

  Type Name Description
Public struct FScopedAcquireDrawBuffer Acquire the draw buffer and release it at the end of the scope.  

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

Deprecated Functions

  Type Name Description
Public function Virtual FSlateDrawBuffer & Use FSlateRenderer::AcquireDrawBuffer instead and release the draw buffer.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page