vkd3d 2.1
The vkd3d 3D Graphics Library
Loading...
Searching...
No Matches
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
30extern "C" {
31#endif /* __cplusplus */
32
43
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
55struct ID3D10ShaderReflection;
56
57/* 1.0 */
58VKD3D_UTILS_API HANDLE vkd3d_create_event(void);
59VKD3D_UTILS_API HRESULT vkd3d_signal_event(HANDLE event);
60VKD3D_UTILS_API unsigned int vkd3d_wait_event(HANDLE event, unsigned int milliseconds);
61VKD3D_UTILS_API void vkd3d_destroy_event(HANDLE event);
62
63#if __STDC_VERSION__ >= 199901L || __cplusplus >= 201103L
64# define D3D12CreateDevice(...) D3D12CreateDeviceVKD3D(__VA_ARGS__, VKD3D_UTILS_API_VERSION)
65#else
66# define D3D12CreateDevice(a, b, c, d) D3D12CreateDeviceVKD3D(a, b, c, d, VKD3D_UTILS_API_VERSION)
67#endif
68VKD3D_UTILS_API HRESULT WINAPI D3D12CreateRootSignatureDeserializer(
69 const void *data, SIZE_T data_size, REFIID iid, void **deserializer);
70VKD3D_UTILS_API HRESULT WINAPI D3D12GetDebugInterface(REFIID iid, void **debug);
71VKD3D_UTILS_API HRESULT WINAPI D3D12SerializeRootSignature(const D3D12_ROOT_SIGNATURE_DESC *desc,
72 D3D_ROOT_SIGNATURE_VERSION version, ID3DBlob **blob, ID3DBlob **error_blob);
73
74/* 1.2 */
75VKD3D_UTILS_API HRESULT WINAPI D3D12CreateDeviceVKD3D(IUnknown *adapter, D3D_FEATURE_LEVEL feature_level,
76 REFIID iid, void **device, enum vkd3d_api_version api_version);
77VKD3D_UTILS_API HRESULT WINAPI D3D12CreateVersionedRootSignatureDeserializer(const void *data,
78 SIZE_T data_size, REFIID iid, void **deserializer);
79VKD3D_UTILS_API HRESULT WINAPI D3D12SerializeVersionedRootSignature(const D3D12_VERSIONED_ROOT_SIGNATURE_DESC *desc,
80 ID3DBlob **blob, ID3DBlob **error_blob);
81
82/* 1.3 */
83VKD3D_UTILS_API HRESULT WINAPI D3DCompile(const void *data, SIZE_T data_size, const char *filename,
84 const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
85 const char *target, UINT flags, UINT effect_flags, ID3DBlob **shader, ID3DBlob **error_messages);
92VKD3D_UTILS_API HRESULT WINAPI D3DCompile2(const void *data, SIZE_T data_size, const char *filename,
93 const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
94 const char *target, UINT flags, UINT effect_flags, UINT secondary_flags,
95 const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader,
96 ID3DBlob **error_messages);
97VKD3D_UTILS_API HRESULT WINAPI D3DCreateBlob(SIZE_T data_size, ID3DBlob **blob);
104VKD3D_UTILS_API HRESULT WINAPI D3DPreprocess(const void *data, SIZE_T size, const char *filename,
105 const D3D_SHADER_MACRO *defines, ID3DInclude *include,
106 ID3DBlob **shader, ID3DBlob **error_messages);
107
121VKD3D_UTILS_API void vkd3d_utils_set_log_callback(PFN_vkd3d_log callback);
122
124VKD3D_UTILS_API HRESULT WINAPI D3DGetBlobPart(const void *data,
125 SIZE_T data_size, D3D_BLOB_PART part, UINT flags, ID3DBlob **blob);
127VKD3D_UTILS_API HRESULT WINAPI D3DGetDebugInfo(const void *data, SIZE_T data_size, ID3DBlob **blob);
129VKD3D_UTILS_API HRESULT WINAPI D3DGetInputAndOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
131VKD3D_UTILS_API HRESULT WINAPI D3DGetInputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
133VKD3D_UTILS_API HRESULT WINAPI D3DGetOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob);
135VKD3D_UTILS_API HRESULT WINAPI D3DStripShader(const void *data, SIZE_T data_size, UINT flags, ID3DBlob **blob);
136
138VKD3D_UTILS_API HRESULT WINAPI D3DDisassemble(const void *data,
139 SIZE_T data_size, UINT flags, const char *comments, ID3DBlob **blob);
141VKD3D_UTILS_API HRESULT WINAPI D3DReflect(const void *data, SIZE_T data_size, REFIID iid, void **reflection);
143VKD3D_UTILS_API HRESULT WINAPI D3D10ReflectShader(const void *data,
144 SIZE_T data_size, struct ID3D10ShaderReflection **reflection);
145
159VKD3D_UTILS_API HRESULT WINAPI D3DCompile2VKD3D(const void *data, SIZE_T data_size, const char *filename,
160 const D3D_SHADER_MACRO *defines, ID3DInclude *include, const char *entrypoint,
161 const char *target, UINT flags, UINT effect_flags, UINT secondary_flags,
162 const void *secondary_data, SIZE_T secondary_data_size, ID3DBlob **shader,
163 ID3DBlob **error_messages, unsigned int compiler_version);
164
178VKD3D_UTILS_API HRESULT WINAPI D3DPreprocessVKD3D(const void *data, SIZE_T size,
179 const char *filename, const D3D_SHADER_MACRO *defines, ID3DInclude *include,
180 ID3DBlob **shader, ID3DBlob **error_messages, unsigned int compiler_version);
181
193VKD3D_UTILS_API HRESULT WINAPI D3DReflectVKD3D(const void *data,
194 SIZE_T data_size, REFIID iid, void **reflection, unsigned int version);
195
196#ifdef __cplusplus
197}
198#endif /* __cplusplus */
199
200#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 D3DPreprocess(const void *data, SIZE_T size, const char *filename, const D3D_SHADER_MACRO *defines, ID3DInclude *include, ID3DBlob **shader, ID3DBlob **error_messages)
D3DPreprocess() targets the behaviour of d3dcompiler_47.dll.
VKD3D_UTILS_API HRESULT WINAPI D3DReflect(const void *data, SIZE_T data_size, REFIID iid, void **reflection)
VKD3D_UTILS_API HRESULT WINAPI D3DReflectVKD3D(const void *data, SIZE_T data_size, REFIID iid, void **reflection, unsigned int version)
As D3DReflect(), but with an extra argument that allows targeting different d3dcompiler versions.
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 D3DPreprocessVKD3D(const void *data, SIZE_T size, const char *filename, const D3D_SHADER_MACRO *defines, ID3DInclude *include, ID3DBlob **shader, ID3DBlob **error_messages, unsigned int compiler_version)
As D3DPreprocess(), but with an extra argument that allows targeting different d3dcompiler versions.
VKD3D_UTILS_API HRESULT WINAPI D3DGetInputAndOutputSignatureBlob(const void *data, SIZE_T data_size, ID3DBlob **blob)
VKD3D_UTILS_API HRESULT WINAPI D3D10ReflectShader(const void *data, SIZE_T data_size, struct ID3D10ShaderReflection **reflection)