From b079e67426eaf406dbfd7f5d6ce594af1829d68d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=91=D1=80=D0=B0=D0=BD=D0=B8=D0=BC=D0=B8=D1=80=20=D0=9A?= =?UTF-8?q?=D0=B0=D1=80=D0=B0=D1=9F=D0=B8=D1=9B?= Date: Sat, 17 Aug 2019 21:35:20 -0700 Subject: [PATCH] Cleanup. --- bindings/cs/bgfx.cs | 6 ++-- include/bgfx/bgfx.h | 12 ++++---- include/bgfx/c99/bgfx.h | 6 ++-- scripts/bgfx.idl | 62 ++++++++++++++++++++--------------------- 4 files changed, 43 insertions(+), 43 deletions(-) diff --git a/bindings/cs/bgfx.cs b/bindings/cs/bgfx.cs index 60ef987ee..e0bca6f80 100644 --- a/bindings/cs/bgfx.cs +++ b/bindings/cs/bgfx.cs @@ -3536,7 +3536,7 @@ public static partial class bgfx /// Vertex buffer. /// First vertex to render. /// Number of vertices to render. - /// VertexLayout handle for aliasing vertex buffer. + /// Vertex layout for aliasing vertex buffer. /// [DllImport(DllName, EntryPoint="bgfx_encoder_set_vertex_buffer", CallingConvention = CallingConvention.Cdecl)] public static extern unsafe void encoder_set_vertex_buffer(Encoder* _this, byte _stream, VertexBufferHandle _handle, uint _startVertex, uint _numVertices, VertexLayoutHandle _layoutHandle); @@ -3549,7 +3549,7 @@ public static partial class bgfx /// Dynamic vertex buffer. /// First vertex to render. /// Number of vertices to render. - /// VertexLayout handle for aliasing vertex buffer. + /// Vertex layout for aliasing vertex buffer. /// [DllImport(DllName, EntryPoint="bgfx_encoder_set_dynamic_vertex_buffer", CallingConvention = CallingConvention.Cdecl)] public static extern unsafe void encoder_set_dynamic_vertex_buffer(Encoder* _this, byte _stream, DynamicVertexBufferHandle _handle, uint _startVertex, uint _numVertices, VertexLayoutHandle _layoutHandle); @@ -3562,7 +3562,7 @@ public static partial class bgfx /// Transient vertex buffer. /// First vertex to render. /// Number of vertices to render. - /// VertexLayout handle for aliasing vertex buffer. + /// Vertex layout for aliasing vertex buffer. /// [DllImport(DllName, EntryPoint="bgfx_encoder_set_transient_vertex_buffer", CallingConvention = CallingConvention.Cdecl)] public static extern unsafe void encoder_set_transient_vertex_buffer(Encoder* _this, byte _stream, TransientVertexBuffer* _tvb, uint _startVertex, uint _numVertices, VertexLayoutHandle _layoutHandle); diff --git a/include/bgfx/bgfx.h b/include/bgfx/bgfx.h index b67ea8a95..e34aaf406 100644 --- a/include/bgfx/bgfx.h +++ b/include/bgfx/bgfx.h @@ -1225,7 +1225,7 @@ namespace bgfx /// @param[in] _handle Vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_encoder_set_vertex_buffer`. /// @@ -1255,7 +1255,7 @@ namespace bgfx /// @param[in] _handle Dynamic vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_encoder_set_dynamic_vertex_buffer`. /// @@ -1285,7 +1285,7 @@ namespace bgfx /// @param[in] _tvb Transient vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_encoder_set_transient_vertex_buffer`. /// @@ -3621,7 +3621,7 @@ namespace bgfx /// @param[in] _handle Vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_set_vertex_buffer`. /// @@ -3651,7 +3651,7 @@ namespace bgfx /// @param[in] _handle Dynamic vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_set_dynamic_vertex_buffer`. /// @@ -3681,7 +3681,7 @@ namespace bgfx /// @param[in] _tvb Transient vertex buffer. /// @param[in] _startVertex First vertex to render. /// @param[in] _numVertices Number of vertices to render. - /// @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + /// @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. /// /// @attention C99 equivalent is `bgfx_set_transient_vertex_buffer`. /// diff --git a/include/bgfx/c99/bgfx.h b/include/bgfx/c99/bgfx.h index 6af6ae19e..71287b603 100644 --- a/include/bgfx/c99/bgfx.h +++ b/include/bgfx/c99/bgfx.h @@ -2435,7 +2435,7 @@ BGFX_C_API void bgfx_encoder_set_transient_index_buffer(bgfx_encoder_t* _this, c * @param[in] _handle Vertex buffer. * @param[in] _startVertex First vertex to render. * @param[in] _numVertices Number of vertices to render. - * @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + * @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. * */ BGFX_C_API void bgfx_encoder_set_vertex_buffer(bgfx_encoder_t* _this, uint8_t _stream, bgfx_vertex_buffer_handle_t _handle, uint32_t _startVertex, uint32_t _numVertices, bgfx_vertex_layout_handle_t _layoutHandle); @@ -2447,7 +2447,7 @@ BGFX_C_API void bgfx_encoder_set_vertex_buffer(bgfx_encoder_t* _this, uint8_t _s * @param[in] _handle Dynamic vertex buffer. * @param[in] _startVertex First vertex to render. * @param[in] _numVertices Number of vertices to render. - * @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + * @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. * */ BGFX_C_API void bgfx_encoder_set_dynamic_vertex_buffer(bgfx_encoder_t* _this, uint8_t _stream, bgfx_dynamic_vertex_buffer_handle_t _handle, uint32_t _startVertex, uint32_t _numVertices, bgfx_vertex_layout_handle_t _layoutHandle); @@ -2459,7 +2459,7 @@ BGFX_C_API void bgfx_encoder_set_dynamic_vertex_buffer(bgfx_encoder_t* _this, ui * @param[in] _tvb Transient vertex buffer. * @param[in] _startVertex First vertex to render. * @param[in] _numVertices Number of vertices to render. - * @param[in] _layoutHandle VertexLayout handle for aliasing vertex buffer. + * @param[in] _layoutHandle Vertex layout for aliasing vertex buffer. * */ BGFX_C_API void bgfx_encoder_set_transient_vertex_buffer(bgfx_encoder_t* _this, uint8_t _stream, const bgfx_transient_vertex_buffer_t* _tvb, uint32_t _startVertex, uint32_t _numVertices, bgfx_vertex_layout_handle_t _layoutHandle); diff --git a/scripts/bgfx.idl b/scripts/bgfx.idl index 888a60943..23a1ecee2 100644 --- a/scripts/bgfx.idl +++ b/scripts/bgfx.idl @@ -1291,19 +1291,19 @@ func.destroy { cname = "destroy_vertex_layout" } --- Create static vertex buffer. func.createVertexBuffer - "VertexBufferHandle" --- Static vertex buffer handle. - .mem "const Memory*" --- Vertex buffer data. - .layout "const VertexLayout &" --- Vertex layout. - .flags "uint16_t" --- Buffer creation flags. - { default = "BGFX_BUFFER_NONE" } --- - `BGFX_BUFFER_NONE` - No flags. - --- - `BGFX_BUFFER_COMPUTE_READ` - Buffer will be read from by compute shader. - --- - `BGFX_BUFFER_COMPUTE_WRITE` - Buffer will be written into by compute shader. When buffer - --- is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated from CPU. - --- - `BGFX_BUFFER_COMPUTE_READ_WRITE` - Buffer will be used for read/write by compute shader. - --- - `BGFX_BUFFER_ALLOW_RESIZE` - Buffer will resize on buffer update if a different amount of - --- data is passed. If this flag is not specified, and more data is passed on update, the buffer - --- will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers. - --- - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on index buffers. + "VertexBufferHandle" --- Static vertex buffer handle. + .mem "const Memory*" --- Vertex buffer data. + .layout "const VertexLayout &" --- Vertex layout. + .flags "uint16_t" --- Buffer creation flags. + { default = "BGFX_BUFFER_NONE" } --- - `BGFX_BUFFER_NONE` - No flags. + --- - `BGFX_BUFFER_COMPUTE_READ` - Buffer will be read from by compute shader. + --- - `BGFX_BUFFER_COMPUTE_WRITE` - Buffer will be written into by compute shader. When buffer + --- is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated from CPU. + --- - `BGFX_BUFFER_COMPUTE_READ_WRITE` - Buffer will be used for read/write by compute shader. + --- - `BGFX_BUFFER_ALLOW_RESIZE` - Buffer will resize on buffer update if a different amount of + --- data is passed. If this flag is not specified, and more data is passed on update, the buffer + --- will be trimmed to fit the existing buffer size. This flag has effect only on dynamic buffers. + --- - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on index buffers. --- Set static vertex buffer debug name. func.setName { cname = "set_vertex_buffer_name" } @@ -1384,21 +1384,21 @@ func.createDynamicVertexBuffer --- Create dynamic vertex buffer and initialize it. func.createDynamicVertexBuffer { cname = "create_dynamic_vertex_buffer_mem" } - "DynamicVertexBufferHandle" --- Dynamic vertex buffer handle. - .mem "const Memory*" --- Vertex buffer data. - .layout "const VertexLayout&" --- Vertex layout. - .flags "uint16_t" --- Buffer creation flags. - { default = "BGFX_BUFFER_NONE" } --- - `BGFX_BUFFER_NONE` - No flags. - --- - `BGFX_BUFFER_COMPUTE_READ` - Buffer will be read from by compute shader. - --- - `BGFX_BUFFER_COMPUTE_WRITE` - Buffer will be written into by compute shader. When buffer - --- is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated from CPU. - --- - `BGFX_BUFFER_COMPUTE_READ_WRITE` - Buffer will be used for read/write by compute shader. - --- - `BGFX_BUFFER_ALLOW_RESIZE` - Buffer will resize on buffer update if a different amount of - --- data is passed. If this flag is not specified, and more data is passed on update, the buffer - --- will be trimmed to fit the existing buffer size. This flag has effect only on dynamic - --- buffers. - --- - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on - --- index buffers. + "DynamicVertexBufferHandle" --- Dynamic vertex buffer handle. + .mem "const Memory*" --- Vertex buffer data. + .layout "const VertexLayout&" --- Vertex layout. + .flags "uint16_t" --- Buffer creation flags. + { default = "BGFX_BUFFER_NONE" } --- - `BGFX_BUFFER_NONE` - No flags. + --- - `BGFX_BUFFER_COMPUTE_READ` - Buffer will be read from by compute shader. + --- - `BGFX_BUFFER_COMPUTE_WRITE` - Buffer will be written into by compute shader. When buffer + --- is created with `BGFX_BUFFER_COMPUTE_WRITE` flag it cannot be updated from CPU. + --- - `BGFX_BUFFER_COMPUTE_READ_WRITE` - Buffer will be used for read/write by compute shader. + --- - `BGFX_BUFFER_ALLOW_RESIZE` - Buffer will resize on buffer update if a different amount of + --- data is passed. If this flag is not specified, and more data is passed on update, the buffer + --- will be trimmed to fit the existing buffer size. This flag has effect only on dynamic + --- buffers. + --- - `BGFX_BUFFER_INDEX32` - Buffer is using 32-bit indices. This flag has effect only on + --- index buffers. --- Update dynamic vertex buffer. func.update { cname = "update_dynamic_vertex_buffer" } @@ -2211,7 +2211,7 @@ func.Encoder.setVertexBuffer .handle "VertexBufferHandle" --- Vertex buffer. .startVertex "uint32_t" --- First vertex to render. .numVertices "uint32_t" --- Number of vertices to render. - .layoutHandle "VertexLayoutHandle" --- VertexLayout handle for aliasing vertex buffer. + .layoutHandle "VertexLayoutHandle" --- Vertex layout for aliasing vertex buffer. { default = "BGFX_INVALID_HANDLE" } --- Set vertex buffer for draw primitive. @@ -2227,7 +2227,7 @@ func.Encoder.setVertexBuffer { cname = "set_dynamic_vertex_buffer" } .handle "DynamicVertexBufferHandle" --- Dynamic vertex buffer. .startVertex "uint32_t" --- First vertex to render. .numVertices "uint32_t" --- Number of vertices to render. - .layoutHandle "VertexLayoutHandle" --- VertexLayout handle for aliasing vertex buffer. + .layoutHandle "VertexLayoutHandle" --- Vertex layout for aliasing vertex buffer. { default = "BGFX_INVALID_HANDLE" } --- Set vertex buffer for draw primitive. @@ -2243,7 +2243,7 @@ func.Encoder.setVertexBuffer { cname = "set_transient_vertex_buffer" } .tvb "const TransientVertexBuffer*" --- Transient vertex buffer. .startVertex "uint32_t" --- First vertex to render. .numVertices "uint32_t" --- Number of vertices to render. - .layoutHandle "VertexLayoutHandle" --- VertexLayout handle for aliasing vertex buffer. + .layoutHandle "VertexLayoutHandle" --- Vertex layout for aliasing vertex buffer. { default = "BGFX_INVALID_HANDLE" } --- Set number of vertices for auto generated vertices use in conjuction