SlateShaderResource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Stats/Stats.h"
#include "SlateGlobals.h"
#include "Rendering/SlateRendererTypes.h"
#include "Rendering/SlateResourceHandle.h"
 
class FSlateShaderResourceProxy;
 
DECLARE_MEMORY_STAT_EXTERN(TEXT("Texture Data Memory (GPU)"), STAT_SlateTextureGPUMemory, STATGROUP_SlateMemory, SLATECORE_API);
 
namespace ESlateShaderResource
{
    enum Type
    {
        NativeTexture,
 
        TextureObject,
 
        Material,
 
        PostProcess, 
 
        Invalid,
    };
}
 
 
class FSlateShaderResource
{
public:
 
    virtual uint32 GetWidth() const = 0;
 
    virtual uint32 GetHeight() const = 0;
 
    virtual ESlateShaderResource::Type GetType() const = 0;
 
    virtual bool IsResourceValid() const { return true; };
 
    virtual ESlatePostRT GetUsedSlatePostBuffers() const { return ESlatePostRT::None; }
 
    virtual bool RequiresVirtualTextureFeedback() const { return false; }
 
#if SLATE_CHECK_UOBJECT_RENDER_RESOURCES
    virtual void CheckForStaleResources() const { }
    bool Debug_IsDestroyed() const { return DestroyState != 0x21; }
 
    virtual ~FSlateShaderResource() { DestroyState = 0x84; }
#else
    inline void CheckForStaleResources() const { }
    bool Debug_IsDestroyed() const { return false; }
 
    virtual ~FSlateShaderResource() = default;
#endif
 
 
#if SLATE_CHECK_UOBJECT_RENDER_RESOURCES
private:
    // Use an int, instead of a bool, to make sure the value is "exactly" what it's set in the destructor.
    uint8 DestroyState = 0x21;
#endif
};
 
class FSlateSharedHandleData
{
public:
    FSlateSharedHandleData( FSlateShaderResourceProxy* InProxy = nullptr )
        : Proxy( InProxy )
    {}
 
public:
    FSlateShaderResourceProxy* Proxy;
};
 
class FSlateShaderResourceProxy
{
public:
 
    FVector2f StartUV;
 
    FVector2f SizeUV;
 
    FSlateShaderResource* Resource;
 
    FIntPoint ActualSize;
 
    TSharedPtr<FSlateSharedHandleData> HandleData;
 
    FSlateShaderResourceProxy( )
        : StartUV(0.0f, 0.0f)
        , SizeUV(1.0f, 1.0f)
        , Resource(nullptr)
        , ActualSize(0, 0)
    { }
 
    ~FSlateShaderResourceProxy()
    {
        if( HandleData.IsValid() )
        {
            // Handles exist for this proxy.
            // Null out the proxy to invalidate all handles
            HandleData->Proxy = nullptr; 
        }
    }
};
 
 
template <typename ResourceType>
class TSlateTexture
    : public FSlateShaderResource
{
public:
 
    TSlateTexture( ) { }
 
    TSlateTexture( ResourceType& InShaderResource )
        : ShaderResource( InShaderResource )
    { }
 
    virtual ~TSlateTexture() { }
 
public:
 
    ResourceType& GetTypedResource()
    {
        return ShaderResource;
    }
 
public:
 
    // FSlateShaderResource interface
    virtual ESlateShaderResource::Type GetType() const override
    {
        return ESlateShaderResource::NativeTexture;
    }
 
protected:
 
    // Holds the resource.
    ResourceType ShaderResource;
};
 
class UE_DEPRECATED(5.5, "This is no longer used.") IViewportRenderTargetProvider
{
public:
    virtual FSlateShaderResource* GetViewportRenderTargetTexture() = 0;
};