1. Epic GamesDeveloper
  3. FSlateDrawElement

FSlateDrawElement

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

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

Inheritance Hierarchy

References

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

Syntax

class FSlateDrawElement

Remarks

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

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Update element cached position with an arbitrary offset
Public function Const ESlateBatchDrawFlag  
Public function Const const FClipStateHandle &  
Public function Const ESlateDrawEffect  
Public function Const FSlateLayoutTransform  
Public function Const int32  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const int32  
Public function Const const FSlateRenderTransform &  
Public function Const float  
Public function Const const int8  
Public function Const bool  
Public function Const bool  
Public function 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.
Public function 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
Public function 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
Public function 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
)

  
Public function Static void

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

 Creates a wireframe quad for debug purposes
Public function 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.
Public function Static void

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

 Creates a gradient element
Public function 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
Public function Static void

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

 Creates a line defined by the provided points
Public function 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
Public function Static void

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

 Creates a line defined by the provided points
Public function Static void

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

  
Public function 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
)

  
Public function 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
Public function 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
Public function Static void

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

  
Public function 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
Public function Static void

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

  
Public function 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
Public function void  
Public function void

SetIsCached ( bool bInIsCached
)

  
Public function void  
Public function void

SetPrecachedClippingIndex ( int32 InClippingIndex
)

  
Public function void

SetRenderTransform ( const FSlateRenderTransform& InRenderTransform
)

  

Enums

  Type Name Description
Public enum ERotationSpace    

Deprecated Functions

  Type Name Description
Public function Const const int32 GetClippingIndex has been deprecated. If you were using this please use GetPrecachedClippingIndex instead.
Public function void

SetClippingIndex ( const int32 InClippingIndex
)

 SetClippingIndex has been deprecated. If you were using this please use SetPrecachedClippingIndex instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page