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

#include <SlateDynamicImageBrush.h>

+ Inheritance diagram for FSlateDynamicImageBrush:

Public Member Functions

FORCENOINLINE FSlateDynamicImageBrush (class UTexture2D *InTexture, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FName InTextureName, const FLinearColor &InTint=FLinearColor(1.0f, 1.0f, 1.0f, 1.0f), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateDynamicImageBrush (class UTexture2DDynamic *InTexture, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FName InTextureName, const FLinearColor &InTint=FLinearColor(1.0f, 1.0f, 1.0f, 1.0f), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
FORCENOINLINE FSlateDynamicImageBrush (const FName InTextureName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const FLinearColor &InTint=FLinearColor(1.0f, 1.0f, 1.0f, 1.0f), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
SLATECORE_API void ReleaseResource ()
 
virtual SLATECORE_API ~FSlateDynamicImageBrush ()
 
- 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
 
- Public Member Functions inherited from TSharedFromThis< FSlateDynamicImageBrush >
TSharedRef< FSlateDynamicImageBrush, Mode > AsShared ()
 
TSharedRef< FSlateDynamicImageBrush const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< FSlateDynamicImageBrush, Mode > AsWeak ()
 
TWeakPtr< FSlateDynamicImageBrush const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Static Public Member Functions

static SLATECORE_API TSharedPtr< FSlateDynamicImageBrushCreateWithImageData (const FName InTextureName, const UE::Slate::FDeprecateVector2DParameter &InImageSize, const TArray< uint8 > &InImageData, const FLinearColor &InTint=FLinearColor(1.0f, 1.0f, 1.0f, 1.0f), ESlateBrushTileType::Type InTiling=ESlateBrushTileType::NoTile, ESlateBrushImageType::Type InImageType=ESlateBrushImageType::FullColor)
 
- Static Public Member Functions inherited from FSlateBrush
static SLATECORE_API const FString UTextureIdentifier ()
 

Additional Inherited Members

- 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 Member Functions inherited from TSharedFromThis< FSlateDynamicImageBrush >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 
- Static Protected Member Functions inherited from TSharedFromThis< FSlateDynamicImageBrush >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 
- 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

◆ FSlateDynamicImageBrush() [1/3]

FORCENOINLINE FSlateDynamicImageBrush::FSlateDynamicImageBrush ( class UTexture2D InTexture,
const UE::Slate::FDeprecateVector2DParameter InImageSize,
const FName  InTextureName,
const FLinearColor InTint = FLinearColor(1.0f, 1.0f, 1.0f, 1.0f),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InTextureThe UTexture2D being used for this brush.
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

◆ FSlateDynamicImageBrush() [2/3]

FORCENOINLINE FSlateDynamicImageBrush::FSlateDynamicImageBrush ( class UTexture2DDynamic InTexture,
const UE::Slate::FDeprecateVector2DParameter InImageSize,
const FName  InTextureName,
const FLinearColor InTint = FLinearColor(1.0f, 1.0f, 1.0f, 1.0f),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InTextureThe UTexture2DDynamic being used for this brush.
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

◆ FSlateDynamicImageBrush() [3/3]

FORCENOINLINE FSlateDynamicImageBrush::FSlateDynamicImageBrush ( const FName  InTextureName,
const UE::Slate::FDeprecateVector2DParameter InImageSize,
const FLinearColor InTint = FLinearColor(1.0f, 1.0f, 1.0f, 1.0f),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
inline
Parameters
InTextureNameThe name of the texture to load.
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

◆ ~FSlateDynamicImageBrush()

FSlateDynamicImageBrush::~FSlateDynamicImageBrush ( )
virtual

Destructor.

Member Function Documentation

◆ CreateWithImageData()

TSharedPtr< FSlateDynamicImageBrush > FSlateDynamicImageBrush::CreateWithImageData ( const FName  InTextureName,
const UE::Slate::FDeprecateVector2DParameter InImageSize,
const TArray< uint8 > &  InImageData,
const FLinearColor InTint = FLinearColor(1.0f, 1.0f, 1.0f, 1.0f),
ESlateBrushTileType::Type  InTiling = ESlateBrushTileType::NoTile,
ESlateBrushImageType::Type  InImageType = ESlateBrushImageType::FullColor 
)
static
Parameters
InTextureNameThe name to use when registering the image data as a texture.
InImageSizeHow large should the image be (not necessarily the image size on disk)
InImageDataThe raw image data formatted as BGRA
InTintThe tint of the image.
InTilingHow do we tile if at all?
InImageTypeThe type of image this this is

◆ ReleaseResource()

void FSlateDynamicImageBrush::ReleaseResource ( )

Releases the resource when it is safe to do so


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