Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guide to debugging in Xcode #151

Merged
merged 2 commits into from
Jul 9, 2020
Merged

Conversation

chinedufn
Copy link
Collaborator

Closes #148

Copy link
Contributor

@monocodus monocodus bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .monocodus config not found in your repo. Default config is used.
Check config documentation here

@@ -0,0 +1,37 @@
# Debugging in Xcode
Copy link
Collaborator Author

@chinedufn chinedufn Jul 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

@monocodus monocodus bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The .monocodus config not found in your repo. Default config is used.
Check config documentation here

@chinedufn
Copy link
Collaborator Author

chinedufn commented Jul 5, 2020

It turns out that you can also capture GPU frame programatically (without using Xcode) and write them to a .gpuTrace file.

Then later just open that file and it will launch in Xcode.

https://developer.apple.com/documentation/metal/frame_capture_debugging_tools/capturing_gpu_command_data_programmatically

I left a TODO to add this to the debugging docs

@adamnemecek
Copy link
Contributor

This is very timely. Are you on discord or twitter or something? I think that we are like the only two rust developers who use metal directly, we should form some sort of union.

@chinedufn
Copy link
Collaborator Author

Haha I'm not on either but my email is in my GitHub profile if you ever want to chat Metal and all that good stuff

Copy link
Member

@kvark kvark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!
Do you think this should live in an MD file here instead of just in a wiki page?
I think the latter has a bit less friction when you need to tweak it and collaborate.

@chinedufn
Copy link
Collaborator Author

chinedufn commented Jul 8, 2020

tl;dr

I'm cool with a wiki albeit not my first choice. Could you create a wiki for the repo and I'll get this moved?




Ha so if it was only up to me I'd prefer an mdbook. I went ahead and assumed that you might feel that was too heavy handed. So I threw in the markdown file.

I like being able to #include the real example code in the guide a la -> https://rustwasm.github.io/docs/wasm-bindgen/examples/web-audio.html .

But that aside. As someone who primarily works offline - having guides be in tree is helpful. I like to be able to just clone a repo and have everything that I need.


Now, that all being said. I have no issues with going with the wiki!

My only goal/vision is that other people get to experience the joy of targeting Metal with Rust. It's a super smooth experience and I want others to know it!

I'd like a future where someone building a production-grade Metal application is seriously considering Rust + metal-rs.

To me a major gap for that future is for someone to land in metal-rs and immediately know how to get running. I want us to hold people's hands. "Here's how the bindings work (lightly explain msg_send!, etc)." "Here's some assurance that you aren't missing anything that you would have targetting Metal from Swift." etc.

Ok so slightly off-topic rant over.

I say all of that to say.

I'm cool with a wiki albeit not my first choice. Could you create a wiki for the repo and I'll get this moved?

Cheers!

@kvark
Copy link
Member

kvark commented Jul 9, 2020

Ok, that's fine by me :)
If you don't have write access to the wiki, please let me know.

@kvark kvark merged commit 261bf55 into gfx-rs:master Jul 9, 2020
@chinedufn chinedufn deleted the debugging-guide branch July 9, 2020 20:14
@chinedufn
Copy link
Collaborator Author

Whenever I try to go to the wiki it redirects me to the repo homepage

@kvark
Copy link
Member

kvark commented Jul 9, 2020

@chinedufn please try again now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation describing how to set up Xcode debugging
3 participants