wine/vkd3d
0
0
Fork 0
mirror of https://gitlab.winehq.org/wine/vkd3d.git synced 2025-09-12 18:50:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

include: Add basic documentation for vkd3d_types.h.

Browse Source 
This is built on Doxygen. I'm not personally attached to Doxygen, but it was
easy enough to set up and write for, and I've found its compiled HTML to be
reasonably legible.

Note that Doxygen does allow for specifying documentation in external files,
if keeping the documentation out of the header is desired.

Signed-off-by: Zebediah Figura <z.figura12@gmail.com>
Signed-off-by: Henri Verbeet <hverbeet@codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard@winehq.org>
This commit is contained in:
Zebediah Figura
2020-09-01 10:32:29 -05:00
committed by Alexandre Julliard
parent f895f0dce6
commit 83c67e76ff
6 changed files with 633 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/vkd3d_types.h
View File

@@ -23,15 +23,31 @@
extern "C" {
#endif /* __cplusplus */
/**
* \file vkd3d_types.h
*
* This file contains definitions for basic types used by vkd3d libraries.
*/
#define VKD3D_FORCE_32_BIT_ENUM(name) name##_FORCE_32BIT = 0x7fffffff
/**
* Result codes returned by some vkd3d functions. Error codes always have
* negative values; non-error codes never do.
*/
enum vkd3d_result
{
/** Success. */
VKD3D_OK = 0,
VKD3D_ERROR = -1, /* unspecified failure */
/** An unspecified failure occurred. */
VKD3D_ERROR = -1,
/** There are not enough resources available to complete the operation. */
VKD3D_ERROR_OUT_OF_MEMORY = -2,
/** One or more parameters passed to a vkd3d function were invalid. */
VKD3D_ERROR_INVALID_ARGUMENT = -3,
/** A shader passed to a vkd3d function was invalid. */
VKD3D_ERROR_INVALID_SHADER = -4,
/** The operation is not implemented in this version of vkd3d. */
VKD3D_ERROR_NOT_IMPLEMENTED = -5,
VKD3D_FORCE_32_BIT_ENUM(VKD3D_RESULT),