Rendering

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FCompareFNewTextureInfoByTextureSize

Public class

FElementBatchMap

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 class

FSlateDataPayload

Public class

FSlateDrawBuffer

Implements a draw buffer for Slate.

Public class

FSlateDrawElement

FSlateDrawElement is the building block for Slate's rendering interface.

Public class

FSlateDrawLayer

The draw layer represents a logical draw layer.

Public class

FSlateDrawLayerHandle

Public class

FSlateElementBatch

Represents an element batch for 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

FSlateGradientStop

Public class

FSlateInstanceBufferUpdate

Represents an update to the per-instance buffer.

Public class

FSlateLayoutTransform

Represents a 2D transformation in the following order: scale then translate.

Public class

FSlateObjectReferenceCollector

Used to gather all the referenced UObjects used by Slate when rendering a frame.

Public class

FSlateRenderBatch

Public class

FSlateRenderDataHandle

Public class

FSlateRenderer

Abstract base class for Slate renderers.

Public class

FSlateRenderingPolicy

Abstract base class for Slate rendering policies.

Public class

FSlateShaderResourceManager

Base texture manager class used by a Slate renderer to manage texture resources

Public struct

FSlateVertex

A struct which defines a basic vertex seen by the Slate vertex buffers and shaders

Public class

FSlateWindowElementList

Represents a top level window and its draw elements.

Public class

ICustomSlateElement

An interface for a custom slate drawing element Implementers of this interface are expected to handle destroying this interface properly when a separate rendering thread may have access to it.

Public class

ISlateRenderDataManager

Public class

ISlateUpdatableInstanceBuffer

Represents a per instance data buffer for a custom Slate mesh element.

Public class

ISlateViewport

Viewport implementation interface that is used by SViewport when it needs to draw and processes input.

Typedefs

Name

Description

FElementBatchArray

FSlateIndexArray

FSlateRenderTransform

Typecast so it's more clear to the reader when we are dealing with a render transform vs.

FSlateVertexArray

FTexture2DRHIRef

SlateIndex

Type

Type

Enums

Name

Description

Public enum

EColorVisionDeficiency

Enumerates color vision deficiency types.

Public enum

ESlateBatchDrawFlag

Flags for drawing a batch

Public enum

ESlateDrawEffect

Effects that can be applied to elements when rendered.

Public enum

ESlateLineJoinType

Public enum

ESlateVertexRounding

Functions

Name Description

Public function

FSlateLayout...

 

Concatenate

(
    float Scale,
    const FVector2D& Translation
)

Specialization for concatenating a uniform scale and 2D Translation.

Public function

FSlateLayout...

 

Concatenate

(
    const FVector2D& Translation,
    float Scale
)

Specialization for concatenating a 2D Translation and uniform scale.

Public function

bool

 

DoesThreadOwnSlateRendering()

If it's the game thread, and there's no loading thread, then it owns slate rendering.

Public function

bool

 

IsThreadSafeForSlateRendering()

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

constexpr bo...

 

operator!

(
    ESlateDrawEffect E
)

Public function

constexpr bo...

 

operator!

(
    ESlateBatchDrawFlag E
)

Public function

constexpr ES...

 

operator&

(
    ESlateDrawEffect Lhs,
    ESlateDrawEffect Rhs
)

Public function

constexpr ES...

 

operator&

(
    ESlateBatchDrawFlag Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

ESlateDrawEf...

 

operator&=

(
    ESlateDrawEffect& Lhs,
    ESlateDrawEffect Rhs
)

Public function

ESlateBatchD...

 

operator&=

(
    ESlateBatchDrawFlag& Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

constexpr ES...

 

operator^

(
    ESlateDrawEffect Lhs,
    ESlateDrawEffect Rhs
)

Public function

constexpr ES...

 

operator^

(
    ESlateBatchDrawFlag Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

ESlateDrawEf...

 

operator^=

(
    ESlateDrawEffect& Lhs,
    ESlateDrawEffect Rhs
)

Public function

ESlateBatchD...

 

operator^=

(
    ESlateBatchDrawFlag& Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

constexpr ES...

 

operator|

(
    ESlateDrawEffect Lhs,
    ESlateDrawEffect Rhs
)

Public function

constexpr ES...

 

operator|

(
    ESlateBatchDrawFlag Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

ESlateDrawEf...

 

operator|=

(
    ESlateDrawEffect& Lhs,
    ESlateDrawEffect Rhs
)

Public function

ESlateBatchD...

 

operator|=

(
    ESlateBatchDrawFlag& Lhs,
    ESlateBatchDrawFlag Rhs
)

Public function

constexpr ES...

 

operator~

(
    ESlateDrawEffect E
)

Public function

constexpr ES...

 

operator~

(
    ESlateBatchDrawFlag E
)

Public function Static

FVector2D

 

RoundToInt

(
    const FVector2D& Vec
)

Variables

Name Description

Public variable

const Type

 

Border

Border shader

Public variable

const Type

 

Custom

For completely customized materials. Makes no assumptions on use

Public variable

const Type

 

Default

The default shader type. Simple texture lookup

Public variable

const Type

 

Font

Font shader, same as default except uses an alpha only texture

Public variable

const Type

 

LineList

Public variable

const Type

 

LineSegment

Line segment shader. For drawing anti-aliased lines

Public variable

const Type

 

PostProcess

For post processing passes

Public variable

const Type

 

TriangleList

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback