ResourceArray.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Serialization/MemoryLayout.h"
 
struct FResourceArrayUploadInterface
{
    virtual ~FResourceArrayUploadInterface() {}
 
    [[nodiscard]] virtual const void* GetResourceData() const = 0;
 
    [[nodiscard]] virtual uint32 GetResourceDataSize() const = 0;
 
    template<typename TElement>
    TConstArrayView<TElement> GetResourceDataView() const
    {
        return TConstArrayView<TElement>(reinterpret_cast<const TElement*>(GetResourceData()), GetResourceDataSize());
    }
 
    virtual void Discard() = 0;
};
 
struct FResourceArrayUploadArrayView : public FResourceArrayUploadInterface
{
    const void* const Data;
    const uint32 SizeInBytes;
 
    FResourceArrayUploadArrayView() = delete;
 
    [[nodiscard]] explicit FResourceArrayUploadArrayView(const void* InData, uint32 InSizeInBytes)
        : Data(InData)
        , SizeInBytes(InSizeInBytes)
    {
    }
 
    template<typename ElementType>
    [[nodiscard]] explicit FResourceArrayUploadArrayView(TConstArrayView<ElementType> View)
        : Data(View.GetData())
        , SizeInBytes(View.Num() * View.GetTypeSize())
    {
    }
 
    template<typename ElementType, typename AllocatorType>
    [[nodiscard]] explicit FResourceArrayUploadArrayView(const TArray<ElementType, AllocatorType>& InArray)
        : FResourceArrayUploadArrayView(MakeArrayView(InArray))
    {
    }
 
    // FResourceArrayUploadInterface
    [[nodiscard]] virtual const void* GetResourceData() const final
    {
        return Data;
    }
 
    [[nodiscard]] virtual uint32 GetResourceDataSize() const final
    {
        return SizeInBytes;
    }
 
    virtual void Discard() final
    {
        // do nothing
    }
};
 
class FResourceArrayInterface : public FResourceArrayUploadInterface
{
    DECLARE_EXPORTED_TYPE_LAYOUT(FResourceArrayInterface, CORE_API, Abstract);
public:
 
    [[nodiscard]] virtual bool IsStatic() const = 0;
 
    [[nodiscard]] virtual bool GetAllowCPUAccess() const = 0;
 
    virtual void SetAllowCPUAccess( bool bInNeedsCPUAccess ) = 0;
};
 
 
class FResourceBulkDataInterface
{
public:
 
    virtual ~FResourceBulkDataInterface() {}
 
    [[nodiscard]] virtual const void* GetResourceBulkData() const = 0;
 
    [[nodiscard]] virtual uint32 GetResourceBulkDataSize() const = 0;
 
    template<typename TElement>
    [[nodiscard]] TConstArrayView<TElement> GetBulkDataView() const
    {
        return TConstArrayView<TElement>(reinterpret_cast<const TElement*>(GetResourceBulkData()), GetResourceBulkDataSize());
    }
 
    virtual void Discard() = 0;
};
 
struct FResourceBulkDataArrayView : public FResourceBulkDataInterface
{
    const void* const Data;
    const uint32 SizeInBytes;
 
    FResourceBulkDataArrayView() = delete;
 
    [[nodiscard]] explicit FResourceBulkDataArrayView(const void* InData, uint32 InSizeInBytes)
        : Data(InData)
        , SizeInBytes(InSizeInBytes)
    {
    }
 
    template<typename ElementType>
    [[nodiscard]] explicit FResourceBulkDataArrayView(TConstArrayView<ElementType> View)
        : Data(View.GetData())
        , SizeInBytes(View.Num()* View.GetTypeSize())
    {
    }
 
    template<typename ElementType, typename AllocatorType>
    [[nodiscard]] explicit FResourceBulkDataArrayView(const TArray<ElementType, AllocatorType>& InArray)
        : FResourceBulkDataArrayView(MakeArrayView(InArray))
    {
    }
 
    // FResourceArrayUploadInterface
    [[nodiscard]] virtual const void* GetResourceBulkData() const final
    {
        return Data;
    }
 
    [[nodiscard]] virtual uint32 GetResourceBulkDataSize() const final
    {
        return SizeInBytes;
    }
 
    virtual void Discard() final
    {
        // do nothing
    }
};
 
 
class FTexture2DResourceMem : public FResourceBulkDataInterface
{
public:
 
    [[nodiscard]] virtual void* GetMipData(int32 MipIdx) = 0;
 
    [[nodiscard]] virtual int32 GetNumMips() = 0;
 
    [[nodiscard]] virtual int32 GetSizeX() = 0;
 
    [[nodiscard]] virtual int32 GetSizeY() = 0;
 
    [[nodiscard]] virtual bool IsValid() = 0;
 
    [[nodiscard]] virtual bool HasAsyncAllocationCompleted() const = 0;
 
    virtual void FinishAsyncAllocation() = 0;
 
    virtual void CancelAsyncAllocation() = 0;
 
    virtual ~FTexture2DResourceMem() {}
};