vkd3d 1.16
The vkd3d 3D Graphics Library
Loading...
Searching...
No Matches
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
48
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 VKD3D_API_VERSION_1_14,
102 VKD3D_API_VERSION_1_15,
103 VKD3D_API_VERSION_1_16,
104
105 VKD3D_FORCE_32_BIT_ENUM(VKD3D_API_VERSION),
106};
107
108typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
109
110typedef void * (*PFN_vkd3d_thread)(void *data);
111
112typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
113typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
114
115struct vkd3d_instance;
116
121{
125 const void *next;
126
128 PFN_vkd3d_signal_event pfn_signal_event;
134 PFN_vkd3d_create_thread pfn_create_thread;
140 PFN_vkd3d_join_thread pfn_join_thread;
143
148 PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
149
154 const char * const *instance_extensions;
157};
158
167{
171 const void *next;
172
177 const char * const *extensions;
180};
181
190{
194 const void *next;
195
201 const char *application_name;
204
208 const char *engine_name;
214
219 enum vkd3d_api_version api_version;
220};
221
244
249{
253 const void *next;
254
257 D3D_FEATURE_LEVEL minimum_feature_level;
258
263 struct vkd3d_instance *instance;
269
276 VkPhysicalDevice vk_physical_device;
277
282 const char * const *device_extensions;
285
290 IUnknown *parent;
296};
297
306{
310 const void *next;
311
316 const char * const *extensions;
319};
320
327#define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
332#define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
333
339{
343 const void *next;
344
346 VkImage vk_image;
348 D3D12_RESOURCE_DESC desc;
353 unsigned int flags;
373 D3D12_RESOURCE_STATES present_state;
374};
375
376#ifdef LIBVKD3D_SOURCE
377# define VKD3D_API VKD3D_EXPORT
378#else
379# define VKD3D_API VKD3D_IMPORT
380#endif
381
382#ifndef VKD3D_NO_PROTOTYPES
383
384VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
385 struct vkd3d_instance **instance);
386VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
387VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
388VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
389
390VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
391 REFIID iid, void **device);
392VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
393VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
394VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
395VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
396
397VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
398
426VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
427
438VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
439
440VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
441 const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
442VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
443VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
444
445VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
446 D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
447VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
448 REFIID iid, void **deserializer);
449
450VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
451
452/* 1.1 */
453VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
454
455/* 1.2 */
456VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
457 ID3DBlob **blob, ID3DBlob **error_blob);
458VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
459 REFIID iid, void **deserializer);
460
473VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback);
474
487VKD3D_API HRESULT vkd3d_queue_signal_on_cpu(ID3D12CommandQueue *queue,
488 ID3D12Fence *fence, uint64_t value);
489
490#endif /* VKD3D_NO_PROTOTYPES */
491
492/*
493 * Function pointer typedefs for vkd3d functions.
494 */
495typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
496 struct vkd3d_instance **instance);
497typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
498typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
499typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
500
501typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
502 REFIID iid, void **device);
503typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
504typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
505typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
506typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
507
508typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
509typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
510typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
511
512typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
513 const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
514typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
515typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
516
517typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
518 D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
519typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
520 REFIID iid, void **deserializer);
521
522typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
523
524/* 1.1 */
525typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
526
527/* 1.2 */
528typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
529 ID3DBlob **blob, ID3DBlob **error_blob);
530typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
531 REFIID iid, void **deserializer);
532
534typedef void (*PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback);
535
537typedef HRESULT (*PFN_vkd3d_queue_signal_on_cpu)(ID3D12CommandQueue *queue,
538 ID3D12Fence *fence, uint64_t value);
539
540#ifdef __cplusplus
541}
542#endif /* __cplusplus */
543
544#endif /* __VKD3D_H */
A chained structure to specify application information.
Definition vkd3d.h:190
uint32_t engine_version
The engine version, to be passed to the Vulkan implementation.
Definition vkd3d.h:213
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:194
enum vkd3d_api_version api_version
The vkd3d API version to use, to guarantee backward compatibility of the shared library.
Definition vkd3d.h:219
const char * engine_name
The engine name, to be passed to the Vulkan implementation.
Definition vkd3d.h:208
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_APPLICATION_INFO.
Definition vkd3d.h:192
const char * application_name
The application's name, to be passed to the Vulkan implementation.
Definition vkd3d.h:201
uint32_t application_version
The application's version, to be passed to the Vulkan implementation.
Definition vkd3d.h:203
A chained structure containing device creation parameters.
Definition vkd3d.h:249
struct vkd3d_instance * instance
The vkd3d instance to use to create a device.
Definition vkd3d.h:263
LUID adapter_luid
The adapter LUID to be set for the device.
Definition vkd3d.h:295
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:268
IUnknown * parent
An object to be set as the device parent.
Definition vkd3d.h:290
uint32_t device_extension_count
The number of elements in the device_extensions array.
Definition vkd3d.h:284
D3D_FEATURE_LEVEL minimum_feature_level
The minimum feature level to request.
Definition vkd3d.h:257
const char *const * device_extensions
A list of Vulkan device extensions to request.
Definition vkd3d.h:282
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:253
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO.
Definition vkd3d.h:251
VkPhysicalDevice vk_physical_device
The Vulkan physical device to use.
Definition vkd3d.h:276
A chained structure to specify the host time domain.
Definition vkd3d.h:230
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO.
Definition vkd3d.h:232
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:234
uint64_t ticks_per_second
The number of clock ticks per second, used for GetClockCalibration().
Definition vkd3d.h:242
A chained structure containing the parameters to create a D3D12 resource backed by a Vulkan image.
Definition vkd3d.h:339
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:343
VkImage vk_image
The Vulkan image that backs the resource.
Definition vkd3d.h:346
D3D12_RESOURCE_STATES present_state
This field specifies how to handle resource state D3D12_RESOURCE_STATE_PRESENT for the resource.
Definition vkd3d.h:373
unsigned int flags
A combination of zero or more flags.
Definition vkd3d.h:353
D3D12_RESOURCE_DESC desc
The resource description.
Definition vkd3d.h:348
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO.
Definition vkd3d.h:341
A chained structure containing instance creation parameters.
Definition vkd3d.h:121
size_t wchar_size
The size of type WCHAR.
Definition vkd3d.h:142
const char *const * instance_extensions
A list of Vulkan instance extensions to request.
Definition vkd3d.h:154
uint32_t instance_extension_count
The number of elements in the instance_extensions array.
Definition vkd3d.h:156
PFN_vkd3d_signal_event pfn_signal_event
An pointer to a function to signal events.
Definition vkd3d.h:128
PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr
A pointer to the vkGetInstanceProcAddr Vulkan function, which will be used to load all the other Vulk...
Definition vkd3d.h:148
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:125
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO.
Definition vkd3d.h:123
PFN_vkd3d_join_thread pfn_join_thread
An optional pointer to a function to join threads.
Definition vkd3d.h:140
PFN_vkd3d_create_thread pfn_create_thread
An optional pointer to a function to create threads.
Definition vkd3d.h:134
A chained structure to specify optional device extensions.
Definition vkd3d.h:306
uint32_t extension_count
The number of elements in the extensions array.
Definition vkd3d.h:318
const char *const * extensions
A list of optional Vulkan device extensions to request.
Definition vkd3d.h:316
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO.
Definition vkd3d.h:308
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:310
A chained structure to specify optional instance extensions.
Definition vkd3d.h:167
uint32_t extension_count
The number of elements in the extensions array.
Definition vkd3d.h:179
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO.
Definition vkd3d.h:169
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:171
const char *const * extensions
A list of optional Vulkan instance extensions to request.
Definition vkd3d.h:177
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:537
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:534
This file contains definitions for basic types used by vkd3d libraries.