FSlateDrawBuffer

Implements a draw buffer for Slate.

Windows
MacOS
Linux

Inheritance Hierarchy

FGCObject

FSlateDrawBuffer

References

Module

SlateCore

Header

/Engine/Source/Runtime/SlateCore/Public/Rendering/SlateDrawBuffer.h

Include

#include "Rendering/SlateDrawBuffer.h"

Syntax

class FSlateDrawBuffer : public FGCObject

Remarks

Implements a draw buffer for Slate.

Variables

Name Description

Protected variable

int32

 

Locked

1 if this buffer is locked, 0 otherwise.

Protected variable

uint32

 

ResourceVersion

Last recorded version from the render. The WindowElementListsPool is emptied when this changes.

Public variable

FVector2D

 

ViewOffset

Protected variable

TArray< TShared...

 

WindowElementLists

List of window element lists.

Protected variable

TArray< TShared...

 

WindowElementListsPool

List of window element lists that we store from the previous frame that we restore if they're requested again.

Constructors

Name Description

Public function

FSlateDrawBuffer()

Default constructor.

Destructors

Name Description

Public function

~FSlateDrawBuffer()

Functions

Name Description

Public function

FSlateWindow...

 

AddWindowElementList

(
    TSharedRef< SWindow > ForWindow
)

Creates a new FSlateWindowElementList and returns a reference to it so it can have draw elements added to it

Public function

void

 

ClearBuffer()

Removes all data from the buffer.

Public function

const TArray...

 

GetWindowElementLists()

Gets all window element lists in this buffer.

Public function

bool

 

Lock()

Locks the draw buffer. Indicates that the viewport is in use.

Public function

void

 

RemoveUnusedWindowElement

(
    const TArray< SWindow* >& All...
)

Removes any window from the draw buffer that's not in this list or whose window has become invalid.

Public function

void

 

Unlock()

Unlocks the buffer. Indicates that the buffer is free.

Public function

void

 

UpdateResourceVersion

(
    uint32 NewResourceVersion
)

Updates renderer resource version to allow the draw buffer to clean up cached resources

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

FGCObject Interface

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss