From 0ed4ec11a94379e0e934817e30eb004a01e1b3d2 Mon Sep 17 00:00:00 2001 From: Andrea Ciliberti Date: Wed, 5 Apr 2023 14:26:16 +0200 Subject: [PATCH 1/3] Fix licensing --- README.md | 5 ++ citro3d-sys/Cargo.toml | 3 +- citro3d-sys/LICENSE | 18 +++++ citro3d/Cargo.toml | 4 +- citro3d/LICENSE-APACHE | 176 +++++++++++++++++++++++++++++++++++++++++ citro3d/LICENSE-MIT | 23 ++++++ 6 files changed, 227 insertions(+), 2 deletions(-) create mode 100644 citro3d-sys/LICENSE create mode 100644 citro3d/LICENSE-APACHE create mode 100644 citro3d/LICENSE-MIT diff --git a/README.md b/README.md index 65371c2..e52fbad 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,8 @@ library, to write homebrew graphical programs for the Nintendo 3DS. * `citro3d-sys` - C bindings to `libcitro3d` * `citro3d` - safe Rust wrappers for `citro3d-sys` (WIP) + +## License + +* `citro3d-sys` is licensed under Zlib +* `citro3d` is dual-licensed under MIT or Apache-2.0 diff --git a/citro3d-sys/Cargo.toml b/citro3d-sys/Cargo.toml index 4c5a246..3e03c41 100644 --- a/citro3d-sys/Cargo.toml +++ b/citro3d-sys/Cargo.toml @@ -1,8 +1,9 @@ [package] name = "citro3d-sys" version = "0.1.0" -authors = ["panicbit "] # TODO update author? +authors = [ "Rust3DS Org", "panicbit " ] edition = "2021" +license = "Zlib" [dependencies] libc = "0.2.116" diff --git a/citro3d-sys/LICENSE b/citro3d-sys/LICENSE new file mode 100644 index 0000000..da0cd15 --- /dev/null +++ b/citro3d-sys/LICENSE @@ -0,0 +1,18 @@ +As with the original citro3d, this library is licensed under zlib. + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any + damages arising from the use of this software. + + Permission is granted to anyone to use this software for any + purpose, including commercial applications, and to alter it and + redistribute it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you + must not claim that you wrote the original software. If you use + this software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and + must not be misrepresented as being the original software. + 3. This notice may not be removed or altered from any source + distribution. \ No newline at end of file diff --git a/citro3d/Cargo.toml b/citro3d/Cargo.toml index 70eca7f..0ac2fa7 100644 --- a/citro3d/Cargo.toml +++ b/citro3d/Cargo.toml @@ -1,12 +1,14 @@ [package] name = "citro3d" +authors = [ "Rust3DS Org" ] +license = "MIT OR Apache-2.0" version = "0.1.0" edition = "2021" [dependencies] bitflags = "1.3.2" bytemuck = { version = "1.10.0", features = ["extern_crate_std"] } -citro3d-sys = { git = "https://github.com/ian-h-chamberlain/citro3d-rs.git" } +citro3d-sys = { git = "https://github.com/rust3ds/citro3d-rs.git" } ctru-rs = { git = "https://github.com/rust3ds/ctru-rs.git" } ctru-sys = { git = "https://github.com/rust3ds/ctru-rs.git" } libc = "0.2.125" diff --git a/citro3d/LICENSE-APACHE b/citro3d/LICENSE-APACHE new file mode 100644 index 0000000..a7e77cb --- /dev/null +++ b/citro3d/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/LICENSE-MIT b/citro3d/LICENSE-MIT new file mode 100644 index 0000000..468cd79 --- /dev/null +++ b/citro3d/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 From 4fa59ada84fcf4ba16de3a87594298a17b5875ff Mon Sep 17 00:00:00 2001 From: Ian Chamberlain Date: Fri, 14 Apr 2023 11:50:29 -0400 Subject: [PATCH 2/3] Update example for 3D and new gfx APIs --- Cargo.toml | 1 + citro3d/examples/triangle.rs | 69 ++++++++++++++++++++++-------------- citro3d/src/render.rs | 12 +++---- 3 files changed, 49 insertions(+), 33 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 248e09b..1ceb75b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,6 @@ [workspace] members = ["citro3d-sys", "citro3d", "bindgen-citro3d"] +default-members = ["citro3d", "citro3d-sys"] [patch."https://github.com/rust3ds/citro3d-rs.git"] citro3d-sys = { path = "citro3d-sys" } diff --git a/citro3d/examples/triangle.rs b/citro3d/examples/triangle.rs index 50831e0..b1154ea 100644 --- a/citro3d/examples/triangle.rs +++ b/citro3d/examples/triangle.rs @@ -3,11 +3,10 @@ use citro3d::render::{ClearFlags, Target}; use citro3d::{include_aligned_bytes, shader}; use citro3d_sys::C3D_Mtx; -use ctru::gfx::{Gfx, RawFrameBuffer, Screen}; -use ctru::services::apt::Apt; -use ctru::services::hid::{Hid, KeyPad}; -use ctru::services::soc::Soc; +use ctru::prelude::*; +use ctru::services::gfx::{RawFrameBuffer, Screen, TopScreen3D}; +use std::f32::consts::PI; use std::ffi::CStr; use std::mem::MaybeUninit; @@ -51,25 +50,31 @@ static SHADER_BYTES: &[u8] = include_aligned_bytes!(concat!(env!("OUT_DIR"), "/examples/assets/vshader.shbin")); fn main() { - ctru::init(); + ctru::use_panic_handler(); - let mut soc = Soc::init().expect("failed to get SOC"); + let mut soc = Soc::new().expect("failed to get SOC"); drop(soc.redirect_to_3dslink(true, true)); - let gfx = Gfx::init().expect("Couldn't obtain GFX controller"); - let hid = Hid::init().expect("Couldn't obtain HID controller"); - let apt = Apt::init().expect("Couldn't obtain APT controller"); - - let mut top_screen = gfx.top_screen.borrow_mut(); - let RawFrameBuffer { width, height, .. } = top_screen.get_raw_framebuffer(); + let gfx = Gfx::new().expect("Couldn't obtain GFX controller"); + let mut hid = Hid::new().expect("Couldn't obtain HID controller"); + let apt = Apt::new().expect("Couldn't obtain APT controller"); let mut instance = citro3d::Instance::new().expect("failed to initialize Citro3D"); - let mut top_target = citro3d::render::Target::new(width, height, top_screen, None) + let top_screen = TopScreen3D::from(&gfx.top_screen); + + let (mut top_left, mut top_right) = top_screen.split_mut(); + + let RawFrameBuffer { width, height, .. } = top_left.raw_framebuffer(); + let mut top_left_target = citro3d::render::Target::new(width, height, top_left, None) + .expect("failed to create render target"); + + let RawFrameBuffer { width, height, .. } = top_right.raw_framebuffer(); + let mut top_right_target = citro3d::render::Target::new(width, height, top_right, None) .expect("failed to create render target"); let mut bottom_screen = gfx.bottom_screen.borrow_mut(); - let RawFrameBuffer { width, height, .. } = bottom_screen.get_raw_framebuffer(); + let RawFrameBuffer { width, height, .. } = bottom_screen.raw_framebuffer(); let mut bottom_target = citro3d::render::Target::new(width, height, bottom_screen, None) .expect("failed to create bottom screen render target"); @@ -82,29 +87,35 @@ fn main() { let mut vbo_data = Vec::with_capacity_in(VERTICES.len(), ctru::linear::LinearAllocator); vbo_data.extend_from_slice(VERTICES); - let (uloc_projection, projection) = scene_init(&mut program, &vbo_data); + let (projection_uniform_idx, mut projection) = scene_init(&mut program, &vbo_data); + + unsafe { citro3d_sys::Mtx_RotateY(&mut projection, -PI / 12.0, true) }; + + let mut right_eye_projection = projection; + unsafe { citro3d_sys::Mtx_RotateY(&mut right_eye_projection, 2.0 * PI / 12.0, true) }; while apt.main_loop() { hid.scan_input(); - if hid.keys_down().contains(KeyPad::KEY_START) { + if hid.keys_down().contains(KeyPad::START) { break; } - let mut render_to = |target: &mut Target| { - instance.render_frame_with(|instance| { + instance.render_frame_with(|instance| { + let mut render_to = |target: &mut Target, projection| { instance .select_render_target(target) .expect("failed to set render target"); let clear_color: u32 = 0x7F_7F_7F_FF; target.clear(ClearFlags::ALL, clear_color, 0); - scene_render(uloc_projection.into(), &projection); - }); - }; + scene_render(projection_uniform_idx.into(), projection); + }; - render_to(&mut top_target); - render_to(&mut bottom_target); + render_to(&mut top_left_target, &projection); + render_to(&mut top_right_target, &right_eye_projection); + render_to(&mut bottom_target, &projection); + }); } } @@ -115,7 +126,7 @@ fn scene_init(program: &mut shader::Program, vbo_data: &[Vertex]) -> (i8, C3D_Mt // Get the location of the uniforms let projection_name = CStr::from_bytes_with_nul(b"projection\0").unwrap(); - let uloc_projection = ctru_sys::shaderInstanceGetUniformLocation( + let projection_uniform_idx = ctru_sys::shaderInstanceGetUniformLocation( (*program.as_raw()).vertexShader, projection_name.as_ptr(), ); @@ -169,14 +180,18 @@ fn scene_init(program: &mut shader::Program, vbo_data: &[Vertex]) -> (i8, C3D_Mt ); citro3d_sys::C3D_TexEnvFunc(env, citro3d_sys::C3D_Both, ctru_sys::GPU_REPLACE); - (uloc_projection, projection) + (projection_uniform_idx, projection) } } -fn scene_render(uloc_projection: i32, projection: &C3D_Mtx) { +fn scene_render(projection_uniform_idx: i32, projection: &C3D_Mtx) { unsafe { // Update the uniforms - citro3d_sys::C3D_FVUnifMtx4x4(ctru_sys::GPU_VERTEX_SHADER, uloc_projection, projection); + citro3d_sys::C3D_FVUnifMtx4x4( + ctru_sys::GPU_VERTEX_SHADER, + projection_uniform_idx, + projection, + ); // Draw the VBO citro3d_sys::C3D_DrawArrays( diff --git a/citro3d/src/render.rs b/citro3d/src/render.rs index 0a7a563..16bd48b 100644 --- a/citro3d/src/render.rs +++ b/citro3d/src/render.rs @@ -6,7 +6,7 @@ use std::cell::RefMut; use citro3d_sys::{ C3D_RenderTarget, C3D_RenderTargetCreate, C3D_RenderTargetDelete, C3D_DEPTHTYPE, }; -use ctru::gfx::Screen; +use ctru::services::gfx::Screen; use ctru::services::gspgpu::FramebufferFormat; use ctru_sys::{GPU_COLORBUF, GPU_DEPTHBUF}; @@ -39,17 +39,17 @@ impl<'screen> Target<'screen> { /// /// Fails if the target could not be created. pub fn new( - width: u16, - height: u16, + width: usize, + height: usize, screen: RefMut<'screen, dyn Screen>, depth_format: Option, ) -> Result { - let color_format: ColorFormat = screen.get_framebuffer_format().into(); + let color_format: ColorFormat = screen.framebuffer_format().into(); let raw = unsafe { C3D_RenderTargetCreate( - width.into(), - height.into(), + width.try_into()?, + height.try_into()?, color_format as GPU_COLORBUF, depth_format.map_or(C3D_DEPTHTYPE { __i: -1 }, DepthFormat::as_raw), ) From 009b7eb94f714511882552818932d206acef0061 Mon Sep 17 00:00:00 2001 From: Ian Chamberlain Date: Fri, 2 Jun 2023 09:42:43 -0400 Subject: [PATCH 3/3] Update to 2021 resolver by default --- Cargo.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/Cargo.toml b/Cargo.toml index 1ceb75b..d59cf00 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,7 @@ [workspace] members = ["citro3d-sys", "citro3d", "bindgen-citro3d"] default-members = ["citro3d", "citro3d-sys"] +resolver = "2" [patch."https://github.com/rust3ds/citro3d-rs.git"] citro3d-sys = { path = "citro3d-sys" }