TextureRenderTarget.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 "Engine/Texture.h"
#include "RenderUtils.h"
#include "TextureRenderTarget.generated.h"
 
enum EConstructTextureFlags : uint32;
 
UCLASS(abstract, MinimalAPI)
class UTextureRenderTarget : public UTexture
{
    GENERATED_UCLASS_BODY() 
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=TextureRenderTarget)
    float TargetGamma;
 
    uint32 bNeedsTwoCopies:1;
 
    uint32 bCanCreateUAV : 1;
 
    uint32 bTargetArraySlicesIndependently : 1;
 
    ENGINE_API class FTextureRenderTargetResource* GetRenderTargetResource();
 
    ENGINE_API class FTextureRenderTargetResource* GameThread_GetRenderTargetResource();
 
 
    //~ Begin UTexture Interface
    virtual ETextureClass GetTextureClass() const { return ETextureClass::RenderTarget; }
    ENGINE_API virtual class FTextureResource* CreateResource() override;
    ENGINE_API virtual EMaterialValueType GetMaterialType() const override;
    //~ End UTexture Interface
 
    virtual bool CanConvertToTexture(ETextureSourceFormat& OutTextureSourceFormat, EPixelFormat& OutPixelFormat, FText* OutErrorMessage = nullptr) const PURE_VIRTUAL(UTextureRenderTarget, return false;);
 
    ENGINE_API bool CanConvertToTexture(FText* OutErrorMessage = nullptr) const;
 
    virtual TSubclassOf<UTexture> GetTextureUClass() const PURE_VIRTUAL(GetTextureUClass, return nullptr;)
    // GetTextureClass() will just return "RenderTarget" ; to get the sub-type (2d/cube), use GetRenderTargetTextureClass
    virtual ETextureClass GetRenderTargetTextureClass() const PURE_VIRTUAL(GetRenderTargetTextureClass, return ETextureClass::Invalid;)
 
    virtual EPixelFormat GetFormat() const PURE_VIRTUAL(GetFormat,return PF_Unknown;)
    virtual bool IsSRGB() const PURE_VIRTUAL(IsSRGB,return false;)
    virtual float GetDisplayGamma() const PURE_VIRTUAL(GetDisplayGamma,return 0.f;)
 
    // UTextureRenderTarget default display gamma if none is set
    //  returns hard-coded 2.2
    ENGINE_API static float GetDefaultDisplayGamma();
 
    // get the variant of ReadPixels call that should be used
    //  either BGRA8,RGBA32F,or RGBA16F
    //  for FColor,FLinearColor, or Float16
    static ERawImageFormat::Type GetReadPixelsFormat(EPixelFormat PF,bool bIsVolume);
 
#if WITH_EDITOR
 
    using FOnTextureChangingDelegate = TFunctionRef<void(UTexture* /*InTexture*/)>;
    constexpr static auto OnTextureChangingDefault = [](UTexture*){};
    ENGINE_API bool UpdateTexture(UTexture* InTexture, EConstructTextureFlags InFlags = CTF_Default, const TArray<uint8>* InAlphaOverride = nullptr, FOnTextureChangingDelegate InOnTextureChangingDelegate = OnTextureChangingDefault, FText* OutErrorMessage = nullptr);
 
    ENGINE_API UTexture* ConstructTexture(UObject* InOuter, const FString& InNewTextureName, EObjectFlags InObjectFlags = RF_NoFlags, EConstructTextureFlags InFlags = CTF_Default, const TArray<uint8>* InAlphaOverride = nullptr, FText* OutErrorMessage = nullptr);
#endif // WITH_EDITOR
 
protected:
    ETextureSourceFormat ValidateTextureFormatForConversionToTextureInternal(EPixelFormat InFormat, const TArrayView<const EPixelFormat>& InCompatibleFormats, FText* OutErrorMessage) const;
};