diff --git a/bindings/bf/bgfx.bf b/bindings/bf/bgfx.bf index 163c4b47e..30c7f4635 100644 --- a/bindings/bf/bgfx.bf +++ b/bindings/bf/bgfx.bf @@ -2867,7 +2867,7 @@ public static class bgfx /// Allocate transient index buffer. /// /// - /// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. /// @@ -2878,7 +2878,7 @@ public static class bgfx /// Allocate transient vertex buffer. /// /// - /// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of vertices to allocate. /// Vertex layout. /// @@ -2891,10 +2891,10 @@ public static class bgfx /// true. /// /// - /// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Vertex layout. /// Number of vertices to allocate. - /// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. /// @@ -2905,7 +2905,7 @@ public static class bgfx /// Allocate instance data buffer. /// /// - /// InstanceDataBuffer structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. + /// InstanceDataBuffer structure will be filled, and will be valid for duration of frame, and can be reused for multiple draw calls. /// Number of instances. /// Instance stride. Must be multiple of 16. /// diff --git a/bindings/cs/bgfx.cs b/bindings/cs/bgfx.cs index 23ad28423..2dfaaec8b 100644 --- a/bindings/cs/bgfx.cs +++ b/bindings/cs/bgfx.cs @@ -2821,7 +2821,7 @@ public static partial class bgfx /// Allocate transient index buffer. /// /// - /// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. /// @@ -2832,7 +2832,7 @@ public static partial class bgfx /// Allocate transient vertex buffer. /// /// - /// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of vertices to allocate. /// Vertex layout. /// @@ -2845,10 +2845,10 @@ public static partial class bgfx /// true. /// /// - /// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Vertex layout. /// Number of vertices to allocate. - /// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. + /// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. /// @@ -2860,7 +2860,7 @@ public static partial class bgfx /// Allocate instance data buffer. /// /// - /// InstanceDataBuffer structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. + /// InstanceDataBuffer structure will be filled, and will be valid for duration of frame, and can be reused for multiple draw calls. /// Number of instances. /// Instance stride. Must be multiple of 16. /// diff --git a/bindings/d/funcs.d b/bindings/d/funcs.d index 1005b3241..2bb7d738e 100644 --- a/bindings/d/funcs.d +++ b/bindings/d/funcs.d @@ -566,8 +566,8 @@ version(BindBgfx_Static) /** * Allocate transient index buffer. * Params: - * _tib = TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tib = TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _num = Number of indices to allocate. * _index32 = Set to `true` if input indices will be 32-bit. @@ -577,8 +577,8 @@ version(BindBgfx_Static) /** * Allocate transient vertex buffer. * Params: - * _tvb = TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tvb = TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _num = Number of vertices to allocate. * _layout = Vertex layout. @@ -590,13 +590,13 @@ version(BindBgfx_Static) * buffers. If both space requirements are satisfied function returns * true. * Params: - * _tvb = TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tvb = TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _layout = Vertex layout. * _numVertices = Number of vertices to allocate. - * _tib = TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tib = TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _numIndices = Number of indices to allocate. * _index32 = Set to `true` if input indices will be 32-bit. @@ -606,8 +606,8 @@ version(BindBgfx_Static) /** * Allocate instance data buffer. * Params: - * _idb = InstanceDataBuffer structure is filled and is valid - * for duration of frame, and it can be reused for multiple draw + * _idb = InstanceDataBuffer structure will be filled, and will be valid + * for duration of frame, and can be reused for multiple draw * calls. * _num = Number of instances. * _stride = Instance stride. Must be multiple of 16. @@ -2761,8 +2761,8 @@ else /** * Allocate transient index buffer. * Params: - * _tib = TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tib = TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _num = Number of indices to allocate. * _index32 = Set to `true` if input indices will be 32-bit. @@ -2773,8 +2773,8 @@ else /** * Allocate transient vertex buffer. * Params: - * _tvb = TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tvb = TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _num = Number of vertices to allocate. * _layout = Vertex layout. @@ -2787,13 +2787,13 @@ else * buffers. If both space requirements are satisfied function returns * true. * Params: - * _tvb = TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tvb = TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _layout = Vertex layout. * _numVertices = Number of vertices to allocate. - * _tib = TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * _tib = TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * _numIndices = Number of indices to allocate. * _index32 = Set to `true` if input indices will be 32-bit. @@ -2804,8 +2804,8 @@ else /** * Allocate instance data buffer. * Params: - * _idb = InstanceDataBuffer structure is filled and is valid - * for duration of frame, and it can be reused for multiple draw + * _idb = InstanceDataBuffer structure will be filled, and will be valid + * for duration of frame, and can be reused for multiple draw * calls. * _num = Number of instances. * _stride = Instance stride. Must be multiple of 16. diff --git a/bindings/zig/bgfx.zig b/bindings/zig/bgfx.zig index 1cfdfe0bf..4e4f6fab2 100644 --- a/bindings/zig/bgfx.zig +++ b/bindings/zig/bgfx.zig @@ -2283,7 +2283,7 @@ pub inline fn getAvailInstanceDataBuffer(_num: u32, _stride: u16) u32 { extern fn bgfx_get_avail_instance_data_buffer(_num: u32, _stride: u16) u32; /// Allocate transient index buffer. -/// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. +/// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. pub inline fn allocTransientIndexBuffer(_tib: [*c]TransientIndexBuffer, _num: u32, _index32: bool) void { @@ -2292,7 +2292,7 @@ pub inline fn allocTransientIndexBuffer(_tib: [*c]TransientIndexBuffer, _num: u3 extern fn bgfx_alloc_transient_index_buffer(_tib: [*c]TransientIndexBuffer, _num: u32, _index32: bool) void; /// Allocate transient vertex buffer. -/// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. +/// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of vertices to allocate. /// Vertex layout. pub inline fn allocTransientVertexBuffer(_tvb: [*c]TransientVertexBuffer, _num: u32, _layout: [*c]const VertexLayout) void { @@ -2303,10 +2303,10 @@ extern fn bgfx_alloc_transient_vertex_buffer(_tvb: [*c]TransientVertexBuffer, _n /// Check for required space and allocate transient vertex and index /// buffers. If both space requirements are satisfied function returns /// true. -/// TransientVertexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. +/// TransientVertexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Vertex layout. /// Number of vertices to allocate. -/// TransientIndexBuffer structure is filled and is valid for the duration of frame, and it can be reused for multiple draw calls. +/// TransientIndexBuffer structure will be filled, and will be valid for the duration of frame, and can be reused for multiple draw calls. /// Number of indices to allocate. /// Set to `true` if input indices will be 32-bit. pub inline fn allocTransientBuffers(_tvb: [*c]TransientVertexBuffer, _layout: [*c]const VertexLayout, _numVertices: u32, _tib: [*c]TransientIndexBuffer, _numIndices: u32, _index32: bool) bool { @@ -2315,7 +2315,7 @@ pub inline fn allocTransientBuffers(_tvb: [*c]TransientVertexBuffer, _layout: [* extern fn bgfx_alloc_transient_buffers(_tvb: [*c]TransientVertexBuffer, _layout: [*c]const VertexLayout, _numVertices: u32, _tib: [*c]TransientIndexBuffer, _numIndices: u32, _index32: bool) bool; /// Allocate instance data buffer. -/// InstanceDataBuffer structure is filled and is valid for duration of frame, and it can be reused for multiple draw calls. +/// InstanceDataBuffer structure will be filled, and will be valid for duration of frame, and can be reused for multiple draw calls. /// Number of instances. /// Instance stride. Must be multiple of 16. pub inline fn allocInstanceDataBuffer(_idb: [*c]InstanceDataBuffer, _num: u32, _stride: u16) void { diff --git a/include/bgfx/c99/bgfx.h b/include/bgfx/c99/bgfx.h index 2007162a6..889fbd137 100644 --- a/include/bgfx/c99/bgfx.h +++ b/include/bgfx/c99/bgfx.h @@ -1557,8 +1557,8 @@ BGFX_C_API uint32_t bgfx_get_avail_instance_data_buffer(uint32_t _num, uint16_t /** * Allocate transient index buffer. * - * @param[out] _tib TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * @param[out] _tib TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * @param[in] _num Number of indices to allocate. * @param[in] _index32 Set to `true` if input indices will be 32-bit. @@ -1569,8 +1569,8 @@ BGFX_C_API void bgfx_alloc_transient_index_buffer(bgfx_transient_index_buffer_t* /** * Allocate transient vertex buffer. * - * @param[out] _tvb TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * @param[out] _tvb TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * @param[in] _num Number of vertices to allocate. * @param[in] _layout Vertex layout. @@ -1583,13 +1583,13 @@ BGFX_C_API void bgfx_alloc_transient_vertex_buffer(bgfx_transient_vertex_buffer_ * buffers. If both space requirements are satisfied function returns * true. * - * @param[out] _tvb TransientVertexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * @param[out] _tvb TransientVertexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * @param[in] _layout Vertex layout. * @param[in] _numVertices Number of vertices to allocate. - * @param[out] _tib TransientIndexBuffer structure is filled and is valid - * for the duration of frame, and it can be reused for multiple draw + * @param[out] _tib TransientIndexBuffer structure will be filled, and will be valid + * for the duration of frame, and can be reused for multiple draw * calls. * @param[in] _numIndices Number of indices to allocate. * @param[in] _index32 Set to `true` if input indices will be 32-bit. @@ -1600,8 +1600,8 @@ BGFX_C_API bool bgfx_alloc_transient_buffers(bgfx_transient_vertex_buffer_t* _tv /** * Allocate instance data buffer. * - * @param[out] _idb InstanceDataBuffer structure is filled and is valid - * for duration of frame, and it can be reused for multiple draw + * @param[out] _idb InstanceDataBuffer structure will be filled, and will be valid + * for duration of frame, and can be reused for multiple draw * calls. * @param[in] _num Number of instances. * @param[in] _stride Instance stride. Must be multiple of 16. diff --git a/scripts/bgfx.idl b/scripts/bgfx.idl index dd27df0e7..8c904cd1d 100644 --- a/scripts/bgfx.idl +++ b/scripts/bgfx.idl @@ -1484,8 +1484,8 @@ func.getAvailInstanceDataBuffer --- func.allocTransientIndexBuffer "void" - .tib "TransientIndexBuffer*" { out } --- TransientIndexBuffer structure is filled and is valid - --- for the duration of frame, and it can be reused for multiple draw + .tib "TransientIndexBuffer*" { out } --- TransientIndexBuffer structure will be filled, and will be valid + --- for the duration of frame, and can be reused for multiple draw --- calls. .num "uint32_t" --- Number of indices to allocate. .index32 "bool" --- Set to `true` if input indices will be 32-bit. @@ -1494,8 +1494,8 @@ func.allocTransientIndexBuffer --- Allocate transient vertex buffer. func.allocTransientVertexBuffer "void" - .tvb "TransientVertexBuffer*" { out } --- TransientVertexBuffer structure is filled and is valid - --- for the duration of frame, and it can be reused for multiple draw + .tvb "TransientVertexBuffer*" { out } --- TransientVertexBuffer structure will be filled, and will be valid + --- for the duration of frame, and can be reused for multiple draw --- calls. .num "uint32_t" --- Number of vertices to allocate. .layout "const VertexLayout &" --- Vertex layout. @@ -1506,13 +1506,13 @@ func.allocTransientVertexBuffer --- func.allocTransientBuffers "bool" - .tvb "TransientVertexBuffer*" { out } --- TransientVertexBuffer structure is filled and is valid - --- for the duration of frame, and it can be reused for multiple draw + .tvb "TransientVertexBuffer*" { out } --- TransientVertexBuffer structure will be filled, and will be valid + --- for the duration of frame, and can be reused for multiple draw --- calls. .layout "const VertexLayout &" --- Vertex layout. .numVertices "uint32_t" --- Number of vertices to allocate. - .tib "TransientIndexBuffer*" { out } --- TransientIndexBuffer structure is filled and is valid - --- for the duration of frame, and it can be reused for multiple draw + .tib "TransientIndexBuffer*" { out } --- TransientIndexBuffer structure will be filled, and will be valid + --- for the duration of frame, and can be reused for multiple draw --- calls. .numIndices "uint32_t" --- Number of indices to allocate. .index32 "bool" --- Set to `true` if input indices will be 32-bit. @@ -1521,8 +1521,8 @@ func.allocTransientBuffers --- Allocate instance data buffer. func.allocInstanceDataBuffer "void" - .idb "InstanceDataBuffer*" { out } --- InstanceDataBuffer structure is filled and is valid - --- for duration of frame, and it can be reused for multiple draw + .idb "InstanceDataBuffer*" { out } --- InstanceDataBuffer structure will be filled, and will be valid + --- for duration of frame, and can be reused for multiple draw --- calls. .num "uint32_t" --- Number of instances. .stride "uint16_t" --- Instance stride. Must be multiple of 16. diff --git a/src/version.h b/src/version.h index 617c1a5fd..ed747ec5e 100644 --- a/src/version.h +++ b/src/version.h @@ -9,5 +9,5 @@ * */ -#define BGFX_REV_NUMBER 8127 -#define BGFX_REV_SHA1 "d038172603d51a12485433206ef0912f7ff73308" +#define BGFX_REV_NUMBER 8193 +#define BGFX_REV_SHA1 "d0a467230751db396779e10b59fd37de74443d01"