aboutsummaryrefslogtreecommitdiff
path: root/vendor
diff options
context:
space:
mode:
authorJeroen van Rijn <Kelimion@users.noreply.github.com>2025-10-10 17:51:28 +0200
committerJeroen van Rijn <Kelimion@users.noreply.github.com>2025-10-10 17:51:28 +0200
commit998fbdc5c028f57619e58bda69819d131692b800 (patch)
treec6e6d8d9d77a4afbd6e98191ac80847c6c21873e /vendor
parent7e7b6ac0de9f34dd8efd08a9c6f303bcd25ed1cc (diff)
Doc lines for vendor:*
Diffstat (limited to 'vendor')
-rw-r--r--vendor/ENet/enet.odin1
-rw-r--r--vendor/OpenEXRCore/exr_base.odin1
-rw-r--r--vendor/OpenGL/helpers.odin1
-rw-r--r--vendor/cgltf/cgltf.odin2
-rw-r--r--vendor/commonmark/cmark.odin6
-rw-r--r--vendor/commonmark/doc.odin83
-rw-r--r--vendor/directx/d3d11/d3d11.odin1
-rw-r--r--vendor/directx/d3d12/d3d12.odin1
-rw-r--r--vendor/directx/d3d_compiler/d3d_compiler.odin1
-rw-r--r--vendor/directx/dxc/dxcapi.odin1
-rw-r--r--vendor/directx/dxgi/dxgi.odin1
-rw-r--r--vendor/egl/egl.odin1
-rw-r--r--vendor/fontstash/fontstash.odin1
-rw-r--r--vendor/ggpo/ggpo.odin2
-rw-r--r--vendor/glfw/types.odin1
-rw-r--r--vendor/kb_text_shape/kb_text_shape_procs.odin1
-rw-r--r--vendor/libc/stdlib.odin1
-rw-r--r--vendor/lua/5.1/lua.odin1
-rw-r--r--vendor/lua/5.2/lua.odin1
-rw-r--r--vendor/lua/5.3/lua.odin1
-rw-r--r--vendor/lua/5.4/lua.odin1
-rw-r--r--vendor/microui/microui.odin3
-rw-r--r--vendor/miniaudio/doc.odin9
-rw-r--r--vendor/nanovg/gl/gl.odin1
-rw-r--r--vendor/nanovg/nanovg.odin1
-rw-r--r--vendor/portmidi/doc.odin1
-rw-r--r--vendor/raylib/raylib.odin2
-rw-r--r--vendor/sdl2/image/sdl_image.odin1
-rw-r--r--vendor/sdl2/mixer/sdl_mixer.odin1
-rw-r--r--vendor/sdl2/net/sdl_net.odin1
-rw-r--r--vendor/sdl2/sdl2.odin1
-rw-r--r--vendor/sdl2/ttf/sdl_ttf.odin1
-rw-r--r--vendor/sdl3/image/sdl_image.odin1
-rw-r--r--vendor/sdl3/sdl3_main.odin1
-rw-r--r--vendor/sdl3/ttf/sdl3_ttf.odin1
-rw-r--r--vendor/stb/easy_font/stb_easy_font.odin40
-rw-r--r--vendor/stb/image/stb_image.odin1
-rw-r--r--vendor/stb/rect_pack/stb_rect_pack.odin1
-rw-r--r--vendor/stb/truetype/stb_truetype.odin1
-rw-r--r--vendor/stb/vorbis/stb_vorbis.odin1
-rw-r--r--vendor/vulkan/_gen/create_vulkan_odin_wrapper.py24
-rw-r--r--vendor/vulkan/core.odin4
-rw-r--r--vendor/vulkan/enums.odin3
-rw-r--r--vendor/vulkan/procedures.odin3
-rw-r--r--vendor/vulkan/structs.odin3
-rw-r--r--vendor/wgpu/glfwglue/doc.odin2
-rw-r--r--vendor/wgpu/sdl2glue/doc.odin2
-rw-r--r--vendor/wgpu/sdl3glue/doc.odin2
-rw-r--r--vendor/windows/GameInput/doc.odin6
-rw-r--r--vendor/windows/XAudio2/doc.odin6
-rw-r--r--vendor/x11/xlib/xlib.odin1
-rw-r--r--vendor/zlib/zlib.odin1
52 files changed, 128 insertions, 108 deletions
diff --git a/vendor/ENet/enet.odin b/vendor/ENet/enet.odin
index b4ef3fe70..235cc5684 100644
--- a/vendor/ENet/enet.odin
+++ b/vendor/ENet/enet.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ ENet ; https://github.com/lsalzman/enet ]].
package ENet
when ODIN_OS == .Windows {
diff --git a/vendor/OpenEXRCore/exr_base.odin b/vendor/OpenEXRCore/exr_base.odin
index cf059ffcf..4dffe86e3 100644
--- a/vendor/OpenEXRCore/exr_base.odin
+++ b/vendor/OpenEXRCore/exr_base.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ OpenEXRCore ; https://github.com/AcademySoftwareFoundation/openexr/tree/main/src/lib/OpenEXRCore ]].
package vendor_openexr
OPENEXRCORE_SHARED :: #config(OPENEXRCORE_SHARED, false)
diff --git a/vendor/OpenGL/helpers.odin b/vendor/OpenGL/helpers.odin
index 0bd8e451b..84e3eae81 100644
--- a/vendor/OpenGL/helpers.odin
+++ b/vendor/OpenGL/helpers.odin
@@ -1,3 +1,4 @@
+// OpenGL function pointer loader implemented in Odin. Supports the `core` profile up to version 4.6.
package vendor_gl
// Helper for loading shaders into a program
diff --git a/vendor/cgltf/cgltf.odin b/vendor/cgltf/cgltf.odin
index 9d2a975f3..aeceb14c5 100644
--- a/vendor/cgltf/cgltf.odin
+++ b/vendor/cgltf/cgltf.odin
@@ -1,4 +1,4 @@
-// Bindings for [[ cgtlf ; https://github.com/jkuhlmann/cgltf ]].
+// Bindings for [[ Cgtlf ; https://github.com/jkuhlmann/cgltf ]].
package cgltf
@(private)
diff --git a/vendor/commonmark/cmark.odin b/vendor/commonmark/cmark.odin
index e63db9b15..fd1be45fd 100644
--- a/vendor/commonmark/cmark.odin
+++ b/vendor/commonmark/cmark.odin
@@ -1,9 +1,3 @@
-/*
- Bindings for [[CMark ; https://github.com/commonmark/cmark ]].
-
- Original authors: John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
- See LICENSE for license details.
-*/
package vendor_commonmark
import "core:c"
diff --git a/vendor/commonmark/doc.odin b/vendor/commonmark/doc.odin
index 3b96594d9..648226234 100644
--- a/vendor/commonmark/doc.odin
+++ b/vendor/commonmark/doc.odin
@@ -1,18 +1,13 @@
-#+build ignore
/*
- Bindings for [[CMark; https://github.com/commonmark/cmark]].
+Bindings for [[ CMark; https://github.com/commonmark/cmark ]].
- Original authors: John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
- See LICENSE for license details.
-*/
-package vendor_commonmark
-
-/*
- Parsing - Simple interface:
+Original authors: John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
+See LICENSE for license details.
- ```odin
+Example:
import cm "vendor:commonmark"
+ // Parsing - Simple interface
hellope_world :: proc() {
fmt.printf("CMark version: %v\n", cm.version_string())
@@ -25,13 +20,8 @@ package vendor_commonmark
fmt.println(html)
}
- ```
-
- Parsing - Streaming interface:
-
- ```odin
- import cm "vendor:commonmark"
+ // Parsing - Streaming interface
streaming :: proc() {
using cm
@@ -67,26 +57,23 @@ package vendor_commonmark
fmt.println(html)
}
- ```
+An iterator will walk through a tree of nodes, starting from a root
+node, returning one node at a time, together with information about
+whether the node is being entered or exited.
- An iterator will walk through a tree of nodes, starting from a root
- node, returning one node at a time, together with information about
- whether the node is being entered or exited.
+The iterator will first descend to a child node, if there is one.
+When there is no child, the iterator will go to the next sibling.
+When there is no next sibling, the iterator will return to the parent
+(but with an `Event_Type.Exit`).
- The iterator will first descend to a child node, if there is one.
- When there is no child, the iterator will go to the next sibling.
- When there is no next sibling, the iterator will return to the parent
- (but with an `Event_Type.Exit`).
+The iterator will return `.Done` when it reaches the root node again.
- The iterator will return `.Done` when it reaches the root node again.
+One natural application is an HTML renderer, where an `.Enter` event
+outputs an open tag and an `.Exit` event outputs a close tag.
- One natural application is an HTML renderer, where an `.Enter` event
- outputs an open tag and an `.Exit` event outputs a close tag.
+An iterator might also be used to transform an AST in some systematic
+way, for example, turning all level-3 headings into regular paragraphs.
- An iterator might also be used to transform an AST in some systematic
- way, for example, turning all level-3 headings into regular paragraphs.
-
- ```odin
usage_example(root: ^Node) {
ev_type: Event_Type
iter := iter_new(root)
@@ -98,20 +85,20 @@ package vendor_commonmark
// Do something with `cur` and `ev_type`
}
}
- ```
-
- Iterators will never return `.Exit` events for leaf nodes,
- which are nodes of type:
-
- * HTML_Block
- * Thematic_Break
- * Code_Block
- * Text
- * Soft_Break
- * Line_Break
- * Code
- * HTML_Inline
-
- Nodes must only be modified after an `.Exit` event, or an `.Enter` event for
- leaf nodes.
-*/ \ No newline at end of file
+
+Iterators will never return `.Exit` events for leaf nodes,
+which are nodes of type:
+
+* HTML_Block
+* Thematic_Break
+* Code_Block
+* Text
+* Soft_Break
+* Line_Break
+* Code
+* HTML_Inline
+
+Nodes must only be modified after an `.Exit` event, or an `.Enter` event for
+leaf nodes.
+*/
+package vendor_commonmark \ No newline at end of file
diff --git a/vendor/directx/d3d11/d3d11.odin b/vendor/directx/d3d11/d3d11.odin
index c15f19934..835655bbf 100644
--- a/vendor/directx/d3d11/d3d11.odin
+++ b/vendor/directx/d3d11/d3d11.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Direct3D 11 ; https://learn.microsoft.com/en-us/windows/win32/direct3d11/atoc-dx-graphics-direct3d-11 ]].
package directx_d3d11
foreign import "system:d3d11.lib"
diff --git a/vendor/directx/d3d12/d3d12.odin b/vendor/directx/d3d12/d3d12.odin
index 0d4dbc4e0..75e94c833 100644
--- a/vendor/directx/d3d12/d3d12.odin
+++ b/vendor/directx/d3d12/d3d12.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Direct3D 12 ; https://learn.microsoft.com/en-us/windows/win32/direct3d12/direct3d-12-graphics ]].
package directx_d3d12
foreign import "system:d3d12.lib"
diff --git a/vendor/directx/d3d_compiler/d3d_compiler.odin b/vendor/directx/d3d_compiler/d3d_compiler.odin
index 5a7178aff..6f9f3fe89 100644
--- a/vendor/directx/d3d_compiler/d3d_compiler.odin
+++ b/vendor/directx/d3d_compiler/d3d_compiler.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Direct3D Shader Compiler ; https://learn.microsoft.com/en-us/windows/win32/api/d3dcompiler/ ]].
package directx_d3d_compiler
foreign import d3dcompiler "d3dcompiler_47.lib"
diff --git a/vendor/directx/dxc/dxcapi.odin b/vendor/directx/dxc/dxcapi.odin
index d9f8401db..1d3155feb 100644
--- a/vendor/directx/dxc/dxcapi.odin
+++ b/vendor/directx/dxc/dxcapi.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ DXC ; https://learn.microsoft.com/en-us/windows/win32/api/dxcapi/ ]].
package directx_dxc
when ODIN_OS == .Windows {
diff --git a/vendor/directx/dxgi/dxgi.odin b/vendor/directx/dxgi/dxgi.odin
index 0056b6a66..05b3925ff 100644
--- a/vendor/directx/dxgi/dxgi.odin
+++ b/vendor/directx/dxgi/dxgi.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ DXGI ; https://learn.microsoft.com/en-us/windows/win32/api/dxgi/ ]].
package directx_dxgi
foreign import dxgi {
diff --git a/vendor/egl/egl.odin b/vendor/egl/egl.odin
index 985d58457..fe52a7fce 100644
--- a/vendor/egl/egl.odin
+++ b/vendor/egl/egl.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ EGL ; https://registry.khronos.org/EGL/sdk/docs/man/html/eglIntro.xhtml ]].
#+build linux
package egl
diff --git a/vendor/fontstash/fontstash.odin b/vendor/fontstash/fontstash.odin
index 8563277b1..0ab97e8cb 100644
--- a/vendor/fontstash/fontstash.odin
+++ b/vendor/fontstash/fontstash.odin
@@ -1,3 +1,4 @@
+// An Odin-native source port of [[ Fontstash ; https://github.com/memononen/fontstash ]].
#+vet !using-param
package fontstash
diff --git a/vendor/ggpo/ggpo.odin b/vendor/ggpo/ggpo.odin
index 59321326a..80b6a0d4a 100644
--- a/vendor/ggpo/ggpo.odin
+++ b/vendor/ggpo/ggpo.odin
@@ -1,4 +1,6 @@
/*
+Bindings for [[ GGPO ; https://www.ggpo.net ]] rollback networking.
+
Created in 2009, the GGPO networking SDK pioneered the use of rollback networking in peer-to-peer games.
It's designed specifically to hide network latency in fast paced, twitch style games which require very
precise inputs and frame perfect execution.
diff --git a/vendor/glfw/types.odin b/vendor/glfw/types.odin
index cfe810fe5..a89e0d1ba 100644
--- a/vendor/glfw/types.odin
+++ b/vendor/glfw/types.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ GLFW ; https://www.glfw.org ]]
package glfw
import glfw "bindings"
diff --git a/vendor/kb_text_shape/kb_text_shape_procs.odin b/vendor/kb_text_shape/kb_text_shape_procs.odin
index efcdcc4ed..a033402bc 100644
--- a/vendor/kb_text_shape/kb_text_shape_procs.odin
+++ b/vendor/kb_text_shape/kb_text_shape_procs.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Jimmy Lefevre's Text Shape ; https://github.com/JimmyLefevre/kb ]] Unicode text segmentation and OpenType shaping.
package vendor_kb_text_shape
when ODIN_OS == .Windows {
diff --git a/vendor/libc/stdlib.odin b/vendor/libc/stdlib.odin
index bb9233a28..cffc66ed2 100644
--- a/vendor/libc/stdlib.odin
+++ b/vendor/libc/stdlib.odin
@@ -1,3 +1,4 @@
+// A (very small) subset of a libc implementation over Odin libraries for use with `vendor:*` packages.
package odin_libc
import "base:intrinsics"
diff --git a/vendor/lua/5.1/lua.odin b/vendor/lua/5.1/lua.odin
index 5b7482931..19a2d9085 100644
--- a/vendor/lua/5.1/lua.odin
+++ b/vendor/lua/5.1/lua.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Lua 5.1 ; https://www.lua.org/manual/5.1/ ]].
package lua_5_1
import "base:intrinsics"
diff --git a/vendor/lua/5.2/lua.odin b/vendor/lua/5.2/lua.odin
index bc47479e3..95105703c 100644
--- a/vendor/lua/5.2/lua.odin
+++ b/vendor/lua/5.2/lua.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Lua 5.2 ; https://www.lua.org/manual/5.2/ ]].
package lua_5_2
import "base:intrinsics"
diff --git a/vendor/lua/5.3/lua.odin b/vendor/lua/5.3/lua.odin
index 47215a327..02b1c83ad 100644
--- a/vendor/lua/5.3/lua.odin
+++ b/vendor/lua/5.3/lua.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Lua 5.3 ; https://www.lua.org/manual/5.3/ ]].
package lua_5_3
import "base:intrinsics"
diff --git a/vendor/lua/5.4/lua.odin b/vendor/lua/5.4/lua.odin
index a45de4d49..1bda09542 100644
--- a/vendor/lua/5.4/lua.odin
+++ b/vendor/lua/5.4/lua.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ Lua 5.4 ; https://www.lua.org/manual/5.4/ ]].
package lua_5_4
import "base:intrinsics"
diff --git a/vendor/microui/microui.odin b/vendor/microui/microui.odin
index 08a96acf2..5f5646cc2 100644
--- a/vendor/microui/microui.odin
+++ b/vendor/microui/microui.odin
@@ -1,4 +1,6 @@
/*
+An Odin-native source port of [[ rxi's microui ; https://github.com/rxi/microui ]] immediate mode UI.
+
** Original work: Copyright (c) 2020 rxi
** Modified work: Copyright (c) 2020 oskarnp
** Modified work: Copyright (c) 2021 gingerBill
@@ -21,7 +23,6 @@
** FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
** IN THE SOFTWARE.
*/
-
package microui
import "core:fmt"
diff --git a/vendor/miniaudio/doc.odin b/vendor/miniaudio/doc.odin
index ff7924b89..58b13b845 100644
--- a/vendor/miniaudio/doc.odin
+++ b/vendor/miniaudio/doc.odin
@@ -1,7 +1,7 @@
-package miniaudio
-
/*
-Audio playback and capture library. Choice of public domain or MIT-0. See license statements at the end of this file.
+Bindings for [[ miniaudio ; https://miniaud.io/docs ]] audio playback and capture library.
+
+Choice of public domain or MIT-0. See license statements at the end of this file.
miniaudio - v0.11.21 - 2023-11-15
David Reid - mackron@gmail.com
@@ -9,9 +9,7 @@ David Reid - mackron@gmail.com
Website: https://miniaud.io
Documentation: https://miniaud.io/docs
GitHub: https://github.com/mackron/miniaudio
-*/
-/*
1. Introduction
===============
miniaudio is a single file library for audio playback and capture. To use it, do the following in
@@ -3736,3 +3734,4 @@ See below for some tips on improving performance.
- When compiling with VC6 and earlier, decoding is restricted to files less than 2GB in size. This
is due to 64-bit file APIs not being available.
*/
+package miniaudio \ No newline at end of file
diff --git a/vendor/nanovg/gl/gl.odin b/vendor/nanovg/gl/gl.odin
index 5af7ed4bc..e43f07354 100644
--- a/vendor/nanovg/gl/gl.odin
+++ b/vendor/nanovg/gl/gl.odin
@@ -1,3 +1,4 @@
+// An Odin-native source port of [[ nanovg ; https://github.com/memononen/nanovg ]]'s GL backend.
#+build windows, linux, darwin
package nanovg_gl
diff --git a/vendor/nanovg/nanovg.odin b/vendor/nanovg/nanovg.odin
index 540ca47cf..70ba90681 100644
--- a/vendor/nanovg/nanovg.odin
+++ b/vendor/nanovg/nanovg.odin
@@ -1,3 +1,4 @@
+// An Odin-native source port of [[ nanovg ; https://github.com/memononen/nanovg ]].
#+build windows, linux, darwin
package nanovg
diff --git a/vendor/portmidi/doc.odin b/vendor/portmidi/doc.odin
index 6a3d5331a..3e6b0b3b2 100644
--- a/vendor/portmidi/doc.odin
+++ b/vendor/portmidi/doc.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ PortMidi ; http://sourceforge.net/projects/portmedia ]] Portable Real-Time MIDI Library.
package portmidi
/*
diff --git a/vendor/raylib/raylib.odin b/vendor/raylib/raylib.odin
index bb8f0e894..7dae19f4b 100644
--- a/vendor/raylib/raylib.odin
+++ b/vendor/raylib/raylib.odin
@@ -1,5 +1,5 @@
/*
-Package vendor:raylib implements bindings for version 5.5 of the raylib library (https://www.raylib.com/)
+Bindings for [[ raylib v5.5 ; https://www.raylib.com ]].
*********************************************************************************************
*
diff --git a/vendor/sdl2/image/sdl_image.odin b/vendor/sdl2/image/sdl_image.odin
index 204ec9a0d..de9b74cac 100644
--- a/vendor/sdl2/image/sdl_image.odin
+++ b/vendor/sdl2/image/sdl_image.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL2 Image; https://wiki.libsdl.org/SDL2/FrontPage ]].
package sdl2_image
import "core:c"
diff --git a/vendor/sdl2/mixer/sdl_mixer.odin b/vendor/sdl2/mixer/sdl_mixer.odin
index b0c16871d..a3032a08c 100644
--- a/vendor/sdl2/mixer/sdl_mixer.odin
+++ b/vendor/sdl2/mixer/sdl_mixer.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL2 Mixer ; https://wiki.libsdl.org/SDL2/FrontPage ]].
package sdl2_mixer
import "core:c"
diff --git a/vendor/sdl2/net/sdl_net.odin b/vendor/sdl2/net/sdl_net.odin
index 579f245e5..2e13a7406 100644
--- a/vendor/sdl2/net/sdl_net.odin
+++ b/vendor/sdl2/net/sdl_net.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL2 Net ; https://wiki.libsdl.org/SDL2/FrontPage ]].
package sdl2_net
import "core:c"
diff --git a/vendor/sdl2/sdl2.odin b/vendor/sdl2/sdl2.odin
index 5bc52b70e..ffe70c330 100644
--- a/vendor/sdl2/sdl2.odin
+++ b/vendor/sdl2/sdl2.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL2 ; https://wiki.libsdl.org/SDL2/FrontPage ]].
package sdl2
/*
diff --git a/vendor/sdl2/ttf/sdl_ttf.odin b/vendor/sdl2/ttf/sdl_ttf.odin
index ca9beded0..15c861847 100644
--- a/vendor/sdl2/ttf/sdl_ttf.odin
+++ b/vendor/sdl2/ttf/sdl_ttf.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL2 TTF ; https://wiki.libsdl.org/SDL2/FrontPage ]].
package sdl2_ttf
import "core:c"
diff --git a/vendor/sdl3/image/sdl_image.odin b/vendor/sdl3/image/sdl_image.odin
index d2c628a86..d43885644 100644
--- a/vendor/sdl3/image/sdl_image.odin
+++ b/vendor/sdl3/image/sdl_image.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL3 Image ; https://wiki.libsdl.org/SDL3/FrontPage ]].
package sdl3_image
import "core:c"
diff --git a/vendor/sdl3/sdl3_main.odin b/vendor/sdl3/sdl3_main.odin
index f5f9b7f52..103372bed 100644
--- a/vendor/sdl3/sdl3_main.odin
+++ b/vendor/sdl3/sdl3_main.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL3 ; https://wiki.libsdl.org/SDL3/FrontPage ]].
package sdl3
import "core:c"
diff --git a/vendor/sdl3/ttf/sdl3_ttf.odin b/vendor/sdl3/ttf/sdl3_ttf.odin
index ada1de833..7fb583726 100644
--- a/vendor/sdl3/ttf/sdl3_ttf.odin
+++ b/vendor/sdl3/ttf/sdl3_ttf.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ SDL3 TTF ; https://wiki.libsdl.org/SDL3/FrontPage ]].
package sdl3_ttf
import "core:c"
diff --git a/vendor/stb/easy_font/stb_easy_font.odin b/vendor/stb/easy_font/stb_easy_font.odin
index 0208ca316..17e8127e9 100644
--- a/vendor/stb/easy_font/stb_easy_font.odin
+++ b/vendor/stb/easy_font/stb_easy_font.odin
@@ -1,26 +1,7 @@
-package stb_easy_font
-
/*
- Source port of stb_easy_font.h
-
- Original port: gingerBill
- Bugfixes: Florian Behr & Jeroen van Rijn
- Additions: Jeroen van Rijn
-
- Changelog:
- 2022-04-03
- Bug fixes
- Add `print(x, y, text, color, quad_buffer)` version that takes `[]quad`.
- (Same internal memory layout as []u8 API, but more convenient for the caller.)
- Add optional `scale := f32(1.0)` param to `print` to embiggen the glyph quads.
-
- 2021-09-14
- Original Odin version
-*/
-
-/*
- // Example for use with vendor:raylib
+An Odin-native source port of [[ stb_easy_font.h ; https://github.com/nothings/stb/blob/master/stb_easy_font.h ]].
+Example:
quads: [999]easy_font.Quad = ---
color := rl.GREEN
@@ -38,7 +19,24 @@ package stb_easy_font
// And in practice this code will likely not live as close to the `easy_font` call.
rl.DrawRectangleRec(r, color)
}
+
+
+Changelog:
+ 2022-04-03
+ Bug fixes
+ Add `print(x, y, text, color, quad_buffer)` version that takes `[]quad`.
+ (Same internal memory layout as []u8 API, but more convenient for the caller.)
+ Add optional `scale := f32(1.0)` param to `print` to embiggen the glyph quads.
+
+ 2021-09-14
+ Original Odin version
+
+Credits:
+ Original port: gingerBill
+ Bugfixes: Florian Behr & Jeroen van Rijn
+ Additions: Jeroen van Rijn
*/
+package stb_easy_font
import "core:math"
import "core:mem"
diff --git a/vendor/stb/image/stb_image.odin b/vendor/stb/image/stb_image.odin
index 1ba63dc47..ac0892d0a 100644
--- a/vendor/stb/image/stb_image.odin
+++ b/vendor/stb/image/stb_image.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ stb_image.h ; https://github.com/nothings/stb/blob/master/stb_image.h ]].
package stb_image
import "core:c"
diff --git a/vendor/stb/rect_pack/stb_rect_pack.odin b/vendor/stb/rect_pack/stb_rect_pack.odin
index 696b9c8c0..0ba975b15 100644
--- a/vendor/stb/rect_pack/stb_rect_pack.odin
+++ b/vendor/stb/rect_pack/stb_rect_pack.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ stb_rect_pack.h ; https://github.com/nothings/stb/blob/master/stb_rect_pack.h ]].
package stb_rect_pack
import "core:c"
diff --git a/vendor/stb/truetype/stb_truetype.odin b/vendor/stb/truetype/stb_truetype.odin
index f1dcdf2a2..d88fafda1 100644
--- a/vendor/stb/truetype/stb_truetype.odin
+++ b/vendor/stb/truetype/stb_truetype.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ stb_truetype.h ; https://github.com/nothings/stb/blob/master/stb_truetype.h ]].
package stb_truetype
import c "core:c"
diff --git a/vendor/stb/vorbis/stb_vorbis.odin b/vendor/stb/vorbis/stb_vorbis.odin
index 867ffb86d..38bba4f29 100644
--- a/vendor/stb/vorbis/stb_vorbis.odin
+++ b/vendor/stb/vorbis/stb_vorbis.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ stb_vorbis.c ; https://github.com/nothings/stb/blob/master/stb_vorbis.c ]].
package stb_vorbis
import c "core:c/libc"
diff --git a/vendor/vulkan/_gen/create_vulkan_odin_wrapper.py b/vendor/vulkan/_gen/create_vulkan_odin_wrapper.py
index 79a022243..4900d52b7 100644
--- a/vendor/vulkan/_gen/create_vulkan_odin_wrapper.py
+++ b/vendor/vulkan/_gen/create_vulkan_odin_wrapper.py
@@ -6,6 +6,13 @@ import string
import os.path
import math
+PACKAGE_LINE = "package vulkan"
+
+BASE = """
+// Vulkan wrapper generated from [[ vulkan_core.h ; https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h ]].
+"""[1::]
+
+
file_and_urls = [
("vk_platform.h", 'https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/main/include/vulkan/vk_platform.h', True),
("vulkan_core.h", 'https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/main/include/vulkan/vulkan_core.h', False),
@@ -889,18 +896,9 @@ load_proc_addresses :: proc{
}\n
"""[1::])
-
-
-BASE = """
-//
-// Vulkan wrapper generated from "https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h"
-//
-package vulkan
-"""[1::]
-
-
with open("../core.odin", 'w', encoding='utf-8') as f:
f.write(BASE)
+ f.write(PACKAGE_LINE)
f.write("""
// Core API
API_VERSION_1_0 :: (1<<22) | (0<<12) | (0)
@@ -974,13 +972,13 @@ MAKE_VIDEO_STD_VERSION :: MAKE_VERSION
f.write("\n\n")
parse_flags_def(f)
with open("../enums.odin", 'w', encoding='utf-8') as f:
- f.write(BASE)
+ f.write(PACKAGE_LINE)
f.write("\n")
parse_enums(f)
parse_fake_enums(f)
f.write("\n\n")
with open("../structs.odin", 'w', encoding='utf-8') as f:
- f.write(BASE)
+ f.write(PACKAGE_LINE)
f.write("""
import "core:c"
@@ -1041,7 +1039,7 @@ MTLCommandQueue_id :: rawptr
parse_structs(f)
f.write("\n\n")
with open("../procedures.odin", 'w', encoding='utf-8') as f:
- f.write(BASE)
+ f.write(PACKAGE_LINE)
f.write("\n")
parse_procedures(f)
f.write("\n")
diff --git a/vendor/vulkan/core.odin b/vendor/vulkan/core.odin
index ad33df148..c3cb59a16 100644
--- a/vendor/vulkan/core.odin
+++ b/vendor/vulkan/core.odin
@@ -1,6 +1,4 @@
-//
-// Vulkan wrapper generated from "https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h"
-//
+// Vulkan wrapper generated from [[ vulkan_core.h ; https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h ]].
package vulkan
// Core API
API_VERSION_1_0 :: (1<<22) | (0<<12) | (0)
diff --git a/vendor/vulkan/enums.odin b/vendor/vulkan/enums.odin
index 418c7c8b1..3b9a1dc34 100644
--- a/vendor/vulkan/enums.odin
+++ b/vendor/vulkan/enums.odin
@@ -1,6 +1,3 @@
-//
-// Vulkan wrapper generated from "https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h"
-//
package vulkan
import "core:c"
diff --git a/vendor/vulkan/procedures.odin b/vendor/vulkan/procedures.odin
index 6a63c83d0..12eedbcfe 100644
--- a/vendor/vulkan/procedures.odin
+++ b/vendor/vulkan/procedures.odin
@@ -1,6 +1,3 @@
-//
-// Vulkan wrapper generated from "https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h"
-//
package vulkan
import "core:c"
diff --git a/vendor/vulkan/structs.odin b/vendor/vulkan/structs.odin
index 7ceac8c82..5391b3319 100644
--- a/vendor/vulkan/structs.odin
+++ b/vendor/vulkan/structs.odin
@@ -1,6 +1,3 @@
-//
-// Vulkan wrapper generated from "https://raw.githubusercontent.com/KhronosGroup/Vulkan-Headers/master/include/vulkan/vulkan_core.h"
-//
package vulkan
import "core:c"
diff --git a/vendor/wgpu/glfwglue/doc.odin b/vendor/wgpu/glfwglue/doc.odin
new file mode 100644
index 000000000..65716dd91
--- /dev/null
+++ b/vendor/wgpu/glfwglue/doc.odin
@@ -0,0 +1,2 @@
+// WGPU glue for GLFW.
+package wgpu_glfw_glue \ No newline at end of file
diff --git a/vendor/wgpu/sdl2glue/doc.odin b/vendor/wgpu/sdl2glue/doc.odin
new file mode 100644
index 000000000..13d7eb103
--- /dev/null
+++ b/vendor/wgpu/sdl2glue/doc.odin
@@ -0,0 +1,2 @@
+// WGPU glue for SDL2.
+package wgpu_sdl2_glue
diff --git a/vendor/wgpu/sdl3glue/doc.odin b/vendor/wgpu/sdl3glue/doc.odin
new file mode 100644
index 000000000..e95ed5c47
--- /dev/null
+++ b/vendor/wgpu/sdl3glue/doc.odin
@@ -0,0 +1,2 @@
+// WGPU glue for SDL3.
+package wgpu_sdl3_glue \ No newline at end of file
diff --git a/vendor/windows/GameInput/doc.odin b/vendor/windows/GameInput/doc.odin
new file mode 100644
index 000000000..873062edf
--- /dev/null
+++ b/vendor/windows/GameInput/doc.odin
@@ -0,0 +1,6 @@
+/*
+ Bindings for [[ Windows Game Input GDK ; https://learn.microsoft.com/en-us/gaming/gdk/_content/gc/input/overviews/input-overview ]].
+
+ Windows SDK 10.0.26100.0 is at least required to link with.
+*/
+package windows_game_input \ No newline at end of file
diff --git a/vendor/windows/XAudio2/doc.odin b/vendor/windows/XAudio2/doc.odin
new file mode 100644
index 000000000..84ab08c39
--- /dev/null
+++ b/vendor/windows/XAudio2/doc.odin
@@ -0,0 +1,6 @@
+/*
+ Bindings for [[ Windows XAudio2 ; https://learn.microsoft.com/en-us/windows/win32/xaudio2/xaudio2-introduction ]].
+
+ Compiling for Windows 10 RS5 (1809) and later
+*/
+package windows_xaudio2 \ No newline at end of file
diff --git a/vendor/x11/xlib/xlib.odin b/vendor/x11/xlib/xlib.odin
index bd9ba3b59..a2d51c401 100644
--- a/vendor/x11/xlib/xlib.odin
+++ b/vendor/x11/xlib/xlib.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ X11's Xlib (PDF) ; https://www.x.org/docs/X11/xlib.pdf ]].
package xlib
// Value, specifying whether `vendor:x11/xlib` is available on the current platform.
diff --git a/vendor/zlib/zlib.odin b/vendor/zlib/zlib.odin
index 021449813..4c2ce712a 100644
--- a/vendor/zlib/zlib.odin
+++ b/vendor/zlib/zlib.odin
@@ -1,3 +1,4 @@
+// Bindings for [[ libz ; https://zlib.net ]] ZLIB compression library.
package vendor_zlib
import "core:c"