vkd3d 1.13
The vkd3d 3D Graphics Library
vkd3d.h
Go to the documentation of this file.
1/*
2 * Copyright 2016 Józef Kucia for CodeWeavers
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17 */
18
19#ifndef __VKD3D_H
20#define __VKD3D_H
21
22#include <vkd3d_types.h>
23
24#ifndef VKD3D_NO_WIN32_TYPES
25# include <vkd3d_windows.h>
26# include <vkd3d_d3d12.h>
27#endif /* VKD3D_NO_WIN32_TYPES */
28
29#ifndef VKD3D_NO_VULKAN_H
30# include <vulkan/vulkan.h>
31#endif /* VKD3D_NO_VULKAN_H */
32
33#ifdef __cplusplus
34extern "C" {
35#endif /* __cplusplus */
36
51{
58
64
75
81
82 VKD3D_FORCE_32_BIT_ENUM(VKD3D_STRUCTURE_TYPE),
83};
84
85enum vkd3d_api_version
86{
87 VKD3D_API_VERSION_1_0,
88 VKD3D_API_VERSION_1_1,
89 VKD3D_API_VERSION_1_2,
90 VKD3D_API_VERSION_1_3,
91 VKD3D_API_VERSION_1_4,
92 VKD3D_API_VERSION_1_5,
93 VKD3D_API_VERSION_1_6,
94 VKD3D_API_VERSION_1_7,
95 VKD3D_API_VERSION_1_8,
96 VKD3D_API_VERSION_1_9,
97 VKD3D_API_VERSION_1_10,
98 VKD3D_API_VERSION_1_11,
99 VKD3D_API_VERSION_1_12,
100 VKD3D_API_VERSION_1_13,
101
102 VKD3D_FORCE_32_BIT_ENUM(VKD3D_API_VERSION),
103};
104
105typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
106
107typedef void * (*PFN_vkd3d_thread)(void *data);
108
109typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
110typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
111
112struct vkd3d_instance;
113
118{
122 const void *next;
123
125 PFN_vkd3d_signal_event pfn_signal_event;
131 PFN_vkd3d_create_thread pfn_create_thread;
137 PFN_vkd3d_join_thread pfn_join_thread;
140
145 PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
146
151 const char * const *instance_extensions;
154};
155
164{
168 const void *next;
169
174 const char * const *extensions;
177};
178
187{
191 const void *next;
192
198 const char *application_name;
201
205 const char *engine_name;
211
216 enum vkd3d_api_version api_version;
217};
218
227{
231 const void *next;
232
240};
241
246{
250 const void *next;
251
254 D3D_FEATURE_LEVEL minimum_feature_level;
255
260 struct vkd3d_instance *instance;
266
273 VkPhysicalDevice vk_physical_device;
274
279 const char * const *device_extensions;
282
287 IUnknown *parent;
293};
294
303{
307 const void *next;
308
313 const char * const *extensions;
316};
317
324#define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
329#define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
330
336{
340 const void *next;
341
343 VkImage vk_image;
345 D3D12_RESOURCE_DESC desc;
350 unsigned int flags;
370 D3D12_RESOURCE_STATES present_state;
371};
372
373#ifdef LIBVKD3D_SOURCE
374# define VKD3D_API VKD3D_EXPORT
375#else
376# define VKD3D_API VKD3D_IMPORT
377#endif
378
379#ifndef VKD3D_NO_PROTOTYPES
380
381VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
382 struct vkd3d_instance **instance);
383VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
384VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
385VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
386
387VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
388 REFIID iid, void **device);
389VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
390VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
391VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
392VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
393
394VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
395
419VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
420
431VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
432
433VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
434 const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
435VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
436VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
437
438VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
439 D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
440VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
441 REFIID iid, void **deserializer);
442
443VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
444
445/* 1.1 */
446VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
447
448/* 1.2 */
449VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
450 ID3DBlob **blob, ID3DBlob **error_blob);
451VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
452 REFIID iid, void **deserializer);
453
466VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback);
467
468#endif /* VKD3D_NO_PROTOTYPES */
469
470/*
471 * Function pointer typedefs for vkd3d functions.
472 */
473typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
474 struct vkd3d_instance **instance);
475typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
476typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
477typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
478
479typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
480 REFIID iid, void **device);
481typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
482typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
483typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
484typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
485
486typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
487typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
488typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
489
490typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
491 const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
492typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
493typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
494
495typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
496 D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
497typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
498 REFIID iid, void **deserializer);
499
500typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
501
502/* 1.1 */
503typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
504
505/* 1.2 */
506typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
507 ID3DBlob **blob, ID3DBlob **error_blob);
508typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
509 REFIID iid, void **deserializer);
510
512typedef void (*PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback);
513
514#ifdef __cplusplus
515}
516#endif /* __cplusplus */
517
518#endif /* __VKD3D_H */
A chained structure to specify application information.
Definition: vkd3d.h:187
uint32_t engine_version
The engine version, to be passed to the Vulkan implementation.
Definition: vkd3d.h:210
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:191
enum vkd3d_api_version api_version
The vkd3d API version to use, to guarantee backward compatibility of the shared library.
Definition: vkd3d.h:216
const char * engine_name
The engine name, to be passed to the Vulkan implementation.
Definition: vkd3d.h:205
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_APPLICATION_INFO.
Definition: vkd3d.h:189
const char * application_name
The application's name, to be passed to the Vulkan implementation.
Definition: vkd3d.h:198
uint32_t application_version
The application's version, to be passed to the Vulkan implementation.
Definition: vkd3d.h:200
A chained structure containing device creation parameters.
Definition: vkd3d.h:246
struct vkd3d_instance * instance
The vkd3d instance to use to create a device.
Definition: vkd3d.h:260
LUID adapter_luid
The adapter LUID to be set for the device.
Definition: vkd3d.h:292
const struct vkd3d_instance_create_info * instance_create_info
The parameters used to create an instance, which is then used to create a device.
Definition: vkd3d.h:265
IUnknown * parent
An object to be set as the device parent.
Definition: vkd3d.h:287
uint32_t device_extension_count
The number of elements in the device_extensions array.
Definition: vkd3d.h:281
D3D_FEATURE_LEVEL minimum_feature_level
The minimum feature level to request.
Definition: vkd3d.h:254
const char *const * device_extensions
A list of Vulkan device extensions to request.
Definition: vkd3d.h:279
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:250
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO.
Definition: vkd3d.h:248
VkPhysicalDevice vk_physical_device
The Vulkan physical device to use.
Definition: vkd3d.h:273
A chained structure to specify the host time domain.
Definition: vkd3d.h:227
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO.
Definition: vkd3d.h:229
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:231
uint64_t ticks_per_second
The number of clock ticks per second, used for GetClockCalibration().
Definition: vkd3d.h:239
A chained structure containing the parameters to create a D3D12 resource backed by a Vulkan image.
Definition: vkd3d.h:336
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:340
VkImage vk_image
The Vulkan image that backs the resource.
Definition: vkd3d.h:343
D3D12_RESOURCE_STATES present_state
This field specifies how to handle resource state D3D12_RESOURCE_STATE_PRESENT for the resource.
Definition: vkd3d.h:370
unsigned int flags
A combination of zero or more flags.
Definition: vkd3d.h:350
D3D12_RESOURCE_DESC desc
The resource description.
Definition: vkd3d.h:345
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO.
Definition: vkd3d.h:338
A chained structure containing instance creation parameters.
Definition: vkd3d.h:118
size_t wchar_size
The size of type WCHAR.
Definition: vkd3d.h:139
const char *const * instance_extensions
A list of Vulkan instance extensions to request.
Definition: vkd3d.h:151
uint32_t instance_extension_count
The number of elements in the instance_extensions array.
Definition: vkd3d.h:153
PFN_vkd3d_signal_event pfn_signal_event
An pointer to a function to signal events.
Definition: vkd3d.h:125
PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr
A pointer to the vkGetInstanceProcAddr Vulkan function, which will be used to load all the other Vulk...
Definition: vkd3d.h:145
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:122
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO.
Definition: vkd3d.h:120
PFN_vkd3d_join_thread pfn_join_thread
An optional pointer to a function to join threads.
Definition: vkd3d.h:137
PFN_vkd3d_create_thread pfn_create_thread
An optional pointer to a function to create threads.
Definition: vkd3d.h:131
A chained structure to specify optional device extensions.
Definition: vkd3d.h:303
uint32_t extension_count
The number of elements in the extensions array.
Definition: vkd3d.h:315
const char *const * extensions
A list of optional Vulkan device extensions to request.
Definition: vkd3d.h:313
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO.
Definition: vkd3d.h:305
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:307
A chained structure to specify optional instance extensions.
Definition: vkd3d.h:164
uint32_t extension_count
The number of elements in the extensions array.
Definition: vkd3d.h:176
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO.
Definition: vkd3d.h:166
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:168
const char *const * extensions
A list of optional Vulkan instance extensions to request.
Definition: vkd3d.h:174
VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue)
Acquire the Vulkan queue backing a command queue.
VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback)
Set a callback to be called when vkd3d outputs debug logging.
vkd3d_structure_type
The type of a chained structure.
Definition: vkd3d.h:51
@ VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO
The structure is a vkd3d_host_time_domain_info structure.
Definition: vkd3d.h:80
@ VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO
The structure is a vkd3d_optional_instance_extensions_info structure.
Definition: vkd3d.h:63
@ VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO
The structure is a vkd3d_instance_create_info structure.
Definition: vkd3d.h:53
@ VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO
The structure is a vkd3d_device_create_info structure.
Definition: vkd3d.h:55
@ VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO
The structure is a vkd3d_optional_device_extensions_info structure.
Definition: vkd3d.h:69
@ VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO
The structure is a vkd3d_image_resource_create_info structure.
Definition: vkd3d.h:57
@ VKD3D_STRUCTURE_TYPE_APPLICATION_INFO
The structure is a vkd3d_application_info structure.
Definition: vkd3d.h:74
VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue)
Release the Vulkan queue backing a command queue.
void(* PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback)
Type of vkd3d_set_log_callback().
Definition: vkd3d.h:512
This file contains definitions for basic types used by vkd3d libraries.