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

Adding nested tab for cpp for Beyond SplashKit in usage examples & updating draw bitmap named usage example #339

Open
wants to merge 6 commits into
base: beyond-splashkit
Choose a base branch
from

Conversation

rmachu
Copy link

@rmachu rmachu commented Dec 10, 2024

Description

This is a PR for an additional nested tab in the C++ section of usage examples for Beyond SplashKit. I have also updated the CONTRIBUTING file to include guides for file naming with Beyond SK files. The normal SK file will have -sk.cpp and Beyond SK files have -beyond.cpp.

I have also added the without SplashKit version into the Draw Bitmap usage example using the nested tab. This uses the same code as in the Draw Bitmap section of Beyond SplashKit, with just minor changes to match the existing output in the usage example. Also added free all bitmap to the SK code to align with the beyond SK code.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Documentation (update or new)

How Has This Been Tested?

Tested by adding dummy files with -sk.cpp and -beyond.cpp to a few usage examples and running npm run build and preview on Chrome, Firefox and Safari to ensure the code is presented properly.

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Firefox
  • npm run build
  • npm run preview

Checklist

If involving code

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Folders and Files Added/Modified

  • Added:
    • draw_bitmap_named-1-simple-beyond.cpp
  • Modified:
    • CONTRIBUTING.mdx
    • usage-example-page-generation.cjs
    • draw_bitmap_named-1-simple-sk.cpp

@omckeon
Copy link

omckeon commented Dec 20, 2024

Great work @rmachu. Would you be able to update the draw_bitmap_named usage example to include the new beyond splashkit code? (To provide a working example to test)

You can look at the Draw Bitmap and Eyedropper sections of the guide that Simon wrote (and I updated some formatting) to help with this.

Above each correlating part, it would be good to have a comment with the corresponding SplashKit function name or code line. :)

@omckeon omckeon self-assigned this Jan 10, 2025
@rmachu rmachu changed the title Adding nested tab for cpp for Beyond SplashKit in usage examples Adding nested tab for cpp for Beyond SplashKit in usage examples & updating draw bitmap named usage example Jan 11, 2025
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.

2 participants