1. Epic GamesDeveloper
  3. FSlateBrush

FSlateBrush

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

Unreal Engine C++ API Reference > Runtime > SlateCore > Styling

Inheritance Hierarchy

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

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

Constructors

  Type Name Description
Public function   Default constructor.
Protected function  

FSlateBrush ( ESlateBrushDrawType::Type InDrawType,
const FName InResourceName,
const FMargin& InMargin,
ESlateBrushTileType::Type InTiling,
ESlateBrushImageType::Type InImageType,
const UE::Slate::FDeprecateVector2DParameter& InImageSize,
const FLinearColor& InTint,
UObject* InObjectResource,
bool bInDynamicallyLoaded
)

 This constructor is protected; use one of the deriving classes instead.
Protected function  

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,
bool bInDynamicallyLoaded
)

  
Protected function  

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,
bool bInDynamicallyLoaded
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddReferencedObjects ( FReferenceCollector& Collector,
UObject* ReferencingObject
)

 Report any references to UObjects to the reference collector.
Public function Const ESlateBrushDrawType::Type  
Public function Const UE::Slate::FDeprecateVector2DResult  
Public function Const ESlateBrushImageType::Type  
Public function Const const FMargin &  
Public function Const ESlateBrushMirrorType::Type  
Public function Const const FSlateResourceHandle &  
Public function Const const FSlateResourceHandle &  
Public function Const const FName Gets the name of the resource object, if any.
Public function Const UObject * Gets the UObject that represents the brush resource, if any.
Public function Const ESlateBrushTileType::Type  
Public function Const FLinearColor

GetTint ( const FWidgetStyle& InWidgetStyle
)

 Gets the brush's tint color.
Public function Const UE::Slate::FDeprecateBox2D Get brush UV region, should check if region is valid before using it
Public function Const bool Checks whether this brush has a UTexture object
Public function void  
Public function Const bool Checks whether the brush resource is loaded dynamically.
Public function Const bool

IsSet ()

  
Public function void  
Public function void

SetResourceObject ( UObject* InResourceObject
)

 Sets the UObject that represents the brush resource.
Public function void

SetUVRegion ( const FBox2d& InUVRegion
)

 Set brush UV region
Public function void

SetUVRegion ( const FBox2f& InUVRegion
)

  
Public function void Unlinks all colors in this brush.
Public function Static const FString Gets the identifier for UObject based texture paths.

Operators

  Type Name Description
Public function Const bool

operator!= ( const FSlateBrush& Other
)

 Compares this brush with another for inequality.
Public function Const bool

operator== ( const FSlateBrush& Other
)

 Compares this brush with another for equality.

Deprecated Variables

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page