Diligent Engine  v.2.4.g
DynamicBuffer.hpp
Go to the documentation of this file.
1 /*
2  * Copyright 2019-2021 Diligent Graphics LLC
3  * Copyright 2015-2019 Egor Yusov
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  * In no event and under no legal theory, whether in tort (including negligence),
18  * contract, or otherwise, unless required by applicable law (such as deliberate
19  * and grossly negligent acts) or agreed to in writing, shall any Contributor be
20  * liable for any damages, including any direct, indirect, special, incidental,
21  * or consequential damages of any character arising as a result of this License or
22  * out of the use or inability to use the software (including but not limited to damages
23  * for loss of goodwill, work stoppage, computer failure or malfunction, or any and
24  * all other commercial damages or losses), even if such Contributor has been advised
25  * of the possibility of such damages.
26  */
27 
28 #pragma once
29 
32 
33 #include "../../GraphicsEngine/interface/RenderDevice.h"
34 #include "../../GraphicsEngine/interface/DeviceContext.h"
35 #include "../../GraphicsEngine/interface/Buffer.h"
36 #include "../../../Common/interface/RefCntAutoPtr.hpp"
37 
38 namespace Diligent
39 {
40 
43 {
44 public:
46 
53  DynamicBuffer(IRenderDevice* pDevice, const BufferDesc& Desc);
54 
55  // clang-format off
56  DynamicBuffer (const DynamicBuffer&) = delete;
57  DynamicBuffer& operator=(const DynamicBuffer&) = delete;
58  DynamicBuffer ( DynamicBuffer&&) = delete;
60  // clang-format on
61 
62 
64 
87  IBuffer* Resize(IRenderDevice* pDevice,
88  IDeviceContext* pContext,
89  Uint32 NewSize);
90 
91 
93 
105  IBuffer* GetBuffer(IRenderDevice* pDevice,
106  IDeviceContext* pContext);
107 
108 
112  bool PendingUpdate() const
113  {
114  return (m_Desc.uiSizeInBytes > 0) && (!m_pBuffer || m_pStaleBuffer);
115  }
116 
117 
120  {
121  return m_Desc;
122  }
123 
124 
128  {
129  return m_Version;
130  }
131 
132 private:
133  void CommitResize(IRenderDevice* pDevice,
134  IDeviceContext* pContext);
135 
136  BufferDesc m_Desc;
137  const std::string m_Name;
138  Uint32 m_Version = 0;
139 
140  RefCntAutoPtr<IBuffer> m_pBuffer;
141  RefCntAutoPtr<IBuffer> m_pStaleBuffer;
142 };
143 
144 } // namespace Diligent
Diligent::DynamicBuffer::operator=
DynamicBuffer & operator=(const DynamicBuffer &)=delete
Diligent::BufferDesc::uiSizeInBytes
Uint32 uiSizeInBytes
Size of the buffer, in bytes. For a uniform buffer, this must be multiple of 16.
Definition: Buffer.h:77
Diligent::DynamicBuffer::DynamicBuffer
DynamicBuffer(IRenderDevice *pDevice, const BufferDesc &Desc)
Initialies the dynamic buffer.
Definition: DynamicBuffer.cpp:37
Diligent::DynamicBuffer::PendingUpdate
bool PendingUpdate() const
Returns true if the buffer buffer must be updated before use (e.g. it has been resized,...
Definition: DynamicBuffer.hpp:112
Diligent::IBuffer
Buffer interface.
Definition: Buffer.h:187
Diligent::IRenderDevice
Render device interface.
Definition: RenderDevice.h:75
Diligent::RefCntAutoPtr
Template class that implements reference counting.
Definition: RefCntAutoPtr.hpp:73
Diligent::Uint32
uint32_t Uint32
32-bit unsigned integer
Definition: BasicTypes.h:51
Diligent::BufferDesc
Buffer description.
Definition: Buffer.h:74
Diligent::DynamicBuffer
Dynamically resizable buffer.
Definition: DynamicBuffer.hpp:42
Diligent::DynamicBuffer::Resize
IBuffer * Resize(IRenderDevice *pDevice, IDeviceContext *pContext, Uint32 NewSize)
Resizes the buffer to the new size.
Definition: DynamicBuffer.cpp:68
Diligent::IDeviceContext
Device context interface.
Definition: DeviceContext.h:1460
Diligent::DynamicBuffer::GetBuffer
IBuffer * GetBuffer(IRenderDevice *pDevice, IDeviceContext *pContext)
Returns the pointer to the buffer object, initializing it if necessary.
Definition: DynamicBuffer.cpp:99
Diligent::DynamicBuffer::GetDesc
const BufferDesc & GetDesc()
Returns the buffer description.
Definition: DynamicBuffer.hpp:119
Diligent
The library uses Direct3D-style math:
Definition: AdvancedMath.hpp:37
Diligent::DynamicBuffer::GetVersion
Uint32 GetVersion() const
Returns dynamic buffer version. The version is incremented every time a new internal buffer is create...
Definition: DynamicBuffer.hpp:127