/*     Copyright 2019 Diligent Graphics LLC
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 *  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 OF ANY PROPRIETARY RIGHTS.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#pragma once

#include "BaseInterfacesGL.h"
#include "TextureGL.h"
#include "TextureBase.h"
#include "RenderDevice.h"
#include "GLObjectWrapper.h"
#include "TextureViewGLImpl.h"
#include "AsyncWritableResource.h"
#include "RenderDeviceGLImpl.h"

namespace Diligent
{

class FixedBlockMemoryAllocator;

/// Base implementation of a texture object in OpenGL backend.
class TextureBaseGL : public TextureBase<ITextureGL, RenderDeviceGLImpl, TextureViewGLImpl, FixedBlockMemoryAllocator>, public AsyncWritableResource
{
public:
    using TTextureBase = TextureBase<ITextureGL, RenderDeviceGLImpl, TextureViewGLImpl, FixedBlockMemoryAllocator>;
    using ViewImplType = TextureViewGLImpl;

    TextureBaseGL(IReferenceCounters*        pRefCounters,
                  FixedBlockMemoryAllocator& TexViewObjAllocator,
                  RenderDeviceGLImpl*        pDeviceGL,
                  const TextureDesc&         TexDesc,
                  GLenum                     BindTarget,
                  const TextureData*         pInitData         = nullptr,
                  bool                       bIsDeviceInternal = false);

    TextureBaseGL(IReferenceCounters*        pRefCounters,
                  FixedBlockMemoryAllocator& TexViewObjAllocator,
                  RenderDeviceGLImpl*        pDeviceGL,
                  GLContextState&            GLState,
                  const TextureDesc&         TexDesc,
                  GLuint                     GLTextureHandle,
                  GLenum                     BindTarget,
                  bool                       bIsDeviceInternal);

    /// Initializes a dummy texture (dummy textures are used by the swap chain to
    /// proxy default framebuffer).
    TextureBaseGL(IReferenceCounters*        pRefCounters,
                  FixedBlockMemoryAllocator& TexViewObjAllocator,
                  RenderDeviceGLImpl*        pDeviceGL,
                  const TextureDesc&         TexDesc,
                  bool                       bIsDeviceInternal);

    ~TextureBaseGL();

    virtual void QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override;

    const GLObjectWrappers::GLTextureObj& GetGLHandle() const { return m_GlTexture; }

    /// Implementation of ITextureGL::GetBindTarget().
    virtual GLenum GetBindTarget() const override final { return m_BindTarget; }

    GLenum GetGLTexFormat() const { return m_GLTexFormat; }

    void TextureMemoryBarrier(Uint32 RequiredBarriers, class GLContextState& GLContextState);

    virtual void AttachToFramebuffer(const struct TextureViewDesc& ViewDesc, GLenum AttachmentPoint) = 0;

    void CopyData(DeviceContextGLImpl* pDeviceCtxGL,
                  TextureBaseGL*       pSrcTextureGL,
                  Uint32               SrcMipLevel,
                  Uint32               SrcSlice,
                  const Box*           pSrcBox,
                  Uint32               DstMipLevel,
                  Uint32               DstSlice,
                  Uint32               DstX,
                  Uint32               DstY,
                  Uint32               DstZ);

    /// Implementation of ITextureGL::GetGLTextureHandle().
    virtual GLuint GetGLTextureHandle() override final { return GetGLHandle(); }

    /// Implementation of ITexture::GetNativeHandle() in OpenGL backend.
    virtual void* GetNativeHandle() override final
    {
        return reinterpret_cast<void*>(static_cast<size_t>(GetGLTextureHandle()));
    }

    virtual void UpdateData(class GLContextState&    CtxState,
                            Uint32                   MipLevel,
                            Uint32                   Slice,
                            const Box&               DstBox,
                            const TextureSubResData& SubresData) = 0;

protected:
    virtual void CreateViewInternal(const struct TextureViewDesc& ViewDesc,
                                    class ITextureView**          ppView,
                                    bool                          bIsDefaultView) override;

    void SetDefaultGLParameters();

    GLObjectWrappers::GLTextureObj m_GlTexture;
    const GLenum                   m_BindTarget;
    const GLenum                   m_GLTexFormat;
    //Uint32 m_uiMapTarget;
};

} // namespace Diligent
