VulkanTutorial

Tutorial Vulkan

Repositori ini meng-host isi vulkan-tutorial.com. Situs web itu sendiri didasarkan pada daux.io, yang mendukung penurunan rasa gitub. Situs yang sebenarnya menjalankan Daux.io dengan tema khusus dan beberapa modifikasi (https://github.com/overv/daux.io) dan ini dibangun ke dalam gambar Docker.

Gunakan masalah dan tarik permintaan untuk memberikan umpan balik yang terkait dengan situs web. Jika Anda memiliki masalah dengan kode Anda, maka gunakan bagian komentar di bab terkait untuk mengajukan pertanyaan. Harap berikan sistem operasi Anda, kartu grafis, versi driver, kode sumber, perilaku yang diharapkan dan perilaku aktual.

E-book

Panduan ini sekarang tersedia dalam format e-book juga:

• Epub (Inggris, Prancis)
• PDF (Bahasa Inggris, Prancis)

E-book dapat dibangun dari konten yang ada dengan menjalankan:

 python3 build_ebook.py

Skrip ini tergantung pada utilitas berikut yang tersedia di jalur:

• inkscape : Konversi SVG ke PNG (diuji dengan versi 1.0.2)
• pandoc : Membangun PDF dan Epub dari Kode Markdown (diuji dengan versi 2.13)

Anda juga perlu menginstal distribusi lateks untuk pembuatan PDF.

Mengubah kode lintas bab

Kadang -kadang perlu untuk mengubah kode yang digunakan kembali di banyak bab, misalnya fungsi seperti createBuffer . Jika Anda melakukan perubahan seperti itu, maka Anda harus memperbarui file kode menggunakan langkah -langkah berikut:

• Perbarui bab apa pun yang merujuk kode yang dimodifikasi.
• Buat salinan file pertama yang menggunakannya dan ubah kode di sana, misalnya base_code_fixed.cpp .
• Buat tambalan menggunakan diff -Naur base_code.cpp base_code_fixed.cpp > patch.txt .
• Terapkan tambalan ke file kode yang ditentukan dan semua file dalam bab -bab selanjutnya menggunakan skrip incremental_patch.sh . Jalankan seperti ini: ./incremental_patch.sh base_code.cpp patch.txt .
• Bersihkan file base_code_fixed.cpp dan patch.txt .
• Melakukan.

Memberikan tutorial

Untuk membuat tutorial (yaitu mengonversi markdown ke HTML), Anda memiliki dua opsi:

1. Sajikan file yang diberikan dengan cepat menggunakan server web yang telah diinstal PHP
2. Hasilkan file HTML statis yang dapat Anda lihat secara lokal atau taruh di server

Untuk salah satu dari opsi ini, Anda membutuhkan PHP dan Daux yang ditambal.

Php

1. Pastikan PHP diinstal (Daux ditulis dalam PHP)
   1. Ekstensi php_mbstring dan php_openssl perlu diaktifkan
   2. Pengaturan phar.readonly perlu diatur ke Off (untuk dapat membangun kembali Daux)
2. Pastikan komposer diinstal, manajer ketergantungan PHP yang digunakan Daux

Klon, tambalan, dan membangun kembali Daux

1. Klon Daux
   • git clone https://github.com/dauxio/daux.io.git
2. Buat cabang baru di revisi yang lebih tua bahwa tambalan Vulkantutorial menentang:
   • git checkout d45ccff -b vtpatch
   • Membuat cabang baru tidak sepenuhnya diperlukan, karena Anda dapat mengatur ulang master , tetapi ini membuat master tetap utuh.
3. Salin melalui file daux.patch ke direktori Daux.io, pastikan ujung garis adalah gaya UNIX (jika Anda menggunakan Windows), dan terapkan tambalan. Itu harus berlaku dengan bersih.
   • git am daux.patch
4. Jalankan komposer di direktori daux.io sehingga mengunduh dependensi kebutuhan daux untuk dibangun
   • composer install
5. Membangun kembali Daux
   • php bin/compile (ini bisa memakan waktu cukup lama)
   • daux.phar yang baru dibuat sekarang akan berada di direktori dasar Anda

Menggunakan Daux untuk menyajikan file yang diberikan dengan cepat

Setelah Anda menyelesaikan di atas, ikuti instruksi di situs Daux untuk cara menjalankan Daux menggunakan server web.

Sebagai opsi sederhana mengingat Anda telah menginstal PHP, Anda juga dapat menggunakan server web pengembangan php yang dibangun jika Anda hanya perlu melihat hal -hal seperti seperti apa:

1. Di Direktori daux.io , Edit global.json sehingga opsi docs_directory Poin di Direktori Vulkantutorial Anda
   • "docs_directory": "../VulkanTutorial",
2. Di direktori daux.io , jalankan
   • php -S localhost:8080 index.php
3. Ketik localhost:8080 di bar URL browser web Anda dan tekan enter. Anda sekarang harus melihat halaman depan Vulkantutorial.

Menggunakan Daux untuk secara statis menghasilkan file HTML

Sebelum kita menghasilkan file statis, kita perlu mengubah Daux dan pengaturan tutorial untuk mencegahnya mencoba memuat beberapa sumber daya luar (yang akan menghentikan browser Anda saat mencoba memuat halaman statis yang sebaliknya)

1. Di Direktori VulkanTutorial , edit config.json dan hapus baris google_analytics sehingga Daux tidak mencoba memuatnya.
2. Di direktori daux.io , edit themes/daux/config.json dan hapus garis font sehingga Daux tidak mencoba memuat font eksternal.
3. Bangun kembali Daux menurut instruksi sebelumnya sehingga mengambil perubahan tema.

Kami sedang mengerjakan perbaikan sehingga di masa depan langkah -langkah di atas tidak akan diperlukan.

Sekarang dengan yang dilakukan di atas, kami dapat menghasilkan file statis. Asuming direktori Daux.io dan Vulkantutorial berada di sebelah satu sama lain, masuk ke direktori daux.io dan jalankan perintah yang mirip dengan: php generate -s ../VulkanTutorial -d ../VulkanTutorial/out .

-s mengatakan di mana menemukan dokumentasi, sementara -d mengatakan di mana harus meletakkan file yang dihasilkan.

Catatan: Jika Anda ingin menghasilkan dokumen lagi, hapus direktori out terlebih dahulu atau Daux akan membuat direktori out dalam direktori out yang ada.

Lisensi

Isi repositori ini dilisensikan sebagai CC BY-SA 4.0, kecuali dinyatakan sebaliknya. Dengan berkontribusi pada repositori ini, Anda setuju untuk melisensikan kontribusi Anda kepada publik di bawah lisensi yang sama.

Daftar kode dalam direktori code dilisensikan sebagai CC0 1.0 Universal. Dengan berkontribusi pada direktori itu, Anda setuju untuk melisensikan kontribusi Anda kepada publik di bawah lisensi seperti domain publik yang sama.