SlateDynamicImageBrush.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Margin.h"
#include "Styling/SlateBrush.h"
#include "Types/SlateVector2.h"
 
struct FSlateDynamicImageBrush
    : public FSlateBrush, public TSharedFromThis<FSlateDynamicImageBrush>
{
    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
    )
        : FSlateBrush(ESlateBrushDrawType::Image, FName(TEXT("None")), FMargin(0.0f), InTiling, InImageType, InImageSize, InTint, (UObject*)InTexture)
        , bRemoveResourceFromRootSet(false)
        , bIsInitalized(true)
    {
        bIsDynamicallyLoaded = true;
        InitFromTextureObject(InTextureName);
    }
 
    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
    )
        : FSlateBrush(ESlateBrushDrawType::Image, FName(TEXT("None")), FMargin(0.0f), InTiling, InImageType, InImageSize, InTint, (UObject*)InTexture)
        , bRemoveResourceFromRootSet(false)
        , bIsInitalized(true)
    {
        bIsDynamicallyLoaded = true;
        InitFromTextureObject(InTextureName);
    }
        
    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 )
        : FSlateBrush(ESlateBrushDrawType::Image, InTextureName, FMargin(0.0f), InTiling, InImageType, InImageSize, InTint, nullptr, true)
        , bRemoveResourceFromRootSet(false)
        , bIsInitalized(true)
    {
        bIsDynamicallyLoaded = true;
    }
 
    static SLATECORE_API TSharedPtr<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);
 
    SLATECORE_API void ReleaseResource();
 
    SLATECORE_API virtual ~FSlateDynamicImageBrush();
 
private:
    SLATECORE_API void ReleaseResourceInternal();
 
    void InitFromTextureObject(FName InTextureName)
    {
        UObject* Object = GetResourceObject();
        // if we have a texture, make a unique name
        if (Object != nullptr)
        {
            // @todo Slate - Hack:  This is to address an issue where the brush created and a GC occurs before the brush resource object becomes referenced
            // by the Slate resource manager. Don't add objects that are already in root set (and mark them as such) to avoid incorrect removing objects
            // from root set in destructor.
            if (!Object->IsRooted())
            {
                ensureMsgf(false, TEXT("This hack usually results in a crash during loading screens in slate.  Please change any code that arrives here to not use FSlateDynamicImageBrush.  In the case of loading screens, you can use FDeferredCleanupSlateBrush.  Which correctly accounts for both GC lifetime, and the lifetime of the object through the slate rendering pipeline which may be several frames after you stop using it."));
 
                Object->AddToRoot();
                bRemoveResourceFromRootSet = true;
            }
 
            ResourceName = InTextureName;
        }
    }
 
private:
    bool bRemoveResourceFromRootSet : 1;
 
    bool bIsInitalized : 1;
};