d3d_d3d12_allocator.hpp File Reference

Higher-level D3D12-backed image buffer allocation routine. More...

#include "xrt/xrt_compositor.h"
#include <Unknwn.h>
#include <d3d12.h>
#include <wil/com.h>
#include <wil/resource.h>
#include <cstdint>
#include <vector>

Include dependency graph for d3d_d3d12_allocator.hpp:

Go to the source code of this file.

Functions
xrt_result_t	xrt::auxiliary::d3d::d3d12::allocateSharedImages (ID3D12Device &device, const xrt_swapchain_create_info &xsci, size_t image_count, std::vector< wil::com_ptr< ID3D12Resource > > &out_images, std::vector< wil::unique_handle > &out_handles, std::uint64_t &out_image_mem_size)
	Allocate images (ID3D12Resource) that have a corresponding native handle. More...

Detailed Description

Higher-level D3D12-backed image buffer allocation routine.

Author

Rylie Pavlik rylie.nosp@m..pav.nosp@m.lik@c.nosp@m.olla.nosp@m.bora..nosp@m.com

Fernando Velazquez Innella finne.nosp@m.lla@.nosp@m.magic.nosp@m.leap.nosp@m..com

Korcan Hussein korca.nosp@m.n.hu.nosp@m.ssein.nosp@m.@col.nosp@m.labor.nosp@m.a.co.nosp@m.m

Function Documentation

allocateSharedImages()

xrt_result_t xrt::auxiliary::d3d::d3d12::allocateSharedImages	(	ID3D12Device &	device,
		const xrt_swapchain_create_info &	xsci,
		size_t	image_count,
		std::vector< wil::com_ptr< ID3D12Resource > > &	out_images,
		std::vector< wil::unique_handle > &	out_handles,
		std::uint64_t &	out_image_mem_size
	)

Allocate images (ID3D12Resource) that have a corresponding native handle.

Parameters

	device	A D3D12 device to allocate with.
	xsci	Swapchain create info: note that the format is assumed to be a DXGI_FORMAT (conversion to typeless is automatic)
	image_count	The number of images to create.
	keyed_mutex	Whether to create images with a shared "keyed mutex" as well
[out]	out_images	A vector that will be cleared and populated with the images.
[out]	out_handles	A vector that will be cleared and populated with the corresponding native handles.
[out]	out_image_mem_size	The image memory allocation size in bytes

Returns

xrt_result_t, one of:

• XRT_SUCCESS
• XRT_ERROR_ALLOCATION
• XRT_ERROR_SWAPCHAIN_FORMAT_UNSUPPORTED
• XRT_ERROR_SWAPCHAIN_FLAG_VALID_BUT_UNSUPPORTED
• XRT_ERROR_D3D12

References XRT_ERROR_SWAPCHAIN_FLAG_VALID_BUT_UNSUPPORTED, XRT_SWAPCHAIN_CREATE_PROTECTED_CONTENT, and XRT_SWAPCHAIN_CREATE_STATIC_IMAGE.