Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 1 | #ifndef __XGLDBG_H__ |
| 2 | #define __XGLDBG_H__ |
| 3 | |
| 4 | #include <xgl.h> |
| 5 | |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" |
| 8 | { |
| 9 | #endif // __cplusplus |
| 10 | |
| 11 | typedef enum _XGL_DBG_MSG_TYPE |
| 12 | { |
| 13 | XGL_DBG_MSG_UNKNOWN = 0x0, |
| 14 | XGL_DBG_MSG_ERROR = 0x1, |
| 15 | XGL_DBG_MSG_WARNING = 0x2, |
| 16 | XGL_DBG_MSG_PERF_WARNING = 0x3, |
| 17 | |
| 18 | XGL_DBG_MSG_TYPE_BEGIN_RANGE = XGL_DBG_MSG_UNKNOWN, |
| 19 | XGL_DBG_MSG_TYPE_END_RANGE = XGL_DBG_MSG_PERF_WARNING, |
| 20 | XGL_NUM_DBG_MSG_TYPE = (XGL_DBG_MSG_TYPE_END_RANGE - XGL_DBG_MSG_TYPE_BEGIN_RANGE + 1), |
| 21 | } XGL_DBG_MSG_TYPE; |
| 22 | |
| 23 | typedef enum _XGL_DBG_MSG_FILTER |
| 24 | { |
| 25 | XGL_DBG_MSG_FILTER_NONE = 0x0, |
| 26 | XGL_DBG_MSG_FILTER_REPEATED = 0x1, |
| 27 | XGL_DBG_MSG_FILTER_ALL = 0x2, |
| 28 | |
| 29 | XGL_DBG_MSG_FILTER_BEGIN_RANGE = XGL_DBG_MSG_FILTER_NONE, |
| 30 | XGL_DBG_MSG_FILTER_END_RANGE = XGL_DBG_MSG_FILTER_ALL, |
| 31 | XGL_NUM_DBG_MSG_FILTER = (XGL_DBG_MSG_FILTER_END_RANGE - XGL_DBG_MSG_FILTER_BEGIN_RANGE + 1), |
| 32 | } XGL_DBG_MSG_FILTER; |
| 33 | |
| 34 | typedef enum _XGL_DBG_GLOBAL_OPTION |
| 35 | { |
| 36 | XGL_DBG_OPTION_DEBUG_ECHO_ENABLE = 0x0, |
| 37 | XGL_DBG_OPTION_BREAK_ON_ERROR = 0x1, |
| 38 | XGL_DBG_OPTION_BREAK_ON_WARNING = 0x2, |
| 39 | |
| 40 | XGL_DBG_GLOBAL_OPTION_BEGIN_RANGE = XGL_DBG_OPTION_DEBUG_ECHO_ENABLE, |
| 41 | XGL_DBG_GLOBAL_OPTION_END_RANGE = XGL_DBG_OPTION_BREAK_ON_WARNING, |
| 42 | XGL_NUM_DBG_GLOBAL_OPTION = (XGL_DBG_GLOBAL_OPTION_END_RANGE - XGL_DBG_GLOBAL_OPTION_BEGIN_RANGE + 1), |
| 43 | } XGL_DBG_GLOBAL_OPTION; |
| 44 | |
| 45 | typedef enum _XGL_DBG_DEVICE_OPTION |
| 46 | { |
| 47 | XGL_DBG_OPTION_DISABLE_PIPELINE_LOADS = 0x0, |
| 48 | XGL_DBG_OPTION_FORCE_OBJECT_MEMORY_REQS = 0x1, |
| 49 | XGL_DBG_OPTION_FORCE_LARGE_IMAGE_ALIGNMENT = 0x2, |
| 50 | |
| 51 | XGL_DBG_DEVICE_OPTION_BEGIN_RANGE = XGL_DBG_OPTION_DISABLE_PIPELINE_LOADS, |
| 52 | XGL_DBG_DEVICE_OPTION_END_RANGE = XGL_DBG_OPTION_FORCE_LARGE_IMAGE_ALIGNMENT, |
| 53 | XGL_NUM_DBG_DEVICE_OPTION = (XGL_DBG_DEVICE_OPTION_END_RANGE - XGL_DBG_DEVICE_OPTION_BEGIN_RANGE + 1), |
| 54 | } XGL_DBG_DEVICE_OPTION; |
| 55 | |
Chia-I Wu | 450a423 | 2014-08-05 14:50:53 +0800 | [diff] [blame] | 56 | typedef enum _XGL_DBG_OBJECT_TYPE |
| 57 | { |
| 58 | XGL_DBG_OBJECT_UNKNOWN = 0x00, |
| 59 | XGL_DBG_OBJECT_DEVICE = 0x01, |
| 60 | XGL_DBG_OBJECT_QUEUE = 0x02, |
| 61 | XGL_DBG_OBJECT_GPU_MEMORY = 0x03, |
| 62 | XGL_DBG_OBJECT_IMAGE = 0x04, |
| 63 | XGL_DBG_OBJECT_IMAGE_VIEW = 0x05, |
| 64 | XGL_DBG_OBJECT_COLOR_TARGET_VIEW = 0x06, |
| 65 | XGL_DBG_OBJECT_DEPTH_STENCIL_VIEW = 0x07, |
| 66 | XGL_DBG_OBJECT_SHADER = 0x08, |
| 67 | XGL_DBG_OBJECT_GRAPHICS_PIPELINE = 0x09, |
| 68 | XGL_DBG_OBJECT_COMPUTE_PIPELINE = 0x0a, |
| 69 | XGL_DBG_OBJECT_SAMPLER = 0x0b, |
| 70 | XGL_DBG_OBJECT_DESCRIPTOR_SET = 0x0c, |
| 71 | XGL_DBG_OBJECT_VIEWPORT_STATE = 0x0d, |
| 72 | XGL_DBG_OBJECT_RASTER_STATE = 0x0e, |
| 73 | XGL_DBG_OBJECT_MSAA_STATE = 0x0f, |
| 74 | XGL_DBG_OBJECT_COLOR_BLEND_STATE = 0x10, |
| 75 | XGL_DBG_OBJECT_DEPTH_STENCIL_STATE = 0x11, |
| 76 | XGL_DBG_OBJECT_CMD_BUFFER = 0x12, |
| 77 | XGL_DBG_OBJECT_FENCE = 0x13, |
| 78 | XGL_DBG_OBJECT_QUEUE_SEMAPHORE = 0x14, |
| 79 | XGL_DBG_OBJECT_EVENT = 0x15, |
| 80 | XGL_DBG_OBJECT_QUERY_POOL = 0x16, |
| 81 | XGL_DBG_OBJECT_SHARED_GPU_MEMORY = 0x17, |
| 82 | XGL_DBG_OBJECT_SHARED_QUEUE_SEMAPHORE = 0x18, |
| 83 | XGL_DBG_OBJECT_PEER_GPU_MEMORY = 0x19, |
| 84 | XGL_DBG_OBJECT_PEER_IMAGE = 0x1a, |
| 85 | XGL_DBG_OBJECT_PINNED_GPU_MEMORY = 0x1b, |
| 86 | XGL_DBG_OBJECT_INTERNAL_GPU_MEMORY = 0x1c, |
Jon Ashburn | fa42099 | 2014-12-24 12:09:06 -0700 | [diff] [blame] | 87 | XGL_DBG_OBJECT_FRAMEBUFFER = 0x1d, |
| 88 | XGL_DBG_OBJECT_RENDER_PASS = 0x1e, |
Chia-I Wu | 450a423 | 2014-08-05 14:50:53 +0800 | [diff] [blame] | 89 | |
Chia-I Wu | 1a28fe0 | 2015-01-01 07:55:04 +0800 | [diff] [blame] | 90 | XGL_DBG_OBJECT_BUFFER, |
| 91 | XGL_DBG_OBJECT_BUFFER_VIEW, |
Chia-I Wu | 11078b0 | 2015-01-04 16:27:24 +0800 | [diff] [blame] | 92 | XGL_DBG_OBJECT_DESCRIPTOR_SET_LAYOUT, |
| 93 | XGL_DBG_OBJECT_DESCRIPTOR_REGION, |
Chia-I Wu | 1a28fe0 | 2015-01-01 07:55:04 +0800 | [diff] [blame] | 94 | |
Chia-I Wu | 450a423 | 2014-08-05 14:50:53 +0800 | [diff] [blame] | 95 | XGL_DBG_OBJECT_TYPE_BEGIN_RANGE = XGL_DBG_OBJECT_UNKNOWN, |
Jon Ashburn | 9c9340f | 2015-01-28 15:05:09 -0700 | [diff] [blame] | 96 | XGL_DBG_OBJECT_TYPE_END_RANGE = XGL_DBG_OBJECT_DESCRIPTOR_REGION, |
Chia-I Wu | 450a423 | 2014-08-05 14:50:53 +0800 | [diff] [blame] | 97 | XGL_NUM_DBG_OBJECT_TYPE = (XGL_DBG_OBJECT_TYPE_END_RANGE - XGL_DBG_OBJECT_TYPE_BEGIN_RANGE + 1), |
| 98 | } XGL_DBG_OBJECT_TYPE; |
| 99 | |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 100 | typedef void (XGLAPI *XGL_DBG_MSG_CALLBACK_FUNCTION)( |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 101 | XGL_DBG_MSG_TYPE msgType, |
| 102 | XGL_VALIDATION_LEVEL validationLevel, |
| 103 | XGL_BASE_OBJECT srcObject, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 104 | size_t location, |
| 105 | int32_t msgCode, |
| 106 | const char* pMsg, |
| 107 | void* pUserData); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 108 | |
| 109 | // Debug functions |
Mark Lobodzinski | 391bb6d | 2015-01-09 15:12:03 -0600 | [diff] [blame] | 110 | typedef XGL_RESULT (XGLAPI *xglDbgSetValidationLevelType)(XGL_DEVICE device, XGL_VALIDATION_LEVEL validationLevel); |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 111 | typedef XGL_RESULT (XGLAPI *xglDbgRegisterMsgCallbackType)(XGL_DBG_MSG_CALLBACK_FUNCTION pfnMsgCallback, void* pUserData); |
Mark Lobodzinski | 391bb6d | 2015-01-09 15:12:03 -0600 | [diff] [blame] | 112 | typedef XGL_RESULT (XGLAPI *xglDbgUnregisterMsgCallbackType)(XGL_DBG_MSG_CALLBACK_FUNCTION pfnMsgCallback); |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 113 | typedef XGL_RESULT (XGLAPI *xglDbgSetMessageFilterType)(XGL_DEVICE device, int32_t msgCode, XGL_DBG_MSG_FILTER filter); |
| 114 | typedef XGL_RESULT (XGLAPI *xglDbgSetObjectTagType)(XGL_BASE_OBJECT object, size_t tagSize, const void* pTag); |
| 115 | typedef XGL_RESULT (XGLAPI *xglDbgSetGlobalOptionType)(XGL_DBG_GLOBAL_OPTION dbgOption, size_t dataSize, const void* pData); |
| 116 | typedef XGL_RESULT (XGLAPI *xglDbgSetDeviceOptionType)(XGL_DEVICE device, XGL_DBG_DEVICE_OPTION dbgOption, size_t dataSize, const void* pData); |
| 117 | typedef void (XGLAPI *xglCmdDbgMarkerBeginType)(XGL_CMD_BUFFER cmdBuffer, const char* pMarker); |
| 118 | typedef void (XGLAPI *xglCmdDbgMarkerEndType)(XGL_CMD_BUFFER cmdBuffer); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 119 | |
| 120 | XGL_RESULT XGLAPI xglDbgSetValidationLevel( |
| 121 | XGL_DEVICE device, |
| 122 | XGL_VALIDATION_LEVEL validationLevel); |
| 123 | |
| 124 | XGL_RESULT XGLAPI xglDbgRegisterMsgCallback( |
| 125 | XGL_DBG_MSG_CALLBACK_FUNCTION pfnMsgCallback, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 126 | void* pUserData); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 127 | |
| 128 | XGL_RESULT XGLAPI xglDbgUnregisterMsgCallback( |
| 129 | XGL_DBG_MSG_CALLBACK_FUNCTION pfnMsgCallback); |
| 130 | |
| 131 | XGL_RESULT XGLAPI xglDbgSetMessageFilter( |
| 132 | XGL_DEVICE device, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 133 | int32_t msgCode, |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 134 | XGL_DBG_MSG_FILTER filter); |
| 135 | |
| 136 | XGL_RESULT XGLAPI xglDbgSetObjectTag( |
| 137 | XGL_BASE_OBJECT object, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 138 | size_t tagSize, |
| 139 | const void* pTag); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 140 | |
| 141 | XGL_RESULT XGLAPI xglDbgSetGlobalOption( |
| 142 | XGL_DBG_GLOBAL_OPTION dbgOption, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 143 | size_t dataSize, |
| 144 | const void* pData); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 145 | |
| 146 | XGL_RESULT XGLAPI xglDbgSetDeviceOption( |
| 147 | XGL_DEVICE device, |
| 148 | XGL_DBG_DEVICE_OPTION dbgOption, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 149 | size_t dataSize, |
| 150 | const void* pData); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 151 | |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 152 | void XGLAPI xglCmdDbgMarkerBegin( |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 153 | XGL_CMD_BUFFER cmdBuffer, |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 154 | const char* pMarker); |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 155 | |
Mark Lobodzinski | 17caf57 | 2015-01-29 08:55:56 -0600 | [diff] [blame^] | 156 | void XGLAPI xglCmdDbgMarkerEnd( |
Chia-I Wu | 68a5524 | 2014-08-01 11:18:21 +0800 | [diff] [blame] | 157 | XGL_CMD_BUFFER cmdBuffer); |
| 158 | |
| 159 | #ifdef __cplusplus |
| 160 | }; // extern "C" |
| 161 | #endif // __cplusplus |
| 162 | |
| 163 | #endif // __XGLDBG_H__ |