Model::LoadStaticBuffers to use static VB/IB instead of dynamic #38
Conversation
| @@ -53,10 +53,14 @@ namespace DirectX | |||
| uint32_t vertexOffset; | |||
| uint32_t vertexStride; | |||
| uint32_t vertexCount; | |||
| uint32_t indexBufferSize; | |||
There was a problem hiding this comment.
For simplicity, I require these values both be populated if you are using either dynamic or static VB/IB. It's a breaking change for custom loaders and renderers, but an easy one to resolve.
Inc/Model.h
Outdated
| _In_opt_z_ const wchar_t* texturesPath = nullptr, | ||
| D3D12_DESCRIPTOR_HEAP_FLAGS flags = D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE) const; | ||
|
|
||
| // Load VB/IB resources for static geometry | ||
| void __cdecl LoadBuffers( |
There was a problem hiding this comment.
This is the new method on Model that you can call to optimize your content.
| _In_ uint32_t numSubresources); | ||
| uint32_t numSubresources); | ||
|
|
||
| void __cdecl Upload( |
There was a problem hiding this comment.
To support this, I modified ResourceUploadBatch to have an overload that will take data from a SharedGraphicsResource.
| @@ -49,15 +52,33 @@ ModelMeshPart::~ModelMeshPart() | |||
| _Use_decl_annotations_ | |||
| void ModelMeshPart::Draw(_In_ ID3D12GraphicsCommandList* commandList) const | |||
| { | |||
| if (!indexBufferSize || !vertexBufferSize) | |||
There was a problem hiding this comment.
This validation will ensure that developers moving to the new version won't get silent failures...
Src/Model.cpp
Outdated
| @@ -208,6 +229,135 @@ std::unique_ptr<EffectTextureFactory> Model::LoadTextures( | |||
| } | |||
|
|
|||
|
|
|||
| // Load VB/IB resources for static geometry | |||
| _Use_decl_annotations_ | |||
| void Model::LoadBuffers( | |||
There was a problem hiding this comment.
This is the algorithm which converts a Model using dynamic VB/IB to static VB/IB. If you pass keepMemory = true (it defaults to false) I will keep the original vertexBuffer and indexBuffer members set as well as setting the staticVertexBuffer and staticIndexBuffer values. The rendering will only use the static versions if both are set.
A usage scenario for
keepMemoryis that if you need the VB/IB data for other purposes (DirectX Raytracing or CPU collision/picking) you can keep the data in the upload heap for subsequent operations as well as have an optimized static buffer.
| @@ -549,12 +549,14 @@ std::unique_ptr<Model> DirectX::Model::CreateFromSDKMESH(const uint8_t* meshData | |||
| // Vertex data | |||
| auto verts = bufferData + (vh.DataOffset - bufferDataOffset); | |||
| auto vbytes = static_cast<size_t>(vh.SizeBytes); | |||
| part->vertexBufferSize = static_cast<uint32_t>(vh.SizeBytes); | |||
There was a problem hiding this comment.
Here I update the SDKMESH and VBO loaders for the minor breaking change
| uploadBatch->CommandList = mList; | ||
| uploadBatch->Fence = fence; | ||
| uploadBatch->GpuCompleteEvent = gpuCompletedEvent; | ||
| uploadBatch->TrackedObjects.insert(std::end(uploadBatch->TrackedObjects), std::begin(mTrackedObjects), std::end(mTrackedObjects)); | ||
| std::swap(mTrackedObjects, uploadBatch->TrackedObjects); |
There was a problem hiding this comment.
Looking at the logic here, it makes more sense to swap than it does to copy then reset...
| @@ -92,6 +92,9 @@ namespace DirectX | |||
|
|
|||
| explicit operator bool () const { return mSharedResource != nullptr; } | |||
|
|
|||
| bool operator == (const SharedGraphicsResource& other) const { return mSharedResource.get() == other.mSharedResource.get(); } | |||
There was a problem hiding this comment.
Note that comparison operators of std::shared_ptr have the same semantics...
walbourn
changed the title
In the original implementation, all Model vertex buffers and index buffers are allocated by
GraphicsMemory. This means that they are in a upload heap which is accessible to both the CPU and GPU, equivalent to the Direct3D 11 version ofUSAGE_DYNAMIC. This is simple and easy to use, but has performance impacts--which on Xbox One can be quite noticeable due to the caching behavior.This change adds an optional call to
LoadStaticBufferswhich uses aResourceUploadBatchto create static VB/IBs for rendering copying the data from the loadedGraphicsMemoryresources. This is equivalent toUSAGE_DEFAULTin Direct3D 11.The
ModelMeshPartnow contains four new members:staticVertexBuffer: If set, then this vertex buffer is used for rendering as the VB in the view. Otherwise it usesvertexBuffer.staticIndexBuffer: If set, then this index buffer is used for rendering as the IB in the view. Otherwise it usesindexBuffer.vertexBufferSize: The size of the VB for rendering set in the view.indexBufferSize: The size of the IB for rendering set in the view.There is a small breaking change here in that all custom Model loaders must populate the new
vertexBufferSizeandindexBufferSizemembers ofModelMeshPart.Custom Model renderers should be updated for all four new member variables.
To support this I added a new
Uploadmethod overload forResourceUploadBatch. The existingUploadmethod copies the data into a staging upload heap resource for use in the copy to the GPU, but here the data is already in an upload heap managed byGraphicsMemorywhich we can use directly.