TextureRenderTarget2D.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "RenderUtils.h"
#include "Engine/TextureRenderTarget.h"
#include "TextureRenderTarget2D.generated.h"
 
class FTextureResource;
class UTexture2D;
struct FPropertyChangedEvent;
 
extern ENGINE_API int32 GTextureRenderTarget2DMaxSizeX;
extern ENGINE_API int32 GTextureRenderTarget2DMaxSizeY;
 
UENUM(BlueprintType)
enum ETextureRenderTargetFormat : int
{
    RTF_R8,
    RTF_RG8,
    RTF_RGBA8,
    RTF_RGBA8_SRGB,
    RTF_R16f,
    RTF_RG16f,
    RTF_RGBA16f,
    RTF_R32f,
    RTF_RG32f,
    RTF_RGBA32f,
    RTF_RGB10A2
};
 
inline EPixelFormat GetPixelFormatFromRenderTargetFormat(ETextureRenderTargetFormat RTFormat)
{
    switch (RTFormat)
    {
    case RTF_R8: return PF_G8;
    case RTF_RG8: return PF_R8G8;
    case RTF_RGBA8: return PF_B8G8R8A8;
    case RTF_RGBA8_SRGB: return PF_B8G8R8A8;
 
    case RTF_R16f: return PF_R16F;
    case RTF_RG16f: return PF_G16R16F;
    case RTF_RGBA16f: return PF_FloatRGBA;
 
    case RTF_R32f: return PF_R32_FLOAT;
    case RTF_RG32f: return PF_G32R32F;
    case RTF_RGBA32f: return PF_A32B32G32R32F;
    case RTF_RGB10A2: return PF_A2B10G10R10;
    }
 
    ensureMsgf(false, TEXT("Unhandled ETextureRenderTargetFormat entry %u"), (uint32)RTFormat);
    return PF_Unknown;
}
 
UENUM(BlueprintType)
enum class ETextureRenderTargetSampleCount : uint8
{
    RTSC_1 UMETA(DisplayName = "MSAAx1"),
    RTSC_2 UMETA(DisplayName = "MSAAx2"),
    RTSC_4 UMETA(DisplayName = "MSAAx4"),
    RTSC_8 UMETA(DisplayName = "MSAAx8"),
 
    RTSC_MAX,
};
 
inline int32 GetNumFromRenderTargetSampleCount(ETextureRenderTargetSampleCount InSampleCount)
{
    switch (InSampleCount)
    {
    case ETextureRenderTargetSampleCount::RTSC_1: return 1 << 0;
    case ETextureRenderTargetSampleCount::RTSC_2: return 1 << 1;
    case ETextureRenderTargetSampleCount::RTSC_4: return 1 << 2;
    case ETextureRenderTargetSampleCount::RTSC_8: return 1 << 3;
 
    default:
        ensureMsgf(false, TEXT("Unhandled ETextureRenderTargetSampleCount entry %u"), (uint32)InSampleCount);
        return 1;
    }
}
 
UCLASS(hidecategories=Object, hidecategories=Texture, hidecategories=Compression, hidecategories=Adjustments, hidecategories=Compositing, MinimalAPI)
class UTextureRenderTarget2D : public UTextureRenderTarget
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTarget2D, AssetRegistrySearchable)
    int32 SizeX;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTarget2D, AssetRegistrySearchable)
    int32 SizeY;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D)
    FLinearColor ClearColor;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=TextureRenderTarget2D, AssetRegistrySearchable)
    TEnumAsByte<enum TextureAddress> AddressX;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=TextureRenderTarget2D, AssetRegistrySearchable)
    TEnumAsByte<enum TextureAddress> AddressY;
 
    UPROPERTY()
    uint8 bForceLinearGamma:1;
 
    uint8 bNoFastClear:1;
 
    UPROPERTY()
    uint8 bHDR_DEPRECATED:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, meta=(DisplayName = "Shared"), AssetRegistrySearchable, AdvancedDisplay)
    uint8 bGPUSharedFlag : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTarget2D, AssetRegistrySearchable)
    TEnumAsByte<ETextureRenderTargetFormat> RenderTargetFormat;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, AssetRegistrySearchable)
    uint8 bSupportsUAV : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, AssetRegistrySearchable)
    uint8 bAutoGenerateMips : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, AssetRegistrySearchable, meta = (editcondition = "bAutoGenerateMips"))
    TEnumAsByte<enum TextureFilter> MipsSamplerFilter;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, AssetRegistrySearchable, meta = (editcondition = "bAutoGenerateMips"))
    TEnumAsByte<enum TextureAddress> MipsAddressU;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = TextureRenderTarget2D, AssetRegistrySearchable, meta = (editcondition = "bAutoGenerateMips"))
    TEnumAsByte<enum TextureAddress> MipsAddressV;
 
    UPROPERTY()
    TEnumAsByte<enum EPixelFormat> OverrideFormat;
 
    ENGINE_API void InitCustomFormat(uint32 InSizeX, uint32 InSizeY, EPixelFormat InOverrideFormat, bool bInForceLinearGamma);
 
    ENGINE_API void InitAutoFormat(uint32 InSizeX, uint32 InSizeY);
 
    ENGINE_API void ResizeTarget(uint32 InSizeX, uint32 InSizeY);
 
    ENGINE_API UTexture2D* ConstructTexture2D(UObject* InOuter, const FString& InNewTextureName, EObjectFlags InObjectFlags, uint32 InFlags = CTF_Default, TArray<uint8>* InAlphaOverride = nullptr);
    
    UE_DEPRECATED(5.4, "Use CanConvertToTexture")
    ENGINE_API ETextureSourceFormat GetTextureFormatForConversionToTexture2D() const;
 
    //~ Begin UTextureRenderTarget Interface
    ENGINE_API virtual bool CanConvertToTexture(ETextureSourceFormat& OutTextureSourceFormat, EPixelFormat& OutPixelFormat, FText* OutErrorMessage) const override;
    ENGINE_API virtual TSubclassOf<UTexture> GetTextureUClass() const override;
    ENGINE_API virtual EPixelFormat GetFormat() const override;
    ENGINE_API virtual bool IsSRGB() const override;
    ENGINE_API virtual float GetDisplayGamma() const override;
    virtual ETextureClass GetRenderTargetTextureClass() const override { return ETextureClass::TwoD; }
    //~ End UTextureRenderTarget Interface
 
    UE_DEPRECATED(5.4, "Use URenderTarget::UpdateTexture")
    ENGINE_API void UpdateTexture2D(UTexture2D* InTexture2D, ETextureSourceFormat InTextureFormat, uint32 Flags = CTF_Default, TArray<uint8>* AlphaOverride = nullptr);
 
    UE_DEPRECATED(5.4, "Use URenderTarget::FOnTextureChangingDelegate")
    DECLARE_DELEGATE_OneParam(FTextureChangingDelegate, UTexture2D*);
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    UE_DEPRECATED(5.4, "Use URenderTarget::UpdateTexture")
    ENGINE_API void UpdateTexture2D(UTexture2D* InTexture2D, ETextureSourceFormat InTextureFormat, uint32 Flags, TArray<uint8>* AlphaOverride, FTextureChangingDelegate TextureChangingDelegate);
PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    ENGINE_API void UpdateResourceImmediate(bool bClearRenderTarget=true);
 
    //~ Begin UTexture Interface.
    virtual float GetSurfaceWidth() const override { return (float)SizeX; }
    virtual float GetSurfaceHeight() const override { return (float)SizeY; }
    virtual float GetSurfaceDepth() const override { return 0; }
    virtual uint32 GetSurfaceArraySize() const override { return 0; }
    ENGINE_API virtual FTextureResource* CreateResource() override;
    ENGINE_API virtual EMaterialValueType GetMaterialType() const override;
    virtual uint32 CalcTextureMemorySizeEnum(ETextureMipCount Enum) const override;
    //~ End UTexture Interface.
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
    ENGINE_API virtual FString GetDesc() override;
    //~ End UObject Interface
 
    inline int32 GetNumMips() const
    {
        return NumMips;
    }
 
    virtual ETextureRenderTargetSampleCount GetSampleCount() const;
 
private:
    int32   NumMips;
};