vkd3d  1.4
The vkd3d 3D Graphics Library
vkd3d.h
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 
37 enum vkd3d_structure_type
38 {
39  /* 1.0 */
40  VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
41  VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
42  VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO,
43 
44  /* 1.1 */
45  VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO,
46 
47  /* 1.2 */
48  VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO,
49  VKD3D_STRUCTURE_TYPE_APPLICATION_INFO,
50 
51  /* 1.3 */
52  VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO,
53 
54  VKD3D_FORCE_32_BIT_ENUM(VKD3D_STRUCTURE_TYPE),
55 };
56 
57 enum vkd3d_api_version
58 {
59  VKD3D_API_VERSION_1_0,
60  VKD3D_API_VERSION_1_1,
61  VKD3D_API_VERSION_1_2,
62  VKD3D_API_VERSION_1_3,
63  VKD3D_API_VERSION_1_4,
64 };
65 
66 typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
67 
68 typedef void * (*PFN_vkd3d_thread)(void *data);
69 
70 typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
71 typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
72 
73 struct vkd3d_instance;
74 
76 {
77  enum vkd3d_structure_type type;
78  const void *next;
79 
80  PFN_vkd3d_signal_event pfn_signal_event;
81  PFN_vkd3d_create_thread pfn_create_thread;
82  PFN_vkd3d_join_thread pfn_join_thread;
83  size_t wchar_size;
84 
85  /* If set to NULL, libvkd3d loads libvulkan. */
86  PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
87 
88  const char * const *instance_extensions;
89  uint32_t instance_extension_count;
90 };
91 
92 /* Extends vkd3d_instance_create_info. Available since 1.1. */
94 {
95  enum vkd3d_structure_type type;
96  const void *next;
97 
98  const char * const *extensions;
99  uint32_t extension_count;
100 };
101 
102 /* Extends vkd3d_instance_create_info. Available since 1.2. */
104 {
105  enum vkd3d_structure_type type;
106  const void *next;
107 
108  const char *application_name;
109  uint32_t application_version;
110 
111  const char *engine_name; /* "vkd3d" if NULL */
112  uint32_t engine_version; /* vkd3d version if engine_name is NULL */
113 
114  enum vkd3d_api_version api_version;
115 };
116 
117 /* Extends vkd3d_instance_create_info. Available since 1.3. */
119 {
120  enum vkd3d_structure_type type;
121  const void *next;
122 
123  uint64_t ticks_per_second;
124 };
125 
127 {
128  enum vkd3d_structure_type type;
129  const void *next;
130 
131  D3D_FEATURE_LEVEL minimum_feature_level;
132 
133  struct vkd3d_instance *instance;
134  const struct vkd3d_instance_create_info *instance_create_info;
135 
136  VkPhysicalDevice vk_physical_device;
137 
138  const char * const *device_extensions;
139  uint32_t device_extension_count;
140 
141  IUnknown *parent;
142  LUID adapter_luid;
143 };
144 
145 /* Extends vkd3d_device_create_info. Available since 1.2. */
147 {
148  enum vkd3d_structure_type type;
149  const void *next;
150 
151  const char * const *extensions;
152  uint32_t extension_count;
153 };
154 
155 /* vkd3d_image_resource_create_info flags */
156 #define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
157 #define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
158 
160 {
161  enum vkd3d_structure_type type;
162  const void *next;
163 
164  VkImage vk_image;
165  D3D12_RESOURCE_DESC desc;
166  unsigned int flags;
167  D3D12_RESOURCE_STATES present_state;
168 };
169 
170 #ifdef LIBVKD3D_SOURCE
171 # define VKD3D_API VKD3D_EXPORT
172 #else
173 # define VKD3D_API VKD3D_IMPORT
174 #endif
175 
176 #ifndef VKD3D_NO_PROTOTYPES
177 
178 VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
179  struct vkd3d_instance **instance);
180 VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
181 VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
182 VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
183 
184 VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
185  REFIID iid, void **device);
186 VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
187 VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
188 VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
189 VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
190 
191 VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
192 VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
193 VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
194 
195 VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
196  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
197 VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
198 VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
199 
200 VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
201  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
202 VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
203  REFIID iid, void **deserializer);
204 
205 VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
206 
207 /* 1.1 */
208 VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
209 
210 /* 1.2 */
211 VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
212  ID3DBlob **blob, ID3DBlob **error_blob);
213 VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
214  REFIID iid, void **deserializer);
215 
228 VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback);
229 
230 #endif /* VKD3D_NO_PROTOTYPES */
231 
232 /*
233  * Function pointer typedefs for vkd3d functions.
234  */
235 typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
236  struct vkd3d_instance **instance);
237 typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
238 typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
239 typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
240 
241 typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
242  REFIID iid, void **device);
243 typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
244 typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
245 typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
246 typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
247 
248 typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
249 typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
250 typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
251 
252 typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
253  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
254 typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
255 typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
256 
257 typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
258  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
259 typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
260  REFIID iid, void **deserializer);
261 
262 typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
263 
264 /* 1.1 */
265 typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
266 
267 /* 1.2 */
268 typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
269  ID3DBlob **blob, ID3DBlob **error_blob);
270 typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
271  REFIID iid, void **deserializer);
272 
274 typedef void (*PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback);
275 
276 #ifdef __cplusplus
277 }
278 #endif /* __cplusplus */
279 
280 #endif /* __VKD3D_H */
Definition: vkd3d.h:104
Definition: vkd3d.h:127
Definition: vkd3d.h:119
Definition: vkd3d.h:160
Definition: vkd3d.h:76
This file contains definitions for basic types used by vkd3d libraries.