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