Fork of VKD3D. Development branches for Proton's Direct3D 12 implementation.
Go to file
Józef Kucia b402ae96a6 include: Include stdlib.h for malloc().
Signed-off-by: Józef Kucia <jkucia@codeweavers.com>
Signed-off-by: Henri Verbeet <hverbeet@codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard@winehq.org>
2019-01-31 18:06:24 +01:00
bin build: Add initial Autotools files. 2016-09-21 09:05:15 +02:00
crosslibs Add crosslibs .a to .gitignore. 2016-10-24 13:57:04 +02:00
demos demos: Check return value of ID3D12Fence_SetEventOnCompletion() (Coverity). 2018-10-24 17:00:47 +02:00
include include: Include stdlib.h for malloc(). 2019-01-31 18:06:24 +01:00
libs vkd3d-shader: Use VKD3D_SHADER_DEBUG instead of VKD3D_DEBUG. 2019-01-31 18:05:55 +01:00
m4 build: Check VK_HEADER_VERSION. 2018-10-29 17:08:38 +01:00
programs/vkd3d-compiler include: Include stdlib.h for malloc(). 2019-01-31 18:06:24 +01:00
tests tests: Add tests for image memory allocation info with various miplevels. 2019-01-31 18:05:49 +01:00
.gitignore build: The dist target produces .tar.xz files. 2017-07-10 16:32:01 +02:00
ANNOUNCE Release 1.1. 2018-10-05 13:48:18 -05:00
AUTHORS Release 1.1. 2018-10-05 13:48:18 -05:00
COPYING Update copyright info for 2019. 2019-01-10 10:03:58 -06:00
INSTALL build: Add some standard files. 2016-10-28 12:34:12 +02:00
LICENSE Update license to LGPL v2.1. 2017-06-16 22:11:21 +02:00
Makefile.am build: Add option to disable tests. 2019-01-31 18:06:07 +01:00
README readme: Expand on building and using vkd3d. 2019-01-25 19:12:07 +01:00
autogen.sh build: Add initial Autotools files. 2016-09-21 09:05:15 +02:00
configure.ac build: Add option to disable tests. 2019-01-31 18:06:07 +01:00

README

=============================
The vkd3d 3D Graphics Library
=============================

Vkd3d is a 3D graphics library built on top of Vulkan. It has an API very
similar, but not identical, to Direct3D 12.

==============
Building vkd3d
==============

Vkd3d depends on SPIRV-Headers and Vulkan-Headers (>= 1.1.88).

Vkd3d generates some of its headers from IDL files. If you are using the
release tarballs, then these headers are pre-generated and are included. If
you are building from git, then they will be generated at build-time using
widl. By default, vkd3d will use the widl found in `PATH'. If widl is not
available or is not recent (>= 3.0 or so), then you can build Wine with
`make tools/widl' to avoid building all of Wine. You can then point vkd3d's
configure at that widl binary with `WIDL="/path/to/widl"'.

===========
Using vkd3d
===========

Vkd3d can be used by projects that target Direct3D 12 as a drop-in replacement
at build-time with some modest source modifications.

If vkd3d is available when building Wine, then Wine will use it to support
Direct3D 12 applications.