1. Epic GamesDeveloper
  3. FSlateDrawElement

FSlateDrawElement

[FSlateDrawElement](API\Runtime\SlateCore\FSlateDrawElement) is the building block for Slate's rendering interface.

API > API/Runtime > API/Runtime/SlateCore

FSlateDrawElement is the building block for Slate's rendering interface. Slate describes its visual output as an ordered list of FSlateDrawElement s

   
Name FSlateDrawElement
Type class
Header File /Engine/Source/Runtime/SlateCore/Public/Rendering/DrawElementTypes.h
Include Path #include "Rendering/DrawElementTypes.h"

Syntax

class FSlateDrawElement

Derived Classes

FSlateDrawElement derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FSlateDrawElement()

   Rendering/DrawElementTypes.h  

Enums

Public

Name Remarks
ERotationSpace  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BatchFlags ESlateBatchDrawFlag Misc data. Rendering/DrawElementTypes.h  
bIsCached uint8   Rendering/DrawElementTypes.h  
ClipStateHandle FClipStateHandle   Rendering/DrawElementTypes.h  
DrawEffects ESlateDrawEffect   Rendering/DrawElementTypes.h  
ElementType EElementType   Rendering/DrawElementTypes.h  
LayerId int32   Rendering/DrawElementTypes.h  
LocalSize FVector2f   Rendering/DrawElementTypes.h  
Position FVector2f   Rendering/DrawElementTypes.h  
RenderTransform FSlateRenderTransform   Rendering/DrawElementTypes.h  
Scale float   Rendering/DrawElementTypes.h  
SceneIndex int8   Rendering/DrawElementTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyPositionOffset ( UE::Slate::FDeprecateVector2DParameter InOffset
)

 Update element cached position with an arbitrary offset Rendering/DrawElementTypes.h  

ESlateBatchDrawFlag GetBatchFlags()

   Rendering/DrawElementTypes.h  

const FClipStateHandle & GetClippingHandle()

   Rendering/DrawElementTypes.h  

ESlateDrawEffect GetDrawEffects()

   Rendering/DrawElementTypes.h  

FSlateLayoutTransform GetInverseLayoutTransform()

   Rendering/DrawElementTypes.h  

int32 GetLayer()

   Rendering/DrawElementTypes.h  

UE::Slate::FDeprecateVector2DResult GetLocalSize()

   Rendering/DrawElementTypes.h  

UE::Slate::FDeprecateVector2DResult GetPosition()

   Rendering/DrawElementTypes.h  

int32 GetPrecachedClippingIndex()

   Rendering/DrawElementTypes.h  

const FSlateRenderTransform & GetRenderTransform()

   Rendering/DrawElementTypes.h  

float GetScale()

   Rendering/DrawElementTypes.h  

const int8 GetSceneIndex()

   Rendering/DrawElementTypes.h  

bool IsCached()

   Rendering/DrawElementTypes.h  

bool IsPixelSnapped()

   Rendering/DrawElementTypes.h  

void SetCachedClippingState ( const FSlateClippingState* CachedState
)

   Rendering/DrawElementTypes.h  

void SetIsCached ( bool bInIsCached
)

   Rendering/DrawElementTypes.h  

void SetPosition ( UE::Slate::FDeprecateVector2DParameter InPosition
)

   Rendering/DrawElementTypes.h  

void SetPrecachedClippingIndex ( int32 InClippingIndex
)

   Rendering/DrawElementTypes.h  

void SetRenderTransform ( const FSlateRenderTransform& InRenderTransform
)

   Rendering/DrawElementTypes.h  

Static

Name Remarks Include Path Unreal Specifiers

static FVector2f GetRotationPoint ( const FPaintGeometry& PaintGeometry,
const TOptional< FVector2f >& UserRotationPoint,
ERotationSpace RotationSpace
)

   Rendering/DrawElementTypes.h  

static void MakeBox ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FSlateBrush* InBrush,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Creates a box element based on the following diagram. Rendering/DrawElementTypes.h  

static FSlateDrawElement & MakeBoxInternal ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FSlateBrush* InBrush,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

   Rendering/DrawElementTypes.h  

static void MakeCubicBezierSpline ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const UE::Slate::FDeprecateVector2DParameter P0,
const UE::Slate::FDeprecateVector2DParameter P1,
const UE::Slate::FDeprecateVector2DParameter P2,
const UE::Slate::FDeprecateVector2DParameter P3,
float InThickness,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Creates a Bezier Spline element Rendering/DrawElementTypes.h  

static void MakeCustom ( FSlateWindowElementList& ElementList,
uint32 InLayer,
TSharedPtr< ICustomSlateElement, ESPMode::ThreadSafe > CustomDrawer
)

 Creates a custom element which can be used to manually draw into the Slate render target with graphics API calls rather than Slate elements Rendering/DrawElementTypes.h  

static void MakeCustomVerts ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FSlateResourceHandle& InRenderResourceHandle,
const TArray< FSlateVertex >& InVerts,
const TArray< SlateIndex >& InIndexes,
ISlateUpdatableInstanceBuffer* InInstanceData,
uint32 InInstanceOffset,
uint32 InNumInstances,
ESlateDrawEffect InDrawEffects
)

   Rendering/DrawElementTypes.h  

static void MakeDashedLines ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TArray< FVector2f >&& Points,
TArray< FLinearColor >&& PointColors,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint,
float Thickness,
float DashLengthPx,
float DashScreenOffset
)

 Creates a dashed or dotted line defined by the provided points. Rendering/DrawElementTypes.h  

static void MakeDashedLines ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TArray< FVector2f >&& Points,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint,
float Thickness,
float DashLengthPx,
float DashScreenOffset
)

 Creates a dashed or dotted line defined by the provided points. Rendering/DrawElementTypes.h  

static void MakeDebugQuad ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
FLinearColor Tint
)

 Creates a wireframe quad for debug purposes Rendering/DrawElementTypes.h  

static void MakeDrawSpaceSpline ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const UE::Slate::FDeprecateVector2DParameter InStart,
const UE::Slate::FDeprecateVector2DParameter InStartDir,
const UE::Slate::FDeprecateVector2DParameter InEnd,
const UE::Slate::FDeprecateVector2DParameter InEndDir,
float InThickness,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Just like MakeSpline but in draw-space coordinates. Rendering/DrawElementTypes.h  

static void MakeGradient ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TArray< FSlateGradientStop > InGradientStops,
EOrientation InGradientType,
ESlateDrawEffect InDrawEffects,
FVector4f CornerRadius
)

 Creates a gradient element Rendering/DrawElementTypes.h  

static void MakeLines ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TArray< FVector2f > Points,
TArray< FLinearColor > PointColors,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint,
bool bAntialias,
float Thickness
)

 Creates a line defined by the provided points Rendering/DrawElementTypes.h  

static void MakeLines ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TArray< FVector2f > Points,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint,
bool bAntialias,
float Thickness
)

 Creates a line defined by the provided points Rendering/DrawElementTypes.h  

static void MakePostProcessBlur ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FVector4f& Params,
int32 DownsampleAmount,
const FVector4f CornerRadius
)

 Creates an element that performs a blur pass Rendering/DrawElementTypes.h  

static void MakePostProcessPass ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FVector4f& Params,
int32 DownsampleAmount,
const FVector4f CornerRadius
)

   Rendering/DrawElementTypes.h  

static void MakeRotatedBox ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FSlateBrush* InBrush,
ESlateDrawEffect,
float Angle,
UE::Slate::FDeprecateOptionalVector2DParameter InRotationPoint,
ERotationSpace RotationSpace,
const FLinearColor& InTint
)

   Rendering/DrawElementTypes.h  

static void MakeRotatedShapedText ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FShapedGlyphSequenceRef& InShapedGlyphSequence,
ESlateDrawEffect InDrawEffects,
const FLinearColor& BaseTint,
const FLinearColor& OutlineTint,
float Angle2D,
const UE::Slate::FDeprecateOptionalVector2DParameter& InRotationPoint,
ERotationSpace RotationSpace,
const FTextOverflowArgs& TextOverflowArgs
)

 Creates a text element which displays a series of shaped glyphs on the screen Rendering/DrawElementTypes.h  

static void MakeShapedText ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FShapedGlyphSequenceRef& InShapedGlyphSequence,
ESlateDrawEffect InDrawEffects,
const FLinearColor& BaseTint,
const FLinearColor& OutlineTint,
FTextOverflowArgs TextOverflowArgs
)

 Creates a text element which displays a series of shaped glyphs on the screen Rendering/DrawElementTypes.h  

static void MakeSpline ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const UE::Slate::FDeprecateVector2DParameter InStart,
const UE::Slate::FDeprecateVector2DParameter InStartDir,
const UE::Slate::FDeprecateVector2DParameter InEnd,
const UE::Slate::FDeprecateVector2DParameter InEndDir,
float InThickness,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Creates a Hermite Spline element Rendering/DrawElementTypes.h  

static void MakeText ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FString& InText,
const FSlateFontInfo& InFontInfo,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

   Rendering/DrawElementTypes.h  

static void MakeText ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FString& InText,
const int32 StartIndex,
const int32 EndIndex,
const FSlateFontInfo& InFontInfo,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Creates a text element which displays a string of a rendered in a certain font on the screen Rendering/DrawElementTypes.h  

static void MakeText ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
const FText& InText,
const FSlateFontInfo& InFontInfo,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

   Rendering/DrawElementTypes.h  

static void MakeViewport ( FSlateWindowElementList& ElementList,
uint32 InLayer,
const FPaintGeometry& PaintGeometry,
TSharedPtr< const ISlateViewport > Viewport,
ESlateDrawEffect InDrawEffects,
const FLinearColor& InTint
)

 Creates a viewport element which is useful for rendering custom data in a texture into Slate Rendering/DrawElementTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page