Buffer.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 "DeviceObject.h"

namespace Diligent
{

// {EC47EAD3-A2C4-44F2-81C5-5248D14F10E4}
static constexpr INTERFACE_ID IID_Buffer =
{ 0xec47ead3, 0xa2c4, 0x44f2, { 0x81, 0xc5, 0x52, 0x48, 0xd1, 0x4f, 0x10, 0xe4 } };


enum BUFFER_MODE : Int32
{
    BUFFER_MODE_UNDEFINED = 0,

    BUFFER_MODE_FORMATTED,

    BUFFER_MODE_STRUCTURED,

    BUFFER_MODE_NUM_MODES
};

struct BufferDesc : DeviceObjectAttribs
{
    Uint32 uiSizeInBytes;


    Uint32 BindFlags;

    USAGE Usage;

    Uint32 CPUAccessFlags;
    
    BUFFER_MODE Mode;

    struct BufferFormat
    {
        VALUE_TYPE ValueType;

        Uint32 NumComponents;

        Bool IsNormalized;


        BufferFormat() :
            ValueType( VT_UNDEFINED ),
            NumComponents( 0 ),
            IsNormalized(True)
        {}
        
        bool operator == (const BufferFormat& RHS)const
        {
            return ValueType     == RHS.ValueType && 
                   NumComponents == RHS.NumComponents &&
                   IsNormalized  == RHS.IsNormalized;
        }
    };


    BufferFormat Format;

    Uint32 ElementByteStride;


    BufferDesc() : 
        uiSizeInBytes(0),
        BindFlags(0),
        Usage(USAGE_DEFAULT),
        CPUAccessFlags(0),
        Mode( BUFFER_MODE_UNDEFINED ),
        ElementByteStride(0)
    {}



    bool operator == (const BufferDesc& RHS)const
    {
        return uiSizeInBytes     == RHS.uiSizeInBytes  && 
               BindFlags         == RHS.BindFlags      &&
               Usage             == RHS.Usage          &&
               CPUAccessFlags    == RHS.CPUAccessFlags &&
               Mode              == RHS.Mode           &&
               Format            == RHS.Format         &&
               ElementByteStride == RHS.ElementByteStride;
    }
};

struct BufferData
{
    const void* pData;

    Uint32 DataSize;


    BufferData() : 
        pData(nullptr),
        DataSize(0)
    {}
};


class IBuffer : public IDeviceObject
{
public:
    virtual void QueryInterface( const Diligent::INTERFACE_ID &IID, IObject **ppInterface ) = 0;

    virtual const BufferDesc& GetDesc()const = 0;
    

    virtual void UpdateData( class IDeviceContext *pContext, Uint32 Offset, Uint32 Size, const PVoid pData) = 0;


    virtual void CopyData( IDeviceContext *pContext, IBuffer *pSrcBuffer, Uint32 SrcOffset, Uint32 DstOffset, Uint32 Size ) = 0;
    

    virtual void Map( IDeviceContext *pContext, MAP_TYPE MapType, Uint32 MapFlags, PVoid &pMappedData ) = 0;

    virtual void Unmap( IDeviceContext *pContext, MAP_TYPE MapType, Uint32 MapFlags ) = 0;


    virtual void CreateView( const struct BufferViewDesc &ViewDesc, class IBufferView **ppView ) = 0;

    
    virtual IBufferView* GetDefaultView( BUFFER_VIEW_TYPE ViewType ) = 0;


    virtual void* GetNativeHandle() = 0;
};

}