# DX11 Writing a D3DX11Buffer to a file

This topic is 2471 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

## Recommended Posts

After creating a ID3DX11Buffer how can I write it to a file? And then how do I load it back? So I can create buffers at asset-built-time and then just load them at run-time.

##### Share on other sites
Umm, Google doesn't know what a "D3DX11Buffer" is...

Did you mean a ID3DXBuffer?

##### Share on other sites

Umm, Google doesn't know what a "D3DX11Buffer" is...

Did you mean a ID3DXBuffer?

Well I meant ID3DX11Buffer (ID3DXBuffer -> DX9 / ID3D11Buffer -> DX11 So they should be similar )

##### Share on other sites
Do you mean the standard ID3D11Buffer resource, or are you using some framework on top of D3D11?

In general, to read the contents of a buffer in D3D11, you need to use a staging buffer. This is more or less a buffer resource of the same size that is created with the staging usage flag. Then you copy the desired buffer to the staging buffer with ID3D11DeviceContext::CopyResource (or one of the other methods for copying resource memory). This staging buffer can then be mapped and written to file.

The process for writing from file to the resource depends on when you have the data from file. If you can read the file before creating the resource, then you can provide the initial data to the resource creation method directly. Otherwise, depending on the target usage of the buffer you can use update subresource, or use the staging buffer in the reverse order.

##### Share on other sites
Well since you can't CPU-Read from a static (default)/dynamic buffer, you have to create a second, staging-usage buffer where you map it, read the data, and then export the data to whatever format you're writing to. Then when you load said format up, you use that data as you normally would when initializing the buffer. Staging buffers can also be used the other way too, e.g. for a default-usage buffer that you may want to write data to after its been created.

Edit: Bah! Beaten to the punch

##### Share on other sites
1. Create a staging buffer with the same size
2. Copy to the staging buffer
3. Map the staging buffer to get a pointer to the buffer data
4. Write that data to a file using whatever file I/O classes/functions you're comfortable with

For any practical usage you'll probably want to also write some data indicating the size of the buffer, as well as other properties such as stride or format, the flags used to create it, etc. You'll probably want to do that before step 4, so that you have a little file header before the actual buffer data.

Reading it back in is just as easy. Read in your header data, use the header data to allocate enough memory to store the buffer data, read in the buffer data to that memory, then provide a pointer to that memory in the pSysMem pointer D3D11_SUBRESOURCE_DATA when creating the buffer with the size and flags specified by the header.

This is how I do it for my StructuredBuffer class:

 struct StructuredBuffer { ID3D11BufferPtr Buffer; ID3D11ShaderResourceViewPtr SRView; ID3D11UnorderedAccessViewPtr UAView; UINT Size; UINT Stride; UINT NumElements; StructuredBuffer(); void Initialize(ID3D11Device* device, UINT stride, UINT numElements, BOOL useAsUAV = false, BOOL appendConsume = false, BOOL useAsDrawIndirect = false, const void* initData = NULL); void WriteToFile(const WCHAR* path, ID3D11Device* device, ID3D11DeviceContext* context); void ReadFromFile(const WCHAR* path, ID3D11Device* device); }; StructuredBuffer::StructuredBuffer() : Size(0), Stride(0), NumElements(0) { } void StructuredBuffer::Initialize(ID3D11Device* device, UINT stride, UINT numElements, BOOL useAsUAV, BOOL appendConsume, BOOL useAsDrawIndirect, const void* initData) { Size = stride * numElements; Stride = stride; NumElements = numElements; if(appendConsume || useAsDrawIndirect) useAsUAV = true; D3D11_BUFFER_DESC bufferDesc; bufferDesc.ByteWidth = stride * numElements; bufferDesc.Usage = D3D11_USAGE_DEFAULT; bufferDesc.BindFlags = D3D11_BIND_SHADER_RESOURCE; bufferDesc.BindFlags |= useAsUAV ? D3D11_BIND_UNORDERED_ACCESS : 0; bufferDesc.CPUAccessFlags = 0; bufferDesc.MiscFlags = D3D11_RESOURCE_MISC_BUFFER_STRUCTURED; bufferDesc.MiscFlags |= useAsDrawIndirect ? D3D11_RESOURCE_MISC_DRAWINDIRECT_ARGS : 0; bufferDesc.StructureByteStride = stride; D3D11_SUBRESOURCE_DATA subresourceData; subresourceData.pSysMem = initData; subresourceData.SysMemPitch = 0; subresourceData.SysMemSlicePitch = 0; DXCall(device->CreateBuffer(&bufferDesc, initData != NULL ? &subresourceData : NULL, &Buffer)); D3D11_SHADER_RESOURCE_VIEW_DESC srvDesc; srvDesc.Format = DXGI_FORMAT_UNKNOWN; srvDesc.ViewDimension = D3D11_SRV_DIMENSION_BUFFER; srvDesc.Buffer.ElementOffset = 0; srvDesc.Buffer.ElementWidth = numElements; DXCall(device->CreateShaderResourceView(Buffer, &srvDesc, &SRView)); if(useAsUAV) { D3D11_UNORDERED_ACCESS_VIEW_DESC uavDesc; uavDesc.Format = DXGI_FORMAT_UNKNOWN; uavDesc.ViewDimension = D3D11_UAV_DIMENSION_BUFFER; uavDesc.Buffer.FirstElement = 0; uavDesc.Buffer.Flags = appendConsume ? D3D11_BUFFER_UAV_FLAG_APPEND : 0; uavDesc.Buffer.NumElements = numElements; DXCall(device->CreateUnorderedAccessView(Buffer, &uavDesc, &UAView)); } } void StructuredBuffer::WriteToFile(const WCHAR* path, ID3D11Device* device, ID3D11DeviceContext* context) { _ASSERT(Buffer != NULL); // Get the buffer info D3D11_BUFFER_DESC desc; Buffer->GetDesc(&desc); UINT32 useAsUAV = (desc.BindFlags & D3D11_BIND_UNORDERED_ACCESS) ? 1 : 0; UINT32 useAsDrawIndirect = (desc.MiscFlags & D3D11_RESOURCE_MISC_DRAWINDIRECT_ARGS) ? 1 : 0; UINT32 appendConsume = 0; if(useAsUAV) { D3D11_UNORDERED_ACCESS_VIEW_DESC uavDesc; UAView->GetDesc(&uavDesc); appendConsume = (uavDesc.Format & D3D11_BUFFER_UAV_FLAG_APPEND) ? 1 : 0; } // If the exists, delete it if(FileExists(path)) Win32Call(DeleteFile(path)); // Create the file HANDLE fileHandle = CreateFile(path, GENERIC_WRITE, 0, NULL, CREATE_NEW, FILE_ATTRIBUTE_NORMAL, NULL); if(fileHandle == INVALID_HANDLE_VALUE) Win32Call(false); // Write the buffer info DWORD bytesWritten = 0; Win32Call(WriteFile(fileHandle, &Size, 4, &bytesWritten, NULL)); Win32Call(WriteFile(fileHandle, &Stride, 4, &bytesWritten, NULL)); Win32Call(WriteFile(fileHandle, &NumElements, 4, &bytesWritten, NULL)); Win32Call(WriteFile(fileHandle, &useAsUAV, 4, &bytesWritten, NULL)); Win32Call(WriteFile(fileHandle, &useAsDrawIndirect, 4, &bytesWritten, NULL)); Win32Call(WriteFile(fileHandle, &appendConsume, 4, &bytesWritten, NULL)); // Get the buffer data StagingBuffer stagingBuffer; stagingBuffer.Initialize(device, Size); context->CopyResource(stagingBuffer.Buffer, Buffer); const void* bufferData= stagingBuffer.Map(context); // Write the data to the file Win32Call(WriteFile(fileHandle, bufferData, Size, &bytesWritten, NULL)); // Un-map the staging buffer stagingBuffer.Unmap(context); // Close the file Win32Call(CloseHandle(fileHandle)); } void StructuredBuffer::ReadFromFile(const WCHAR* path, ID3D11Device* device) { // Open the file HANDLE fileHandle = CreateFile(path, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL); if(fileHandle == INVALID_HANDLE_VALUE) Win32Call(false); // Read the buffer info UINT32 useAsUAV, useAsDrawIndirect, appendConsume; DWORD bytesRead = 0; Win32Call(ReadFile(fileHandle, &Size, 4, &bytesRead, NULL)); Win32Call(ReadFile(fileHandle, &Stride, 4, &bytesRead, NULL)); Win32Call(ReadFile(fileHandle, &NumElements, 4, &bytesRead, NULL)); Win32Call(ReadFile(fileHandle, &useAsUAV, 4, &bytesRead, NULL)); Win32Call(ReadFile(fileHandle, &useAsDrawIndirect, 4, &bytesRead, NULL)); Win32Call(ReadFile(fileHandle, &appendConsume, 4, &bytesRead, NULL)); // Read the buffer data UINT8* bufferData = new UINT8[Size]; Win32Call(ReadFile(fileHandle, bufferData, Size, &bytesRead, NULL)); // Close the file Win32Call(CloseHandle(fileHandle)); // Init Initialize(device, Stride, NumElements, useAsUAV, appendConsume, useAsDrawIndirect, bufferData); // Clean up delete [] bufferData; } 

And this is the StagingBuffer class:
 struct StagingBuffer { ID3D11BufferPtr Buffer; UINT Size; StagingBuffer(); void Initialize(ID3D11Device* device, UINT size); void* Map(ID3D11DeviceContext* context); void Unmap(ID3D11DeviceContext* context); }; StagingBuffer::StagingBuffer() : Size(0) { } void StagingBuffer::Initialize(ID3D11Device* device, UINT size) { Size = size; D3D11_BUFFER_DESC bufferDesc; bufferDesc.ByteWidth = Size; bufferDesc.Usage = D3D11_USAGE_STAGING; bufferDesc.BindFlags = 0; bufferDesc.CPUAccessFlags = D3D11_CPU_ACCESS_READ; bufferDesc.MiscFlags = 0; bufferDesc.StructureByteStride = 0; DXCall(device->CreateBuffer(&bufferDesc, NULL, &Buffer)); } void* StagingBuffer::Map(ID3D11DeviceContext* context) { D3D11_MAPPED_SUBRESOURCE mapped; DXCall(context->Map(Buffer, 0, D3D11_MAP_READ, 0, &mapped)); return mapped.pData; } void StagingBuffer::Unmap(ID3D11DeviceContext* context) { context->Unmap(Buffer, 0); } 

• 17
• 10
• 19
• 14
• 19
• ### Similar Content

• By chiffre
Introduction:
In general my questions pertain to the differences between floating- and fixed-point data. Additionally I would like to understand when it can be advantageous to prefer fixed-point representation over floating-point representation in the context of vertex data and how the hardware deals with the different data-types. I believe I should be able to reduce the amount of data (bytes) necessary per vertex by choosing the most opportune representations for my vertex attributes. Thanks ahead of time if you, the reader, are considering the effort of reading this and helping me.
I found an old topic that shows this is possible in principal, but I am not sure I understand what the pitfalls are when using fixed-point representation and whether there are any hardware-based performance advantages/disadvantages.
(TLDR at bottom)
The Actual Post:
To my understanding HLSL/D3D11 offers not just the traditional floating point model in half-,single-, and double-precision, but also the fixed-point model in form of signed/unsigned normalized integers in 8-,10-,16-,24-, and 32-bit variants. Both models offer a finite sequence of "grid-points". The obvious difference between the two models is that the fixed-point model offers a constant spacing between values in the normalized range of [0,1] or [-1,1], while the floating point model allows for smaller "deltas" as you get closer to 0, and larger "deltas" the further you are away from 0.
To add some context, let me define a struct as an example:
struct VertexData { float[3] position; //3x32-bits float[2] texCoord; //2x32-bits float[3] normals; //3x32-bits } //Total of 32 bytes Every vertex gets a position, a coordinate on my texture, and a normal to do some light calculations. In this case we have 8x32=256bits per vertex. Since the texture coordinates lie in the interval [0,1] and the normal vector components are in the interval [-1,1] it would seem useful to use normalized representation as suggested in the topic linked at the top of the post. The texture coordinates might as well be represented in a fixed-point model, because it seems most useful to be able to sample the texture in a uniform manner, as the pixels don't get any "denser" as we get closer to 0. In other words the "delta" does not need to become any smaller as the texture coordinates approach (0,0). A similar argument can be made for the normal-vector, as a normal vector should be normalized anyway, and we want as many points as possible on the sphere around (0,0,0) with a radius of 1, and we don't care about precision around the origin. Even if we have large textures such as 4k by 4k (or the maximum allowed by D3D11, 16k by 16k) we only need as many grid-points on one axis, as there are pixels on one axis. An unsigned normalized 14 bit integer would be ideal, but because it is both unsupported and impractical, we will stick to an unsigned normalized 16 bit integer. The same type should take care of the normal vector coordinates, and might even be a bit overkill.
struct VertexData { float[3] position; //3x32-bits uint16_t[2] texCoord; //2x16bits uint16_t[3] normals; //3x16bits } //Total of 22 bytes Seems like a good start, and we might even be able to take it further, but before we pursue that path, here is my first question: can the GPU even work with the data in this format, or is all I have accomplished minimizing CPU-side RAM usage? Does the GPU have to convert the texture coordinates back to a floating-point model when I hand them over to the sampler in my pixel shader? I have looked up the data types for HLSL and I am not sure I even comprehend how to declare the vertex input type in HLSL. Would the following work?
struct VertexInputType { float3 pos; //this one is obvious unorm half2 tex; //half corresponds to a 16-bit float, so I assume this is wrong, but this the only 16-bit type I found on the linked MSDN site snorm half3 normal; //same as above } I assume this is possible somehow, as I have found input element formats such as: DXGI_FORMAT_R16G16B16A16_SNORM and DXGI_FORMAT_R16G16B16A16_UNORM (also available with a different number of components, as well as different component lengths). I might have to avoid 3-component vectors because there is no 3-component 16-bit input element format, but that is the least of my worries. The next question would be: what happens with my normals if I try to do lighting calculations with them in such a normalized-fixed-point format? Is there no issue as long as I take care not to mix floating- and fixed-point data? Or would that work as well? In general this gives rise to the question: how does the GPU handle fixed-point arithmetic? Is it the same as integer-arithmetic, and/or is it faster/slower than floating-point arithmetic?
Assuming that we still have a valid and useful VertexData format, how far could I take this while remaining on the sensible side of what could be called optimization? Theoretically I could use the an input element format such as DXGI_FORMAT_R10G10B10A2_UNORM to pack my normal coordinates into a 10-bit fixed-point format, and my verticies (in object space) might even be representable in a 16-bit unsigned normalized fixed-point format. That way I could end up with something like the following struct:
struct VertexData { uint16_t[3] pos; //3x16bits uint16_t[2] texCoord; //2x16bits uint32_t packedNormals; //10+10+10+2bits } //Total of 14 bytes Could I use a vertex structure like this without too much performance-loss on the GPU-side? If the GPU has to execute some sort of unpacking algorithm in the background I might as well let it be. In the end I have a functioning deferred renderer, but I would like to reduce the memory footprint of the huge amount of vertecies involved in rendering my landscape.
TLDR: I have a lot of vertices that I need to render and I want to reduce the RAM-usage without introducing crazy compression/decompression algorithms to the CPU or GPU. I am hoping to find a solution by involving fixed-point data-types, but I am not exactly sure how how that would work.
• By cozzie
Hi all,
I was wondering it it matters in which order you draw 2D and 3D items, looking at the BeginDraw/EndDraw calls on a D2D rendertarget.
The order in which you do the actual draw calls is clear, 3D first then 2D, means the 2D (DrawText in this case) is in front of the 3D scene.
The question is mainly about when to call the BeginDraw and EndDraw.
Note that I'm drawing D2D stuff through a DXGI surface linked to the 3D RT.
Option 1:
A - Begin frame, clear D3D RT
B - Draw 3D
C - BeginDraw D2D RT
D - Draw 2D
E - EndDraw D2D RT
F - Present
Option 2:
A - Begin frame, clear D3D RT + BeginDraw D2D RT
B - Draw 3D
C - Draw 2D
D - EndDraw D2D RT
E- Present
Would there be a difference (performance/issue?) in using option 2? (versus 1)
Any input is appreciated.

• Do you know any papers that cover custom data structures like lists or binary trees implemented in hlsl without CUDA that work perfectly fine no matter how many threads try to use them at any given time?
• By cozzie
Hi all,
Last week I noticed that when I run my test application(s) in Renderdoc, it crashes when it enable my code that uses D2D/DirectWrite. In Visual Studio no issues occur (debug or release), but when I run the same executable in Renderdoc, it crashes somehow (assert of D2D rendertarget or without any information). Before I spend hours on debugging/ figuring it out, does someone have experience with this symptom and/or know if Renderdoc has known issues with D2D? (if so, that would be bad news for debugging my application in the future );
I can also post some more information on what happens, code and which code commented out, eliminates the problems (when running in RenderDoc).
Any input is appreciated.

• Hi Guys,
I understand how to create input layouts etc... But I am wondering is it at all possible to derive an input layout from a shader and create the input layout directly from this? (Rather than manually specifying the input layout format?)

×

## Important Information

Participate in the game development conversation and more when you create an account on GameDev.net!

Sign me up!