Texture2D.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/ThreadSafeCounter.h"
#include "ImageCoreBP.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
#include "Engine/Texture.h"
#include "Engine/TextureAllMipDataProviderFactory.h"
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_6
#include "Serialization/BulkData.h"
#endif
 
#include "Texture2D.generated.h"
 
class FTexture2DResourceMem;
class FTexture2DResource;
struct FTexture2DMipMap;
struct FUpdateTextureRegion2D;
 
UCLASS(hidecategories=Object, MinimalAPI, BlueprintType)
class UTexture2D : public UTexture
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UPROPERTY()
    int32 FirstResourceMemMip;
 
public:
#if WITH_EDITOR
    ENGINE_API FIntPoint GetImportedSize() const;
#else // #if WITH_EDITOR
    inline FIntPoint GetImportedSize() const
    {
        return ImportedSize;
    }
#endif // #if WITH_EDITOR
 
private:
    UPROPERTY(transient)
    uint8 bTemporarilyDisableStreaming:1;
 
public:
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    uint8 bHasBeenPaintedInEditor:1;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Texture, meta=(DisplayName="X-axis Tiling Method"), AssetRegistrySearchable, AdvancedDisplay)
    TEnumAsByte<enum TextureAddress> AddressX;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Texture, meta=(DisplayName="Y-axis Tiling Method"), AssetRegistrySearchable, AdvancedDisplay)
    TEnumAsByte<enum TextureAddress> AddressY;
 
private:
    UPROPERTY()
    FIntPoint ImportedSize;
 
    FTexturePlatformData* PrivatePlatformData;
 
public:
 
    ENGINE_API void SetPlatformData(FTexturePlatformData* PlatformData);
    ENGINE_API FTexturePlatformData* GetPlatformData();
    ENGINE_API const FTexturePlatformData* GetPlatformData() const;
 
    UTextureAllMipDataProviderFactory* GetAllMipProvider() const
    {
        return const_cast<UTexture2D*>(this)->GetAssetUserData<UTextureAllMipDataProviderFactory>();
    }
 
#if WITH_EDITOR
    /* cooked platform data for this texture */
    TMap<FString, FTexturePlatformData*> CookedPlatformData;
#endif
 
    FTexture2DResourceMem*      ResourceMem;
 
protected:
 
    friend class FTexture2DUpdate;
 
public:
 
    //~ Begin UObject Interface.
    virtual void Serialize(FArchive& Ar) override;  
#if WITH_EDITOR
    virtual void PostLinkerChange() override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual bool IsDefaultTexture() const override;
#endif // WITH_EDITOR
    virtual void BeginDestroy() override;
    virtual bool IsReadyForAsyncPostLoad() const override;
    virtual void PostLoad() override;
    virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override;
#if WITH_EDITOR
    virtual void OnCookEvent(UE::Cook::ECookEvent CookEvent, UE::Cook::FCookEventContext& CookContext) override;
#endif
    virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
    virtual FString GetDesc() override;
    //~ End UObject Interface.
 
    //~ Begin UTexture Interface.
    virtual ETextureClass GetTextureClass() const override { return ETextureClass::TwoD; }
    virtual float GetSurfaceWidth() const override { return static_cast<float>(GetSizeX()); }
    virtual float GetSurfaceHeight() const override { return static_cast<float>(GetSizeY()); }
    virtual float GetSurfaceDepth() const override { return 0.0f; }
    virtual uint32 GetSurfaceArraySize() const override { return 0; }
    virtual TextureAddress GetTextureAddressX() const override { return AddressX; }
    virtual TextureAddress GetTextureAddressY() const override { return AddressY; }
    virtual FTextureResource* CreateResource() override;
    virtual EMaterialValueType GetMaterialType() const override;
    virtual void UpdateResourceWithParams(EUpdateResourceFlags InFlags) override;
    virtual float GetAverageBrightness(bool bIgnoreTrueBlack, bool bUseGrayscale) override;
    virtual FTexturePlatformData** GetRunningPlatformData() final override;
#if WITH_EDITOR
    virtual TMap<FString,FTexturePlatformData*>* GetCookedPlatformData() override { return &CookedPlatformData; }
#endif
    //~ End UTexture Interface.
 
    //~ Begin UStreamableRenderAsset Interface
    virtual int32 CalcCumulativeLODSize(int32 NumLODs) const final override { return CalcTextureMemorySize(NumLODs); }
    ENGINE_API int32 GetNumResidentMips() const;
    ENGINE_API virtual bool StreamOut(int32 NewMipCount) final override;
    ENGINE_API virtual bool StreamIn(int32 NewMipCount, bool bHighPrio) final override;
    //~ End UStreamableRenderAsset Interface
 
    ENGINE_API int32 GetSizeX() const;
    ENGINE_API int32 GetSizeY() const;
    ENGINE_API int32 GetNumMips() const;
    ENGINE_API EPixelFormat GetPixelFormat(uint32 LayerIndex = 0u) const;
    ENGINE_API int32 GetMipTailBaseIndex() const;
    ENGINE_API const TIndirectArray<FTexture2DMipMap>& GetPlatformMips() const;
    ENGINE_API int32 GetExtData() const;
 
 
 
    ENGINE_API int32 GetNumMipsAllowed(bool bIgnoreMinResidency) const;
 
public:
    inline int32 GetMinTextureResidentMipCount() const
    {
        return FMath::Max(GMinTextureResidentMipCount, GetPlatformData() ? (int32)GetPlatformData()->GetNumMipsInTail() : 0);
    }
 
    ENGINE_API void GetMipData(int32 FirstMipToLoad, void** OutMipData);
 
    virtual bool GetInitialMipData(int32 InFirstMipToLoad, TArrayView<void*> OutMipData, TArrayView<int64> OutMipSize);
 
    int32 CalcTextureMemorySize( int32 MipCount ) const;
 
    virtual uint32 CalcTextureMemorySizeEnum( ETextureMipCount Enum ) const override;
 
    ENGINE_API bool GetSourceArtCRC(uint32& OutSourceCRC);
 
    ENGINE_API bool HasSameSourceArt(UTexture2D* InTexture);
    
    ENGINE_API bool HasAlphaChannel() const;
 
    virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
 
    ENGINE_API static float GetGlobalMipMapLODBias();
 
    bool GetResourceMemSettings(int32 FirstMipIdx, int32& OutSizeX, int32& OutSizeY, int32& OutNumMips, uint32& OutTexCreateFlags);
 
    ENGINE_API void UpdateTextureRegions(int32 MipIndex, uint32 NumRegions, const FUpdateTextureRegion2D* Regions, uint32 SrcPitch, uint32 SrcBpp, uint8* SrcData, TFunction<void(uint8* SrcData, const FUpdateTextureRegion2D* Regions)> DataCleanupFunc = [](uint8*, const FUpdateTextureRegion2D*){});
 
#if WITH_EDITOR
    
    ENGINE_API void TemporarilyDisableStreaming();
 
    virtual void PostEditUndo() override;
 
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
    UPROPERTY();
    TObjectPtr<UTexture2D> CPUCopyTexture;
 
    ENGINE_API UTexture2D* GetCPUCopyTexture();
 
    virtual bool AreDownscalePropertiesEditable() const override { return MipGenSettings == TMGS_NoMipmaps || MipGenSettings == TMGS_FromTextureGroup; }
#endif
 
    friend struct FRenderAssetStreamingManager;
    friend struct FStreamingRenderAsset;
    
    ENGINE_API static class UTexture2D* CreateTransient(int32 InSizeX, int32 InSizeY, EPixelFormat InFormat = PF_B8G8R8A8, const FName InName = NAME_None, TConstArrayView64<uint8> InImageData = TConstArrayView64<uint8>());
 
    ENGINE_API static class UTexture2D* CreateTransientFromImage(const FImage* InImage, const FName InName = NAME_None);
 
    ENGINE_API FSharedImageConstRef GetCPUCopy() const;
 
    UFUNCTION(BlueprintCallable, meta=(DisplayName = "GetCPUCopy"), Category = "Rendering|Texture")
    FSharedImageConstRefBlueprint Blueprint_GetCPUCopy() const;
 
 
    UFUNCTION(BlueprintCallable, meta=(DisplayName = "GetSizeX"), Category="Rendering|Texture")
    int32 Blueprint_GetSizeX() const;
 
    UFUNCTION(BlueprintCallable, meta=(DisplayName = "GetSizeY"), Category="Rendering|Texture")
    int32 Blueprint_GetSizeY() const;
 
    virtual void RefreshSamplerStates();
 
    virtual bool IsCurrentlyVirtualTextured() const override;
 
    virtual bool IsVirtualTexturedWithContinuousUpdate() const { return false; }
 
    virtual bool IsVirtualTexturedWithSinglePhysicalSpace() const { return false;  }
 
    virtual bool IsVirtualTexturedWithSinglePhysicalPool() const { return false; }
};