Texture.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_TEXTURE_H_
#define DVD_TEXTURE_H_
 
#include "Core/Resources/Headers/Resource.h"
#include "Platform/Video/Headers/TextureData.h"
#include "Platform/Video/Headers/DescriptorSets.h"
 
#include "Platform/Video/Headers/GraphicsResource.h"
#include "Platform/Video/Textures/Headers/TextureDescriptor.h"
 
#include "Utility/Headers/ImageTools.h"
 
namespace Divide
{
 
class Kernel;
class ResourceCache;
 
namespace Attorney
{
    class TextureKernel;
};
 
namespace TypeUtil
{
    [[nodiscard]] const char* WrapModeToString( TextureWrap wrapMode ) noexcept;
    [[nodiscard]] TextureWrap StringToWrapMode( const string& wrapMode );
 
    [[nodiscard]] const char* TextureFilterToString( TextureFilter filter ) noexcept;
    [[nodiscard]] TextureFilter StringToTextureFilter( const string& filter );
 
    [[nodiscard]] const char* TextureMipSamplingToString( TextureMipSampling sampling ) noexcept;
    [[nodiscard]] TextureMipSampling StringToTextureMipSampling( const string& sampling );
};
 
class Texture;
 
struct TextureLayoutChange
{
    ImageView _targetView;
    ImageUsage _sourceLayout{ ImageUsage::COUNT };
    ImageUsage _targetLayout{ ImageUsage::COUNT };
};
 
using TextureLayoutChanges = eastl::fixed_vector<TextureLayoutChange, 6, true>;
 
[[nodiscard]] bool IsEmpty( const TextureLayoutChanges& changes ) noexcept;
 
class NOINITVTABLE Texture : public CachedResource, public GraphicsResource
{
    friend class ResourceCache;
    friend struct ResourceLoader;
    template <typename T>
    friend class ImplResourceLoader;
    friend class Attorney::TextureKernel;
 
    public:
        explicit Texture( PlatformContext& context, const ResourceDescriptor<Texture>& descriptor );
 
        virtual ~Texture() override;
 
        static void OnStartup( GFXDevice& gfx );
        static void OnShutdown() noexcept;
        [[nodiscard]] static bool UseTextureDDSCache() noexcept;
        [[nodiscard]] static Handle<Texture> DefaultTexture2D() noexcept;
        [[nodiscard]] static Handle<Texture> DefaultTexture2DArray() noexcept;
        [[nodiscard]] static const SamplerDescriptor DefaultSampler() noexcept;
        [[nodiscard]] static U8 GetBytesPerPixel( GFXDataFormat format, GFXImageFormat baseFormat, GFXImagePacking packing ) noexcept;
 
        void createWithData( const ImageTools::ImageData& imageData, const PixelAlignment& pixelUnpackAlignment );
        void createWithData( const Byte* data, size_t dataSize, const vec2<U16>& dimensions, const PixelAlignment& pixelUnpackAlignment );
        void createWithData( const Byte* data, size_t dataSize, const vec3<U16>& dimensions, const PixelAlignment& pixelUnpackAlignment );
 
        void replaceData(const Byte* data, size_t dataSize, const vec3<U16>& offset, const vec3<U16>& range, const PixelAlignment& pixelUnpackAlignment );
 
        void setSampleCount( U8 newSampleCount );
 
        [[nodiscard]] ImageView getView() const noexcept;
        [[nodiscard]] ImageView getView( TextureType targetType ) const noexcept;
        [[nodiscard]] ImageView getView( SubRange mipRange ) const noexcept;
        [[nodiscard]] ImageView getView( SubRange mipRange, SubRange layerRange ) const noexcept;
        [[nodiscard]] ImageView getView( TextureType targetType, SubRange mipRange ) const noexcept;
        [[nodiscard]] ImageView getView( TextureType targetType, SubRange mipRange, SubRange layerRange/*offset, count*/ ) const noexcept;
 
        [[nodiscard]] virtual ImageReadbackData readData( U8 mipLevel, const PixelAlignment& pixelPackAlignment) const = 0;
 
        PROPERTY_R( TextureDescriptor, descriptor );
        PROPERTY_R( U16, mipCount, 1u );
        PROPERTY_R( U16, width, 0u );
        PROPERTY_R( U16, height, 0u );
        PROPERTY_R( U16, depth, 1u );
        PROPERTY_R( bool, hasTranslucency, false );
        PROPERTY_R( bool, hasTransparency, false );
        PROPERTY_R( bool, loadedFromFile, false );
        [[nodiscard]] U8 numChannels() const noexcept;
 
        bool load( PlatformContext& context ) override;
        bool postLoad() override;
     protected:
        bool loadFile( const ResourcePath& path, std::string_view name, ImageTools::ImageData& fileData );
        bool checkTransparency( const ResourcePath& path, std::string_view name, ImageTools::ImageData& fileData );
        bool loadInternal();
 
        void validateDescriptor();
 
        virtual void loadDataInternal( const ImageTools::ImageData& imageData, const vec3<U16>& offset, const PixelAlignment& pixelUnpackAlignment ) = 0;
        virtual void loadDataInternal( const Byte* data, size_t size, U8 targetMip, const vec3<U16>& offset, const vec3<U16>& dimensions, const PixelAlignment& pixelUnpackAlignment ) = 0;
        virtual void prepareTextureData( U16 width, U16 height, U16 depth, bool emptyAllocation );
        virtual void submitTextureData();
 
    protected:
        static bool s_useDDSCache;
        static SamplerDescriptor s_defaultSampler;
        static Handle<Texture> s_defaultTexture2D;
        static Handle<Texture> s_defaultTexture2DArray;
        static Str<64> s_missingTextureFileName;
};
 
namespace Attorney
{
    class TextureKernel
    {
        protected:
        static void UseTextureDDSCache( const bool state ) noexcept
        {
            Texture::s_useDDSCache = state;
        }
 
        friend class Divide::Kernel;
    };
}
 
};  // namespace Divide
#endif // DVD_TEXTURE_H_