mirror of
https://gitlab.winehq.org/wine/vkd3d.git
synced 2024-11-21 16:46:41 -08:00
83c67e76ff
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>
61 lines
1.9 KiB
C
61 lines
1.9 KiB
C
/*
|
|
* Copyright 2016-2018 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_TYPES_H
|
|
#define __VKD3D_TYPES_H
|
|
|
|
#ifdef __cplusplus
|
|
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,
|
|
/** 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),
|
|
};
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* __VKD3D_TYPES_H */
|