[RFC] citro3d documentation

.github/workflows/doxygen.yaml

@@ -0,0 +1,37 @@
+name: Deploy site
+
+on:
+  push:
+    branches: [ c3d-docs ]
+
+jobs:
+  doc-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+
+      - name: Set up Doxygen
+        run: sudo apt install doxygen
+
+      - name: Display Doxygen version
+        run: echo "Doxygen version $(doxygen -v)"
+
+      - name: Generate libctru tags
+        run: |
+            git clone --branch=master --single-branch --depth 1 https://github.com/devkitPro/libctru
+            cd libctru/libctru
+            doxygen
+
+      - name: Build documentation
+        run: CTRU_DOCPATH="https://libctru.devkitpro.org/" doxygen
+
+      - name: Deploy 🚀
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/html # The folder the action should deploy.
+          CLEAN: true # Automatically remove deleted files from the deploy branch

.gitignore

@@ -1,15 +1,18 @@
 .*/
+!.github/
 *~
 *.3dsx
 *.elf
 *.exe
 *.smdh
 *.tar.bz2
+*.tag
 Thumbs.db
 build/
 deps/
 release/
 debug/
 lib/
 bin/
-doc/
+docs/
+libctru/

Changelog.md

@@ -0,0 +1,64 @@
+# Changelog
+
+## Version 1.7.0
+
+- Implement VRAM bank awareness for rendertarget allocations
+- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
+
+## Version 1.6.2
+
+- Added C3D_RenderTargetDetachOutput (called automatically on render target destroy)
+
+## Version 1.6.1
+
+- Pause the VBlank counters while the application is suspended
+- Use gfxScreenSwapBuffers; implement left->right eye duplication with it
+- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
+
+## Version 1.6.0
+
+- Simplified internal render queue framebuffer transfer system
+- Removed long-since obsolete flush functions
+- Further improvements to overall system stability and other minor adjustments have been made to enhance the user experience.
+
+## Version 1.5.0
+
+- Removed deprecated functionality (C3D_RenderTargetSetClear, C3D_SafeDisplayTransfer, C3D_SafeTextureCopy, C3D_SafeMemoryFill, TexEnv_Init, C3D_TexEnvOp).
+- Added experimental gas support.
+- Added logic to make sure that the framebuffer is flushed/reinitialized before changing program.
+
+## Version 1.4.0
+
+- Added an interface for loading .t3x files generated by tex3ds
+- TexEnv code was revamped and cleaner as to provide better error checking through stronger typing
+        - C3D_TexEnvOp separated into C3D_TexEnvOpRgb and C3D_TexEnvOpAlpha
+- C3D_SafeXyz functions have been deprecated and replaced by C3D_SyncXyz functions
+- Miscellaneous bugfixes and optimizations
+
+## Version 1.3.1
+
+- Removed deprecated C3D_RenderBuffer functionality
+- Recompiled with libctru 1.4.0
+
+## Version 1.3.0
+
+Major changes:
+
+- Overhauled texture API
+- Frame rate control & monitoring
+- CPU/GPU time profiling
+- Support for framebuffers (lightweight renderbuffers) - old renderbuffers are now deprecated
+- Rendertarget system now uses libctru GX queue
+- Corrected LUT code
+- Debug build for use with GDB
+- New GPU features:
+        - Mipmaps
+        - Cubemaps
+        - Shadow textures
+        - Procedural textures
+        - Fog
+- Miscellaneous bugfixes and optimizations
+
+## Version 0-1.2.0
+
+No changelog avaliable