Beranda>Terkait pemrograman>kode sumber C#
Unduh
cglm

? OpenGL Mathematics (glm) untuk C





Pustaka matematika 2D|3D yang sangat optimal, juga dikenal sebagai OpenGL Mathematics (glm) untuk `C` . CGLM menyediakan banyak kegunaan untuk membantu operasi matematika menjadi cepat dan cepat untuk ditulis. Ini ramah komunitas, jangan ragu untuk membawa masalah apa pun, bug yang Anda hadapi.

Dokumentasi

Hampir semua fungsi (versi sebaris) dan parameter didokumentasikan di dalam header terkait.
Dokumentasi lengkap: http://cglm.readthedocs.io

? Catatan untuk versi sebelumnya:

  • _dup (duplikat) diubah menjadi _copy. Misalnya glm_vec_dup -> glm_vec3_copy
  • Fungsi terkait OpenGL dihilangkan untuk menjadikan platform lib/pihak ketiga ini independen
  • pastikan Anda memiliki versi terbaru dan jangan ragu untuk melaporkan bug, masalah
  • [perbaikan bug] sudut euler diimplementasikan dalam urutan terbalik (ekstrinsik) telah diperbaiki, sekarang menjadi intrinsik. Pastikan Anda memiliki versi terbaru
  • [perubahan besar] dengan memulai v0.4.0, angka empat disimpan sebagai [x, y, z, w], sebelumnya [w, x, y, z] di v0.3.5 dan versi sebelumnya
  • [ganti nama api] dengan memulai v0.4.5, fungsi glm_simd diubah namanya menjadi glmm_
  • [opsi baru] dengan memulai v0.4.5, Anda dapat menonaktifkan persyaratan penyelarasan, periksa opsi di dokumen.
  • [perubahan besar] dengan memulai v0.5.0, fungsi vec3 menggunakan namespace glm_vec3_ , sebelumnya glm_vec_ hingga v0.5.0
  • [perubahan besar] dengan memulai v0.5.1, perataan bawaan dihapus dari tipe vec3 dan mat3
  • [perubahan besar] dengan memulai v0.7.3, fungsi pencetakan sebaris dinonaktifkan dalam mode rilis/produksi untuk menghilangkan biaya pencetakan (lihat opsi dalam dokumentasi). Hasil cetak juga meningkat. Anda dapat menonaktifkan warna jika perlu (lihat dokumentasi)
  • [perubahan besar] dengan memulai v0.8.3, cglm mendukung konfigurasi clipspace alternatif misalnya Tangan Kiri, Zero-to-One (_zo)... CGLM_FORCE_DEPTH_ZERO_TO_ONE dan CGLM_FORCE_LEFT_HANDED disediakan untuk mengontrol clipspace. Anda seharusnya dapat menggunakan cglm dengan Vulkan, DirectX, dan Metal sekarang... lihat https://cglm.readthedocs.io/en/latest/opt.html#clipspace-option-s

? Catatan untuk pengembang C++:

Jika Anda belum mengetahui perpustakaan GLM asli, Anda mungkin juga ingin melihat: https://github.com/g-truc/glm

? Catatan untuk pendatang baru (Penting):

  • Variabel vec4 dan mat4 harus selaras. (Akan ada versi yang tidak selaras nanti)
  • parameter masuk dan [masuk, keluar] harus diinisialisasi (tolong). Tapi parameter [keluar] tidak, inisialisasi parameter keluar juga mubazir
  • Semua fungsi sebaris jika Anda tidak ingin menggunakan versi yang telah dikompilasi sebelumnya dengan awalan glmc_, Anda dapat mengabaikan proses pembuatan. Cukup sertakan header.
  • jika debugger Anda membawa Anda ke header cglm maka pastikan Anda tidak mencoba menyalin vec4 ke vec3 atau menyelaraskan masalah...
  • Selamat datang!

? Catatan untuk pengembang berpengalaman:

  • Karena saya sedang menguji perpustakaan ini di proyek saya, terkadang terjadi bug; menemukan bug tersebut dan melakukan perbaikan akan lebih mudah dengan banyak pengembang/kontributor dan proyek atau pengetahuan mereka. Pertimbangkan untuk melakukan beberapa tes jika Anda mencurigai ada sesuatu yang salah dan masukan, kontribusi, dan laporan bug apa pun selalu diterima.

? Alokasi?

cglm tidak mengalokasikan memori apa pun di heap. Jadi itu tidak menyediakan pengalokasi apa pun. Anda juga harus mengalokasikan memori untuk parameter keluar jika Anda memberikan penunjuk lokasi memori. Jangan lupa bahwa vec4 (juga quat/ versor ) dan mat4 harus disejajarkan (16-byte), karena cglm menggunakan instruksi SIMD untuk mengoptimalkan sebagian besar operasi jika tersedia.

? Mengembalikan vektor atau matriks...?

cglm mendukung ARRAY API dan STRUCT API , sehingga Anda dapat mengembalikan struct jika Anda menggunakan struct api ( glms_ ).

Seperti beberapa perpustakaan grafis lainnya (terutama OpenGL), perpustakaan ini menggunakan tata letak Kolom-Mayor untuk menyimpan matriks di memori.
Di masa mendatang, perpustakaan mungkin mendukung opsi untuk menggunakan tata letak baris-utama, SAAT INI jika Anda memerlukan tata letak baris-utama, Anda perlu mengubah urutannya.

Fitur

  • optimasi skalar dan simd (sse, avx, neon...).
  • pilihan untuk menggunakan clipspace yang berbeda misalnya Tangan Kiri, Nol-ke-Satu... (saat ini tangan negatif-satu adalah default)
  • array api dan struct api, Anda dapat menggunakan array atau struct.
  • operasi matriks tujuan umum (mat4, mat3)
  • perkalian matriks rantai (hanya persegi)
  • operasi vektor tujuan umum (silang, titik, putar, proj, sudut...)
  • transformasi affine
  • dekomposisi matriks (rotasi ekstrak, faktor penskalaan)
  • matriks transformasi affine yang dioptimalkan (mul, invers benda tegar)
  • kamera (lihat)
  • proyeksi (orto, perspektif)
  • angka empat
  • sudut euler / yaw-pitch-roll ke matriks
  • ekstrak sudut euler
  • panggilan fungsi sebaris atau yang telah dikompilasi sebelumnya
  • frustum (ekstrak tampilan bidang frustum, sudut...)
  • kotak pembatas (AABB di Frustum (pemusnahan), potong, gabung...)
  • bola pembatas
  • proyek, batalkan proyek
  • fungsi pelonggaran
  • kurva
  • pembantu interpolasi kurva (S M C, deCasteljau...)
  • pembantu untuk mengonversi tipe cglm ke perpustakaan simd Apple untuk meneruskan tipe cglm ke Metal GL tanpa mengemasnya di kedua sisi
  • pembantu persimpangan sinar
  • dan lainnya...

Anda memiliki dua opsi untuk memanggil suatu fungsi/operasi: panggilan inline atau perpustakaan (tautan) Hampir semua fungsi ditandai inline (always_inline) sehingga kompiler mungkin akan inline. Untuk memanggil versi yang telah dikompilasi sebelumnya, cukup gunakan glmc_ (c singkatan dari 'call') alih-alih glm_ . 

  #include    /* for inline */
  #include    /* for library call (this also includes cglm.h) */

  mat4 rot , trans , rt ;
  /* ... */
  glm_mul ( trans , rot , rt );  /* inline */
  glmc_mul ( trans , rot , rt ); /* call from library */

Sebagian besar fungsi matematika dioptimalkan secara manual dengan SSE2 jika tersedia, jika tidak? Jangan khawatir, ada versi non-sse dari semua operasi

Anda dapat meneruskan matriks dan vektor sebagai array ke fungsi daripada mendapatkan alamat. 

  mat4 m = {
    1 , 0 , 0 , 0 ,
    0 , 1 , 0 , 0 ,
    0 , 0 , 1 , 0 ,
    0 , 0 , 0 , 1
  };

  glm_translate ( m , ( vec3 ){ 1.0f , 0.0f , 0.0f });

Perpustakaan berisi fungsi mat4 mul dan invers tujuan umum, dan juga berisi beberapa bentuk khusus (dioptimalkan) dari fungsi ini untuk matriks transformasi affine. Jika Anda ingin mengalikan dua matriks transformasi affine, Anda dapat menggunakan glm_mul sebagai ganti glm_mat4_mul dan glm_inv_tr (ROT + TR) sebagai ganti glm_mat4_inv 

 /* multiplication */
mat4 modelMat ;
glm_mul ( T , R , modelMat );

/* othonormal rot + tr matrix inverse (rigid-body) */
glm_inv_tr ( modelMat );

Struktur API

Struktur API berfungsi sebagai berikut, perhatikan akhiran s pada tipe, awalan glms_ pada fungsi, dan awalan GLMS_ pada konstanta: 

 #include 

mat4s mat = GLMS_MAT4_IDENTITY_INIT ;
mat4s inv = glms_mat4_inv ( mat );

Fungsi struktur umumnya mengambil parameternya sebagai nilai dan mengembalikan hasilnya, daripada menggunakan pointer dan menuliskan parameternya. Itu berarti parameter Anda biasanya const , jika Anda menyukainya.

Tipe yang digunakan sebenarnya adalah gabungan yang memungkinkan akses ke data yang sama dengan berbagai cara. Salah satu caranya melibatkan struktur anonim, tersedia sejak C11. MSVC juga mendukungnya untuk versi C sebelumnya dan GCC/Clang mendukungnya jika Anda mengaktifkan -fms-extensions . Untuk mengaktifkan struktur anonim ini secara eksplisit, #define CGLM_USE_ANONYMOUS_STRUCT menjadi 1 , untuk menonaktifkannya, menjadi 0 . Untuk kompatibilitas mundur, Anda juga dapat #define CGLM_NO_ANONYMOUS_STRUCT (nilai tidak relevan) untuk menonaktifkannya. Jika Anda tidak menentukan secara eksplisit, cglm akan melakukan tebakan terbaik berdasarkan kompiler Anda dan versi C yang Anda gunakan.

? Membangun

CMake (Semua platform) 

$ mkdir build
$ cd build
$ cmake .. # [Optional] -DCGLM_SHARED=ON
$ make
$ sudo make install # [Optional]
Opsi pembuatan dengan Default: 
 option (CGLM_SHARED "Shared build" ON )
option (CGLM_STATIC "Static build" OFF )
option (CGLM_USE_C99 "" OFF ) # C11 
option (CGLM_USE_TEST "Enable Tests" OFF ) # for make check - make test

Gunakan sebagai pustaka khusus header dengan proyek CMake Anda

Ini tidak memerlukan bangunan atau instalasi cglm.

  • Contoh: 
 cmake_minimum_required ( VERSION 3.8.2)

project (Name >)

add_executable ( ${PROJECT_NAME} src/main.c)
target_link_libraries ( ${LIBRARY_NAME} PRIVATE
  cglm_headers)

add_subdirectory (external/cglm/ EXCLUDE_FROM_ALL )

Gunakan dengan proyek CMake Anda

  • Contoh: 
 cmake_minimum_required ( VERSION 3.8.2)

project (Name >)

add_executable ( ${PROJECT_NAME} src/main.c)
target_link_libraries ( ${LIBRARY_NAME} PRIVATE
  cglm)

add_subdirectory (external/cglm/)

# or you can use find_package to configure cglm

Gunakan CMake untuk membuat WebAssembly

Karena fungsi matematika seperti sinf digunakan, ini tidak dapat ditargetkan pada wasm32-unknown-unknown , salah satu wasi-sdk atau emscripten harus digunakan.

Perlu diperhatikan bahwa build bersama belum didukung untuk WebAssembly.

Untuk dukungan simd128, tambahkan -msimd128 ke CMAKE_C_FLAGS , di baris perintah -DCMAKE_C_FLAGS="-msimd128" .

Untuk pengujian, opsi cmake CGLM_USE_TEST akan tetap berfungsi, Anda memerlukan waktu proses wasi untuk menjalankan pengujian, lihat file konfigurasi ci kami untuk contoh detailnya.

Gunakan CMake dan WASI SDK untuk membangun WebAssembly 
$ cmake .. 
  -DCMAKE_TOOLCHAIN_FILE=/path/to/wasi-sdk-19.0/share/cmake/wasi-sdk.cmake 
  -DWASI_SDK_PREFIX=/path/to/wasi-sdk-19.0

Dimana /path/to/wasi-sdk-19.0/ adalah jalur untuk mengekstraksi wasi SDK.

Dalam hal ini secara default akan membuat build statis.

Gunakan CMake dan Emscripten SDK untuk membangun WebAssembly 
$ emcmake cmake .. 
  -DCMAKE_EXE_LINKER_FLAGS= " -s STANDALONE_WASM " 
  -DCGLM_STATIC=ON

emcmake di sini adalah pembungkus cmake untuk Emscripten dari emsdk yang diinstal.

Meson (Semua platform) 

$ meson build # [Optional] --default-library=static
$ cd build
$ ninja
$ sudo ninja install # [Optional]
Opsi Meson dengan Default: 
c_std = c11
buildtype = release
default_library = shared
build_tests = true # to run tests: ninja test

Gunakan dengan proyek Meson Anda

  • Contoh: 
 # Clone cglm or create a cglm.wrap under /subprojects
project ( ' name ' , ' c ' )

cglm_dep = dependency ( ' cglm ' , fallback : ' cglm ' , ' cglm_dep ' )

executable ( ' exe ' , ' src/main.c ' , dependencies : cglm_dep)

Swift (Manajer Paket Swift)

Saat ini hanya opsi build default yang didukung. Tambahkan ketergantungan cglm ke proyek Anda: 

 ...
Package ( 
  ...
  dependencies : [
    ...
    . package ( url : " https://github.com/recp/cglm " , . branch ( " master " ) ) ,
  ]
  ...
)

Sekarang tambahkan cgml sebagai ketergantungan pada target Anda. Pilihan produknya adalah:

  • cglm untuk versi perpustakaan sebaris yang hanya dapat ditautkan secara statis
  • cglmc untuk versi perpustakaan yang dikompilasi tanpa batasan tautan 
 ...
. target (
  ...
  dependencies : [
    ...
    . product ( name : " cglm " , package : " cglm " ) ,
  ]
  ...
)
...

Unix (Alat Otomatis) 

$ sh autogen.sh
$ ./configure
$ make
$ make check # [Optional]
$ [sudo] make install # [Optional]

Ini juga akan menginstal file pkg-config sehingga Anda dapat menggunakan pkg-config --cflags cglm dan pkg-config --libs cglm untuk mengambil flag compiler dan linker.

File-file tersebut akan diinstal ke awalan yang diberikan (biasanya /usr/local secara default di Linux), tetapi pkg-config Anda mungkin tidak dikonfigurasi untuk benar-benar memeriksa di sana. Anda dapat mengetahui di mana mencarinya dengan menjalankan pkg-config --variable pc_path pkg-config dan mengubah jalur tempat file diinstal melalui ./configure --with-pkgconfigdir=/your/path . Alternatifnya, Anda dapat menambahkan jalur awalan ke variabel lingkungan PKG_CONFIG_PATH Anda.

Windows (MSBuild)

File build dan file proyek terkait Windows terletak di folder win , pastikan Anda berada di dalam folder cglm/win . Analisis Kode diaktifkan, jadi mungkin perlu beberapa saat untuk membuatnya. 

$ cd win
$ . build.bat

jika msbuild tidak berfungsi (karena multi versi VS) maka cobalah membangun dengan devenv : 

$ devenv cglm.sln / Build Release

Menjalankan Tes di Windows

Anda dapat melihat proyek uji dalam file solusi visual studio yang sama. Cukup menjalankan proyek itu untuk menjalankan pengujian.

Membangun Dokumen

Pertama, Anda perlu menginstal Sphinx: http://www.sphinx-doc.org/en/master/usage/installation.html lalu: 

$ cd docs
$ sphinx-build source build

itu akan mengkompilasi dokumen ke dalam folder build, Anda dapat menjalankan index.html di dalam fungsi itu.

Cara menggunakan

Jika Anda ingin menggunakan fungsi versi sebaris, sertakan header utama 

 #include

header akan mencakup semua header. Kemudian panggil fungsi yang Anda inginkan misalnya memutar vektor berdasarkan sumbu: 

 glm_vec3_rotate ( v1 , glm_rad ( 45 ), ( vec3 ){ 1.0f , 0.0f , 0.0f });

beberapa fungsi kelebihan beban :) misalnya Anda dapat menormalkan vektor: 

 glm_vec3_normalize ( vec );

ini akan menormalkan vec dan menyimpan vektor yang dinormalisasi ke dalam vec tetapi jika Anda akan menyimpan vektor yang dinormalisasi ke vektor lain, lakukan ini: 

 glm_vec3_normalize_to ( vec , result );

seperti fungsi ini Anda mungkin melihat _to postfix, fungsi ini menyimpan hasil ke variabel lain dan menyimpan memori sementara

untuk memanggil versi yang telah dikompilasi termasuk header dengan c postfix, c berarti panggilan. Versi yang telah dikompilasi sebelumnya hanyalah pembungkus. 

 #include

header ini akan menyertakan semua header dengan postfix c. Anda perlu memanggil fungsi dengan c posfix: 

 glmc_vec3_normalize ( vec );

Penggunaan fungsi dan parameter didokumentasikan di dalam header terkait. Anda mungkin melihat parameter yang sama diteruskan dua kali dalam beberapa contoh seperti ini: 

 glm_mat4_mul ( m1 , m2 , m1 );

/* or */
glm_mat4_mul ( m1 , m1 , m1 );

dua parameter pertama adalah parameter [masuk] dan yang terakhir adalah parameter [keluar] . Setelah mengalikan m1 dan m2 , hasilnya disimpan dalam m1 . Inilah sebabnya kami mengirim m1 dua kali. Anda dapat menyimpan hasilnya dalam matriks yang berbeda, ini hanyalah sebuah contoh.

Contoh: Menghitung matriks MVP

Pilihan 1 

 mat4 proj , view , model , mvp ;

/* init proj, view and model ... */

glm_mat4_mul ( proj , view , viewProj );
glm_mat4_mul ( viewProj , model , mvp );

pilihan 2 

 mat4 proj , view , model , mvp ;

/* init proj, view and model ... */

glm_mat4_mulN (( mat4 * []){ & proj , & view , & model }, 3 , mvp );

Cara mengirim matriks ke OpenGL

mat4 adalah array dari vec4 dan vec4 adalah array dari float. Fungsi glUniformMatrix4fv menerima float* sebagai value (param terakhir), sehingga Anda dapat memasukkan mat4 ke float* atau Anda dapat meneruskan kolom pertama matriks sebagai awal memori matriks:

Opsi 1: Kirim kolom pertama 

 glUniformMatrix4fv ( location , 1 , GL_FALSE , matrix [ 0 ]);

/* array of matrices */
glUniformMatrix4fv ( location , 1 , GL_FALSE , matrix [ 0 ][ 0 ]);

Opsi 2: Melemparkan matriks ke tipe penunjuk (juga berlaku untuk array beberapa dimensi) 

 glUniformMatrix4fv ( location , 1 , GL_FALSE , ( float * ) matrix );

Anda dapat meneruskan matriks dengan cara yang sama ke API lain misalnya Vulkan, DX...

Catatan

  • Pustaka ini belum mendukung tipe ganda...
  • Jika header tidak berfungsi dengan baik dengan kompiler Anda, IDE silakan buka masalah, karena saya menggunakan GCC dan dentang untuk mengujinya mungkin terkadang MSVC

YANG HARUS DILAKUKAN:

  • Tes unit (Sedang Berlangsung)
  • Tes unit untuk membandingkan cglm dengan hasil glm
  • Tambahkan info versi
  • Operasi yang tidak selaras (misalnya glm_umat4_mul )
  • Dokumentasi tambahan
  • Lengkungan Neon LENGAN

Kontributor

Proyek ini ada berkat semua orang yang berkontribusi. [Menyumbang].

Pendukung

Terima kasih kepada semua pendukung kami! [Menjadi pendukung]

Sponsor

Dukung proyek ini dengan menjadi sponsor. Logo Anda akan muncul di sini dengan tautan ke situs web Anda. [Menjadi sponsor]

Lisensi

MIT. periksa file LISENSI

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua