Navigation
API > API/Runtime > API/Runtime/SlateCore
Implements a draw buffer for Slate.
| Name | FSlateDrawBuffer |
| Type | class |
| Header File | /Engine/Source/Runtime/SlateCore/Public/Rendering/SlateDrawBuffer.h |
| Include Path | #include "Rendering/SlateDrawBuffer.h" |
Syntax
class FSlateDrawBuffer : public FGCObject
Inheritance Hierarchy
- FGCObject → FSlateDrawBuffer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateDrawBuffer() |
Default constructor. | Rendering/SlateDrawBuffer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSlateDrawBuffer() |
Rendering/SlateDrawBuffer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ViewOffset | FDeprecateSlateVector2D | Rendering/SlateDrawBuffer.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsLocked | std::atomic< bool > | Rendering/SlateDrawBuffer.h | ||
| bIsLockedBySlateThread | bool | Rendering/SlateDrawBuffer.h | ||
| GCLock | FCriticalSection | Rendering/SlateDrawBuffer.h | ||
| ResourceVersion | uint32 | Last recorded version from the render. The WindowElementListsPool is emptied when this changes. | Rendering/SlateDrawBuffer.h | |
| WindowElementLists | TArray< TSharedRef< FSlateWindowElementList > > | List of window element lists. | Rendering/SlateDrawBuffer.h | |
| WindowElementListsPool | TArray< TSharedRef< FSlateWindowElementList > > | List of window element lists that we store from the previous frame that we restore if they're requested again. | Rendering/SlateDrawBuffer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateWindowElementList & AddWindowElementList
(
TSharedRef< SWindow > ForWindow |
Creates a new FSlateWindowElementList and returns a reference to it so it can have draw elements added to it | Rendering/SlateDrawBuffer.h | |
void ClearBuffer() |
Removes all data from the buffer. | Rendering/SlateDrawBuffer.h | |
const TArray< TSharedRef< FSlateWindowElementList > > & GetWindowElementLists() |
Gets all window element lists in this buffer. | Rendering/SlateDrawBuffer.h | |
bool IsLocked() |
Rendering/SlateDrawBuffer.h | ||
bool Lock () |
Locks the draw buffer. Indicates that the viewport is in use. | Rendering/SlateDrawBuffer.h | |
| Removes any window from the draw buffer that's not in this list or whose window has become invalid. | Rendering/SlateDrawBuffer.h | ||
void Unlock () |
Rendering/SlateDrawBuffer.h | ||
void Unlock
(
const UE::Tasks::FTask& PrerequisiteTask |
Unlocks the buffer. Indicates that the buffer is free. | Rendering/SlateDrawBuffer.h | |
void UpdateResourceVersion
(
uint32 NewResourceVersion |
Updates renderer resource version to allow the draw buffer to clean up cached resources | Rendering/SlateDrawBuffer.h |
Overridden from FGCObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddReferencedObjects
(
FReferenceCollector& Collector |
FGCObject Interface | Rendering/SlateDrawBuffer.h | |
virtual FString GetReferencerName() |
Rendering/SlateDrawBuffer.h |