ResourceDataPool.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2020 BMW AG
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_RESOURCEDATAPOOL_H
#define RAMSES_RESOURCEDATAPOOL_H
 
#include "ramses-client-api/EDataType.h"
#include "ramses-client-api/MipLevelData.h"
#include "ramses-client-api/TextureEnums.h"
#include "ramses-client-api/TextureSwizzle.h"
 
#include "ramses-framework-api/RamsesFrameworkTypes.h"
 
#include <string>
 
namespace ramses
{
    class EffectDescription;
    class Resource;
    class Scene;
    class ResourceDataPoolImpl;
 
    class RAMSES_API ResourceDataPool
    {
    public:
        resourceId_t addArrayResourceData(
            EDataType type,
            uint32_t numElements,
            const void* arrayData,
            resourceCacheFlag_t cacheFlag = ResourceCacheFlag_DoNotCache,
            const char* name = nullptr);
 
        resourceId_t addTexture2DData(
            ETextureFormat format,
            uint32_t width,
            uint32_t height,
            uint32_t mipMapCount,
            const MipLevelData mipLevelData[],
            bool generateMipChain = false,
            const TextureSwizzle& swizzle = {},
            resourceCacheFlag_t cacheFlag = ResourceCacheFlag_DoNotCache,
            const char* name = nullptr);
 
        resourceId_t addTexture3DData(
            ETextureFormat format,
            uint32_t width,
            uint32_t height,
            uint32_t depth,
            uint32_t mipMapCount,
            const MipLevelData mipLevelData[],
            bool generateMipChain = false,
            resourceCacheFlag_t cacheFlag = ResourceCacheFlag_DoNotCache,
            const char* name = nullptr);
 
 
        resourceId_t addTextureCubeData(
            ETextureFormat format,
            uint32_t size,
            uint32_t mipMapCount,
            const CubeMipLevelData mipLevelData[],
            bool generateMipChain = false,
            const TextureSwizzle& swizzle = {},
            resourceCacheFlag_t cacheFlag = ResourceCacheFlag_DoNotCache,
            const char* name = nullptr);
 
        resourceId_t addEffectData(
            const EffectDescription& effectDesc,
            resourceCacheFlag_t cacheFlag = ResourceCacheFlag_DoNotCache,
            const char* name = nullptr);
 
        std::string getLastEffectErrorMessages() const;
 
        bool removeResourceData(resourceId_t const& id);
 
        bool addResourceDataFile(std::string const& filename);
 
        bool forceLoadResourcesFromResourceDataFile(std::string const& filename);
 
        bool removeResourceDataFile(std::string const& filename);
 
        Resource* createResourceForScene(Scene& scene, resourceId_t const& id);
 
        ResourceDataPoolImpl& impl;
 
    private:
 
        friend class RamsesClientImpl;
 
        explicit ResourceDataPool(ResourceDataPoolImpl& pimpl);
 
        ~ResourceDataPool();
    };
}
 
#endif