From 137f60861f07e12b1f77f05a0b1572f8a8bcc730 Mon Sep 17 00:00:00 2001 From: Renaldas Zioma Date: Tue, 11 Jun 2024 03:50:05 +0300 Subject: [PATCH] feat(examples): scrolling checkers with adjustable colors, dithering based transparency and illusion of depth. (#6) --- src/examples/checkers/LICENSE.txt | 202 ++++++++++++++++++++++++++++++ src/examples/checkers/index.ts | 12 ++ src/examples/checkers/project.v | 98 +++++++++++++++ src/examples/index.ts | 3 +- 4 files changed, 314 insertions(+), 1 deletion(-) create mode 100644 src/examples/checkers/LICENSE.txt create mode 100644 src/examples/checkers/index.ts create mode 100644 src/examples/checkers/project.v diff --git a/src/examples/checkers/LICENSE.txt b/src/examples/checkers/LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/src/examples/checkers/LICENSE.txt @@ -0,0 +1,202 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/src/examples/checkers/index.ts b/src/examples/checkers/index.ts new file mode 100644 index 0000000..eb5b920 --- /dev/null +++ b/src/examples/checkers/index.ts @@ -0,0 +1,12 @@ +import hvsync_generator_v from '../common/hvsync_generator.v?raw'; +import project_v from './project.v?raw'; + +export const checkers = { + name: 'Checkers', + author: 'Renaldas Zioma', + topModule: 'tt_um_vga_example', + sources: { + 'project.v': project_v, + 'hvsync_generator.v': hvsync_generator_v, + }, +}; diff --git a/src/examples/checkers/project.v b/src/examples/checkers/project.v new file mode 100644 index 0000000..df2e869 --- /dev/null +++ b/src/examples/checkers/project.v @@ -0,0 +1,98 @@ +/* + * Copyright (c) 2024 Renaldas Zioma + * based on the VGA examples by Uri Shaked + * SPDX-License-Identifier: Apache-2.0 + */ + +`default_nettype none + +module tt_um_vga_example( + input wire [7:0] ui_in, // Dedicated inputs + output wire [7:0] uo_out, // Dedicated outputs + input wire [7:0] uio_in, // IOs: Input path + output wire [7:0] uio_out, // IOs: Output path + output wire [7:0] uio_oe, // IOs: Enable path (active high: 0=input, 1=output) + input wire ena, // always 1 when the design is powered, so you can ignore it + input wire clk, // clock + input wire rst_n // reset_n - low to reset +); + // increase couner every frame (vsync happens once per frame) + reg [9:0] counter; + always @(posedge vsync) begin + if (~rst_n) begin + counter <= 0; + end else begin + counter <= counter + 1; + end + end + + // animate layers + wire [9:0] layer_a_x = pix_x + counter*16; + wire [9:0] layer_a_y = pix_y + counter*2; + + wire [9:0] layer_b_x = pix_x + counter*7; + wire [9:0] layer_b_y = pix_y + counter + counter/2; + + wire [9:0] layer_c_x = pix_x + counter*4; + wire [9:0] layer_c_y = pix_y + counter/2; + + wire [9:0] layer_d_x = pix_x + counter*2; + wire [9:0] layer_d_y = pix_y + counter/4; + + wire [9:0] layer_e_x = pix_x + counter/2; + wire [9:0] layer_e_y = pix_y + counter/6; + + // checker shape * transparency using pixel dithering + wire layer_a = (layer_a_x[8] ^ layer_a_y[8]) & ( pix_y[1] ^ pix_x[0]); + wire layer_b = (layer_b_x[7] ^ layer_b_y[7]) & (~pix_y[0] ^ pix_x[1]); + wire layer_c = layer_c_x[6] ^ layer_c_y[6] ; + wire layer_d = layer_d_x[5] ^ layer_d_y[5] ; + wire layer_e = (layer_e_x[4] ^ layer_e_y[4]) & ( pix_y[1] ^ pix_x[0]); + + wire [5:0] color_a = ~ui_in[5:0]; // color of the closest layer + wire [5:0] color_b = color_a ^ 6'b00_10_10; + wire [5:0] color_c = color_b & 6'b10_10_10; + wire [5:0] color_de = color_c >> 1; // color of the two farthest layers + // the layer e also using dithering to darken the color + + assign {R, G, B} = + video_active ? + (layer_a ? color_a : + (layer_b ? color_b : + (layer_c ? color_c : + (layer_d ? color_de : + (layer_e ? color_de : 6'b00_00_00))))) : 6'b00_00_00; + + + + // VGA signals + wire hsync; + wire vsync; + wire [1:0] R; + wire [1:0] G; + wire [1:0] B; + wire video_active; + wire [9:0] pix_x; + wire [9:0] pix_y; + + // TinyVGA PMOD + assign uo_out = {hsync, B[0], G[0], R[0], vsync, B[1], G[1], R[1]}; + + // Unused outputs assigned to 0. + assign uio_out = 0; + assign uio_oe = 0; + + // Suppress unused signals warning + wire _unused_ok = &{ena, ui_in, uio_in}; + + hvsync_generator hvsync_gen( + .clk(clk), + .reset(~rst_n), + .hsync(hsync), + .vsync(vsync), + .display_on(video_active), + .hpos(pix_x), + .vpos(pix_y) + ); + +endmodule diff --git a/src/examples/index.ts b/src/examples/index.ts index a4e6581..44add7e 100644 --- a/src/examples/index.ts +++ b/src/examples/index.ts @@ -3,5 +3,6 @@ import { balls } from './balls'; import { stripes } from './stripes'; import { logo } from './logo'; import { conway } from './conway'; +import { checkers } from './checkers'; -export const examples: Project[] = [stripes, balls, logo, conway]; +export const examples: Project[] = [stripes, balls, logo, conway, checkers];