Loading...
Searching...
No Matches
vkd3d.h
Go to the documentation of this file.
/*
* Copyright 2016 Józef Kucia for CodeWeavers
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef __VKD3D_H
#define __VKD3D_H
#include <vkd3d_types.h>
#ifndef VKD3D_NO_WIN32_TYPES
# include <vkd3d_windows.h>
# include <vkd3d_d3d12.h>
#endif /* VKD3D_NO_WIN32_TYPES */
#ifndef VKD3D_NO_VULKAN_H
# include <vulkan/vulkan.h>
#endif /* VKD3D_NO_VULKAN_H */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
enum vkd3d_structure_type
{
VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO,
VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO,
VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO,
VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO,
VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO,
VKD3D_STRUCTURE_TYPE_APPLICATION_INFO,
VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO,
VKD3D_FORCE_32_BIT_ENUM(VKD3D_STRUCTURE_TYPE),
};
enum vkd3d_api_version
{
VKD3D_API_VERSION_1_0,
VKD3D_API_VERSION_1_1,
VKD3D_API_VERSION_1_2,
VKD3D_API_VERSION_1_3,
VKD3D_API_VERSION_1_4,
VKD3D_API_VERSION_1_5,
VKD3D_API_VERSION_1_6,
VKD3D_API_VERSION_1_7,
VKD3D_API_VERSION_1_8,
VKD3D_API_VERSION_1_9,
VKD3D_API_VERSION_1_10,
VKD3D_API_VERSION_1_11,
VKD3D_API_VERSION_1_12,
VKD3D_API_VERSION_1_13,
VKD3D_API_VERSION_1_14,
VKD3D_API_VERSION_1_15,
VKD3D_API_VERSION_1_16,
VKD3D_API_VERSION_1_17,
VKD3D_API_VERSION_1_18,
VKD3D_API_VERSION_1_19,
VKD3D_API_VERSION_2_0,
VKD3D_FORCE_32_BIT_ENUM(VKD3D_API_VERSION),
};
typedef HRESULT (*PFN_vkd3d_signal_event)(HANDLE event);
typedef void * (*PFN_vkd3d_thread)(void *data);
typedef void * (*PFN_vkd3d_create_thread)(PFN_vkd3d_thread thread_main, void *data);
typedef HRESULT (*PFN_vkd3d_join_thread)(void *thread);
struct vkd3d_instance;
struct vkd3d_instance_create_info
{
enum vkd3d_structure_type type;
const void *next;
PFN_vkd3d_signal_event pfn_signal_event;
PFN_vkd3d_create_thread pfn_create_thread;
PFN_vkd3d_join_thread pfn_join_thread;
size_t wchar_size;
PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr;
const char * const *instance_extensions;
uint32_t instance_extension_count;
};
struct vkd3d_optional_instance_extensions_info
{
enum vkd3d_structure_type type;
const void *next;
const char * const *extensions;
uint32_t extension_count;
};
struct vkd3d_application_info
{
enum vkd3d_structure_type type;
const void *next;
const char *application_name;
uint32_t application_version;
const char *engine_name;
uint32_t engine_version;
enum vkd3d_api_version api_version;
};
struct vkd3d_host_time_domain_info
{
enum vkd3d_structure_type type;
const void *next;
uint64_t ticks_per_second;
};
struct vkd3d_device_create_info
{
enum vkd3d_structure_type type;
const void *next;
D3D_FEATURE_LEVEL minimum_feature_level;
struct vkd3d_instance *instance;
const struct vkd3d_instance_create_info *instance_create_info;
VkPhysicalDevice vk_physical_device;
const char * const *device_extensions;
uint32_t device_extension_count;
IUnknown *parent;
LUID adapter_luid;
};
struct vkd3d_optional_device_extensions_info
{
enum vkd3d_structure_type type;
const void *next;
const char * const *extensions;
uint32_t extension_count;
};
#define VKD3D_RESOURCE_INITIAL_STATE_TRANSITION 0x00000001
#define VKD3D_RESOURCE_PRESENT_STATE_TRANSITION 0x00000002
struct vkd3d_image_resource_create_info
{
enum vkd3d_structure_type type;
const void *next;
VkImage vk_image;
D3D12_RESOURCE_DESC desc;
unsigned int flags;
D3D12_RESOURCE_STATES present_state;
};
#ifdef LIBVKD3D_SOURCE
# define VKD3D_API VKD3D_EXPORT
#else
# define VKD3D_API VKD3D_IMPORT
#endif
#ifndef VKD3D_NO_PROTOTYPES
VKD3D_API HRESULT vkd3d_create_instance(const struct vkd3d_instance_create_info *create_info,
struct vkd3d_instance **instance);
VKD3D_API ULONG vkd3d_instance_decref(struct vkd3d_instance *instance);
VKD3D_API VkInstance vkd3d_instance_get_vk_instance(struct vkd3d_instance *instance);
VKD3D_API ULONG vkd3d_instance_incref(struct vkd3d_instance *instance);
VKD3D_API HRESULT vkd3d_create_device(const struct vkd3d_device_create_info *create_info,
REFIID iid, void **device);
VKD3D_API IUnknown *vkd3d_get_device_parent(ID3D12Device *device);
VKD3D_API VkDevice vkd3d_get_vk_device(ID3D12Device *device);
VKD3D_API VkPhysicalDevice vkd3d_get_vk_physical_device(ID3D12Device *device);
VKD3D_API struct vkd3d_instance *vkd3d_instance_from_device(ID3D12Device *device);
VKD3D_API uint32_t vkd3d_get_vk_queue_family_index(ID3D12CommandQueue *queue);
VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue);
VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue);
VKD3D_API HRESULT vkd3d_create_image_resource(ID3D12Device *device,
const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
VKD3D_API ULONG vkd3d_resource_decref(ID3D12Resource *resource);
VKD3D_API ULONG vkd3d_resource_incref(ID3D12Resource *resource);
VKD3D_API HRESULT vkd3d_serialize_root_signature(const D3D12_ROOT_SIGNATURE_DESC *desc,
D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
VKD3D_API HRESULT vkd3d_create_root_signature_deserializer(const void *data, SIZE_T data_size,
REFIID iid, void **deserializer);
VKD3D_API VkFormat vkd3d_get_vk_format(DXGI_FORMAT format);
/* 1.1 */
VKD3D_API DXGI_FORMAT vkd3d_get_dxgi_format(VkFormat format);
/* 1.2 */
VKD3D_API HRESULT vkd3d_serialize_versioned_root_signature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
ID3DBlob **blob, ID3DBlob **error_blob);
VKD3D_API HRESULT vkd3d_create_versioned_root_signature_deserializer(const void *data, SIZE_T data_size,
REFIID iid, void **deserializer);
VKD3D_API void vkd3d_set_log_callback(PFN_vkd3d_log callback);
VKD3D_API HRESULT vkd3d_queue_signal_on_cpu(ID3D12CommandQueue *queue,
ID3D12Fence *fence, uint64_t value);
#endif /* VKD3D_NO_PROTOTYPES */
/*
* Function pointer typedefs for vkd3d functions.
*/
typedef HRESULT (*PFN_vkd3d_create_instance)(const struct vkd3d_instance_create_info *create_info,
struct vkd3d_instance **instance);
typedef ULONG (*PFN_vkd3d_instance_decref)(struct vkd3d_instance *instance);
typedef VkInstance (*PFN_vkd3d_instance_get_vk_instance)(struct vkd3d_instance *instance);
typedef ULONG (*PFN_vkd3d_instance_incref)(struct vkd3d_instance *instance);
typedef HRESULT (*PFN_vkd3d_create_device)(const struct vkd3d_device_create_info *create_info,
REFIID iid, void **device);
typedef IUnknown * (*PFN_vkd3d_get_device_parent)(ID3D12Device *device);
typedef VkDevice (*PFN_vkd3d_get_vk_device)(ID3D12Device *device);
typedef VkPhysicalDevice (*PFN_vkd3d_get_vk_physical_device)(ID3D12Device *device);
typedef struct vkd3d_instance * (*PFN_vkd3d_instance_from_device)(ID3D12Device *device);
typedef uint32_t (*PFN_vkd3d_get_vk_queue_family_index)(ID3D12CommandQueue *queue);
typedef VkQueue (*PFN_vkd3d_acquire_vk_queue)(ID3D12CommandQueue *queue);
typedef void (*PFN_vkd3d_release_vk_queue)(ID3D12CommandQueue *queue);
typedef HRESULT (*PFN_vkd3d_create_image_resource)(ID3D12Device *device,
const struct vkd3d_image_resource_create_info *create_info, ID3D12Resource **resource);
typedef ULONG (*PFN_vkd3d_resource_decref)(ID3D12Resource *resource);
typedef ULONG (*PFN_vkd3d_resource_incref)(ID3D12Resource *resource);
typedef HRESULT (*PFN_vkd3d_serialize_root_signature)(const D3D12_ROOT_SIGNATURE_DESC *desc,
D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
typedef HRESULT (*PFN_vkd3d_create_root_signature_deserializer)(const void *data, SIZE_T data_size,
REFIID iid, void **deserializer);
typedef VkFormat (*PFN_vkd3d_get_vk_format)(DXGI_FORMAT format);
/* 1.1 */
typedef DXGI_FORMAT (*PFN_vkd3d_get_dxgi_format)(VkFormat format);
/* 1.2 */
typedef HRESULT (*PFN_vkd3d_serialize_versioned_root_signature)(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
ID3DBlob **blob, ID3DBlob **error_blob);
typedef HRESULT (*PFN_vkd3d_create_versioned_root_signature_deserializer)(const void *data, SIZE_T data_size,
REFIID iid, void **deserializer);
typedef void (*PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback);
typedef HRESULT (*PFN_vkd3d_queue_signal_on_cpu)(ID3D12CommandQueue *queue,
ID3D12Fence *fence, uint64_t value);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* __VKD3D_H */
vkd3d_application_info
A chained structure to specify application information.
Definition vkd3d.h:194
vkd3d_application_info::engine_version
uint32_t engine_version
The engine version, to be passed to the Vulkan implementation.
Definition vkd3d.h:217
vkd3d_application_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:198
vkd3d_application_info::api_version
enum vkd3d_api_version api_version
The vkd3d API version to use, to guarantee backward compatibility of the shared library.
Definition vkd3d.h:223
vkd3d_application_info::engine_name
const char * engine_name
The engine name, to be passed to the Vulkan implementation.
Definition vkd3d.h:212
vkd3d_application_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_APPLICATION_INFO.
Definition vkd3d.h:196
vkd3d_application_info::application_name
const char * application_name
The application's name, to be passed to the Vulkan implementation.
Definition vkd3d.h:205
vkd3d_application_info::application_version
uint32_t application_version
The application's version, to be passed to the Vulkan implementation.
Definition vkd3d.h:207
vkd3d_device_create_info
A chained structure containing device creation parameters.
Definition vkd3d.h:253
vkd3d_device_create_info::instance
struct vkd3d_instance * instance
The vkd3d instance to use to create a device.
Definition vkd3d.h:267
vkd3d_device_create_info::adapter_luid
LUID adapter_luid
The adapter LUID to be set for the device.
Definition vkd3d.h:299
vkd3d_device_create_info::instance_create_info
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:272
vkd3d_device_create_info::parent
IUnknown * parent
An object to be set as the device parent.
Definition vkd3d.h:294
vkd3d_device_create_info::device_extension_count
uint32_t device_extension_count
The number of elements in the device_extensions array.
Definition vkd3d.h:288
vkd3d_device_create_info::minimum_feature_level
D3D_FEATURE_LEVEL minimum_feature_level
The minimum feature level to request.
Definition vkd3d.h:261
vkd3d_device_create_info::device_extensions
const char *const * device_extensions
A list of Vulkan device extensions to request.
Definition vkd3d.h:286
vkd3d_device_create_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:257
vkd3d_device_create_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO.
Definition vkd3d.h:255
vkd3d_device_create_info::vk_physical_device
VkPhysicalDevice vk_physical_device
The Vulkan physical device to use.
Definition vkd3d.h:280
vkd3d_host_time_domain_info
A chained structure to specify the host time domain.
Definition vkd3d.h:234
vkd3d_host_time_domain_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO.
Definition vkd3d.h:236
vkd3d_host_time_domain_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:238
vkd3d_host_time_domain_info::ticks_per_second
uint64_t ticks_per_second
The number of clock ticks per second, used for GetClockCalibration().
Definition vkd3d.h:246
vkd3d_image_resource_create_info
A chained structure containing the parameters to create a D3D12 resource backed by a Vulkan image.
Definition vkd3d.h:343
vkd3d_image_resource_create_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:347
vkd3d_image_resource_create_info::vk_image
VkImage vk_image
The Vulkan image that backs the resource.
Definition vkd3d.h:350
vkd3d_image_resource_create_info::present_state
D3D12_RESOURCE_STATES present_state
This field specifies how to handle resource state D3D12_RESOURCE_STATE_PRESENT for the resource.
Definition vkd3d.h:377
vkd3d_image_resource_create_info::flags
unsigned int flags
A combination of zero or more flags.
Definition vkd3d.h:357
vkd3d_image_resource_create_info::desc
D3D12_RESOURCE_DESC desc
The resource description.
Definition vkd3d.h:352
vkd3d_image_resource_create_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO.
Definition vkd3d.h:345
vkd3d_instance_create_info
A chained structure containing instance creation parameters.
Definition vkd3d.h:125
vkd3d_instance_create_info::wchar_size
size_t wchar_size
The size of type WCHAR.
Definition vkd3d.h:146
vkd3d_instance_create_info::instance_extensions
const char *const * instance_extensions
A list of Vulkan instance extensions to request.
Definition vkd3d.h:158
vkd3d_instance_create_info::instance_extension_count
uint32_t instance_extension_count
The number of elements in the instance_extensions array.
Definition vkd3d.h:160
vkd3d_instance_create_info::pfn_signal_event
PFN_vkd3d_signal_event pfn_signal_event
An pointer to a function to signal events.
Definition vkd3d.h:132
vkd3d_instance_create_info::pfn_vkGetInstanceProcAddr
PFN_vkGetInstanceProcAddr pfn_vkGetInstanceProcAddr
A pointer to the vkGetInstanceProcAddr Vulkan function, which will be used to load all the other Vulk...
Definition vkd3d.h:152
vkd3d_instance_create_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:129
vkd3d_instance_create_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO.
Definition vkd3d.h:127
vkd3d_instance_create_info::pfn_join_thread
PFN_vkd3d_join_thread pfn_join_thread
An optional pointer to a function to join threads.
Definition vkd3d.h:144
vkd3d_instance_create_info::pfn_create_thread
PFN_vkd3d_create_thread pfn_create_thread
An optional pointer to a function to create threads.
Definition vkd3d.h:138
vkd3d_optional_device_extensions_info
A chained structure to specify optional device extensions.
Definition vkd3d.h:310
vkd3d_optional_device_extensions_info::extension_count
uint32_t extension_count
The number of elements in the extensions array.
Definition vkd3d.h:322
vkd3d_optional_device_extensions_info::extensions
const char *const * extensions
A list of optional Vulkan device extensions to request.
Definition vkd3d.h:320
vkd3d_optional_device_extensions_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO.
Definition vkd3d.h:312
vkd3d_optional_device_extensions_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:314
vkd3d_optional_instance_extensions_info
A chained structure to specify optional instance extensions.
Definition vkd3d.h:171
vkd3d_optional_instance_extensions_info::extension_count
uint32_t extension_count
The number of elements in the extensions array.
Definition vkd3d.h:183
vkd3d_optional_instance_extensions_info::type
enum vkd3d_structure_type type
Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO.
Definition vkd3d.h:173
vkd3d_optional_instance_extensions_info::next
const void * next
Optional pointer to a structure containing further parameters.
Definition vkd3d.h:175
vkd3d_optional_instance_extensions_info::extensions
const char *const * extensions
A list of optional Vulkan instance extensions to request.
Definition vkd3d.h:181
vkd3d_acquire_vk_queue
VKD3D_API VkQueue vkd3d_acquire_vk_queue(ID3D12CommandQueue *queue)
Acquire the Vulkan queue backing a command queue.
PFN_vkd3d_queue_signal_on_cpu
HRESULT(* PFN_vkd3d_queue_signal_on_cpu)(ID3D12CommandQueue *queue, ID3D12Fence *fence, uint64_t value)
Type of vkd3d_queue_signal_on_cpu().
Definition vkd3d.h:541
vkd3d_queue_signal_on_cpu
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_set_log_callback
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
vkd3d_structure_type
The type of a chained structure.
Definition vkd3d.h:51
VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO
@ 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
@ 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
@ 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
@ 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
@ 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
@ 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
@ VKD3D_STRUCTURE_TYPE_APPLICATION_INFO
The structure is a vkd3d_application_info structure.
Definition vkd3d.h:74
vkd3d_release_vk_queue
VKD3D_API void vkd3d_release_vk_queue(ID3D12CommandQueue *queue)
Release the Vulkan queue backing a command queue.
PFN_vkd3d_set_log_callback
void(* PFN_vkd3d_set_log_callback)(PFN_vkd3d_log callback)
Type of vkd3d_set_log_callback().
Definition vkd3d.h:538
vkd3d_types.h
This file contains definitions for basic types used by vkd3d libraries.