vkd3d  1.15
The vkd3d 3D Graphics Library
vkd3d_utils.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_UTILS_H
20 #define __VKD3D_UTILS_H
21 
22 #include <vkd3d.h>
23 #include <vkd3d_d3dcompiler_types.h>
24 
25 #ifndef VKD3D_UTILS_API_VERSION
26 #define VKD3D_UTILS_API_VERSION VKD3D_API_VERSION_1_0
27 #endif
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif /* __cplusplus */
32 
44 #define VKD3D_WAIT_OBJECT_0 (0)
45 #define VKD3D_WAIT_TIMEOUT (1)
46 #define VKD3D_WAIT_FAILED (~0u)
47 #define VKD3D_INFINITE (~0u)
48 
49 #ifdef LIBVKD3D_UTILS_SOURCE
50 # define VKD3D_UTILS_API VKD3D_EXPORT
51 #else
52 # define VKD3D_UTILS_API VKD3D_IMPORT
53 #endif
54 
55 /* 1.0 */
56 VKD3D_UTILS_API HANDLE vkd3d_create_event(void);
57 VKD3D_UTILS_API HRESULT vkd3d_signal_event(HANDLE event);
58 VKD3D_UTILS_API unsigned int vkd3d_wait_event(HANDLE event, unsigned int milliseconds);
59 VKD3D_UTILS_API void vkd3d_destroy_event(HANDLE event);
60 
61 #if __STDC_VERSION__ >= 199901L || __cplusplus >= 201103L
62 # define D3D12CreateDevice(...) D3D12CreateDeviceVKD3D(__VA_ARGS__, VKD3D_UTILS_API_VERSION)
63 #else
64 # define D3D12CreateDevice(a, b, c, d) D3D12CreateDeviceVKD3D(a, b, c, d, VKD3D_UTILS_API_VERSION)
65 #endif
66 VKD3D_UTILS_API HRESULT WINAPI D3D12CreateRootSignatureDeserializer(
67  const void *data, SIZE_T data_size, REFIID iid, void **deserializer);
68 VKD3D_UTILS_API HRESULT WINAPI D3D12GetDebugInterface(REFIID iid, void **debug);
69 VKD3D_UTILS_API HRESULT WINAPI D3D12SerializeRootSignature(const D3D12_ROOT_SIGNATURE_DESC *desc,
70  D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
71 
72 /* 1.2 */
73 VKD3D_UTILS_API HRESULT WINAPI D3D12CreateDeviceVKD3D(IUnknown *adapter, D3D_FEATURE_LEVEL feature_level,
74  REFIID iid, void **device, enum vkd3d_api_version api_version);
75 VKD3D_UTILS_API HRESULT WINAPI D3D12CreateVersionedRootSignatureDeserializer(const void *data,
76  SIZE_T data_size, REFIID iid, void **deserializer);
77 VKD3D_UTILS_API HRESULT WINAPI D3D12SerializeVersionedRootSignature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
78  ID3DBlob **blob, ID3DBlob **error_blob);
79 
80 /* 1.3 */
81 VKD3D_UTILS_API HRESULT WINAPI D3DCompile(const void *data, SIZE_T data_size, const char *filename,
82  const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
83  const char *target, UINT flags, UINT effect_flags, ID3DBlob **shader, ID3DBlob **error_messages);
90 VKD3D_UTILS_API HRESULT WINAPI D3DCompile2(const void *data, SIZE_T data_size, const char *filename,
91  const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
92  const char *target, UINT flags, UINT effect_flags, UINT secondary_flags,
93  const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader,
94  ID3DBlob **error_messages);
95 VKD3D_UTILS_API HRESULT WINAPI D3DCreateBlob(SIZE_T data_size, ID3DBlob **blob);
96 VKD3D_UTILS_API HRESULT WINAPI D3DPreprocess(const void *data, SIZE_T size, const char *filename,
97  const D3D_SHADER_MACRO *defines, ID3DInclude *include,
98  ID3DBlob **shader, ID3DBlob **error_messages);
99 
113 VKD3D_UTILS_API void vkd3d_utils_set_log_callback(PFN_vkd3d_log callback);
114 
116 VKD3D_UTILS_API HRESULT WINAPI D3DGetBlobPart(const void *data,
117  SIZE_T data_size, D3D_BLOB_PART part, UINT flags, ID3DBlob **blob);
119 VKD3D_UTILS_API HRESULT WINAPI D3DGetDebugInfo(const void *data, SIZE_T data_size, ID3DBlob **blob);
121 VKD3D_UTILS_API HRESULT WINAPI D3DGetInputAndOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
123 VKD3D_UTILS_API HRESULT WINAPI D3DGetInputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
125 VKD3D_UTILS_API HRESULT WINAPI D3DGetOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
127 VKD3D_UTILS_API HRESULT WINAPI D3DStripShader(const void *data, SIZE_T data_size, UINT flags, ID3DBlob **blob);
128 
130 VKD3D_UTILS_API HRESULT WINAPI D3DDisassemble(const void *data,
131  SIZE_T data_size, UINT flags, const char *comments, ID3DBlob **blob);
133 VKD3D_UTILS_API HRESULT WINAPI D3DReflect(const void *data, SIZE_T data_size, REFIID iid, void **reflection);
134 
145 VKD3D_UTILS_API HRESULT WINAPI D3DCompile2VKD3D(const void *data, SIZE_T data_size, const char *filename,
146  const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
147  const char *target, UINT flags, UINT effect_flags, UINT secondary_flags,
148  const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader,
149  ID3DBlob **error_messages, unsigned int compiler_version);
150 
151 #ifdef __cplusplus
152 }
153 #endif /* __cplusplus */
154 
155 #endif /* __VKD3D_UTILS_H */
This file contains definitions for the vkd3d library.
VKD3D_UTILS_API HRESULT WINAPI D3DStripShader(const void *data, SIZE_T data_size, UINT flags, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DCompile2VKD3D(const void *data, SIZE_T data_size, const char *filename, const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint, const char *target, UINT flags, UINT effect_flags, UINT secondary_flags, const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader, ID3DBlob **error_messages, unsigned int compiler_version)
As D3DCompile2(), but with an extra argument that allows targeting different d3dcompiler versions.
VKD3D_UTILS_API void vkd3d_utils_set_log_callback(PFN_vkd3d_log callback)
Set a callback to be called when vkd3d-utils outputs debug logging.
VKD3D_UTILS_API HRESULT WINAPI D3DGetOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DGetDebugInfo(const void *data, SIZE_T data_size, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DGetBlobPart(const void *data, SIZE_T data_size, D3D_BLOB_PART part, UINT flags, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DReflect(const void *data, SIZE_T data_size, REFIID iid, void **reflection)
VKD3D_UTILS_API HRESULT WINAPI D3DGetInputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DCompile2(const void *data, SIZE_T data_size, const char *filename, const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint, const char *target, UINT flags, UINT effect_flags, UINT secondary_flags, const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader, ID3DBlob **error_messages)
D3DCompile2() targets the behaviour of d3dcompiler_47.dll.
VKD3D_UTILS_API HRESULT WINAPI D3DDisassemble(const void *data, SIZE_T data_size, UINT flags, const char *comments, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3DGetInputAndOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob)