BufferGLImpl.h

/*     Copyright 2015-2018 Egor Yusov
 *  
 *  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 "BufferGL.h"
#include "BufferBase.h"
#include "GLObjectWrapper.h"
#include "AsyncWritableResource.h"
#include "BaseInterfacesGL.h"
#include "BufferViewGLImpl.h"


namespace Diligent
{

class FixedBlockMemoryAllocator;

class BufferGLImpl : public BufferBase<IBufferGL, BufferViewGLImpl, FixedBlockMemoryAllocator>, public AsyncWritableResource
{
public:
    typedef BufferBase<IBufferGL, BufferViewGLImpl, FixedBlockMemoryAllocator> TBufferBase;

    BufferGLImpl(IReferenceCounters *pRefCounters, 
                 FixedBlockMemoryAllocator &BuffViewObjMemAllocator, 
                 class RenderDeviceGLImpl *pDeviceGL, 
                 const BufferDesc& BuffDesc, 
                 const BufferData& BuffData,
                 bool bIsDeviceInternal);
    BufferGLImpl(IReferenceCounters *pRefCounters, 
                 FixedBlockMemoryAllocator &BuffViewObjMemAllocator, 
                 class RenderDeviceGLImpl *pDeviceGL, 
                 const BufferDesc& BuffDesc, 
                 GLuint GLHandle,
                 bool bIsDeviceInternal);
    ~BufferGLImpl();
    
    virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface )override;

    virtual void UpdateData(IDeviceContext *pContext, Uint32 Offset, Uint32 Size, const PVoid pData)override;
    virtual void CopyData( IDeviceContext *pContext, IBuffer *pSrcBuffer, Uint32 SrcOffset, Uint32 DstOffset, Uint32 Size )override;
    virtual void Map( IDeviceContext *pContext, MAP_TYPE MapType, Uint32 MapFlags, PVoid &pMappedData )override;
    virtual void Unmap( IDeviceContext *pContext, MAP_TYPE MapType, Uint32 MapFlags )override;

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

    const GLObjectWrappers::GLBufferObj& GetGLHandle(){ return m_GlBuffer; }

    virtual GLuint GetGLBufferHandle()override final { return GetGLHandle(); }
    virtual void* GetNativeHandle()override final { return reinterpret_cast<void*>(static_cast<size_t>(GetGLBufferHandle())); }

private:
    virtual void CreateViewInternal( const struct BufferViewDesc &ViewDesc, class IBufferView **ppView, bool bIsDefaultView )override;

    friend class DeviceContextGLImpl;
    friend class VAOCache;

    GLObjectWrappers::GLBufferObj m_GlBuffer;
    Uint32 m_uiMapTarget;
    const GLenum m_GLUsageHint;
    const Bool m_bUseMapWriteDiscardBugWA;
};

}