vkd3d  1.3
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 };
64 
65 typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
66 
67 typedef void * (*PFN_vkd3d_thread)(void *data);
68 
69 typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
70 typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
71 
72 struct vkd3d_instance;
73 
75 {
76  enum vkd3d_structure_type type;
77  const void *next;
78 
79  PFN_vkd3d_signal_event pfn_signal_event;
80  PFN_vkd3d_create_thread pfn_create_thread;
81  PFN_vkd3d_join_thread pfn_join_thread;
82  size_t wchar_size;
83 
84  /* If set to NULL, libvkd3d loads libvulkan. */
85  PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
86 
87  const char * const *instance_extensions;
88  uint32_t instance_extension_count;
89 };
90 
91 /* Extends vkd3d_instance_create_info. Available since 1.1. */
93 {
94  enum vkd3d_structure_type type;
95  const void *next;
96 
97  const char * const *extensions;
98  uint32_t extension_count;
99 };
100 
101 /* Extends vkd3d_instance_create_info. Available since 1.2. */
103 {
104  enum vkd3d_structure_type type;
105  const void *next;
106 
107  const char *application_name;
108  uint32_t application_version;
109 
110  const char *engine_name; /* "vkd3d" if NULL */
111  uint32_t engine_version; /* vkd3d version if engine_name is NULL */
112 
113  enum vkd3d_api_version api_version;
114 };
115 
116 /* Extends vkd3d_instance_create_info. Available since 1.3. */
118 {
119  enum vkd3d_structure_type type;
120  const void *next;
121 
122  uint64_t ticks_per_second;
123 };
124 
126 {
127  enum vkd3d_structure_type type;
128  const void *next;
129 
130  D3D_FEATURE_LEVEL minimum_feature_level;
131 
132  struct vkd3d_instance *instance;
133  const struct vkd3d_instance_create_info *instance_create_info;
134 
135  VkPhysicalDevice vk_physical_device;
136 
137  const char * const *device_extensions;
138  uint32_t device_extension_count;
139 
140  IUnknown *parent;
141  LUID adapter_luid;
142 };
143 
144 /* Extends vkd3d_device_create_info. Available since 1.2. */
146 {
147  enum vkd3d_structure_type type;
148  const void *next;
149 
150  const char * const *extensions;
151  uint32_t extension_count;
152 };
153 
154 /* vkd3d_image_resource_create_info flags */
155 #define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
156 #define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
157 
159 {
160  enum vkd3d_structure_type type;
161  const void *next;
162 
163  VkImage vk_image;
164  D3D12_RESOURCE_DESC desc;
165  unsigned int flags;
166  D3D12_RESOURCE_STATES present_state;
167 };
168 
169 #ifdef LIBVKD3D_SOURCE
170 # define VKD3D_API VKD3D_EXPORT
171 #else
172 # define VKD3D_API VKD3D_IMPORT
173 #endif
174 
175 #ifndef VKD3D_NO_PROTOTYPES
176 
177 VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
178  struct vkd3d_instance **instance);
179 VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
180 VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
181 VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
182 
183 VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
184  REFIID iid, void **device);
185 VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
186 VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
187 VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
188 VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
189 
190 VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
191 VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
192 VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
193 
194 VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
195  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
196 VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
197 VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
198 
199 VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
200  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
201 VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
202  REFIID iid, void **deserializer);
203 
204 VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
205 
206 /* 1.1 */
207 VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
208 
209 /* 1.2 */
210 VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
211  ID3DBlob **blob, ID3DBlob **error_blob);
212 VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
213  REFIID iid, void **deserializer);
214 
215 #endif /* VKD3D_NO_PROTOTYPES */
216 
217 /*
218  * Function pointer typedefs for vkd3d functions.
219  */
220 typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
221  struct vkd3d_instance **instance);
222 typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
223 typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
224 typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
225 
226 typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
227  REFIID iid, void **device);
228 typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
229 typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
230 typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
231 typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
232 
233 typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
234 typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
235 typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
236 
237 typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
238  const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
239 typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
240 typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
241 
242 typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
243  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
244 typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
245  REFIID iid, void **deserializer);
246 
247 typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
248 
249 /* 1.1 */
250 typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
251 
252 /* 1.2 */
253 typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
254  ID3DBlob **blob, ID3DBlob **error_blob);
255 typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
256  REFIID iid, void **deserializer);
257 
258 #ifdef __cplusplus
259 }
260 #endif /* __cplusplus */
261 
262 #endif /* __VKD3D_H */
vkd3d_instance_create_info
Definition: vkd3d.h:74
vkd3d_optional_device_extensions_info
Definition: vkd3d.h:145
vkd3d_application_info
Definition: vkd3d.h:102
vkd3d_host_time_domain_info
Definition: vkd3d.h:117
vkd3d_optional_instance_extensions_info
Definition: vkd3d.h:92
vkd3d_image_resource_create_info
Definition: vkd3d.h:158
vkd3d_device_create_info
Definition: vkd3d.h:125
vkd3d_types.h