TextureRenderTargetCube.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/TextureRenderTarget.h"
#include "TextureRenderTargetCube.generated.h"
 
class FTextureResource;
struct FPropertyChangedEvent;
 
UCLASS(hidecategories=Object, hidecategories=Texture, hidecategories=Compression, hidecategories=Adjustments, hidecategories=Compositing, MinimalAPI)
class UTextureRenderTargetCube : public UTextureRenderTarget
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=TextureRenderTargetCube, AssetRegistrySearchable)
    int32 SizeX;
 
    UPROPERTY()
    FLinearColor ClearColor;
 
    UPROPERTY()
    TEnumAsByte<enum EPixelFormat> OverrideFormat;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTargetCube, AssetRegistrySearchable)
    uint8 bHDR:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTargetCube, AssetRegistrySearchable)
    uint8 bSupportsUAV : 1;
 
    UPROPERTY()
    uint8 bForceLinearGamma:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTargetCube, AssetRegistrySearchable)
    uint8 bAutoGenerateMips : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=TextureRenderTargetCube, AssetRegistrySearchable, meta = (editcondition = "bAutoGenerateMips"))
    TEnumAsByte<enum TextureFilter> MipsSamplerFilter;
 
    ENGINE_API void Init(uint32 InSizeX, EPixelFormat InFormat);
 
    ENGINE_API void InitAutoFormat(uint32 InSizeX);
 
    ENGINE_API void UpdateResourceImmediate(bool bClearRenderTarget=true);
 
    ENGINE_API class UTextureCube* ConstructTextureCube(UObject* InOuter, const FString& InNewTextureName, EObjectFlags InObjectFlags, uint32 InFlags = CTF_Default, TArray<uint8>* InAlphaOverride = nullptr);
 
    //~ Begin UTexture Interface.
    virtual float GetSurfaceWidth() const  override { return static_cast<float>(SizeX); }
    // PVS-Studio notices that the implementation of GetSurfaceWidth is identical to this one
    // and warns us. In this case, it is intentional, so we disable the warning:
    virtual float GetSurfaceHeight()const  override { return static_cast<float>(SizeX); }    //-V524
    virtual float GetSurfaceDepth() const override { return 0.0f; }
    virtual uint32 GetSurfaceArraySize() const override { return 6; }
    virtual FTextureResource* CreateResource() override;
    virtual EMaterialValueType GetMaterialType() const override;
    //~ End UTexture Interface.
    
    inline int32 GetNumMips() const
    {
        return NumMips;
    }
    //~ Begin UObject Interface
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    virtual void PostLoad() override;
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
    virtual FString GetDesc() override;
    //~ End UObject Interface
 
    //~ Begin UTextureRenderTarget Interface
    virtual bool CanConvertToTexture(ETextureSourceFormat& OutTextureSourceFormat, EPixelFormat& OutPixelFormat, FText* OutErrorMessage) const override;
    virtual TSubclassOf<UTexture> GetTextureUClass() const override;
    virtual EPixelFormat GetFormat() const override;
    virtual bool IsSRGB() const override;
    virtual float GetDisplayGamma() const override;
    virtual ETextureClass GetRenderTargetTextureClass() const override { return ETextureClass::Cube; }
    //~ End UTextureRenderTarget Interface
 
private:
    int32   NumMips;
};