#include <DrawElementTypes.h>

Inheritance diagram for FSlateDrawElement:

Public Types
enum	ERotationSpace { RelativeToElement , RelativeToWorld }

Public Member Functions
	FSlateDrawElement ()

int32	GetLayer () const

const FSlateRenderTransform &	GetRenderTransform () const

void	SetRenderTransform (const FSlateRenderTransform &InRenderTransform)

UE::Slate::FDeprecateVector2DResult	GetPosition () const

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

UE::Slate::FDeprecateVector2DResult	GetLocalSize () const

float	GetScale () const

ESlateDrawEffect	GetDrawEffects () const

ESlateBatchDrawFlag	GetBatchFlags () const

bool	IsPixelSnapped () const

int32	GetPrecachedClippingIndex () const

void	SetPrecachedClippingIndex (int32 InClippingIndex)

void	SetCachedClippingState (const FSlateClippingState *CachedState)

const FClipStateHandle &	GetClippingHandle () const

const int8	GetSceneIndex () const

void	SetIsCached (bool bInIsCached)

bool	IsCached () const

FSlateLayoutTransform	GetInverseLayoutTransform () const

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

Static Public Member Functions
static SLATECORE_API void	MakeDebugQuad (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, FLinearColor Tint=FLinearColor::White)

static SLATECORE_API void	MakeGeometryOutline (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, FLinearColor Tint=FLinearColor::White, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, bool bAntialias=true, float Thickness=1.0f)

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

static SLATECORE_API void	MakeRotatedBox (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, const FSlateBrush *InBrush, ESlateDrawEffect, float Angle, UE::Slate::FDeprecateOptionalVector2DParameter InRotationPoint=TOptional< FVector2f >(), ERotationSpace RotationSpace=RelativeToElement, const FLinearColor &InTint=FLinearColor::White)

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

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

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

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

static SLATECORE_API 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=TOptional< FVector2f >(), ERotationSpace RotationSpace=RelativeToElement, const FTextOverflowArgs &TextOverflowArgs=FTextOverflowArgs())

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

static SLATECORE_API 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=0.0f, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White)

static SLATECORE_API 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=0.0f, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White)

static SLATECORE_API 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=0.0f, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White)

static SLATECORE_API void	MakeLines (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, TArray< FVector2f > Points, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White, bool bAntialias=true, float Thickness=1.0f)

static SLATECORE_API void	MakeDashedLines (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, TArray< FVector2f > &&Points, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White, float Thickness=1.0f, float DashLengthPx=10.0f, float DashScreenOffset=0.f)

static SLATECORE_API void	MakeLines (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, TArray< FVector2f > Points, TArray< FLinearColor > PointColors, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White, bool bAntialias=true, float Thickness=1.0f)

static SLATECORE_API void	MakeDashedLines (FSlateWindowElementList &ElementList, uint32 InLayer, const FPaintGeometry &PaintGeometry, TArray< FVector2f > &&Points, TArray< FLinearColor > &&PointColors, ESlateDrawEffect InDrawEffects=ESlateDrawEffect::None, const FLinearColor &InTint=FLinearColor::White, float Thickness=1.0f, float DashLengthPx=10.0f, float DashScreenOffset=0.f)

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

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

static SLATECORE_API 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=ESlateDrawEffect::None)

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

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

Friends
class	FSlateWindowElementList

Detailed Description

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

Member Enumeration Documentation

◆ ERotationSpace

enum FSlateDrawElement::ERotationSpace

Enumerator
RelativeToElement	Relative to the element. (0,0) is the upper left corner of the element
RelativeToWorld	Relative to the alloted paint geometry. (0,0) is the upper left corner of the paint geometry

Constructor & Destructor Documentation

◆ FSlateDrawElement()

FSlateDrawElement::FSlateDrawElement ( )

Member Function Documentation

◆ ApplyPositionOffset()

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

Update element cached position with an arbitrary offset

Parameters

Element	Element to update
InOffset	Absolute translation delta

◆ GetBatchFlags()

ESlateBatchDrawFlag FSlateDrawElement::GetBatchFlags ( ) const

inline

◆ GetClippingHandle()

const FClipStateHandle & FSlateDrawElement::GetClippingHandle ( ) const

inline

◆ GetDrawEffects()

ESlateDrawEffect FSlateDrawElement::GetDrawEffects ( ) const

inline

◆ GetInverseLayoutTransform()

FSlateLayoutTransform FSlateDrawElement::GetInverseLayoutTransform ( ) const

inline

◆ GetLayer()

int32 FSlateDrawElement::GetLayer ( ) const

inline

◆ GetLocalSize()

UE::Slate::FDeprecateVector2DResult FSlateDrawElement::GetLocalSize ( ) const

inline

◆ GetPosition()

UE::Slate::FDeprecateVector2DResult FSlateDrawElement::GetPosition ( ) const

inline

◆ GetPrecachedClippingIndex()

int32 FSlateDrawElement::GetPrecachedClippingIndex ( ) const

inline

◆ GetRenderTransform()

const FSlateRenderTransform & FSlateDrawElement::GetRenderTransform ( ) const

inline

◆ GetScale()

float FSlateDrawElement::GetScale ( ) const

inline

◆ GetSceneIndex()

const int8 FSlateDrawElement::GetSceneIndex ( ) const

inline

◆ IsCached()

bool FSlateDrawElement::IsCached ( ) const

inline

◆ IsPixelSnapped()

bool FSlateDrawElement::IsPixelSnapped ( ) const

inline

◆ MakeBox()

void FSlateDrawElement::MakeBox	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FSlateBrush *	InBrush,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Creates a box element based on the following diagram. Allows for this element to be resized while maintain the border of the image If there are no margins the resulting box is simply a quad ___LeftMargin ___RightMargin / / +–+----------—+–+ | |c1 |c2| ___TopMargin +–o----------—o–+ | | | | | |c3 |c4| +–o----------—o–+ | | | | ___BottomMargin +–+----------—+–+

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InBrush	Brush to apply to this element
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ MakeCubicBezierSpline()

void FSlateDrawElement::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 = `0.0f`,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Creates a Bezier Spline element

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InStart	The start point of the spline (local space)
InStartDir	The direction of the spline from the start point
InEnd	The end point of the spline (local space)
InEndDir	The direction of the spline to the end point
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ MakeCustom()

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

static

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

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
CustomDrawer	Interface to a drawer which will be called when Slate renders this element

◆ MakeCustomVerts()

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

static

◆ MakeDashedLines() [1/2]

void FSlateDrawElement::MakeDashedLines	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TArray< FVector2f > &&	Points,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`,
		float	Thickness = `1.0f`,
		float	DashLengthPx = `10.0f`,
		float	DashScreenOffset = `0.f`
	)

static

Creates a dashed or dotted line defined by the provided points. Such lines are always renderd using the anti-aliased shader method.

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Points	Points that make up the lines. The points are joined together. I.E if Points has A,B,C there the line is A-B-C. To draw non-joining line segments call MakeLines multiple times
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element
Thickness	The thickness of the line
DashLengthPx	The screen-space length of each dash (and each gap - irregular spacings are not supported)
DashScreenOffset	A screen space offset that can be used to 'anchor' dashes to prevent them sliding when moving lines drawn in a virtual space.

◆ MakeDashedLines() [2/2]

void FSlateDrawElement::MakeDashedLines	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TArray< FVector2f > &&	Points,
		TArray< FLinearColor > &&	PointColors,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`,
		float	Thickness = `1.0f`,
		float	DashLengthPx = `10.0f`,
		float	DashScreenOffset = `0.f`
	)

static

Creates a dashed or dotted line defined by the provided points. Such lines are always renderd using the anti-aliased shader method.

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Points	Points that make up the lines. The points are joined together. I.E if Points has A,B,C there the line is A-B-C. To draw non-joining line segments call MakeLines multiple times
PointColors	Vertex Color for each defined points
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element
Thickness	The thickness of the line
DashLengthPx	The screen-space length of each dash (and each gap - irregular spacings are not supported)
DashScreenOffset	A screen space offset that can be used to 'anchor' dashes to prevent them sliding when moving lines drawn in a virtual space.

◆ MakeDebugQuad()

void FSlateDrawElement::MakeDebugQuad	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		FLinearColor	Tint = `FLinearColor::White`
	)

static

Creates a solid quad for debug purposes

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Tint	The color to tint the quad

◆ MakeDrawSpaceSpline()

void FSlateDrawElement::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 = `0.0f`,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Just like MakeSpline but in draw-space coordinates. This is useful for connecting already-transformed widgets together.

◆ MakeGeometryOutline()

void FSlateDrawElement::MakeGeometryOutline	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		FLinearColor	Tint = `FLinearColor::White`,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		bool	bAntialias = `true`,
		float	Thickness = `1.0f`
	)

static

Creates an outline of the specific Paint Geometry

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Tint	The color to tint the outline
InDrawEffects	Which effects to apply to the outline
bAntialias	Whether to anti-alias the outline
Thickness	How thick the outline should be

◆ MakeGradient()

void FSlateDrawElement::MakeGradient	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TArray< FSlateGradientStop >	InGradientStops,
		EOrientation	InGradientType,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		FVector4f	CornerRadius = `FVector4f(0.0f)`
	)

static

Creates a gradient element

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InGradientStops	List of gradient stops which define the element
InGradientType	The type of gradient (I.E Horizontal, vertical)
InDrawEffects	Optional draw effects to apply
CornerRadius	Rounds the corners of the box created by the gradient by the specified radius

◆ MakeLines() [1/2]

void FSlateDrawElement::MakeLines	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TArray< FVector2f >	Points,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`,
		bool	bAntialias = `true`,
		float	Thickness = `1.0f`
	)

static

Creates a line defined by the provided points

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Points	Points that make up the lines. The points are joined together. I.E if Points has A,B,C there the line is A-B-C. To draw non-joining line segments call MakeLines multiple times
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element
bAntialias	Should antialiasing be applied to the line?
Thickness	The thickness of the line

◆ MakeLines() [2/2]

void FSlateDrawElement::MakeLines	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TArray< FVector2f >	Points,
		TArray< FLinearColor >	PointColors,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`,
		bool	bAntialias = `true`,
		float	Thickness = `1.0f`
	)

static

Creates a line defined by the provided points

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Points	Points that make up the lines. The points are joined together. I.E if Points has A,B,C there the line is A-B-C. To draw non-joining line segments call MakeLines multiple times
PointColors	Vertex Color for each defined points
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element
bAntialias	Should antialiasing be applied to the line?
Thickness	The thickness of the line

◆ MakePostProcessBlur()

PRAGMA_ENABLE_DEPRECATION_WARNINGS void FSlateDrawElement::MakePostProcessBlur	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FVector4f &	Params,
		int32	DownsampleAmount,
		const FVector4f	CornerRadius = `FVector4f(0.0f)`
	)

static

Creates an element that performs a blur pass

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Params	Shader params for blur, should be tuple of KernelSize, Strength, Width, & Height
DownSampleAmount	Amount we can downsample for the blur based on kernel size / strength
CornerRadius	Amount pixels will be weighted in any direction

◆ MakePostProcessPass()

PRAGMA_DISABLE_DEPRECATION_WARNINGS void FSlateDrawElement::MakePostProcessPass	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FVector4f &	Params,
		int32	DownsampleAmount,
		const FVector4f	CornerRadius = `FVector4f(0.0f)`
	)

static

◆ MakeRotatedBox()

void FSlateDrawElement::MakeRotatedBox	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FSlateBrush *	InBrush,
		ESlateDrawEffect	InDrawEffects,
		float	Angle,
		UE::Slate::FDeprecateOptionalVector2DParameter	InRotationPoint = `TOptional<FVector2f>()`,
		ERotationSpace	RotationSpace = `RelativeToElement`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

◆ MakeRotatedShapedText()

void FSlateDrawElement::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 = `TOptional<FVector2f>()`,
		ERotationSpace	RotationSpace = `RelativeToElement`,
		const FTextOverflowArgs &	TextOverflowArgs = `FTextOverflowArgs()`
	)

static

Creates a text element which displays a series of shaped glyphs on the screen

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InShapedGlyphSequence	The shaped glyph sequence to draw
InDrawEffects	Optional draw effects to apply
BaseTint	Color to tint the element
OutlineTint	Color to tint the outline
Angle2D	The rotation of the element in radians

◆ MakeShapedText()

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

static

Creates a text element which displays a series of shaped glyphs on the screen

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InShapedGlyphSequence	The shaped glyph sequence to draw
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ MakeSpline()

void FSlateDrawElement::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 = `0.0f`,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Creates a Hermite Spline element

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InStart	The start point of the spline (local space)
InStartDir	The direction of the spline from the start point
InEnd	The end point of the spline (local space)
InEndDir	The direction of the spline to the end point
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ MakeText() [1/3]

void FSlateDrawElement::MakeText	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FString &	InText,
		const FSlateFontInfo &	InFontInfo,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

◆ MakeText() [2/3]

void FSlateDrawElement::MakeText	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FString &	InText,
		const int32	StartIndex,
		const int32	EndIndex,
		const FSlateFontInfo &	InFontInfo,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Creates a text element which displays a string of a rendered in a certain font on the screen

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
InText	The string to draw
StartIndex	Inclusive index to start rendering from on the specified text
EndIndex	Exclusive index to stop rendering on the specified text
InFontInfo	The font to draw the string with
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ MakeText() [3/3]

static void FSlateDrawElement::MakeText	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		const FText &	InText,
		const FSlateFontInfo &	InFontInfo,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

inlinestatic

◆ MakeViewport()

void FSlateDrawElement::MakeViewport	(	FSlateWindowElementList &	ElementList,
		uint32	InLayer,
		const FPaintGeometry &	PaintGeometry,
		TSharedPtr< const ISlateViewport >	Viewport,
		ESlateDrawEffect	InDrawEffects = `ESlateDrawEffect::None`,
		const FLinearColor &	InTint = `FLinearColor::White`
	)

static

Creates a viewport element which is useful for rendering custom data in a texture into Slate

Parameters

ElementList	The list in which to add elements
InLayer	The layer to draw the element on
PaintGeometry	DrawSpace position and dimensions; see FPaintGeometry
Viewport	Interface for drawing the viewport
InScale	Draw scale to apply to the entire element
InDrawEffects	Optional draw effects to apply
InTint	Color to tint the element

◆ SetCachedClippingState()

void FSlateDrawElement::SetCachedClippingState ( const FSlateClippingState * CachedState )

inline

◆ SetIsCached()

void FSlateDrawElement::SetIsCached ( bool bInIsCached )

inline

◆ SetPosition()

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

inline

◆ SetPrecachedClippingIndex()

void FSlateDrawElement::SetPrecachedClippingIndex ( int32 InClippingIndex )

inline

◆ SetRenderTransform()

void FSlateDrawElement::SetRenderTransform ( const FSlateRenderTransform & InRenderTransform )

inline

Friends And Related Symbol Documentation

◆ FSlateWindowElementList

friend class FSlateWindowElementList

friend

The documentation for this class was generated from the following files:

Engine/Source/Runtime/SlateCore/Public/Rendering/DrawElementTypes.h
Engine/Source/Runtime/SlateCore/Private/Rendering/DrawElementTypes.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ ERotationSpace

Constructor & Destructor Documentation

◆ FSlateDrawElement()

Member Function Documentation

◆ ApplyPositionOffset()

◆ GetBatchFlags()

◆ GetClippingHandle()

◆ GetDrawEffects()

◆ GetInverseLayoutTransform()

◆ GetLayer()

◆ GetLocalSize()

◆ GetPosition()

◆ GetPrecachedClippingIndex()

◆ GetRenderTransform()

◆ GetScale()

◆ GetSceneIndex()

◆ IsCached()

◆ IsPixelSnapped()

◆ MakeBox()

◆ MakeCubicBezierSpline()

◆ MakeCustom()

◆ MakeCustomVerts()

◆ MakeDashedLines() [1/2]

◆ MakeDashedLines() [2/2]

◆ MakeDebugQuad()

◆ MakeDrawSpaceSpline()

◆ MakeGeometryOutline()

◆ MakeGradient()

◆ MakeLines() [1/2]

◆ MakeLines() [2/2]

◆ MakePostProcessBlur()

◆ MakePostProcessPass()

◆ MakeRotatedBox()

◆ MakeRotatedShapedText()

◆ MakeShapedText()

◆ MakeSpline()

◆ MakeText() [1/3]

◆ MakeText() [2/3]

◆ MakeText() [3/3]

◆ MakeViewport()

◆ SetCachedClippingState()

◆ SetIsCached()

◆ SetPosition()

◆ SetPrecachedClippingIndex()

◆ SetRenderTransform()

Friends And Related Symbol Documentation

◆ FSlateWindowElementList