Texture.h

// Texture.h
//
 
namespace nkGraphics
{
    enum class TEX_TYPE
    {
        TEX_2D = 0, 
        TEX_3D,     
        TEX_CUBEMAP 
    } ;
 
    enum class TEX_RENDER_FLAG
    {
        NO_RENDER = 0,      
        RENDER_TARGET,      
        DEPTH_RENDER_TARGET 
    } ;
}
    
namespace nkGraphics
{
    class Texture : public ShaderResource, public nkExport::Exportable
    {       
        public :
        
            virtual ~Texture () ;
 
            TextureCpuDataDescriptor* getCpuData () const ;
            unsigned int getCpuSliceCount () const ;
            bool isFromFile () const ;
            bool isGammaCorrected () const ;
            bool isBackBufferTex () const ;
            TEX_TYPE getTexType () const ;
            TEX_RENDER_FLAG getRenderFlag () const ;
            unsigned int getNeededMipsForSize () const ;
            virtual int getWidth () const = 0 ;
            virtual int getHeight () const = 0 ;
            virtual int getDepthOrArraySize () const = 0 ;
            virtual unsigned int getMipLevels () const = 0 ;
            virtual FORMAT getTextureFormat () const = 0 ;
            virtual BUFFER_CPU_ACCESS_FLAG getCpuAccessRights () const = 0 ;
            virtual BUFFER_USAGE getTextureUsage () const = 0 ;
            virtual BUFFER_BIND_FLAG getTextureBinding () const = 0 ;
            virtual RESOURCE_MISC_FLAG getMiscFlag () const = 0 ;
            virtual unsigned int getSampleCount () const = 0 ;
            virtual unsigned int getSampleQuality () const = 0 ;
            virtual bool getAutoMipGeneration () const = 0 ;
 
            // Setters
            void setCpuData (const ResourceCpuDataDescriptor& data) ;
            void addCpuDataSlice (const nkMemory::BufferView<>& data, unsigned int byteOffset = 0u, unsigned int rowByteSize = 0u, unsigned int sliceByteSize = 0u) ;
            void addCpuDataSliceCopy (const nkMemory::BufferView<>& data, unsigned int byteOffset = 0u, unsigned int rowByteSize = 0u, unsigned int sliceByteSize = 0u) ;
            void addCpuDataSliceForward (nkMemory::Buffer&& data, unsigned int byteOffset = 0u, unsigned int rowByteSize = 0u, unsigned int sliceByteSize = 0u) ;
            void addCpuDataSliceRelativeToLast (unsigned int byteOffset = 0u, unsigned int rowByteSize = 0u, unsigned int sliceByteSize = 0u) ;
            void setBackBufferTex (bool value) ;
            void setFromImage (const nkImages::ImageView& image) ;
            void setFromImageCopy (const nkImages::ImageView& image) ;
            void setFromImageForward (nkImages::Image&& image) ;
            virtual void freeCpuData () ;
            virtual void setGammaCorrected (bool value) ;
            virtual void setPath (nkMemory::StringView value) override ;
            virtual void setWidth (unsigned int width) = 0 ;
            virtual void setHeight (unsigned int height) = 0 ;
            virtual void setDepthOrArraySize (unsigned int depth) = 0 ;
            virtual void setMipLevels (unsigned int value) = 0 ;
            virtual void setTextureFormat (FORMAT format) = 0 ;
            virtual void setCpuAccessRights (BUFFER_CPU_ACCESS_FLAG rights) = 0 ;
            virtual void setTextureUsage (BUFFER_USAGE usage) = 0 ;
            virtual void setTextureBinding (BUFFER_BIND_FLAG binding) = 0 ;
            virtual void setAutoMipGeneration (bool value) = 0 ;
            virtual void copyParams (const Texture& other) = 0 ;
            void setTextureFormatFromString (nkMemory::StringView str) ;
 
            void setMightManuallyGenerateMip (bool value) ;
            virtual void prepareAsTexture2d () ;
            virtual void prepareAsCubemap () ;
            virtual void prepareAsTexture3d () ;
            virtual void setRenderFlag (TEX_RENDER_FLAG value) ;
            virtual void generateMipChain (unsigned int fromMip = 0) = 0 ;
            
            nkImages::Image convertToImage (int mip, int sliceOrArrayIndex) ;
            virtual MapResult map (const MapRequestDescriptor& requestDesc) = 0 ;
            virtual void unmap (const UnmapRequestDescriptor& requestDesc) = 0 ;
            virtual void gpuCopyFrom (Texture& other, const ResourceGpuCopyDescriptor& descriptor) = 0 ;
 
            // Import / Export
            virtual void exportClassToTree (nkExport::Node* rootNode) override ;
            virtual void importClassFromTree (nkExport::Node* rootNode) override ;
 
        public :
 
            // Statics
            static nkMemory::UniquePtr<Texture> create (System* system = nullptr) ;
    } ;
}