Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FSlateBrush

A brush which contains information about how to draw a Slate element

Inheritance Hierarchy

FSlateBrush

FSlateBorderBrush

FSlateVectorBorderBrush

FSlateBoxBrush

FSlateVectorBoxBrush

FSlateColorBrush

FSlateDynamicImageBrush

FSlateImageBrush

FSlateVectorImageBrush

FSlateMaterialBrush

FSlateNoResource

FSlateOptionalBrush

FSlateRoundedBoxBrush

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Styling/SlateBrush.h
Include	#include "Styling/SlateBrush.h"

Syntax

struct FSlateBrush

Remarks

A brush which contains information about how to draw a Slate element

Variables

	Name	Description
uint8: 1	bIsDynamicallyLoaded	Whether or not the brush path is a path to a UObject
uint8: 1	bIsSet	This is true for all constructed brushes except for optional brushes
TEnumAsByte< en...	DrawAs	How to draw the image
FDeprecateSlate...	ImageSize	Size of the resource in Slate Units
TEnumAsByte< en...	ImageType	The type of image
FMargin	Margin	The margin to use in Box and Border modes
TEnumAsByte< en...	Mirroring	How to mirror the image in Image mode.
FSlateBrushOutl...	OutlineSettings	How to draw the outline. Currently only used for RoundedBox type brushes.
FSlateResourceH...	ResourceHandle	Rendering resource for this brush
FName	ResourceName	The name of the rendering resource to use
TEnumAsByte< en...	Tiling	How to tile the image in Image mode
FSlateColor	TintColor	Tinting applied to the image.
FBox2f	UVRegion	Optional UV region for an image When valid - overrides UV region specified in resource proxy

Constructors

	Name	Description
	FSlateBrush()	Default constructor.
	FSlateBrush ( ESlateBrushDrawType::Type InDrawTyp..., const FName InResourceName, const FMargin& InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageT..., const UE::Slate::FDeprecateVector2D..., const FLinearColor& InTint, UObject* InObjectResource, bool bInDynamicallyLoaded )	This constructor is protected; use one of the deriving classes instead.
	FSlateBrush ( ESlateBrushDrawType::Type InDrawTyp..., const FName InResourceName, const FMargin& InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageT..., const UE::Slate::FDeprecateVector2D..., const TSharedRef< FLinearColor >& ..., UObject* InObjectResource, bool bInDynamicallyLoaded )
	FSlateBrush ( ESlateBrushDrawType::Type InDrawTyp..., const FName InResourceName, const FMargin& InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageT..., const UE::Slate::FDeprecateVector2D..., const FSlateColor& InTint, UObject* InObjectResource, bool bInDynamicallyLoaded )

Destructors

	Name	Description
	~FSlateBrush()

Functions

	Name	Description
void	AddReferencedObjects ( FReferenceCollector& Collector, UObject* ReferencingObject )	Report any references to UObjects to the reference collector.
ESlateBrushD...	GetDrawType()
UE::Slate::F...	GetImageSize()
ESlateBrushI...	GetImageType()
const FMargi...	GetMargin()
ESlateBrushM...	GetMirroring()
const FSlate...	GetRenderingResource ( UE::Slate::FDeprecateVector2DParame..., float DrawScale )
const FSlate...	GetRenderingResource()
const FName	GetResourceName()	Gets the name of the resource object, if any.
UObject *...	GetResourceObject()	Gets the UObject that represents the brush resource, if any.
ESlateBrushT...	GetTiling()
FLinearColor	GetTint ( const FWidgetStyle& InWidgetStyle )	Gets the brush's tint color.
UE::Slate::F...	GetUVRegion()	Get brush UV region, should check if region is valid before using it
bool	HasUObject()	Checks whether this brush has a UTexture object
void	InvalidateResourceHandle()
bool	IsDynamicallyLoaded()	Checks whether the brush resource is loaded dynamically.
bool	IsSet()
void	SetImageSize ( UE::Slate::FDeprecateVector2DParame... )
void	SetResourceObject ( UObject* InResourceObject )	Sets the UObject that represents the brush resource.
void	SetUVRegion ( const FBox2d& InUVRegion )	Set brush UV region
void	SetUVRegion ( const FBox2f& InUVRegion )
void	UnlinkColors()	Unlinks all colors in this brush.
const FStrin...	UTextureIdentifier()	Gets the identifier for UObject based texture paths.

Operators

		Name	Description
	bool	operator!= ( const FSlateBrush& Other )	Compares this brush with another for inequality.
	bool	operator== ( const FSlateBrush& Other )	Compares this brush with another for equality.

Deprecated Variables

		Name	Description
	uint8: 1	bHasUObject_DEPRECATED	Whether or not the brush has a UTexture resource
	FLinearColor	Tint_DEPRECATED	Tinting applied to the image.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel