Buffer.h

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 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
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  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
 
// clang-format off
 
 
#include "DeviceObject.h"
#include "BufferView.h"
 
DILIGENT_BEGIN_NAMESPACE(Diligent)
 
 
// {EC47EAD3-A2C4-44F2-81C5-5248D14F10E4}
static const INTERFACE_ID IID_Buffer =
    {0xec47ead3, 0xa2c4, 0x44f2, {0x81, 0xc5, 0x52, 0x48, 0xd1, 0x4f, 0x10, 0xe4}};
 
 
DILIGENT_TYPED_ENUM(BUFFER_MODE, Uint8)
{
    BUFFER_MODE_UNDEFINED = 0,
 
    BUFFER_MODE_FORMATTED,
 
    BUFFER_MODE_STRUCTURED,
 
    BUFFER_MODE_RAW,
 
    BUFFER_MODE_NUM_MODES
};
 
struct BufferDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
    Uint32 uiSizeInBytes            DEFAULT_INITIALIZER(0);
 
 
    BIND_FLAGS BindFlags            DEFAULT_INITIALIZER(BIND_NONE);
 
    USAGE Usage                     DEFAULT_INITIALIZER(USAGE_DEFAULT);
 
    CPU_ACCESS_FLAGS CPUAccessFlags DEFAULT_INITIALIZER(CPU_ACCESS_NONE);
    
    BUFFER_MODE Mode                DEFAULT_INITIALIZER(BUFFER_MODE_UNDEFINED);
 
 
    Uint32 ElementByteStride        DEFAULT_INITIALIZER(0);
 
    Uint64 CommandQueueMask         DEFAULT_INITIALIZER(1);
 
#if DILIGENT_CPP_INTERFACE
    // We have to explicitly define constructors because otherwise the following initialization fails on Apple's clang:
    //      BufferDesc{1024, BIND_UNIFORM_BUFFER, USAGE_DEFAULT}
 
    BufferDesc()noexcept{}
 
    BufferDesc(Uint32           _uiSizeInBytes, 
               BIND_FLAGS       _BindFlags,
               USAGE            _Usage             = BufferDesc{}.Usage,
               CPU_ACCESS_FLAGS _CPUAccessFlags    = BufferDesc{}.CPUAccessFlags,
               BUFFER_MODE      _Mode              = BufferDesc{}.Mode,
               Uint32           _ElementByteStride = BufferDesc{}.ElementByteStride,
               Uint64           _CommandQueueMask  = BufferDesc{}.CommandQueueMask) noexcept :
        uiSizeInBytes       {_uiSizeInBytes    },
        BindFlags           {_BindFlags        },
        Usage               {_Usage            },
        CPUAccessFlags      {_CPUAccessFlags   },
        Mode                {_Mode             },
        ElementByteStride   {_ElementByteStride},
        CommandQueueMask    {_CommandQueueMask }
    {
    }
 
 
    bool operator == (const BufferDesc& RHS)const
    {
        return uiSizeInBytes     == RHS.uiSizeInBytes     && 
               BindFlags         == RHS.BindFlags         &&
               Usage             == RHS.Usage             &&
               CPUAccessFlags    == RHS.CPUAccessFlags    &&
               Mode              == RHS.Mode              &&
               ElementByteStride == RHS.ElementByteStride && 
               CommandQueueMask  == RHS.CommandQueueMask;
    }
#endif
};
typedef struct BufferDesc BufferDesc;
 
struct BufferData
{
    const void* pData DEFAULT_INITIALIZER(nullptr);
 
    Uint32 DataSize   DEFAULT_INITIALIZER(0);
 
 
#if DILIGENT_CPP_INTERFACE
 
    BufferData() noexcept {}
 
    BufferData(const void* _pData,
               Uint32      _DataSize) :
        pData   {_pData   },
        DataSize{_DataSize}
    {}
#endif
};
typedef struct BufferData BufferData;
 
#define DILIGENT_INTERFACE_NAME IBuffer
#include "../../../Primitives/interface/DefineInterfaceHelperMacros.h"
 
#define IBufferInclusiveMethods     \
    IDeviceObjectInclusiveMethods;  \
    IBufferMethods Buffer
 
 
DILIGENT_BEGIN_INTERFACE(IBuffer, IDeviceObject)
{
#if DILIGENT_CPP_INTERFACE
    virtual const BufferDesc& METHOD(GetDesc)() const override = 0;
#endif
 
 
    VIRTUAL void METHOD(CreateView)(THIS_
                                    const BufferViewDesc REF ViewDesc,
                                    IBufferView** ppView) PURE;
 
 
    VIRTUAL  IBufferView* METHOD(GetDefaultView)(THIS_
                                                 BUFFER_VIEW_TYPE ViewType) PURE;
 
 
    VIRTUAL void* METHOD(GetNativeHandle)(THIS) PURE;
 
 
    VIRTUAL void METHOD(SetState)(THIS_
                                  RESOURCE_STATE State) PURE;
 
    VIRTUAL RESOURCE_STATE METHOD(GetState)(THIS) CONST PURE;
};
DILIGENT_END_INTERFACE
 
#include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
#if DILIGENT_C_INTERFACE
 
// clang-format off
 
#    define IBuffer_GetDesc(This) (const struct BufferDesc*)IDeviceObject_GetDesc(This)
 
#    define IBuffer_CreateView(This, ...)     CALL_IFACE_METHOD(Buffer, CreateView,      This, __VA_ARGS__)
#    define IBuffer_GetDefaultView(This, ...) CALL_IFACE_METHOD(Buffer, GetDefaultView,  This, __VA_ARGS__)
#    define IBuffer_GetNativeHandle(This)     CALL_IFACE_METHOD(Buffer, GetNativeHandle, This)
#    define IBuffer_SetState(This, ...)       CALL_IFACE_METHOD(Buffer, SetState,        This, __VA_ARGS__)
#    define IBuffer_GetState(This)            CALL_IFACE_METHOD(Buffer, GetState,        This)
 
// clang-format on
 
#endif
 
DILIGENT_END_NAMESPACE // namespace Diligent