vkd3d  1.15
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
34 extern "C" {
35 #endif /* __cplusplus */
36 
51 {
58 
64 
75 
81 
82  VKD3D_FORCE_32_BIT_ENUM(VKD3D_STRUCTURE_TYPE),
83 };
84 
85 enum 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  VKD3D_API_VERSION_1_14,
102  VKD3D_API_VERSION_1_15,
103 
104  VKD3D_FORCE_32_BIT_ENUM(VKD3D_API_VERSION),
105 };
106 
107 typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
108 
109 typedef void * (*PFN_vkd3d_thread)(void *data);
110 
111 typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
112 typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
113 
114 struct vkd3d_instance;
115 
120 {
124  const void *next;
125 
127  PFN_vkd3d_signal_event pfn_signal_event;
133  PFN_vkd3d_create_thread pfn_create_thread;
139  PFN_vkd3d_join_thread pfn_join_thread;
141  size_t wchar_size;
142 
147  PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
148 
153  const char * const *instance_extensions;
156 };
157 
166 {
170  const void *next;
171 
176  const char * const *extensions;
178  uint32_t extension_count;
179 };
180 
189 {
193  const void *next;
194 
200  const char *application_name;
203 
207  const char *engine_name;
212  uint32_t engine_version;
213 
218  enum vkd3d_api_version api_version;
219 };
220 
229 {
233  const void *next;
234 
242 };
243 
248 {
252  const void *next;
253 
256  D3D_FEATURE_LEVEL minimum_feature_level;
257 
262  struct vkd3d_instance *instance;
268 
275  VkPhysicalDevice vk_physical_device;
276 
281  const char * const *device_extensions;
284 
289  IUnknown *parent;
295 };
296 
305 {
309  const void *next;
310 
315  const char * const *extensions;
317  uint32_t extension_count;
318 };
319 
326 #define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
331 #define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
332 
338 {
342  const void *next;
343 
345  VkImage vk_image;
347  D3D12_RESOURCE_DESC desc;
352  unsigned int flags;
372  D3D12_RESOURCE_STATES present_state;
373 };
374 
375 #ifdef LIBVKD3D_SOURCE
376 # define VKD3D_API VKD3D_EXPORT
377 #else
378 # define VKD3D_API VKD3D_IMPORT
379 #endif
380 
381 #ifndef VKD3D_NO_PROTOTYPES
382 
383 VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
384  struct vkd3d_instance **instance);
385 VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
386 VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
387 VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
388 
389 VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
390  REFIID iid, void **device);
391 VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
392 VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
393 VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
394 VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
395 
396 VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
397 
425 VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
426 
437 VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
438 
439 VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
440  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
441 VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
442 VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
443 
444 VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
445  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
446 VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
447  REFIID iid, void **deserializer);
448 
449 VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
450 
451 /* 1.1 */
452 VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
453 
454 /* 1.2 */
455 VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
456  ID3DBlob **blob, ID3DBlob **error_blob);
457 VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
458  REFIID iid, void **deserializer);
459 
472 VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback);
473 
486 VKD3D_API HRESULT vkd3d_queue_signal_on_cpu(ID3D12CommandQueue *queue,
487  ID3D12Fence *fence, uint64_t value);
488 
489 #endif /* VKD3D_NO_PROTOTYPES */
490 
491 /*
492  * Function pointer typedefs for vkd3d functions.
493  */
494 typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
495  struct vkd3d_instance **instance);
496 typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
497 typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
498 typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
499 
500 typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
501  REFIID iid, void **device);
502 typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
503 typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
504 typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
505 typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
506 
507 typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
508 typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
509 typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
510 
511 typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
512  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
513 typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
514 typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
515 
516 typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
517  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
518 typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
519  REFIID iid, void **deserializer);
520 
521 typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
522 
523 /* 1.1 */
524 typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
525 
526 /* 1.2 */
527 typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
528  ID3DBlob **blob, ID3DBlob **error_blob);
529 typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
530  REFIID iid, void **deserializer);
531 
533 typedef void (*PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback);
534 
536 typedef HRESULT (*PFN_vkd3d_queue_signal_on_cpu)(ID3D12CommandQueue *queue,
537  ID3D12Fence *fence, uint64_t value);
538 
539 #ifdef __cplusplus
540 }
541 #endif /* __cplusplus */
542 
543 #endif /* __VKD3D_H */
A chained structure to specify application information.
Definition: vkd3d.h:189
uint32_t engine_version
The engine version, to be passed to the Vulkan implementation.
Definition: vkd3d.h:212
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:193
enum vkd3d_api_version api_version
The vkd3d API version to use, to guarantee backward compatibility of the shared library.
Definition: vkd3d.h:218
const char * engine_name
The engine name, to be passed to the Vulkan implementation.
Definition: vkd3d.h:207
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_APPLICATION_INFO.
Definition: vkd3d.h:191
const char * application_name
The application's name, to be passed to the Vulkan implementation.
Definition: vkd3d.h:200
uint32_t application_version
The application's version, to be passed to the Vulkan implementation.
Definition: vkd3d.h:202
A chained structure containing device creation parameters.
Definition: vkd3d.h:248
struct vkd3d_instance * instance
The vkd3d instance to use to create a device.
Definition: vkd3d.h:262
LUID adapter_luid
The adapter LUID to be set for the device.
Definition: vkd3d.h:294
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:267
IUnknown * parent
An object to be set as the device parent.
Definition: vkd3d.h:289
uint32_t device_extension_count
The number of elements in the device_extensions array.
Definition: vkd3d.h:283
D3D_FEATURE_LEVEL minimum_feature_level
The minimum feature level to request.
Definition: vkd3d.h:256
const char *const * device_extensions
A list of Vulkan device extensions to request.
Definition: vkd3d.h:281
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:252
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO.
Definition: vkd3d.h:250
VkPhysicalDevice vk_physical_device
The Vulkan physical device to use.
Definition: vkd3d.h:275
A chained structure to specify the host time domain.
Definition: vkd3d.h:229
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO.
Definition: vkd3d.h:231
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:233
uint64_t ticks_per_second
The number of clock ticks per second, used for GetClockCalibration().
Definition: vkd3d.h:241
A chained structure containing the parameters to create a D3D12 resource backed by a Vulkan image.
Definition: vkd3d.h:338
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:342
VkImage vk_image
The Vulkan image that backs the resource.
Definition: vkd3d.h:345
D3D12_RESOURCE_STATES present_state
This field specifies how to handle resource state D3D12_RESOURCE_STATE_PRESENT for the resource.
Definition: vkd3d.h:372
unsigned int flags
A combination of zero or more flags.
Definition: vkd3d.h:352
D3D12_RESOURCE_DESC desc
The resource description.
Definition: vkd3d.h:347
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO.
Definition: vkd3d.h:340
A chained structure containing instance creation parameters.
Definition: vkd3d.h:120
size_t wchar_size
The size of type WCHAR.
Definition: vkd3d.h:141
const char *const * instance_extensions
A list of Vulkan instance extensions to request.
Definition: vkd3d.h:153
uint32_t instance_extension_count
The number of elements in the instance_extensions array.
Definition: vkd3d.h:155
PFN_vkd3d_signal_event pfn_signal_event
An pointer to a function to signal events.
Definition: vkd3d.h:127
PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr
A pointer to the vkGetInstanceProcAddr Vulkan function, which will be used to load all the other Vulk...
Definition: vkd3d.h:147
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:124
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO.
Definition: vkd3d.h:122
PFN_vkd3d_join_thread pfn_join_thread
An optional pointer to a function to join threads.
Definition: vkd3d.h:139
PFN_vkd3d_create_thread pfn_create_thread
An optional pointer to a function to create threads.
Definition: vkd3d.h:133
A chained structure to specify optional device extensions.
Definition: vkd3d.h:305
uint32_t extension_count
The number of elements in the extensions array.
Definition: vkd3d.h:317
const char *const * extensions
A list of optional Vulkan device extensions to request.
Definition: vkd3d.h:315
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO.
Definition: vkd3d.h:307
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:309
A chained structure to specify optional instance extensions.
Definition: vkd3d.h:166
uint32_t extension_count
The number of elements in the extensions array.
Definition: vkd3d.h:178
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO.
Definition: vkd3d.h:168
const void * next
Optional pointer to a structure containing further parameters.
Definition: vkd3d.h:170
const char *const * extensions
A list of optional Vulkan instance extensions to request.
Definition: vkd3d.h:176
VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue)
Acquire the Vulkan queue backing a command queue.
HRESULT(* PFN_vkd3d_queue_signal_on_cpu)(ID3D12CommandQueue *queue, ID3D12Fence *fence, uint64_t value)
Type of vkd3d_queue_signal_on_cpu().
Definition: vkd3d.h:536
VKD3D_API HRESULT vkd3d_queue_signal_on_cpu(ID3D12CommandQueue *queue, ID3D12Fence *fence, uint64_t value)
Signal a fence on the CPU once all the currently outstanding queue work is submitted to Vulkan.
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:533
This file contains definitions for basic types used by vkd3d libraries.