UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlateBorderBrush Struct Reference

#include <SlateBorderBrush.h>

+ Inheritance diagram for FSlateBorderBrush:

Public Member Functions

FORCENOINLINE FSlateBorderBrush (const FName &InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const FString &InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const WIDECHAR *InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const FName &InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const FString &InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const TCHAR *InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const FName &InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const FString &InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (const TCHAR *InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBorderBrush (UObject *InResourceObject, const FMargin &InMargin, const FSlateColor &InColorAndOpacity=FSlateColor(FLinearColor(1, 1, 1, 1)), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
- Public Member Functions inherited from FSlateBrush
SLATECORE_API FSlateBrush ()
 
virtual ~FSlateBrush ()
 
UE::Slate::FDeprecateVector2DResult GetImageSize () const
 
void SetImageSize (UE::Slate::FDeprecateVector2DParameter InImageSize)
 
const FMarginGetMargin () const
 
ESlateBrushTileType::Type GetTiling () const
 
ESlateBrushMirrorType::Type GetMirroring () const
 
ESlateBrushImageType::Type GetImageType () const
 
ESlateBrushDrawType::Type GetDrawType () const
 
const FName GetResourceName () const
 
class UObjectGetResourceObject () const
 
SLATECORE_API void SetResourceObject (class UObject *InResourceObject)
 
FLinearColor GetTint (const FWidgetStyle &InWidgetStyle) const
 
void UnlinkColors ()
 
bool HasUObject () const
 
bool IsDynamicallyLoaded () const
 
UE::Slate::FDeprecateBox2D GetUVRegion () const
 
void SetUVRegion (const FBox2d &InUVRegion)
 
void SetUVRegion (const FBox2f &InUVRegion)
 
bool operator== (const FSlateBrush &Other) const
 
bool operator!= (const FSlateBrush &Other) const
 
void AddReferencedObjects (FReferenceCollector &Collector, UObject *ReferencingObject=nullptr)
 
const FSlateResourceHandleGetRenderingResource (UE::Slate::FDeprecateVector2DParameter LocalSize, float DrawScale) const
 
SLATECORE_API const FSlateResourceHandleGetRenderingResource () const
 
bool IsSet () const
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateBrush
static SLATECORE_API const FString UTextureIdentifier ()
 
- Public Attributes inherited from FSlateBrush
FSlateColor TintColor
 
TEnumAsByte< enum ESlateBrushDrawType::TypeDrawAs
 
TEnumAsByte< enum ESlateBrushTileType::TypeTiling
 
TEnumAsByte< enum ESlateBrushMirrorType::TypeMirroring
 
TEnumAsByte< enum ESlateBrushImageType::TypeImageType
 
FDeprecateSlateVector2D ImageSize
 
FMargin Margin
 
FSlateBrushOutlineSettings OutlineSettings
 
FSlateResourceHandle ResourceHandle
 
- Protected Member Functions inherited from FSlateBrush
SLATECORE_API FORCENOINLINE FSlateBrush (ESlateBrushDrawType::Type InDrawType, const FName InResourceName, const FMargin &InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageType, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor::White, UObject *InObjectResource=nullptr, bool bInDynamicallyLoaded=false)
 
SLATECORE_API FORCENOINLINE FSlateBrush (ESlateBrushDrawType::Type InDrawType, const FName InResourceName, const FMargin &InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageType, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TSharedRef< FLinearColor > &InTint, UObject *InObjectResource=nullptr, bool bInDynamicallyLoaded=false)
 
SLATECORE_API FORCENOINLINE FSlateBrush (ESlateBrushDrawType::Type InDrawType, const FName InResourceName, const FMargin &InMargin, ESlateBrushTileType::Type InTiling, ESlateBrushImageType::Type InImageType, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint, UObject *InObjectResource=nullptr, bool bInDynamicallyLoaded=false)
 
- Protected Attributes inherited from FSlateBrush
FBox2f UVRegion
 
uint8 bIsDynamicallyLoaded:1
 
uint8 bHasUObject_DEPRECATED:1
 
uint8 bIsSet: 1
 
FName ResourceName
 

Detailed Description

Similar to FSlateBoxBrush but has no middle and the sides tile instead of stretching. The margin is applied exactly as in FSlateBoxBrush.

Constructor & Destructor Documentation

◆ FSlateBorderBrush() [1/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FName InImageName,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InImageNameThe name of the texture to draw
InMarginDetermines the sides and corner sizes; see FSlateBoxBrush.
InColorAndOpacityColor and opacity scale.
InImageTypeThe type of image this this is

◆ FSlateBorderBrush() [2/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FString &  InImageName,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [3/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const ANSICHAR InImageName,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [4/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const WIDECHAR InImageName,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [5/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FName InImageName,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [6/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FString &  InImageName,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [7/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const ANSICHAR InImageName,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [8/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const TCHAR InImageName,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [9/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FName InImageName,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [10/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const FString &  InImageName,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [11/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const ANSICHAR InImageName,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [12/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( const TCHAR InImageName,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBorderBrush() [13/13]

FORCENOINLINE FSlateBorderBrush::FSlateBorderBrush ( UObject InResourceObject,
const FMargin InMargin,
const FSlateColor InColorAndOpacity = FSlateColor(FLinearColor(1, 1, 1, 1)),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InResourceObjectThe image to render for this brush, can be a UTexture, UMaterialInterface, or AtlasedTextureInterface
InMarginDetermines the sides and corner sizes; see FSlateBoxBrush.
InColorAndOpacityColor and opacity scale.
InImageTypeThe type of image this this is

The documentation for this struct was generated from the following file: