TextureCube.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 "TextureCube.generated.h"
 
class FTextureResource;
 
UCLASS(hidecategories=Object, MinimalAPI)
class UTextureCube : public UTexture
{
    GENERATED_UCLASS_BODY()
 
    
    FTexturePlatformData* PrivatePlatformData;
 
public:
    ENGINE_API void SetPlatformData(FTexturePlatformData* PlatformData);
    ENGINE_API FTexturePlatformData* GetPlatformData();
    ENGINE_API const FTexturePlatformData* GetPlatformData() const;
 
#if WITH_EDITOR
    TMap<FString, FTexturePlatformData*> CookedPlatformData;
#endif
 
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    virtual ~UTextureCube() {};
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    //~ Begin UObject Interface.
    ENGINE_API virtual void Serialize(FArchive& Ar) override;
    ENGINE_API virtual void PostLoad() override;
    ENGINE_API virtual void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const override;
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    ENGINE_API virtual void GetAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) const override;
    ENGINE_API virtual FString GetDesc() override;
    ENGINE_API virtual void GetResourceSizeEx(FResourceSizeEx& CumulativeResourceSize) override;
    ENGINE_API virtual bool NeedsLoadForTargetPlatform(const ITargetPlatform* TargetPlatform) const override;
    //~ End UObject Interface.
 
    ENGINE_API int32 GetSizeX() const;
    ENGINE_API int32 GetSizeY() const;
    ENGINE_API int32 GetNumMips() const;
    ENGINE_API EPixelFormat GetPixelFormat() const;
 
    ENGINE_API void GetMipData(int32 FirstMipToLoad, void** OutMipData);
    
    //~ Begin UTexture Interface
    virtual ETextureClass GetTextureClass() const override { return ETextureClass::Cube; }
    virtual float GetSurfaceWidth() const override { return (float)GetSizeX(); }
    virtual float GetSurfaceHeight() const override { return (float)GetSizeY(); }
    virtual float GetSurfaceDepth() const override { return 0; }
    virtual uint32 GetSurfaceArraySize() const override { return 6; }
    ENGINE_API virtual FTextureResource* CreateResource() override;
    ENGINE_API virtual void UpdateResourceWithParams(EUpdateResourceFlags InFlags) override;
    virtual EMaterialValueType GetMaterialType() const override { return MCT_TextureCube; }
    ENGINE_API virtual FTexturePlatformData** GetRunningPlatformData() override;
 
#if WITH_EDITOR
    ENGINE_API virtual bool IsDefaultTexture() const override;
    virtual TMap<FString, FTexturePlatformData*> *GetCookedPlatformData() override { return &CookedPlatformData; }
#endif
    //~ End UTexture Interface
 
    ENGINE_API static class UTextureCube* CreateTransient(int32 InSizeX, int32 InSizeY, EPixelFormat InFormat = PF_B8G8R8A8, const FName InName = NAME_None);
 
    uint32 CalcTextureMemorySize( int32 MipCount ) const;
 
    ENGINE_API virtual uint32 CalcTextureMemorySizeEnum( ETextureMipCount Enum ) const override;
 
#if WITH_EDITOR
    ENGINE_API virtual uint32 GetMaximumDimension() const override;
#endif
};