1. Epic GamesDeveloper
  3. Rendering

Rendering

Unreal Engine C++ API Reference > Runtime > SlateCore

Classes

  Type Name Description
Public struct FCompareFNewTextureInfoByTextureSize    
Public struct FMappedTextureBuffer    
Public struct FNewTextureInfo Represents a new texture that has been loaded but no resource created for it  
Public struct FRenderThreadUpdateContext Update context for deferred drawing of widgets to render targets  
Public struct FShaderParams Shader parameters for slate  
Public struct FShortRect Stores an aligned rect as shorts.  
Public class FSlateBatchData    
Public struct FSlateBoxElement    
Public struct FSlateCachedBufferElement    
Public struct FSlateCachedElementData Top level class responsible for cached elements within a particular invalidation root.  
Public struct FSlateCachedElementList Cached list of elements corresponding to a particular widget.  
Public struct FSlateCachedElementsHandle Handle used to uniquely identify a cached element list with some widget Used when a widget gets invalidated / additional elements added So we can modify that widget's existing cached element list  
Public struct FSlateCachedFastPathRenderingData Note: FSlateDrawElement has been moved to DrawElementTypes.h Data holder for info used in cached renderbatches.  
Public struct FSlateCustomDrawerElement    
Public struct FSlateCustomVertsElement    
Public class FSlateDrawBuffer Implements a draw buffer for Slate.  
Public class FSlateDrawElement FSlateDrawElement is the building block for Slate's rendering interface.  
Public class FSlateElementBatch Represents an a set of slate draw elements that are batched together These later get converted into FSlateRenderBatches for final rendering  
Public class FSlateElementBatcher A class which batches Slate elements for rendering  
Public class FSlateFontServices Provides access to the game and render thread font caches that Slate should use  
Public struct FSlateGradientElement    
Public struct FSlateGradientStop    
Public struct FSlateLayerElement    
Public class FSlateLayoutTransform Copyright Epic Games, Inc. All Rights Reserved.  
Public struct FSlateLineElement    
Public class FSlateObjectReferenceCollector Used to gather all the referenced UObjects used by Slate when rendering a frame.  
Public struct FSlatePostProcessElement    
Public class FSlateRenderBatch    
Public struct FSlateRenderBatchParams    
Public class FSlateRenderer Abstract base class for Slate renderers.  
Public class FSlateRenderingPolicy Abstract base class for Slate rendering policies.  
Public class FSlateResourceHandle A SlateResourceHandle is used as fast path for looking up a rendering resource for a given brush when adding Slate draw elements This can be cached and stored safely in code.  
Public struct FSlateRoundedBoxElement    
Public class FSlateShaderResourceManager Base texture manager class used by a Slate renderer to manage texture resources  
Public struct FSlateShapedTextElement    
Public struct FSlateSplineElement    
Public class FSlateSVGRasterizer    
Public struct FSlateTextElement    
Public struct FSlateTintableElement    
Public class FSlateVectorGraphicsCache    
Public struct FSlateVertex A struct which defines a basic vertex seen by the Slate vertex buffers and shaders  
Public struct FSlateViewportElement    
Public class FSlateWindowElementList Represents a top level window and its draw elements.  
Public struct FTextOverflowArgs    
Public class ICustomSlateElement An interface for a custom slate elements. Lifetime must support pipelining to the render thread.  
Public class ISlateUpdatableInstanceBuffer Represents a per instance data buffer for a custom Slate mesh element.  
Public class ISlateUpdatableInstanceBufferRenderProxy A proxy object used to access a slate per-instance data buffer on the render thread.  
Public class ISlateViewport Viewport implementation interface that is used by SViewport when it needs to draw and processes input.  

Typedefs

Name Description
FSlateDrawElementArray  
FSlateDrawElementMap Tuple / List of element arrays for each element type
FSlateIndexArray  
FSlateInstanceBufferData  
FSlateRenderTransform Copyright Epic Games, Inc. All Rights Reserved.
FSlateVertexArray Note: FRenderingBufferStatTracker & FSlateDrawElementArray have been moved to DrawElementCoreTypes.h
FTextureRHIRef  
SlateIndex  
TSlateDrawElement Helper template to get draw element type in 'FSlateDrawElementMap' for a given element type enum, used to avoid 'auto' return values

Enums

  Type Name Description
Public enum UEnum EColorVisionDeficiency Enumerates color vision deficiency types.  
Public enum EElementType Slate higher level abstract element types  
Public enum ESlateBatchDrawFlag Flags for drawing a batch  
Public enum ESlateDrawEffect Effects that can be applied to elements when rendered.  
Public enum ESlateDrawPrimitive Draw primitive types  
Public enum ESlateLineJoinType    
Public enum UEnum BlueprintType ESlatePostRT Bitfield used to mark if a slate post RT is used or not  
Public enum ESlateShader Shader types.  
Public enum ESlateVertexRounding    
Public enum ESlateViewportDynamicRange    
Public enum ETextOverflowDirection    

Functions

  Type Name Description
Public function Virtual FORCENOINLINE  
Public function Virtual void  
Public function FSlateLayoutTransform

Concatenate ( const UE::Math::TVector2< T >& Translation,
float Scale
)

 Specialization for concatenating a 2D Translation and uniform scale.
Public function FSlateLayoutTransform

Concatenate ( const UE::Math::TVector2< T >& Translation,
double Scale
)

  
Public function FSlateLayoutTransform

Concatenate ( double Scale,
const UE::Math::TVector2< T >& Translation
)

  
Public function FSlateLayoutTransform

Concatenate ( float Scale,
const UE::Math::TVector2< T >& Translation
)

 Specialization for concatenating a uniform scale and 2D Translation.
Public function bool If it's the game thread, and there's no loading thread, then it owns slate rendering.
Public function    
Public function    
Public function    
Public function    
Public function Const ESlateBrushDrawType::Type  
Public function Const const FMargin &  
Public function Const ESlateBrushMirrorType::Type  
Public function Const ESlateBrushTileType::Type  
Public function Const const FBox2f &  
Public function Const const FSlateFontInfo &  
Public function Const FLinearColor  
Public function Const FLinearColor  
Public function Const float  
Public function Const const TArray< FLinearColor > &  
Public function Const const TArray< FVector2f > &  
Public function Const FVector4f  
Public function Const const FSlateShaderResourceProxy *  
Public function Const const FShapedGlyphSequencePtr &  
Public function Const const TCHAR *

GetText ()

  
Public function Const int32  
Public function Const float  
Public function Const bool  
Public function bool Is this thread valid for sending out rendering commands? If the slate loading thread exists, then yes, it is always safe Otherwise, we have to be on the game thread
Public function void

SetBrush ( const FSlateBrush* InBrush,
UE::Slate::FDeprecateVector2DParameter LocalSize,
float DrawScale
)

  
Public function void

SetCachedBuffer ( FSlateRenderDataHandle* InRenderDataHandle,
const UE::Slate::FDeprecateVector2DParameter Offset
)

 Cached Buffers.
Public function void  
Public function void  
Public function void

SetCustomVerts ( const FSlateShaderResourceProxy* InRenderProxy,
TArray< FSlateVertex > InVerts,
TArray< SlateIndex > InIndices,
ISlateUpdatableInstanceBufferRenderProxy* InInstanceData,
uint32 InInstanceOffset,
uint32 InNumInstances
)

  
Public function void

SetGradient ( TArray< FSlateGradientStop > InGradientStops,
EOrientation InGradientType,
FVector4f InCornerRadius
)

  
Public function void  
Public function void  
Public function void

SetLayer ( FSlateDrawLayerHandle* InLayerHandle
)

  
Public function void

SetLines ( TArray< FVector2f > InPoints,
bool bInAntialias,
TArray< FLinearColor > InPointColors
)

  
Public function void

SetLines ( TArray< FVector2f > InPoints,
bool bInAntialias
)

  
Public function void

SetOutline ( const FLinearColor& InOutlineColor,
float InOutlineWeight
)

  
Public function void  
Public function void

SetRadius ( FVector4f InRadius
)

  
Public function void

SetShapedText ( FSlateWindowElementList& ElementList,
const FShapedGlyphSequencePtr& InShapedGlyphSequence,
const FLinearColor& InOutlineTint
)

  
Public function void

SetText ( const FString& InText,
const FSlateFontInfo& InFontInfo
)

  
Public function void

SetText ( const FString& InText,
const FSlateFontInfo& InFontInfo,
int32 InStartIndex,
int32 InEndIndex
)

  
Public function void

SetThickness ( float InThickness
)

 Thickness.
Public function void

SetViewport ( const TSharedPtr< const ISlateViewport >& InViewport,
const FLinearColor& InTint
)

  
Public function auto  
Public function auto

UE::Slate::MakeTupleIndiciesInner ( std::integer_sequence< IndexType, Indices... >
)

  

Variables

  Type Name Description
Public variable uint8 bAllowViewportScaling  
Public variable bool bAntialias  
Public variable uint8 bRequiresVSync  
Public variable uint8 bViewportTextureAlphaOnly  
Public variable FVector2f CachedRenderDataOffset  
Public variable FVector4f CornerRadius  
Public variable int32 DownsampleAmount  
Public variable ESlateBrushDrawType::Type DrawType  
Public variable EOrientation GradientType  
Public variable int32 GSlateFeathering  
Public variable FString ImmutableText Basic text data.
Public variable TArray< SlateIndex > Indices  
Public variable ISlateUpdatableInstanceBufferRenderProxy * InstanceData Instancing support.
Public variable uint32 InstanceOffset  
Public variable ESlateBrushMirrorType::Type Mirroring  
Public variable uint32 NumInstances  
Public variable FLinearColor OutlineTint  
Public variable float OutlineWeight  
Public variable FTextOverflowArgs OverflowArgs  
Public variable FVector2f P0 Bezier Spline Data points.
Public variable FVector2f P1  
Public variable FVector2f P2  
Public variable FVector2f P3  
Public variable TArray< FLinearColor > PointColors  
Public variable   PRAGMA_DISABLE_DEPRECATION_WARNINGS Deprecated payloads.
Public variable FVector4f Radius  
Public variable const FSlateShaderResourceProxy * ResourceProxy  
Public variable float Thickness  
Public variable ESlateBrushTileType::Type Tiling  
Public variable FBox2f UVRegion  
Public variable TArray< FSlateVertex > Vertices  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page