📝 Add docstrings to vertex_layout
#35
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docstrings generation was requested by @WSQS. * #34 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.gpu.cpp` * `sdl_wrapper/sdl_wrapper.render_procedural.cpp`
Merged
Author
|
Important Review skippedCodeRabbit bot authored PR detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
Contributor
|
Here's the code health analysis summary for commits Analysis Summary
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| * | ||
| * Any failures to upload vertex data or update shaders are logged. | ||
| * | ||
| * @return SDL_AppResult SDL_APP_CONTINUE to indicate the application should continue running. |
There was a problem hiding this comment.
warning: method 'tick' can be made static [readability-convert-member-functions-to-static]
Suggested change
| * @return SDL_AppResult SDL_APP_CONTINUE to indicate the application should continue running. | |
| static SDL_AppResult tick() |
| * to clear and render the color target, uploads the camera uniform, binds vertex buffers | ||
| * and the graphics pipeline, issues the draw call, renders ImGui, and submits the command buffer. | ||
| * | ||
| * @return SDL_AppResult `SDL_APP_CONTINUE` to keep the application running. |
There was a problem hiding this comment.
warning: method 'draw' can be made const [readability-make-member-function-const]
Suggested change
| * @return SDL_AppResult `SDL_APP_CONTINUE` to keep the application running. | |
| SDL_AppResult draw() const |
|
clang-tidy review says "All clean, LGTM! 👍" |
WSQS
approved these changes
Nov 19, 2025
WSQS
added a commit
that referenced
this pull request
Nov 19, 2025
* fix: add comment for main.cpp * fix: add method set_vertex_attributes for PipelineWrapper * fix: using m_vertex_layout to calculate vertex * fix:remove vertex layout from forward declaration * fix:rename pipeline wrapper to render procedural * feat:add method vertex_layout * fix: remove struct Vertex and using byte array * feat: rename function * feat: rename variable * fix: remove unused variable * doc: clean up doc * fix: create Transfer Buffer when created * feat: add class render data * fix:rename variable * fix:rename variable * fix:rename function * fix:change operation order * feat：add method get_buffer_binding * feat：add member variable m_render_data * feat：add missing header * fix:remove unused member variable * fix:change shader interface * fix:add property m_layouts for RenderData * feat:change imgui based onto vertex layout * fix:remove buffer function * fix:hide buffer module * style: format code with ClangFormat This commit fixes the style issues introduced in 6726b98 according to the output from ClangFormat. Details: #34 * Revert "fix:hide buffer module" This reverts commit 6726b98. * 📝 Add docstrings to `vertex_layout` (#35) * 📝 Add docstrings to `vertex_layout` Docstrings generation was requested by @WSQS. * #34 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.gpu.cpp` * `sdl_wrapper/sdl_wrapper.render_procedural.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 79383bc according to the output from ClangFormat. Details: #35 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Co-authored-by: Sophomore <sophomore@duck.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
WSQS
added a commit
that referenced
this pull request
Nov 20, 2025
* fix: add comment for main.cpp * fix: add method set_vertex_attributes for PipelineWrapper * fix: using m_vertex_layout to calculate vertex * fix:remove vertex layout from forward declaration * fix:rename pipeline wrapper to render procedural * feat:add method vertex_layout * fix: remove struct Vertex and using byte array * feat: rename function * feat: rename variable * fix: remove unused variable * doc: clean up doc * fix: create Transfer Buffer when created * feat: add class render data * fix:rename variable * fix:rename variable * fix:rename function * fix:change operation order * feat：add method get_buffer_binding * feat：add member variable m_render_data * feat：add missing header * fix:remove unused member variable * fix:change shader interface * fix:add property m_layouts for RenderData * feat:change imgui based onto vertex layout * fix:remove buffer function * fix:hide buffer module * style: format code with ClangFormat This commit fixes the style issues introduced in 6726b98 according to the output from ClangFormat. Details: #34 * Revert "fix:hide buffer module" This reverts commit 6726b98. * 📝 Add docstrings to `vertex_layout` (#35) * 📝 Add docstrings to `vertex_layout` Docstrings generation was requested by @WSQS. * #34 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.gpu.cpp` * `sdl_wrapper/sdl_wrapper.render_procedural.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 79383bc according to the output from ClangFormat. Details: #35 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Co-authored-by: Sophomore <sophomore@duck.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
WSQS
added a commit
that referenced
this pull request
Nov 20, 2025
* feat: add module glsl reflector * feat: implement glsl reflector * Vertex layout (#34) * fix: add comment for main.cpp * fix: add method set_vertex_attributes for PipelineWrapper * fix: using m_vertex_layout to calculate vertex * fix:remove vertex layout from forward declaration * fix:rename pipeline wrapper to render procedural * feat:add method vertex_layout * fix: remove struct Vertex and using byte array * feat: rename function * feat: rename variable * fix: remove unused variable * doc: clean up doc * fix: create Transfer Buffer when created * feat: add class render data * fix:rename variable * fix:rename variable * fix:rename function * fix:change operation order * feat：add method get_buffer_binding * feat：add member variable m_render_data * feat：add missing header * fix:remove unused member variable * fix:change shader interface * fix:add property m_layouts for RenderData * feat:change imgui based onto vertex layout * fix:remove buffer function * fix:hide buffer module * style: format code with ClangFormat This commit fixes the style issues introduced in 6726b98 according to the output from ClangFormat. Details: #34 * Revert "fix:hide buffer module" This reverts commit 6726b98. * 📝 Add docstrings to `vertex_layout` (#35) * 📝 Add docstrings to `vertex_layout` Docstrings generation was requested by @WSQS. * #34 (comment) The following files were modified: * `main.cpp` * `sdl_wrapper/sdl_wrapper.buffer.cpp` * `sdl_wrapper/sdl_wrapper.gpu.cpp` * `sdl_wrapper/sdl_wrapper.render_procedural.cpp` * style: format code with ClangFormat This commit fixes the style issues introduced in 79383bc according to the output from ClangFormat. Details: #35 --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> --------- Co-authored-by: Sophomore <sophomore@duck.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * feat: Implement glsl reflector into sdl wrapper * feat: recreate data when shader update * fix: add header file cstdint * fix: import module * fix: remove install for glslr * fix: add time out for gtest_discover_tests * fix:add head file to make in compile under mint * fix: add and clean up header file * style: format code with ClangFormat This commit fixes the style issues introduced in 2061a92 according to the output from ClangFormat. Details: #36 --------- Co-authored-by: Sophomore <sophomore@duck.com> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docstrings generation was requested by @WSQS.
The following files were modified:
main.cppsdl_wrapper/sdl_wrapper.buffer.cppsdl_wrapper/sdl_wrapper.gpu.cppsdl_wrapper/sdl_wrapper.render_procedural.cppThese file types are not supported
sdl_wrapper/CMakeLists.txtsdl_wrapper/sdl_wrapper.buffer.ixxsdl_wrapper/sdl_wrapper.decl.ixxsdl_wrapper/sdl_wrapper.gpu.ixxsdl_wrapper/sdl_wrapper.ixxsdl_wrapper/sdl_wrapper.render_data.ixxsdl_wrapper/sdl_wrapper.render_procedural.ixxsdl_wrapper/sdl_wrapper.renderable.ixxsdl_wrapper/sdl_wrapper.vertex_layout.ixxℹ️ Note