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

#include <SlateBoxBrush.h>

+ Inheritance diagram for FSlateBoxBrush:

Public Member Functions

FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const WIDECHAR *InImageName, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const TCHAR *InImageName, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const TCHAR *InImageName, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const WIDECHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FLinearColor &InColorAndOpacity=FLinearColor(1, 1, 1, 1), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const TCHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const TSharedRef< FLinearColor > &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (const TCHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &ImageSize, const FMargin &InMargin, const FSlateColor &InColorAndOpacity, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (UObject *InResourceObject, const FMargin &InMargin, const FSlateColor &InColorAndOpacity=FSlateColor(FLinearColor(1, 1, 1, 1)), ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateBoxBrush (UObject *InResourceObject, const UE::Slate::FDeprecateVector2DParameter &ImageSize, 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

A 3x3 box where the sides stretch horizontally and vertically and the middle stretches to fill. The corners will not be stretched. The size of the sides and corners is determined by the Margin as follows:

            _____________________
           |  | Margin.Top    |  |
           |__|_______________|__|   Margin.Right
           |  |               |  |  /
         +--> |               | <--+
        /  |__|_______________|__|

Margin.Left | | Margin.Bottom | | |__|_______________|__|

Constructor & Destructor Documentation

◆ FSlateBoxBrush() [1/26]

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

Make a 3x3 box that stretches the texture.

Parameters
InImageNameThe name of image to make into a box
InMarginThe size of corners and sides in normalized texture UV space.
InColorAndOpacityColor and opacity scale.

◆ FSlateBoxBrush() [2/26]

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

◆ FSlateBoxBrush() [3/26]

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

◆ FSlateBoxBrush() [4/26]

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

◆ FSlateBoxBrush() [5/26]

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

◆ FSlateBoxBrush() [6/26]

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

◆ FSlateBoxBrush() [7/26]

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

◆ FSlateBoxBrush() [8/26]

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

◆ FSlateBoxBrush() [9/26]

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

◆ FSlateBoxBrush() [10/26]

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

◆ FSlateBoxBrush() [11/26]

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

◆ FSlateBoxBrush() [12/26]

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

◆ FSlateBoxBrush() [13/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FName InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

Make a 3x3 box that stretches the texture.

Parameters
InImageNameThe name of image to make into a box
ImageSizeThe size of the resource as we want it to appear in slate units.
InMarginThe size of corners and sides in texture space.
InColorAndOpacityColor and opacity scale. Note of the image type is ImageType_TintMask, this value should be in HSV

◆ FSlateBoxBrush() [14/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [15/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const ANSICHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [16/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const WIDECHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FLinearColor InColorAndOpacity = FLinearColor(1,1,1,1),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [17/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FName InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [18/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [19/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const ANSICHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [20/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const TCHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const TSharedRef< FLinearColor > &  InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [21/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FName InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [22/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [23/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const ANSICHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [24/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( const TCHAR InImageName,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FSlateColor InColorAndOpacity,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateBoxBrush() [25/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( UObject InResourceObject,
const FMargin InMargin,
const FSlateColor InColorAndOpacity = FSlateColor(FLinearColor(1, 1, 1, 1)),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

Make a 3x3 box that stretches the texture.

Parameters
InResourceObjectThe image to render for this brush, can be a UTexture, UMaterialInterface, or AtlasedTextureInterface
InMarginThe size of corners and sides in normalized texture UV space.
InColorAndOpacityColor and opacity scale.

◆ FSlateBoxBrush() [26/26]

FORCENOINLINE FSlateBoxBrush::FSlateBoxBrush ( UObject InResourceObject,
const UE::Slate::FDeprecateVector2DParameter ImageSize,
const FMargin InMargin,
const FSlateColor InColorAndOpacity = FSlateColor(FLinearColor(1, 1, 1, 1)),
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

Make a 3x3 box that stretches the texture.

Parameters
InImageNameThe name of image to make into a box
ImageSizeThe size of the resource as we want it to appear in slate units.
InMarginThe size of corners and sides in texture space.
InColorAndOpacityColor and opacity scale. Note of the image type is ImageType_TintMask, this value should be in HSV

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