From 041cf475244bae15f96d0b8b782eb5fca96290d8 Mon Sep 17 00:00:00 2001 From: Ian Chamberlain Date: Fri, 24 Nov 2023 13:25:39 -0500 Subject: [PATCH 1/3] Add some basic READMEs and licenses for macros --- README.md | 9 +- citro3d-macros/LICENSE-APACHE | 176 ++++++++++++++++++++++++++++++++++ citro3d-macros/LICENSE-MIT | 23 +++++ citro3d-macros/README.md | 5 + citro3d-sys/README.md | 10 ++ citro3d/README.md | 6 ++ 6 files changed, 226 insertions(+), 3 deletions(-) create mode 100644 citro3d-macros/LICENSE-APACHE create mode 100644 citro3d-macros/LICENSE-MIT create mode 100644 citro3d-macros/README.md create mode 100644 citro3d-sys/README.md create mode 100644 citro3d/README.md diff --git a/README.md b/README.md index e52fbad..54d94f5 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,13 @@ library, to write homebrew graphical programs for the Nintendo 3DS. ## Crates -* `citro3d-sys` - C bindings to `libcitro3d` -* `citro3d` - safe Rust wrappers for `citro3d-sys` (WIP) +* [`citro3d-sys`](./citro3d-sys) - C bindings to `libcitro3d` + ([docs](https://rust3ds.github.io/citro3d-rs/crates/citro3d)) +* [`citro3d`](./citro3d) - safe Rust wrappers for `citro3d-sys` (WIP) + ([docs](https://rust3ds.github.io/citro3d-rs/crates/citro3d_sys)) +* [`citro3d-macros`](./citro3d-macros/) – helper proc-macros for `citro3d` ## License * `citro3d-sys` is licensed under Zlib -* `citro3d` is dual-licensed under MIT or Apache-2.0 +* `citro3d` and `citro3d-macros` are dual-licensed under MIT or Apache-2.0 diff --git a/citro3d-macros/LICENSE-APACHE b/citro3d-macros/LICENSE-APACHE new file mode 100644 index 0000000..a7e77cb --- /dev/null +++ b/citro3d-macros/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/citro3d-macros/LICENSE-MIT b/citro3d-macros/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/citro3d-macros/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/citro3d-macros/README.md b/citro3d-macros/README.md new file mode 100644 index 0000000..cee1350 --- /dev/null +++ b/citro3d-macros/README.md @@ -0,0 +1,5 @@ +# citro3d-macros + +Proc-macro helpers for [`citro3d`](../citro3d). For now, the only available +macro is `include_shader!` which can be used to embed compiled PICA200 shaders +into an application. diff --git a/citro3d-sys/README.md b/citro3d-sys/README.md new file mode 100644 index 0000000..f0bba4c --- /dev/null +++ b/citro3d-sys/README.md @@ -0,0 +1,10 @@ +# citro3d-sys + +Rust bindings to [`citro3d`](https://github.com/devkitPro/citro3d). +Bindings are generated at build time using the locally-installed devkitPro. + +[Documentation](https://rust3ds.github.io/citro3d-rs/crates/citro3d_sys) is generated from the +`main` branch, and should generally be up to date with the latest devkitPro. +This will be more useful than [docs.rs](https://docs.rs/crates/citro3d), since +the bindings are generated at build time and `docs.rs`' build environment does not +have a copy of devkitPro to generate bindings from. diff --git a/citro3d/README.md b/citro3d/README.md new file mode 100644 index 0000000..6c8b536 --- /dev/null +++ b/citro3d/README.md @@ -0,0 +1,6 @@ +# citro3d + +Safe wrappers around [`citro3d-sys`](../citro3d-sys). + +[Documentation](https://rust3ds.github.io/citro3d-rs/crates/citro3d) is generated from the +`main` branch. From 4f0b06c0a89e4a135896696b09cb9c27b3b3cd82 Mon Sep 17 00:00:00 2001 From: Ian Chamberlain Date: Fri, 24 Nov 2023 13:31:20 -0500 Subject: [PATCH 2/3] Add default github pages config plus crate docs --- .github/workflows/docs.yml | 24 +++++++++++++++++------- README.md | 2 +- _config.yml | 1 + 3 files changed, 19 insertions(+), 8 deletions(-) create mode 100644 _config.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index dc1c57e..92aba32 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,16 +14,23 @@ jobs: - name: Checkout branch uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v3 + with: + generator_config_file: ./_site/_config.yml + + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./ + destination: ./_site + - uses: rust3ds/test-runner/setup@v1 with: toolchain: nightly - name: Build workspace docs run: cargo 3ds --verbose doc --verbose --no-deps --workspace - env: - # TODO: might want a custom index page ? - # https://doc.rust-lang.org/rustdoc/unstable-features.html#--index-page-provide-a-top-level-landing-page-for-docs - RUSTDOCFLAGS: "--enable-index-page" # https://github.com/actions/upload-pages-artifact#file-permissions - name: Fix file permissions @@ -32,10 +39,13 @@ jobs: echo "::warning title=Invalid file permissions automatically fixed::$line" done - - name: Upload generated docs + - name: Copy generated docs to _site + # Note: this won't include proc-macro crate, but macros are re-exported + # by the crate docs so there will still be some documentation. + run: cp -R ./target/armv6k-nintendo-3ds/doc ./_site/crates + + - name: Upload docs uses: actions/upload-pages-artifact@v2 - with: - path: ./target/armv6k-nintendo-3ds/doc deploy: runs-on: ubuntu-latest diff --git a/README.md b/README.md index 54d94f5..e88eafb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ⚠️ WIP ⚠️ -Bindings and safe wrapper to the [citro3d](https://github.com/devkitPro/citro3d) +Rust bindings and safe wrapper to the [citro3d](https://github.com/devkitPro/citro3d) library, to write homebrew graphical programs for the Nintendo 3DS. ## Crates diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..bad8266 --- /dev/null +++ b/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-midnight From 30c0c72086e546cceed63d1a2dea251d5b9d76d9 Mon Sep 17 00:00:00 2001 From: Ian Chamberlain Date: Fri, 24 Nov 2023 13:59:54 -0500 Subject: [PATCH 3/3] Try a different theme and fix build failure --- .github/workflows/docs.yml | 7 ++----- _config.yml | 1 + assets/css/style.scss | 15 +++++++++++++++ citro3d/examples/triangle.rs | 4 +--- 4 files changed, 19 insertions(+), 8 deletions(-) create mode 100644 assets/css/style.scss diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 92aba32..c908bd5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,14 +16,9 @@ jobs: - name: Setup Pages uses: actions/configure-pages@v3 - with: - generator_config_file: ./_site/_config.yml - name: Build with Jekyll uses: actions/jekyll-build-pages@v1 - with: - source: ./ - destination: ./_site - uses: rust3ds/test-runner/setup@v1 with: @@ -31,6 +26,8 @@ jobs: - name: Build workspace docs run: cargo 3ds --verbose doc --verbose --no-deps --workspace + env: + RUSTDOCFLAGS: --enable-index-page # https://github.com/actions/upload-pages-artifact#file-permissions - name: Fix file permissions diff --git a/_config.yml b/_config.yml index bad8266..4688e93 100644 --- a/_config.yml +++ b/_config.yml @@ -1 +1,2 @@ +# Configuration for GitHub Pages (Jekyll) theme: jekyll-theme-midnight diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..1efa0fc --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,15 @@ +--- +--- + +// https://github.com/pages-themes/midnight#stylesheet +@import "{{ site.theme }}"; + +// Give code links a color that matches regular links +a code { + color: inherit; +} + +// Remove weird extra padding and spaces from inline code blocks +code { + padding: 0; +} diff --git a/citro3d/examples/triangle.rs b/citro3d/examples/triangle.rs index b367906..6f3c784 100644 --- a/citro3d/examples/triangle.rs +++ b/citro3d/examples/triangle.rs @@ -49,8 +49,6 @@ static VERTICES: &[Vertex] = &[ static SHADER_BYTES: &[u8] = include_shader!("assets/vshader.pica"); fn main() { - ctru::use_panic_handler(); - let mut soc = Soc::new().expect("failed to get SOC"); drop(soc.redirect_to_3dslink(true, true)); @@ -166,7 +164,7 @@ struct Projections { fn calculate_projections() -> Projections { // TODO: it would be cool to allow playing around with these parameters on // the fly with D-pad, etc. - let slider_val = unsafe { ctru_sys::osGet3DSliderState() }; + let slider_val = ctru::os::current_3d_slider_state(); let interocular_distance = slider_val / 2.0; let vertical_fov = 40.0_f32.to_radians();