UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
FSlateImageBrush Struct Reference

#include <SlateImageBrush.h>

+ Inheritance diagram for FSlateImageBrush:

Public Member Functions

FORCENOINLINE FSlateImageBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor(1, 1, 1, 1), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor(1, 1, 1, 1), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor(1, 1, 1, 1), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const WIDECHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor(1, 1, 1, 1), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TSharedRef< FLinearColor > &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TSharedRef< FLinearColor > &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TSharedRef< FLinearColor > &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const TCHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TSharedRef< FLinearColor > &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const FName &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const FString &InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const ANSICHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (const TCHAR *InImageName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint, ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateImageBrush (UObject *InResourceObject, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FSlateColor &InTint=FSlateColor(FLinearColor(1, 1, 1, 1)), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, 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 FMargin & GetMargin () const
 
ESlateBrushTileType::Type GetTiling () const
 
ESlateBrushMirrorType::Type GetMirroring () const
 
ESlateBrushImageType::Type GetImageType () const
 
ESlateBrushDrawType::Type GetDrawType () const
 
const FName GetResourceName () const
 
class UObject * GetResourceObject () 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 FSlateResourceHandle & GetRenderingResource (UE::Slate::FDeprecateVector2DParameter LocalSize, float DrawScale) const
 
SLATECORE_API const FSlateResourceHandle & GetRenderingResource () 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::Type > DrawAs
 
TEnumAsByte< enum ESlateBrushTileType::Type > Tiling
 
TEnumAsByte< enum ESlateBrushMirrorType::Type > Mirroring
 
TEnumAsByte< enum ESlateBrushImageType::Type > ImageType
 
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

Ignores the Margin. Just renders the image. Can tile the image instead of stretching.

Constructor & Destructor Documentation

◆ FSlateImageBrush() [1/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FName &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FLinearColor &  InTint = FLinearColor(1,1,1,1),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InImageNameThe name of the texture to draw
InImageSizeHow large should the image be (not necessarily the image size on disk)
InTintThe tint of the image.
InTilingHow do we tile if at all?
InImageTypeThe type of image this this is

◆ FSlateImageBrush() [2/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FLinearColor &  InTint = FLinearColor(1,1,1,1),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [3/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const ANSICHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FLinearColor &  InTint = FLinearColor(1,1,1,1),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [4/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const WIDECHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FLinearColor &  InTint = FLinearColor(1,1,1,1),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [5/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FName &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const TSharedRef< FLinearColor > &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [6/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const TSharedRef< FLinearColor > &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [7/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const ANSICHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const TSharedRef< FLinearColor > &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [8/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const TCHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const TSharedRef< FLinearColor > &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [9/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FName &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FSlateColor &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [10/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const FString &  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FSlateColor &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [11/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const ANSICHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FSlateColor &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [12/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( const TCHAR *  InImageName,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FSlateColor &  InTint,
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline

◆ FSlateImageBrush() [13/13]

FORCENOINLINE FSlateImageBrush::FSlateImageBrush ( UObject *  InResourceObject,
const UE::Slate::FDeprecateVector2DParameter &  InImageSize,
const FSlateColor &  InTint = FSlateColor(FLinearColor(1, 1, 1, 1)),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InResourceObjectThe image to render for this brush, can be a UTexture, UMaterialInterface, or AtlasedTextureInterface
InImageSizeHow large should the image be (not necessarily the image size on disk)
InTintThe tint of the image.
InTilingHow do we tile if at all?
InImageTypeThe type of image this this is
The documentation for this struct was generated from the following file: