1 /* 2 * 3 * AUTO GENERATED! DO NOT EDIT! 4 * 5 */ 6 7 module bindbc.bgfx.types; 8 9 public import core.stdc.stdarg : va_list; 10 11 extern(C) @nogc nothrow: 12 13 enum uint BGFX_API_VERSION = 100; 14 15 alias bgfx_view_id_t = ushort; 16 17 /// Memory release callback. 18 19 /// Color RGB/alpha/depth write. When it's not specified write will be disabled. 20 enum ulong BGFX_STATE_WRITE_R = 0x0000000000000001; /// Enable R write. 21 enum ulong BGFX_STATE_WRITE_G = 0x0000000000000002; /// Enable G write. 22 enum ulong BGFX_STATE_WRITE_B = 0x0000000000000004; /// Enable B write. 23 enum ulong BGFX_STATE_WRITE_A = 0x0000000000000008; /// Enable alpha write. 24 enum ulong BGFX_STATE_WRITE_Z = 0x0000004000000000; /// Enable depth write. 25 enum ulong BGFX_STATE_WRITE_RGB = 0x0000000000000007; /// Enable RGB write. 26 enum ulong BGFX_STATE_WRITE_MASK = 0x000000400000000f; /// Write all channels mask. 27 28 /// Depth test state. When `BGFX_STATE_DEPTH_` is not specified depth test will be disabled. 29 enum ulong BGFX_STATE_DEPTH_TEST_LESS = 0x0000000000000010; /// Enable depth test, less. 30 enum ulong BGFX_STATE_DEPTH_TEST_LEQUAL = 0x0000000000000020; /// Enable depth test, less or equal. 31 enum ulong BGFX_STATE_DEPTH_TEST_EQUAL = 0x0000000000000030; /// Enable depth test, equal. 32 enum ulong BGFX_STATE_DEPTH_TEST_GEQUAL = 0x0000000000000040; /// Enable depth test, greater or equal. 33 enum ulong BGFX_STATE_DEPTH_TEST_GREATER = 0x0000000000000050; /// Enable depth test, greater. 34 enum ulong BGFX_STATE_DEPTH_TEST_NOTEQUAL = 0x0000000000000060; /// Enable depth test, not equal. 35 enum ulong BGFX_STATE_DEPTH_TEST_NEVER = 0x0000000000000070; /// Enable depth test, never. 36 enum ulong BGFX_STATE_DEPTH_TEST_ALWAYS = 0x0000000000000080; /// Enable depth test, always. 37 enum ulong BGFX_STATE_DEPTH_TEST_SHIFT = 4; /// Depth test state bit shift 38 enum ulong BGFX_STATE_DEPTH_TEST_MASK = 0x00000000000000f0; /// Depth test state bit mask 39 40 /** 41 * Use BGFX_STATE_BLEND_FUNC(_src, _dst) or BGFX_STATE_BLEND_FUNC_SEPARATE(_srcRGB, _dstRGB, _srcA, _dstA) 42 * helper macros. 43 */ 44 enum ulong BGFX_STATE_BLEND_ZERO = 0x0000000000001000; /// 0, 0, 0, 0 45 enum ulong BGFX_STATE_BLEND_ONE = 0x0000000000002000; /// 1, 1, 1, 1 46 enum ulong BGFX_STATE_BLEND_SRC_COLOR = 0x0000000000003000; /// Rs, Gs, Bs, As 47 enum ulong BGFX_STATE_BLEND_INV_SRC_COLOR = 0x0000000000004000; /// 1-Rs, 1-Gs, 1-Bs, 1-As 48 enum ulong BGFX_STATE_BLEND_SRC_ALPHA = 0x0000000000005000; /// As, As, As, As 49 enum ulong BGFX_STATE_BLEND_INV_SRC_ALPHA = 0x0000000000006000; /// 1-As, 1-As, 1-As, 1-As 50 enum ulong BGFX_STATE_BLEND_DST_ALPHA = 0x0000000000007000; /// Ad, Ad, Ad, Ad 51 enum ulong BGFX_STATE_BLEND_INV_DST_ALPHA = 0x0000000000008000; /// 1-Ad, 1-Ad, 1-Ad ,1-Ad 52 enum ulong BGFX_STATE_BLEND_DST_COLOR = 0x0000000000009000; /// Rd, Gd, Bd, Ad 53 enum ulong BGFX_STATE_BLEND_INV_DST_COLOR = 0x000000000000a000; /// 1-Rd, 1-Gd, 1-Bd, 1-Ad 54 enum ulong BGFX_STATE_BLEND_SRC_ALPHA_SAT = 0x000000000000b000; /// f, f, f, 1; f = min(As, 1-Ad) 55 enum ulong BGFX_STATE_BLEND_FACTOR = 0x000000000000c000; /// Blend factor 56 enum ulong BGFX_STATE_BLEND_INV_FACTOR = 0x000000000000d000; /// 1-Blend factor 57 enum ulong BGFX_STATE_BLEND_SHIFT = 12; /// Blend state bit shift 58 enum ulong BGFX_STATE_BLEND_MASK = 0x000000000ffff000; /// Blend state bit mask 59 60 /** 61 * Use BGFX_STATE_BLEND_EQUATION(_equation) or BGFX_STATE_BLEND_EQUATION_SEPARATE(_equationRGB, _equationA) 62 * helper macros. 63 */ 64 enum ulong BGFX_STATE_BLEND_EQUATION_ADD = 0x0000000000000000; /// Blend add: src + dst. 65 enum ulong BGFX_STATE_BLEND_EQUATION_SUB = 0x0000000010000000; /// Blend subtract: src - dst. 66 enum ulong BGFX_STATE_BLEND_EQUATION_REVSUB = 0x0000000020000000; /// Blend reverse subtract: dst - src. 67 enum ulong BGFX_STATE_BLEND_EQUATION_MIN = 0x0000000030000000; /// Blend min: min(src, dst). 68 enum ulong BGFX_STATE_BLEND_EQUATION_MAX = 0x0000000040000000; /// Blend max: max(src, dst). 69 enum ulong BGFX_STATE_BLEND_EQUATION_SHIFT = 28; /// Blend equation bit shift 70 enum ulong BGFX_STATE_BLEND_EQUATION_MASK = 0x00000003f0000000; /// Blend equation bit mask 71 72 /// Cull state. When `BGFX_STATE_CULL_*` is not specified culling will be disabled. 73 enum ulong BGFX_STATE_CULL_CW = 0x0000001000000000; /// Cull clockwise triangles. 74 enum ulong BGFX_STATE_CULL_CCW = 0x0000002000000000; /// Cull counter-clockwise triangles. 75 enum ulong BGFX_STATE_CULL_SHIFT = 36; /// Culling mode bit shift 76 enum ulong BGFX_STATE_CULL_MASK = 0x0000003000000000; /// Culling mode bit mask 77 78 /// Alpha reference value. 79 enum ulong BGFX_STATE_ALPHA_REF_SHIFT = 40; /// Alpha reference bit shift 80 enum ulong BGFX_STATE_ALPHA_REF_MASK = 0x0000ff0000000000; /// Alpha reference bit mask 81 ulong BGFX_STATE_ALPHA_REF (ulong v) { return (v << BGFX_STATE_ALPHA_REF_SHIFT) & BGFX_STATE_ALPHA_REF_MASK; } 82 83 enum ulong BGFX_STATE_PT_TRISTRIP = 0x0001000000000000; /// Tristrip. 84 enum ulong BGFX_STATE_PT_LINES = 0x0002000000000000; /// Lines. 85 enum ulong BGFX_STATE_PT_LINESTRIP = 0x0003000000000000; /// Line strip. 86 enum ulong BGFX_STATE_PT_POINTS = 0x0004000000000000; /// Points. 87 enum ulong BGFX_STATE_PT_SHIFT = 48; /// Primitive type bit shift 88 enum ulong BGFX_STATE_PT_MASK = 0x0007000000000000; /// Primitive type bit mask 89 90 /// Point size value. 91 enum ulong BGFX_STATE_POINT_SIZE_SHIFT = 52; /// Point size bit shift 92 enum ulong BGFX_STATE_POINT_SIZE_MASK = 0x00f0000000000000; /// Point size bit mask 93 ulong BGFX_STATE_POINT_SIZE (ulong v) { return (v << BGFX_STATE_POINT_SIZE_SHIFT) & BGFX_STATE_POINT_SIZE_MASK; } 94 95 /** 96 * Enable MSAA write when writing into MSAA frame buffer. 97 * This flag is ignored when not writing into MSAA frame buffer. 98 */ 99 enum ulong BGFX_STATE_MSAA = 0x0100000000000000; /// Enable MSAA rasterization. 100 enum ulong BGFX_STATE_LINEAA = 0x0200000000000000; /// Enable line AA rasterization. 101 enum ulong BGFX_STATE_CONSERVATIVE_RASTER = 0x0400000000000000; /// Enable conservative rasterization. 102 enum ulong BGFX_STATE_NONE = 0x0000000000000000; /// No state. 103 enum ulong BGFX_STATE_BLEND_INDEPENDENT = 0x0000000400000000; /// Enable blend independent. 104 enum ulong BGFX_STATE_BLEND_ALPHA_TO_COVERAGE = 0x0000000800000000; /// Enable alpha to coverage. 105 /** 106 * Default state is write to RGB, alpha, and depth with depth test less enabled, with clockwise 107 * culling and MSAA (when writing into MSAA frame buffer, otherwise this flag is ignored). 108 */ 109 enum ulong BGFX_STATE_DEFAULT = BGFX_STATE_WRITE_RGB | BGFX_STATE_WRITE_A | BGFX_STATE_WRITE_Z | BGFX_STATE_DEPTH_TEST_LESS | BGFX_STATE_CULL_CW | BGFX_STATE_MSAA; 110 enum ulong BGFX_STATE_MASK = 0xffffffffffffffff; /// State bit mask 111 112 /// Do not use! 113 enum ulong BGFX_STATE_RESERVED_SHIFT = 61; 114 enum ulong BGFX_STATE_RESERVED_MASK = 0xe000000000000000; 115 116 /// Set stencil ref value. 117 enum uint BGFX_STENCIL_FUNC_REF_SHIFT = 0; 118 enum uint BGFX_STENCIL_FUNC_REF_MASK = 0x000000ff; 119 uint BGFX_STENCIL_FUNC_REF (uint v) { return (v << BGFX_STENCIL_FUNC_REF_SHIFT) & BGFX_STENCIL_FUNC_REF_MASK; } 120 121 /// Set stencil rmask value. 122 enum uint BGFX_STENCIL_FUNC_RMASK_SHIFT = 8; 123 enum uint BGFX_STENCIL_FUNC_RMASK_MASK = 0x0000ff00; 124 uint BGFX_STENCIL_FUNC_RMASK (uint v) { return (v << BGFX_STENCIL_FUNC_RMASK_SHIFT) & BGFX_STENCIL_FUNC_RMASK_MASK; } 125 126 enum uint BGFX_STENCIL_NONE = 0x00000000; 127 enum uint BGFX_STENCIL_MASK = 0xffffffff; 128 enum uint BGFX_STENCIL_DEFAULT = 0x00000000; 129 130 enum uint BGFX_STENCIL_TEST_LESS = 0x00010000; /// Enable stencil test, less. 131 enum uint BGFX_STENCIL_TEST_LEQUAL = 0x00020000; /// Enable stencil test, less or equal. 132 enum uint BGFX_STENCIL_TEST_EQUAL = 0x00030000; /// Enable stencil test, equal. 133 enum uint BGFX_STENCIL_TEST_GEQUAL = 0x00040000; /// Enable stencil test, greater or equal. 134 enum uint BGFX_STENCIL_TEST_GREATER = 0x00050000; /// Enable stencil test, greater. 135 enum uint BGFX_STENCIL_TEST_NOTEQUAL = 0x00060000; /// Enable stencil test, not equal. 136 enum uint BGFX_STENCIL_TEST_NEVER = 0x00070000; /// Enable stencil test, never. 137 enum uint BGFX_STENCIL_TEST_ALWAYS = 0x00080000; /// Enable stencil test, always. 138 enum uint BGFX_STENCIL_TEST_SHIFT = 16; /// Stencil test bit shift 139 enum uint BGFX_STENCIL_TEST_MASK = 0x000f0000; /// Stencil test bit mask 140 141 enum uint BGFX_STENCIL_OP_FAIL_S_ZERO = 0x00000000; /// Zero. 142 enum uint BGFX_STENCIL_OP_FAIL_S_KEEP = 0x00100000; /// Keep. 143 enum uint BGFX_STENCIL_OP_FAIL_S_REPLACE = 0x00200000; /// Replace. 144 enum uint BGFX_STENCIL_OP_FAIL_S_INCR = 0x00300000; /// Increment and wrap. 145 enum uint BGFX_STENCIL_OP_FAIL_S_INCRSAT = 0x00400000; /// Increment and clamp. 146 enum uint BGFX_STENCIL_OP_FAIL_S_DECR = 0x00500000; /// Decrement and wrap. 147 enum uint BGFX_STENCIL_OP_FAIL_S_DECRSAT = 0x00600000; /// Decrement and clamp. 148 enum uint BGFX_STENCIL_OP_FAIL_S_INVERT = 0x00700000; /// Invert. 149 enum uint BGFX_STENCIL_OP_FAIL_S_SHIFT = 20; /// Stencil operation fail bit shift 150 enum uint BGFX_STENCIL_OP_FAIL_S_MASK = 0x00f00000; /// Stencil operation fail bit mask 151 152 enum uint BGFX_STENCIL_OP_FAIL_Z_ZERO = 0x00000000; /// Zero. 153 enum uint BGFX_STENCIL_OP_FAIL_Z_KEEP = 0x01000000; /// Keep. 154 enum uint BGFX_STENCIL_OP_FAIL_Z_REPLACE = 0x02000000; /// Replace. 155 enum uint BGFX_STENCIL_OP_FAIL_Z_INCR = 0x03000000; /// Increment and wrap. 156 enum uint BGFX_STENCIL_OP_FAIL_Z_INCRSAT = 0x04000000; /// Increment and clamp. 157 enum uint BGFX_STENCIL_OP_FAIL_Z_DECR = 0x05000000; /// Decrement and wrap. 158 enum uint BGFX_STENCIL_OP_FAIL_Z_DECRSAT = 0x06000000; /// Decrement and clamp. 159 enum uint BGFX_STENCIL_OP_FAIL_Z_INVERT = 0x07000000; /// Invert. 160 enum uint BGFX_STENCIL_OP_FAIL_Z_SHIFT = 24; /// Stencil operation depth fail bit shift 161 enum uint BGFX_STENCIL_OP_FAIL_Z_MASK = 0x0f000000; /// Stencil operation depth fail bit mask 162 163 enum uint BGFX_STENCIL_OP_PASS_Z_ZERO = 0x00000000; /// Zero. 164 enum uint BGFX_STENCIL_OP_PASS_Z_KEEP = 0x10000000; /// Keep. 165 enum uint BGFX_STENCIL_OP_PASS_Z_REPLACE = 0x20000000; /// Replace. 166 enum uint BGFX_STENCIL_OP_PASS_Z_INCR = 0x30000000; /// Increment and wrap. 167 enum uint BGFX_STENCIL_OP_PASS_Z_INCRSAT = 0x40000000; /// Increment and clamp. 168 enum uint BGFX_STENCIL_OP_PASS_Z_DECR = 0x50000000; /// Decrement and wrap. 169 enum uint BGFX_STENCIL_OP_PASS_Z_DECRSAT = 0x60000000; /// Decrement and clamp. 170 enum uint BGFX_STENCIL_OP_PASS_Z_INVERT = 0x70000000; /// Invert. 171 enum uint BGFX_STENCIL_OP_PASS_Z_SHIFT = 28; /// Stencil operation depth pass bit shift 172 enum uint BGFX_STENCIL_OP_PASS_Z_MASK = 0xf0000000; /// Stencil operation depth pass bit mask 173 174 enum ushort BGFX_CLEAR_NONE = 0x0000; /// No clear flags. 175 enum ushort BGFX_CLEAR_COLOR = 0x0001; /// Clear color. 176 enum ushort BGFX_CLEAR_DEPTH = 0x0002; /// Clear depth. 177 enum ushort BGFX_CLEAR_STENCIL = 0x0004; /// Clear stencil. 178 enum ushort BGFX_CLEAR_DISCARD_COLOR_0 = 0x0008; /// Discard frame buffer attachment 0. 179 enum ushort BGFX_CLEAR_DISCARD_COLOR_1 = 0x0010; /// Discard frame buffer attachment 1. 180 enum ushort BGFX_CLEAR_DISCARD_COLOR_2 = 0x0020; /// Discard frame buffer attachment 2. 181 enum ushort BGFX_CLEAR_DISCARD_COLOR_3 = 0x0040; /// Discard frame buffer attachment 3. 182 enum ushort BGFX_CLEAR_DISCARD_COLOR_4 = 0x0080; /// Discard frame buffer attachment 4. 183 enum ushort BGFX_CLEAR_DISCARD_COLOR_5 = 0x0100; /// Discard frame buffer attachment 5. 184 enum ushort BGFX_CLEAR_DISCARD_COLOR_6 = 0x0200; /// Discard frame buffer attachment 6. 185 enum ushort BGFX_CLEAR_DISCARD_COLOR_7 = 0x0400; /// Discard frame buffer attachment 7. 186 enum ushort BGFX_CLEAR_DISCARD_DEPTH = 0x0800; /// Discard frame buffer depth attachment. 187 enum ushort BGFX_CLEAR_DISCARD_STENCIL = 0x1000; /// Discard frame buffer stencil attachment. 188 enum ushort BGFX_CLEAR_DISCARD_COLOR_MASK = 0x07f8; 189 enum ushort BGFX_CLEAR_DISCARD_MASK = 0x1ff8; 190 191 enum uint BGFX_DEBUG_NONE = 0x00000000; /// No debug. 192 enum uint BGFX_DEBUG_WIREFRAME = 0x00000001; /// Enable wireframe for all primitives. 193 /** 194 * Enable infinitely fast hardware test. No draw calls will be submitted to driver. 195 * It's useful when profiling to quickly assess bottleneck between CPU and GPU. 196 */ 197 enum uint BGFX_DEBUG_IFH = 0x00000002; 198 enum uint BGFX_DEBUG_STATS = 0x00000004; /// Enable statistics display. 199 enum uint BGFX_DEBUG_TEXT = 0x00000008; /// Enable debug text display. 200 enum uint BGFX_DEBUG_PROFILER = 0x00000010; /// Enable profiler. 201 202 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_8X1 = 0x0001; /// 1 8-bit value 203 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_8X2 = 0x0002; /// 2 8-bit values 204 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_8X4 = 0x0003; /// 4 8-bit values 205 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_16X1 = 0x0004; /// 1 16-bit value 206 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_16X2 = 0x0005; /// 2 16-bit values 207 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_16X4 = 0x0006; /// 4 16-bit values 208 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_32X1 = 0x0007; /// 1 32-bit value 209 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_32X2 = 0x0008; /// 2 32-bit values 210 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_32X4 = 0x0009; /// 4 32-bit values 211 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_SHIFT = 0; 212 enum ushort BGFX_BUFFER_COMPUTE_FORMAT_MASK = 0x000f; 213 214 enum ushort BGFX_BUFFER_COMPUTE_TYPE_INT = 0x0010; /// Type `int`. 215 enum ushort BGFX_BUFFER_COMPUTE_TYPE_UINT = 0x0020; /// Type `uint`. 216 enum ushort BGFX_BUFFER_COMPUTE_TYPE_FLOAT = 0x0030; /// Type `float`. 217 enum ushort BGFX_BUFFER_COMPUTE_TYPE_SHIFT = 4; 218 enum ushort BGFX_BUFFER_COMPUTE_TYPE_MASK = 0x0030; 219 220 enum ushort BGFX_BUFFER_NONE = 0x0000; 221 enum ushort BGFX_BUFFER_COMPUTE_READ = 0x0100; /// Buffer will be read by shader. 222 enum ushort BGFX_BUFFER_COMPUTE_WRITE = 0x0200; /// Buffer will be used for writing. 223 enum ushort BGFX_BUFFER_DRAW_INDIRECT = 0x0400; /// Buffer will be used for storing draw indirect commands. 224 enum ushort BGFX_BUFFER_ALLOW_RESIZE = 0x0800; /// Allow dynamic index/vertex buffer resize during update. 225 enum ushort BGFX_BUFFER_INDEX32 = 0x1000; /// Index buffer contains 32-bit indices. 226 enum ushort BGFX_BUFFER_COMPUTE_READ_WRITE = 0x0300; 227 228 enum ulong BGFX_TEXTURE_NONE = 0x0000000000000000; 229 enum ulong BGFX_TEXTURE_MSAA_SAMPLE = 0x0000000800000000; /// Texture will be used for MSAA sampling. 230 enum ulong BGFX_TEXTURE_RT = 0x0000001000000000; /// Render target no MSAA. 231 enum ulong BGFX_TEXTURE_COMPUTE_WRITE = 0x0000100000000000; /// Texture will be used for compute write. 232 enum ulong BGFX_TEXTURE_SRGB = 0x0000200000000000; /// Sample texture as sRGB. 233 enum ulong BGFX_TEXTURE_BLIT_DST = 0x0000400000000000; /// Texture will be used as blit destination. 234 enum ulong BGFX_TEXTURE_READ_BACK = 0x0000800000000000; /// Texture will be used for read back from GPU. 235 236 enum ulong BGFX_TEXTURE_RT_MSAA_X2 = 0x0000002000000000; /// Render target MSAAx2 mode. 237 enum ulong BGFX_TEXTURE_RT_MSAA_X4 = 0x0000003000000000; /// Render target MSAAx4 mode. 238 enum ulong BGFX_TEXTURE_RT_MSAA_X8 = 0x0000004000000000; /// Render target MSAAx8 mode. 239 enum ulong BGFX_TEXTURE_RT_MSAA_X16 = 0x0000005000000000; /// Render target MSAAx16 mode. 240 enum ulong BGFX_TEXTURE_RT_MSAA_SHIFT = 36; 241 enum ulong BGFX_TEXTURE_RT_MSAA_MASK = 0x0000007000000000; 242 243 enum ulong BGFX_TEXTURE_RT_WRITE_ONLY = 0x0000008000000000; /// Render target will be used for writing 244 enum ulong BGFX_TEXTURE_RT_SHIFT = 36; 245 enum ulong BGFX_TEXTURE_RT_MASK = 0x000000f000000000; 246 247 /// Sampler flags. 248 enum uint BGFX_SAMPLER_U_MIRROR = 0x00000001; /// Wrap U mode: Mirror 249 enum uint BGFX_SAMPLER_U_CLAMP = 0x00000002; /// Wrap U mode: Clamp 250 enum uint BGFX_SAMPLER_U_BORDER = 0x00000003; /// Wrap U mode: Border 251 enum uint BGFX_SAMPLER_U_SHIFT = 0; 252 enum uint BGFX_SAMPLER_U_MASK = 0x00000003; 253 254 enum uint BGFX_SAMPLER_V_MIRROR = 0x00000004; /// Wrap V mode: Mirror 255 enum uint BGFX_SAMPLER_V_CLAMP = 0x00000008; /// Wrap V mode: Clamp 256 enum uint BGFX_SAMPLER_V_BORDER = 0x0000000c; /// Wrap V mode: Border 257 enum uint BGFX_SAMPLER_V_SHIFT = 2; 258 enum uint BGFX_SAMPLER_V_MASK = 0x0000000c; 259 260 enum uint BGFX_SAMPLER_W_MIRROR = 0x00000010; /// Wrap W mode: Mirror 261 enum uint BGFX_SAMPLER_W_CLAMP = 0x00000020; /// Wrap W mode: Clamp 262 enum uint BGFX_SAMPLER_W_BORDER = 0x00000030; /// Wrap W mode: Border 263 enum uint BGFX_SAMPLER_W_SHIFT = 4; 264 enum uint BGFX_SAMPLER_W_MASK = 0x00000030; 265 266 enum uint BGFX_SAMPLER_MIN_POINT = 0x00000040; /// Min sampling mode: Point 267 enum uint BGFX_SAMPLER_MIN_ANISOTROPIC = 0x00000080; /// Min sampling mode: Anisotropic 268 enum uint BGFX_SAMPLER_MIN_SHIFT = 6; 269 enum uint BGFX_SAMPLER_MIN_MASK = 0x000000c0; 270 271 enum uint BGFX_SAMPLER_MAG_POINT = 0x00000100; /// Mag sampling mode: Point 272 enum uint BGFX_SAMPLER_MAG_ANISOTROPIC = 0x00000200; /// Mag sampling mode: Anisotropic 273 enum uint BGFX_SAMPLER_MAG_SHIFT = 8; 274 enum uint BGFX_SAMPLER_MAG_MASK = 0x00000300; 275 276 enum uint BGFX_SAMPLER_MIP_POINT = 0x00000400; /// Mip sampling mode: Point 277 enum uint BGFX_SAMPLER_MIP_SHIFT = 10; 278 enum uint BGFX_SAMPLER_MIP_MASK = 0x00000400; 279 280 enum uint BGFX_SAMPLER_COMPARE_LESS = 0x00010000; /// Compare when sampling depth texture: less. 281 enum uint BGFX_SAMPLER_COMPARE_LEQUAL = 0x00020000; /// Compare when sampling depth texture: less or equal. 282 enum uint BGFX_SAMPLER_COMPARE_EQUAL = 0x00030000; /// Compare when sampling depth texture: equal. 283 enum uint BGFX_SAMPLER_COMPARE_GEQUAL = 0x00040000; /// Compare when sampling depth texture: greater or equal. 284 enum uint BGFX_SAMPLER_COMPARE_GREATER = 0x00050000; /// Compare when sampling depth texture: greater. 285 enum uint BGFX_SAMPLER_COMPARE_NOTEQUAL = 0x00060000; /// Compare when sampling depth texture: not equal. 286 enum uint BGFX_SAMPLER_COMPARE_NEVER = 0x00070000; /// Compare when sampling depth texture: never. 287 enum uint BGFX_SAMPLER_COMPARE_ALWAYS = 0x00080000; /// Compare when sampling depth texture: always. 288 enum uint BGFX_SAMPLER_COMPARE_SHIFT = 16; 289 enum uint BGFX_SAMPLER_COMPARE_MASK = 0x000f0000; 290 291 enum uint BGFX_SAMPLER_BORDER_COLOR_SHIFT = 24; 292 enum uint BGFX_SAMPLER_BORDER_COLOR_MASK = 0x0f000000; 293 uint BGFX_SAMPLER_BORDER_COLOR (uint v) { return (v << BGFX_SAMPLER_BORDER_COLOR_SHIFT) & BGFX_SAMPLER_BORDER_COLOR_MASK; } 294 295 enum uint BGFX_SAMPLER_RESERVED_SHIFT = 28; 296 enum uint BGFX_SAMPLER_RESERVED_MASK = 0xf0000000; 297 298 enum uint BGFX_SAMPLER_NONE = 0x00000000; 299 enum uint BGFX_SAMPLER_SAMPLE_STENCIL = 0x00100000; /// Sample stencil instead of depth. 300 enum uint BGFX_SAMPLER_POINT = BGFX_SAMPLER_MIN_POINT | BGFX_SAMPLER_MAG_POINT | BGFX_SAMPLER_MIP_POINT; 301 enum uint BGFX_SAMPLER_UVW_MIRROR = BGFX_SAMPLER_U_MIRROR | BGFX_SAMPLER_V_MIRROR | BGFX_SAMPLER_W_MIRROR; 302 enum uint BGFX_SAMPLER_UVW_CLAMP = BGFX_SAMPLER_U_CLAMP | BGFX_SAMPLER_V_CLAMP | BGFX_SAMPLER_W_CLAMP; 303 enum uint BGFX_SAMPLER_UVW_BORDER = BGFX_SAMPLER_U_BORDER | BGFX_SAMPLER_V_BORDER | BGFX_SAMPLER_W_BORDER; 304 enum uint BGFX_SAMPLER_BITS_MASK = BGFX_SAMPLER_U_MASK | BGFX_SAMPLER_V_MASK | BGFX_SAMPLER_W_MASK | BGFX_SAMPLER_MIN_MASK | BGFX_SAMPLER_MAG_MASK | BGFX_SAMPLER_MIP_MASK | BGFX_SAMPLER_COMPARE_MASK; 305 306 enum uint BGFX_RESET_MSAA_X2 = 0x00000010; /// Enable 2x MSAA. 307 enum uint BGFX_RESET_MSAA_X4 = 0x00000020; /// Enable 4x MSAA. 308 enum uint BGFX_RESET_MSAA_X8 = 0x00000030; /// Enable 8x MSAA. 309 enum uint BGFX_RESET_MSAA_X16 = 0x00000040; /// Enable 16x MSAA. 310 enum uint BGFX_RESET_MSAA_SHIFT = 4; 311 enum uint BGFX_RESET_MSAA_MASK = 0x00000070; 312 313 enum uint BGFX_RESET_NONE = 0x00000000; /// No reset flags. 314 enum uint BGFX_RESET_FULLSCREEN = 0x00000001; /// Not supported yet. 315 enum uint BGFX_RESET_VSYNC = 0x00000080; /// Enable V-Sync. 316 enum uint BGFX_RESET_MAXANISOTROPY = 0x00000100; /// Turn on/off max anisotropy. 317 enum uint BGFX_RESET_CAPTURE = 0x00000200; /// Begin screen capture. 318 enum uint BGFX_RESET_FLUSH_AFTER_RENDER = 0x00002000; /// Flush rendering after submitting to GPU. 319 /** 320 * This flag specifies where flip occurs. Default behavior is that flip occurs 321 * before rendering new frame. This flag only has effect when `BGFX_CONFIG_MULTITHREADED=0`. 322 */ 323 enum uint BGFX_RESET_FLIP_AFTER_RENDER = 0x00004000; 324 enum uint BGFX_RESET_SRGB_BACKBUFFER = 0x00008000; /// Enable sRGB backbuffer. 325 enum uint BGFX_RESET_HDR10 = 0x00010000; /// Enable HDR10 rendering. 326 enum uint BGFX_RESET_HIDPI = 0x00020000; /// Enable HiDPI rendering. 327 enum uint BGFX_RESET_DEPTH_CLAMP = 0x00040000; /// Enable depth clamp. 328 enum uint BGFX_RESET_SUSPEND = 0x00080000; /// Suspend rendering. 329 330 enum uint BGFX_RESET_FULLSCREEN_SHIFT = 0; 331 enum uint BGFX_RESET_FULLSCREEN_MASK = 0x00000001; 332 333 enum uint BGFX_RESET_RESERVED_SHIFT = 31; /// Internal bit shift 334 enum uint BGFX_RESET_RESERVED_MASK = 0x80000000; /// Internal bit mask 335 336 enum ulong BGFX_CAPS_ALPHA_TO_COVERAGE = 0x0000000000000001; /// Alpha to coverage is supported. 337 enum ulong BGFX_CAPS_BLEND_INDEPENDENT = 0x0000000000000002; /// Blend independent is supported. 338 enum ulong BGFX_CAPS_COMPUTE = 0x0000000000000004; /// Compute shaders are supported. 339 enum ulong BGFX_CAPS_CONSERVATIVE_RASTER = 0x0000000000000008; /// Conservative rasterization is supported. 340 enum ulong BGFX_CAPS_DRAW_INDIRECT = 0x0000000000000010; /// Draw indirect is supported. 341 enum ulong BGFX_CAPS_FRAGMENT_DEPTH = 0x0000000000000020; /// Fragment depth is accessible in fragment shader. 342 enum ulong BGFX_CAPS_FRAGMENT_ORDERING = 0x0000000000000040; /// Fragment ordering is available in fragment shader. 343 enum ulong BGFX_CAPS_FRAMEBUFFER_RW = 0x0000000000000080; /// Read/Write frame buffer attachments are supported. 344 enum ulong BGFX_CAPS_GRAPHICS_DEBUGGER = 0x0000000000000100; /// Graphics debugger is present. 345 enum ulong BGFX_CAPS_RESERVED = 0x0000000000000200; 346 enum ulong BGFX_CAPS_HDR10 = 0x0000000000000400; /// HDR10 rendering is supported. 347 enum ulong BGFX_CAPS_HIDPI = 0x0000000000000800; /// HiDPI rendering is supported. 348 enum ulong BGFX_CAPS_INDEX32 = 0x0000000000001000; /// 32-bit indices are supported. 349 enum ulong BGFX_CAPS_INSTANCING = 0x0000000000002000; /// Instancing is supported. 350 enum ulong BGFX_CAPS_OCCLUSION_QUERY = 0x0000000000004000; /// Occlusion query is supported. 351 enum ulong BGFX_CAPS_RENDERER_MULTITHREADED = 0x0000000000008000; /// Renderer is on separate thread. 352 enum ulong BGFX_CAPS_SWAP_CHAIN = 0x0000000000010000; /// Multiple windows are supported. 353 enum ulong BGFX_CAPS_TEXTURE_2D_ARRAY = 0x0000000000020000; /// 2D texture array is supported. 354 enum ulong BGFX_CAPS_TEXTURE_3D = 0x0000000000040000; /// 3D textures are supported. 355 enum ulong BGFX_CAPS_TEXTURE_BLIT = 0x0000000000080000; /// Texture blit is supported. 356 enum ulong BGFX_CAPS_TEXTURE_COMPARE_RESERVED = 0x0000000000100000; /// All texture compare modes are supported. 357 enum ulong BGFX_CAPS_TEXTURE_COMPARE_LEQUAL = 0x0000000000200000; /// Texture compare less equal mode is supported. 358 enum ulong BGFX_CAPS_TEXTURE_CUBE_ARRAY = 0x0000000000400000; /// Cubemap texture array is supported. 359 enum ulong BGFX_CAPS_TEXTURE_DIRECT_ACCESS = 0x0000000000800000; /// CPU direct access to GPU texture memory. 360 enum ulong BGFX_CAPS_TEXTURE_READ_BACK = 0x0000000001000000; /// Read-back texture is supported. 361 enum ulong BGFX_CAPS_VERTEX_ATTRIB_HALF = 0x0000000002000000; /// Vertex attribute half-float is supported. 362 enum ulong BGFX_CAPS_VERTEX_ATTRIB_UINT10 = 0x0000000004000000; /// Vertex attribute 10_10_10_2 is supported. 363 enum ulong BGFX_CAPS_VERTEX_ID = 0x0000000008000000; /// Rendering with VertexID only is supported. 364 enum ulong BGFX_CAPS_TEXTURE_COMPARE_ALL = 0x0000000000300000; /// All texture compare modes are supported. 365 366 enum ushort BGFX_CAPS_FORMAT_TEXTURE_NONE = 0x0000; /// Texture format is not supported. 367 enum ushort BGFX_CAPS_FORMAT_TEXTURE_2D = 0x0001; /// Texture format is supported. 368 enum ushort BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB = 0x0002; /// Texture as sRGB format is supported. 369 enum ushort BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED = 0x0004; /// Texture format is emulated. 370 enum ushort BGFX_CAPS_FORMAT_TEXTURE_3D = 0x0008; /// Texture format is supported. 371 enum ushort BGFX_CAPS_FORMAT_TEXTURE_3D_SRGB = 0x0010; /// Texture as sRGB format is supported. 372 enum ushort BGFX_CAPS_FORMAT_TEXTURE_3D_EMULATED = 0x0020; /// Texture format is emulated. 373 enum ushort BGFX_CAPS_FORMAT_TEXTURE_CUBE = 0x0040; /// Texture format is supported. 374 enum ushort BGFX_CAPS_FORMAT_TEXTURE_CUBE_SRGB = 0x0080; /// Texture as sRGB format is supported. 375 enum ushort BGFX_CAPS_FORMAT_TEXTURE_CUBE_EMULATED = 0x0100; /// Texture format is emulated. 376 enum ushort BGFX_CAPS_FORMAT_TEXTURE_VERTEX = 0x0200; /// Texture format can be used from vertex shader. 377 enum ushort BGFX_CAPS_FORMAT_TEXTURE_IMAGE = 0x0400; /// Texture format can be used as image from compute shader. 378 enum ushort BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER = 0x0800; /// Texture format can be used as frame buffer. 379 enum ushort BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA = 0x1000; /// Texture format can be used as MSAA frame buffer. 380 enum ushort BGFX_CAPS_FORMAT_TEXTURE_MSAA = 0x2000; /// Texture can be sampled as MSAA. 381 enum ushort BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN = 0x4000; /// Texture format supports auto-generated mips. 382 383 enum ubyte BGFX_RESOLVE_NONE = 0x00; /// No resolve flags. 384 enum ubyte BGFX_RESOLVE_AUTO_GEN_MIPS = 0x01; /// Auto-generate mip maps on resolve. 385 386 enum ushort BGFX_PCI_ID_NONE = 0x0000; /// Autoselect adapter. 387 enum ushort BGFX_PCI_ID_SOFTWARE_RASTERIZER = 0x0001; /// Software rasterizer. 388 enum ushort BGFX_PCI_ID_AMD = 0x1002; /// AMD adapter. 389 enum ushort BGFX_PCI_ID_INTEL = 0x8086; /// Intel adapter. 390 enum ushort BGFX_PCI_ID_NVIDIA = 0x10de; /// nVidia adapter. 391 392 enum ubyte BGFX_CUBE_MAP_POSITIVE_X = 0x00; /// Cubemap +x. 393 enum ubyte BGFX_CUBE_MAP_NEGATIVE_X = 0x01; /// Cubemap -x. 394 enum ubyte BGFX_CUBE_MAP_POSITIVE_Y = 0x02; /// Cubemap +y. 395 enum ubyte BGFX_CUBE_MAP_NEGATIVE_Y = 0x03; /// Cubemap -y. 396 enum ubyte BGFX_CUBE_MAP_POSITIVE_Z = 0x04; /// Cubemap +z. 397 enum ubyte BGFX_CUBE_MAP_NEGATIVE_Z = 0x05; /// Cubemap -z. 398 399 /// Fatal error enum. 400 enum bgfx_fatal_t 401 { 402 BGFX_FATAL_DEBUGCHECK, 403 BGFX_FATAL_INVALIDSHADER, 404 BGFX_FATAL_UNABLETOINITIALIZE, 405 BGFX_FATAL_UNABLETOCREATETEXTURE, 406 BGFX_FATAL_DEVICELOST, 407 408 BGFX_FATAL_COUNT 409 } 410 411 /// Renderer backend type enum. 412 enum bgfx_renderer_type_t 413 { 414 BGFX_RENDERER_TYPE_NOOP, /// No rendering. 415 BGFX_RENDERER_TYPE_DIRECT3D9, /// Direct3D 9.0 416 BGFX_RENDERER_TYPE_DIRECT3D11, /// Direct3D 11.0 417 BGFX_RENDERER_TYPE_DIRECT3D12, /// Direct3D 12.0 418 BGFX_RENDERER_TYPE_GNM, /// GNM 419 BGFX_RENDERER_TYPE_METAL, /// Metal 420 BGFX_RENDERER_TYPE_NVN, /// NVN 421 BGFX_RENDERER_TYPE_OPENGLES, /// OpenGL ES 2.0+ 422 BGFX_RENDERER_TYPE_OPENGL, /// OpenGL 2.1+ 423 BGFX_RENDERER_TYPE_VULKAN, /// Vulkan 424 425 BGFX_RENDERER_TYPE_COUNT 426 } 427 428 /// Access mode enum. 429 enum bgfx_access_t 430 { 431 BGFX_ACCESS_READ, /// Read. 432 BGFX_ACCESS_WRITE, /// Write. 433 BGFX_ACCESS_READWRITE, /// Read and write. 434 435 BGFX_ACCESS_COUNT 436 } 437 438 /// Vertex attribute enum. 439 enum bgfx_attrib_t 440 { 441 BGFX_ATTRIB_POSITION, /// a_position 442 BGFX_ATTRIB_NORMAL, /// a_normal 443 BGFX_ATTRIB_TANGENT, /// a_tangent 444 BGFX_ATTRIB_BITANGENT, /// a_bitangent 445 BGFX_ATTRIB_COLOR0, /// a_color0 446 BGFX_ATTRIB_COLOR1, /// a_color1 447 BGFX_ATTRIB_COLOR2, /// a_color2 448 BGFX_ATTRIB_COLOR3, /// a_color3 449 BGFX_ATTRIB_INDICES, /// a_indices 450 BGFX_ATTRIB_WEIGHT, /// a_weight 451 BGFX_ATTRIB_TEXCOORD0, /// a_texcoord0 452 BGFX_ATTRIB_TEXCOORD1, /// a_texcoord1 453 BGFX_ATTRIB_TEXCOORD2, /// a_texcoord2 454 BGFX_ATTRIB_TEXCOORD3, /// a_texcoord3 455 BGFX_ATTRIB_TEXCOORD4, /// a_texcoord4 456 BGFX_ATTRIB_TEXCOORD5, /// a_texcoord5 457 BGFX_ATTRIB_TEXCOORD6, /// a_texcoord6 458 BGFX_ATTRIB_TEXCOORD7, /// a_texcoord7 459 460 BGFX_ATTRIB_COUNT 461 } 462 463 /// Vertex attribute type enum. 464 enum bgfx_attrib_type_t 465 { 466 BGFX_ATTRIB_TYPE_UINT8, /// Uint8 467 BGFX_ATTRIB_TYPE_UINT10, /// Uint10, availability depends on: `BGFX_CAPS_VERTEX_ATTRIB_UINT10`. 468 BGFX_ATTRIB_TYPE_INT16, /// Int16 469 BGFX_ATTRIB_TYPE_HALF, /// Half, availability depends on: `BGFX_CAPS_VERTEX_ATTRIB_HALF`. 470 BGFX_ATTRIB_TYPE_FLOAT, /// Float 471 472 BGFX_ATTRIB_TYPE_COUNT 473 } 474 475 /** 476 * Texture format enum. 477 * Notation: 478 * RGBA16S 479 * ^ ^ ^ 480 * | | +-- [ ]Unorm 481 * | | [F]loat 482 * | | [S]norm 483 * | | [I]nt 484 * | | [U]int 485 * | +---- Number of bits per component 486 * +-------- Components 487 * @attention Availability depends on Caps (see: formats). 488 */ 489 enum bgfx_texture_format_t 490 { 491 BGFX_TEXTURE_FORMAT_BC1, /// DXT1 R5G6B5A1 492 BGFX_TEXTURE_FORMAT_BC2, /// DXT3 R5G6B5A4 493 BGFX_TEXTURE_FORMAT_BC3, /// DXT5 R5G6B5A8 494 BGFX_TEXTURE_FORMAT_BC4, /// LATC1/ATI1 R8 495 BGFX_TEXTURE_FORMAT_BC5, /// LATC2/ATI2 RG8 496 BGFX_TEXTURE_FORMAT_BC6H, /// BC6H RGB16F 497 BGFX_TEXTURE_FORMAT_BC7, /// BC7 RGB 4-7 bits per color channel, 0-8 bits alpha 498 BGFX_TEXTURE_FORMAT_ETC1, /// ETC1 RGB8 499 BGFX_TEXTURE_FORMAT_ETC2, /// ETC2 RGB8 500 BGFX_TEXTURE_FORMAT_ETC2A, /// ETC2 RGBA8 501 BGFX_TEXTURE_FORMAT_ETC2A1, /// ETC2 RGB8A1 502 BGFX_TEXTURE_FORMAT_PTC12, /// PVRTC1 RGB 2BPP 503 BGFX_TEXTURE_FORMAT_PTC14, /// PVRTC1 RGB 4BPP 504 BGFX_TEXTURE_FORMAT_PTC12A, /// PVRTC1 RGBA 2BPP 505 BGFX_TEXTURE_FORMAT_PTC14A, /// PVRTC1 RGBA 4BPP 506 BGFX_TEXTURE_FORMAT_PTC22, /// PVRTC2 RGBA 2BPP 507 BGFX_TEXTURE_FORMAT_PTC24, /// PVRTC2 RGBA 4BPP 508 BGFX_TEXTURE_FORMAT_ATC, /// ATC RGB 4BPP 509 BGFX_TEXTURE_FORMAT_ATCE, /// ATCE RGBA 8 BPP explicit alpha 510 BGFX_TEXTURE_FORMAT_ATCI, /// ATCI RGBA 8 BPP interpolated alpha 511 BGFX_TEXTURE_FORMAT_ASTC4X4, /// ASTC 4x4 8.0 BPP 512 BGFX_TEXTURE_FORMAT_ASTC5X5, /// ASTC 5x5 5.12 BPP 513 BGFX_TEXTURE_FORMAT_ASTC6X6, /// ASTC 6x6 3.56 BPP 514 BGFX_TEXTURE_FORMAT_ASTC8X5, /// ASTC 8x5 3.20 BPP 515 BGFX_TEXTURE_FORMAT_ASTC8X6, /// ASTC 8x6 2.67 BPP 516 BGFX_TEXTURE_FORMAT_ASTC10X5, /// ASTC 10x5 2.56 BPP 517 BGFX_TEXTURE_FORMAT_UNKNOWN, /// Compressed formats above. 518 BGFX_TEXTURE_FORMAT_R1, 519 BGFX_TEXTURE_FORMAT_A8, 520 BGFX_TEXTURE_FORMAT_R8, 521 BGFX_TEXTURE_FORMAT_R8I, 522 BGFX_TEXTURE_FORMAT_R8U, 523 BGFX_TEXTURE_FORMAT_R8S, 524 BGFX_TEXTURE_FORMAT_R16, 525 BGFX_TEXTURE_FORMAT_R16I, 526 BGFX_TEXTURE_FORMAT_R16U, 527 BGFX_TEXTURE_FORMAT_R16F, 528 BGFX_TEXTURE_FORMAT_R16S, 529 BGFX_TEXTURE_FORMAT_R32I, 530 BGFX_TEXTURE_FORMAT_R32U, 531 BGFX_TEXTURE_FORMAT_R32F, 532 BGFX_TEXTURE_FORMAT_RG8, 533 BGFX_TEXTURE_FORMAT_RG8I, 534 BGFX_TEXTURE_FORMAT_RG8U, 535 BGFX_TEXTURE_FORMAT_RG8S, 536 BGFX_TEXTURE_FORMAT_RG16, 537 BGFX_TEXTURE_FORMAT_RG16I, 538 BGFX_TEXTURE_FORMAT_RG16U, 539 BGFX_TEXTURE_FORMAT_RG16F, 540 BGFX_TEXTURE_FORMAT_RG16S, 541 BGFX_TEXTURE_FORMAT_RG32I, 542 BGFX_TEXTURE_FORMAT_RG32U, 543 BGFX_TEXTURE_FORMAT_RG32F, 544 BGFX_TEXTURE_FORMAT_RGB8, 545 BGFX_TEXTURE_FORMAT_RGB8I, 546 BGFX_TEXTURE_FORMAT_RGB8U, 547 BGFX_TEXTURE_FORMAT_RGB8S, 548 BGFX_TEXTURE_FORMAT_RGB9E5F, 549 BGFX_TEXTURE_FORMAT_BGRA8, 550 BGFX_TEXTURE_FORMAT_RGBA8, 551 BGFX_TEXTURE_FORMAT_RGBA8I, 552 BGFX_TEXTURE_FORMAT_RGBA8U, 553 BGFX_TEXTURE_FORMAT_RGBA8S, 554 BGFX_TEXTURE_FORMAT_RGBA16, 555 BGFX_TEXTURE_FORMAT_RGBA16I, 556 BGFX_TEXTURE_FORMAT_RGBA16U, 557 BGFX_TEXTURE_FORMAT_RGBA16F, 558 BGFX_TEXTURE_FORMAT_RGBA16S, 559 BGFX_TEXTURE_FORMAT_RGBA32I, 560 BGFX_TEXTURE_FORMAT_RGBA32U, 561 BGFX_TEXTURE_FORMAT_RGBA32F, 562 BGFX_TEXTURE_FORMAT_R5G6B5, 563 BGFX_TEXTURE_FORMAT_RGBA4, 564 BGFX_TEXTURE_FORMAT_RGB5A1, 565 BGFX_TEXTURE_FORMAT_RGB10A2, 566 BGFX_TEXTURE_FORMAT_RG11B10F, 567 BGFX_TEXTURE_FORMAT_UNKNOWNDEPTH, /// Depth formats below. 568 BGFX_TEXTURE_FORMAT_D16, 569 BGFX_TEXTURE_FORMAT_D24, 570 BGFX_TEXTURE_FORMAT_D24S8, 571 BGFX_TEXTURE_FORMAT_D32, 572 BGFX_TEXTURE_FORMAT_D16F, 573 BGFX_TEXTURE_FORMAT_D24F, 574 BGFX_TEXTURE_FORMAT_D32F, 575 BGFX_TEXTURE_FORMAT_D0S8, 576 577 BGFX_TEXTURE_FORMAT_COUNT 578 } 579 580 /// Uniform type enum. 581 enum bgfx_uniform_type_t 582 { 583 BGFX_UNIFORM_TYPE_SAMPLER, /// Sampler. 584 BGFX_UNIFORM_TYPE_END, /// Reserved, do not use. 585 BGFX_UNIFORM_TYPE_VEC4, /// 4 floats vector. 586 BGFX_UNIFORM_TYPE_MAT3, /// 3x3 matrix. 587 BGFX_UNIFORM_TYPE_MAT4, /// 4x4 matrix. 588 589 BGFX_UNIFORM_TYPE_COUNT 590 } 591 592 /// Backbuffer ratio enum. 593 enum bgfx_backbuffer_ratio_t 594 { 595 BGFX_BACKBUFFER_RATIO_EQUAL, /// Equal to backbuffer. 596 BGFX_BACKBUFFER_RATIO_HALF, /// One half size of backbuffer. 597 BGFX_BACKBUFFER_RATIO_QUARTER, /// One quarter size of backbuffer. 598 BGFX_BACKBUFFER_RATIO_EIGHTH, /// One eighth size of backbuffer. 599 BGFX_BACKBUFFER_RATIO_SIXTEENTH, /// One sixteenth size of backbuffer. 600 BGFX_BACKBUFFER_RATIO_DOUBLE, /// Double size of backbuffer. 601 602 BGFX_BACKBUFFER_RATIO_COUNT 603 } 604 605 /// Occlusion query result. 606 enum bgfx_occlusion_query_result_t 607 { 608 BGFX_OCCLUSION_QUERY_RESULT_INVISIBLE, /// Query failed test. 609 BGFX_OCCLUSION_QUERY_RESULT_VISIBLE, /// Query passed test. 610 BGFX_OCCLUSION_QUERY_RESULT_NORESULT, /// Query result is not available yet. 611 612 BGFX_OCCLUSION_QUERY_RESULT_COUNT 613 } 614 615 /// Primitive topology. 616 enum bgfx_topology_t 617 { 618 BGFX_TOPOLOGY_TRILIST, /// Triangle list. 619 BGFX_TOPOLOGY_TRISTRIP, /// Triangle strip. 620 BGFX_TOPOLOGY_LINELIST, /// Line list. 621 BGFX_TOPOLOGY_LINESTRIP, /// Line strip. 622 BGFX_TOPOLOGY_POINTLIST, /// Point list. 623 624 BGFX_TOPOLOGY_COUNT 625 } 626 627 /// Topology conversion function. 628 enum bgfx_topology_convert_t 629 { 630 BGFX_TOPOLOGY_CONVERT_TRILISTFLIPWINDING, /// Flip winding order of triangle list. 631 BGFX_TOPOLOGY_CONVERT_TRISTRIPFLIPWINDING, /// Flip winding order of trinagle strip. 632 BGFX_TOPOLOGY_CONVERT_TRILISTTOLINELIST, /// Convert triangle list to line list. 633 BGFX_TOPOLOGY_CONVERT_TRISTRIPTOTRILIST, /// Convert triangle strip to triangle list. 634 BGFX_TOPOLOGY_CONVERT_LINESTRIPTOLINELIST, /// Convert line strip to line list. 635 636 BGFX_TOPOLOGY_CONVERT_COUNT 637 } 638 639 /// Topology sort order. 640 enum bgfx_topology_sort_t 641 { 642 BGFX_TOPOLOGY_SORT_DIRECTIONFRONTTOBACKMIN, 643 BGFX_TOPOLOGY_SORT_DIRECTIONFRONTTOBACKAVG, 644 BGFX_TOPOLOGY_SORT_DIRECTIONFRONTTOBACKMAX, 645 BGFX_TOPOLOGY_SORT_DIRECTIONBACKTOFRONTMIN, 646 BGFX_TOPOLOGY_SORT_DIRECTIONBACKTOFRONTAVG, 647 BGFX_TOPOLOGY_SORT_DIRECTIONBACKTOFRONTMAX, 648 BGFX_TOPOLOGY_SORT_DISTANCEFRONTTOBACKMIN, 649 BGFX_TOPOLOGY_SORT_DISTANCEFRONTTOBACKAVG, 650 BGFX_TOPOLOGY_SORT_DISTANCEFRONTTOBACKMAX, 651 BGFX_TOPOLOGY_SORT_DISTANCEBACKTOFRONTMIN, 652 BGFX_TOPOLOGY_SORT_DISTANCEBACKTOFRONTAVG, 653 BGFX_TOPOLOGY_SORT_DISTANCEBACKTOFRONTMAX, 654 655 BGFX_TOPOLOGY_SORT_COUNT 656 } 657 658 /// View mode sets draw call sort order. 659 enum bgfx_view_mode_t 660 { 661 BGFX_VIEW_MODE_DEFAULT, /// Default sort order. 662 BGFX_VIEW_MODE_SEQUENTIAL, /// Sort in the same order in which submit calls were called. 663 BGFX_VIEW_MODE_DEPTHASCENDING, /// Sort draw call depth in ascending order. 664 BGFX_VIEW_MODE_DEPTHDESCENDING, /// Sort draw call depth in descending order. 665 666 BGFX_VIEW_MODE_COUNT 667 } 668 669 /// Render frame enum. 670 enum bgfx_render_frame_t 671 { 672 BGFX_RENDER_FRAME_NOCONTEXT, /// Renderer context is not created yet. 673 BGFX_RENDER_FRAME_RENDER, /// Renderer context is created and rendering. 674 BGFX_RENDER_FRAME_TIMEOUT, /// Renderer context wait for main thread signal timed out without rendering. 675 BGFX_RENDER_FRAME_EXITING, /// Renderer context is getting destroyed. 676 677 BGFX_RENDER_FRAME_COUNT 678 } 679 680 /// GPU info. 681 struct bgfx_caps_gpu_t 682 { 683 ushort vendorId; /// Vendor PCI id. See `BGFX_PCI_ID_*`. 684 ushort deviceId; /// Device id. 685 } 686 687 /// Renderer capabilities limits. 688 struct bgfx_caps_limits_t 689 { 690 uint maxDrawCalls; /// Maximum number of draw calls. 691 uint maxBlits; /// Maximum number of blit calls. 692 uint maxTextureSize; /// Maximum texture size. 693 uint maxTextureLayers; /// Maximum texture layers. 694 uint maxViews; /// Maximum number of views. 695 uint maxFrameBuffers; /// Maximum number of frame buffer handles. 696 uint maxFBAttachments; /// Maximum number of frame buffer attachments. 697 uint maxPrograms; /// Maximum number of program handles. 698 uint maxShaders; /// Maximum number of shader handles. 699 uint maxTextures; /// Maximum number of texture handles. 700 uint maxTextureSamplers; /// Maximum number of texture samplers. 701 uint maxComputeBindings; /// Maximum number of compute bindings. 702 uint maxVertexLayouts; /// Maximum number of vertex format layouts. 703 uint maxVertexStreams; /// Maximum number of vertex streams. 704 uint maxIndexBuffers; /// Maximum number of index buffer handles. 705 uint maxVertexBuffers; /// Maximum number of vertex buffer handles. 706 uint maxDynamicIndexBuffers; /// Maximum number of dynamic index buffer handles. 707 uint maxDynamicVertexBuffers; /// Maximum number of dynamic vertex buffer handles. 708 uint maxUniforms; /// Maximum number of uniform handles. 709 uint maxOcclusionQueries; /// Maximum number of occlusion query handles. 710 uint maxEncoders; /// Maximum number of encoder threads. 711 uint transientVbSize; /// Maximum transient vertex buffer size. 712 uint transientIbSize; /// Maximum transient index buffer size. 713 } 714 715 /// Renderer capabilities. 716 struct bgfx_caps_t 717 { 718 bgfx_renderer_type_t rendererType; /// Renderer backend type. See: `bgfx::RendererType` 719 720 /** 721 * Supported functionality. 722 * @attention See BGFX_CAPS_* flags at https://bkaradzic.github.io/bgfx/bgfx.html#available-caps 723 */ 724 ulong supported; 725 ushort vendorId; /// Selected GPU vendor PCI id. 726 ushort deviceId; /// Selected GPU device id. 727 bool homogeneousDepth; /// True when NDC depth is in [-1, 1] range, otherwise its [0, 1]. 728 bool originBottomLeft; /// True when NDC origin is at bottom left. 729 byte numGPUs; /// Number of enumerated GPUs. 730 bgfx_caps_gpu_t[4] gpu; /// Enumerated GPUs. 731 bgfx_caps_limits_t limits; 732 733 /** 734 * Supported texture format capabilities flags: 735 * - `BGFX_CAPS_FORMAT_TEXTURE_NONE` - Texture format is not supported. 736 * - `BGFX_CAPS_FORMAT_TEXTURE_2D` - Texture format is supported. 737 * - `BGFX_CAPS_FORMAT_TEXTURE_2D_SRGB` - Texture as sRGB format is supported. 738 * - `BGFX_CAPS_FORMAT_TEXTURE_2D_EMULATED` - Texture format is emulated. 739 * - `BGFX_CAPS_FORMAT_TEXTURE_3D` - Texture format is supported. 740 * - `BGFX_CAPS_FORMAT_TEXTURE_3D_SRGB` - Texture as sRGB format is supported. 741 * - `BGFX_CAPS_FORMAT_TEXTURE_3D_EMULATED` - Texture format is emulated. 742 * - `BGFX_CAPS_FORMAT_TEXTURE_CUBE` - Texture format is supported. 743 * - `BGFX_CAPS_FORMAT_TEXTURE_CUBE_SRGB` - Texture as sRGB format is supported. 744 * - `BGFX_CAPS_FORMAT_TEXTURE_CUBE_EMULATED` - Texture format is emulated. 745 * - `BGFX_CAPS_FORMAT_TEXTURE_VERTEX` - Texture format can be used from vertex shader. 746 * - `BGFX_CAPS_FORMAT_TEXTURE_IMAGE` - Texture format can be used as image from compute 747 * shader. 748 * - `BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER` - Texture format can be used as frame 749 * buffer. 750 * - `BGFX_CAPS_FORMAT_TEXTURE_FRAMEBUFFER_MSAA` - Texture format can be used as MSAA 751 * frame buffer. 752 * - `BGFX_CAPS_FORMAT_TEXTURE_MSAA` - Texture can be sampled as MSAA. 753 * - `BGFX_CAPS_FORMAT_TEXTURE_MIP_AUTOGEN` - Texture format supports auto-generated 754 * mips. 755 */ 756 ushort[bgfx_texture_format_t.BGFX_TEXTURE_FORMAT_COUNT] formats; 757 } 758 759 /// Internal data. 760 struct bgfx_internal_data_t 761 { 762 const(bgfx_caps_t)* caps; /// Renderer capabilities. 763 void* context; /// GL context, or D3D device. 764 } 765 766 /// Platform data. 767 struct bgfx_platform_data_t 768 { 769 void* ndt; /// Native display type. 770 void* nwh; /// Native window handle. 771 void* context; /// GL context, or D3D device. 772 void* backBuffer; /// GL backbuffer, or D3D render target view. 773 void* backBufferDS; /// Backbuffer depth/stencil. 774 } 775 776 /// Backbuffer resolution and reset parameters. 777 struct bgfx_resolution_t 778 { 779 bgfx_texture_format_t format; /// Backbuffer format. 780 uint width; /// Backbuffer width. 781 uint height; /// Backbuffer height. 782 uint reset; /// Reset parameters. 783 byte numBackBuffers; /// Number of back buffers. 784 byte maxFrameLatency; /// Maximum frame latency. 785 } 786 787 struct bgfx_init_limits_t 788 { 789 ushort maxEncoders; /// Maximum number of encoder threads. 790 uint transientVbSize; /// Maximum transient vertex buffer size. 791 uint transientIbSize; /// Maximum transient index buffer size. 792 } 793 794 /// Initialization parameters used by `bgfx::init`. 795 struct bgfx_init_t 796 { 797 798 /** 799 * Select rendering backend. When set to RendererType::Count 800 * a default rendering backend will be selected appropriate to the platform. 801 * See: `bgfx::RendererType` 802 */ 803 bgfx_renderer_type_t type; 804 805 /** 806 * Vendor PCI id. If set to `BGFX_PCI_ID_NONE` it will select the first 807 * device. 808 * - `BGFX_PCI_ID_NONE` - Autoselect adapter. 809 * - `BGFX_PCI_ID_SOFTWARE_RASTERIZER` - Software rasterizer. 810 * - `BGFX_PCI_ID_AMD` - AMD adapter. 811 * - `BGFX_PCI_ID_INTEL` - Intel adapter. 812 * - `BGFX_PCI_ID_NVIDIA` - nVidia adapter. 813 */ 814 ushort vendorId; 815 816 /** 817 * Device id. If set to 0 it will select first device, or device with 818 * matching id. 819 */ 820 ushort deviceId; 821 bool debug_; /// Enable device for debuging. 822 bool profile; /// Enable device for profiling. 823 bgfx_platform_data_t platformData; /// Platform data. 824 bgfx_resolution_t resolution; /// Backbuffer resolution and reset parameters. See: `bgfx::Resolution`. 825 bgfx_init_limits_t limits; 826 827 /** 828 * Provide application specific callback interface. 829 * See: `bgfx::CallbackI` 830 */ 831 void* callback; 832 833 /** 834 * Custom allocator. When a custom allocator is not 835 * specified, bgfx uses the CRT allocator. Bgfx assumes 836 * custom allocator is thread safe. 837 */ 838 void* allocator; 839 } 840 841 /** 842 * Memory must be obtained by calling `bgfx::alloc`, `bgfx::copy`, or `bgfx::makeRef`. 843 * @attention It is illegal to create this structure on stack and pass it to any bgfx API. 844 */ 845 struct bgfx_memory_t 846 { 847 byte* data; /// Pointer to data. 848 uint size; /// Data size. 849 } 850 851 /// Transient index buffer. 852 struct bgfx_transient_index_buffer_t 853 { 854 byte* data; /// Pointer to data. 855 uint size; /// Data size. 856 uint startIndex; /// First index. 857 bgfx_index_buffer_handle_t handle; /// Index buffer handle. 858 } 859 860 /// Transient vertex buffer. 861 struct bgfx_transient_vertex_buffer_t 862 { 863 byte* data; /// Pointer to data. 864 uint size; /// Data size. 865 uint startVertex; /// First vertex. 866 ushort stride; /// Vertex stride. 867 bgfx_vertex_buffer_handle_t handle; /// Vertex buffer handle. 868 bgfx_vertex_layout_handle_t layoutHandle; /// Vertex layout handle. 869 } 870 871 /// Instance data buffer info. 872 struct bgfx_instance_data_buffer_t 873 { 874 byte* data; /// Pointer to data. 875 uint size; /// Data size. 876 uint offset; /// Offset in vertex buffer. 877 uint num; /// Number of instances. 878 ushort stride; /// Vertex buffer stride. 879 bgfx_vertex_buffer_handle_t handle; /// Vertex buffer object handle. 880 } 881 882 /// Texture info. 883 struct bgfx_texture_info_t 884 { 885 bgfx_texture_format_t format; /// Texture format. 886 uint storageSize; /// Total amount of bytes required to store texture. 887 ushort width; /// Texture width. 888 ushort height; /// Texture height. 889 ushort depth; /// Texture depth. 890 ushort numLayers; /// Number of layers in texture array. 891 byte numMips; /// Number of MIP maps. 892 byte bitsPerPixel; /// Format bits per pixel. 893 bool cubeMap; /// Texture is cubemap. 894 } 895 896 /// Uniform info. 897 struct bgfx_uniform_info_t 898 { 899 char[256] name; /// Uniform name. 900 bgfx_uniform_type_t type; /// Uniform type. 901 ushort num; /// Number of elements in array. 902 } 903 904 /// Frame buffer texture attachment info. 905 struct bgfx_attachment_t 906 { 907 bgfx_access_t access; /// Attachement access. See `Access::Enum`. 908 bgfx_texture_handle_t handle; /// Render target texture handle. 909 ushort mip; /// Mip level. 910 ushort layer; /// Cubemap side or depth layer/slice. 911 byte resolve; /// Resolve flags. See: `BGFX_RESOLVE_*` 912 } 913 914 /// Transform data. 915 struct bgfx_transform_t 916 { 917 float* data; /// Pointer to first 4x4 matrix. 918 ushort num; /// Number of matrices. 919 } 920 921 /// View stats. 922 struct bgfx_view_stats_t 923 { 924 char[256] name; /// View name. 925 bgfx_view_id_t view; /// View id. 926 long cpuTimeElapsed; /// CPU (submit) time elapsed. 927 long gpuTimeElapsed; /// GPU time elapsed. 928 } 929 930 /// Encoder stats. 931 struct bgfx_encoder_stats_t 932 { 933 long cpuTimeBegin; /// Encoder thread CPU submit begin time. 934 long cpuTimeEnd; /// Encoder thread CPU submit end time. 935 } 936 937 /** 938 * Renderer statistics data. 939 * @remarks All time values are high-resolution timestamps, while 940 * time frequencies define timestamps-per-second for that hardware. 941 */ 942 struct bgfx_stats_t 943 { 944 long cpuTimeFrame; /// CPU time between two `bgfx::frame` calls. 945 long cpuTimeBegin; /// Render thread CPU submit begin time. 946 long cpuTimeEnd; /// Render thread CPU submit end time. 947 long cpuTimerFreq; /// CPU timer frequency. Timestamps-per-second 948 long gpuTimeBegin; /// GPU frame begin time. 949 long gpuTimeEnd; /// GPU frame end time. 950 long gpuTimerFreq; /// GPU timer frequency. 951 long waitRender; /// Time spent waiting for render backend thread to finish issuing draw commands to underlying graphics API. 952 long waitSubmit; /// Time spent waiting for submit thread to advance to next frame. 953 uint numDraw; /// Number of draw calls submitted. 954 uint numCompute; /// Number of compute calls submitted. 955 uint numBlit; /// Number of blit calls submitted. 956 uint maxGpuLatency; /// GPU driver latency. 957 ushort numDynamicIndexBuffers; /// Number of used dynamic index buffers. 958 ushort numDynamicVertexBuffers; /// Number of used dynamic vertex buffers. 959 ushort numFrameBuffers; /// Number of used frame buffers. 960 ushort numIndexBuffers; /// Number of used index buffers. 961 ushort numOcclusionQueries; /// Number of used occlusion queries. 962 ushort numPrograms; /// Number of used programs. 963 ushort numShaders; /// Number of used shaders. 964 ushort numTextures; /// Number of used textures. 965 ushort numUniforms; /// Number of used uniforms. 966 ushort numVertexBuffers; /// Number of used vertex buffers. 967 ushort numVertexLayouts; /// Number of used vertex layouts. 968 long textureMemoryUsed; /// Estimate of texture memory used. 969 long rtMemoryUsed; /// Estimate of render target memory used. 970 int transientVbUsed; /// Amount of transient vertex buffer used. 971 int transientIbUsed; /// Amount of transient index buffer used. 972 uint[bgfx_topology_t.BGFX_TOPOLOGY_COUNT] numPrims; /// Number of primitives rendered. 973 long gpuMemoryMax; /// Maximum available GPU memory for application. 974 long gpuMemoryUsed; /// Amount of GPU memory used by the application. 975 ushort width; /// Backbuffer width in pixels. 976 ushort height; /// Backbuffer height in pixels. 977 ushort textWidth; /// Debug text width in characters. 978 ushort textHeight; /// Debug text height in characters. 979 ushort numViews; /// Number of view stats. 980 bgfx_view_stats_t* viewStats; /// Array of View stats. 981 byte numEncoders; /// Number of encoders used during frame. 982 bgfx_encoder_stats_t* encoderStats; /// Array of encoder stats. 983 } 984 985 /// Vertex layout. 986 struct bgfx_vertex_layout_t 987 { 988 uint hash; /// Hash. 989 ushort stride; /// Stride. 990 ushort[bgfx_attrib_t.BGFX_ATTRIB_COUNT] offset; /// Attribute offsets. 991 ushort[bgfx_attrib_t.BGFX_ATTRIB_COUNT] attributes; /// Used attributes. 992 } 993 994 /** 995 * Encoders are used for submitting draw calls from multiple threads. Only one encoder 996 * per thread should be used. Use `bgfx::begin()` to obtain an encoder for a thread. 997 */ 998 struct bgfx_encoder_t 999 { 1000 } 1001 1002 struct bgfx_dynamic_index_buffer_handle_t { ushort idx; } 1003 1004 struct bgfx_dynamic_vertex_buffer_handle_t { ushort idx; } 1005 1006 struct bgfx_frame_buffer_handle_t { ushort idx; } 1007 1008 struct bgfx_index_buffer_handle_t { ushort idx; } 1009 1010 struct bgfx_indirect_buffer_handle_t { ushort idx; } 1011 1012 struct bgfx_occlusion_query_handle_t { ushort idx; } 1013 1014 struct bgfx_program_handle_t { ushort idx; } 1015 1016 struct bgfx_shader_handle_t { ushort idx; } 1017 1018 struct bgfx_texture_handle_t { ushort idx; } 1019 1020 struct bgfx_uniform_handle_t { ushort idx; } 1021 1022 struct bgfx_vertex_buffer_handle_t { ushort idx; } 1023 1024 struct bgfx_vertex_layout_handle_t { ushort idx; } 1025