您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

3144 行
144 KiB

  1. <!-------------------------------------------------------------------------------------- -->
  2. <!-- Window and Graphics Device Functions (Module: core) -->
  3. <!-------------------------------------------------------------------------------------- -->
  4. <!-- Window-related functions -->
  5. <KeyWord name="InitWindow" func="yes">
  6. <Overload retVal="void" descr="Initialize window and OpenGL context">
  7. <Param name="int width" />
  8. <Param name="int height" />
  9. <Param name="const char *title" />
  10. </Overload>
  11. </KeyWord>
  12. <KeyWord name="WindowShouldClose" func="yes">
  13. <Overload retVal="bool" descr="Check if KEY_ESCAPE pressed or Close icon pressed"></Overload>
  14. </KeyWord>
  15. <KeyWord name="CloseWindow" func="yes">
  16. <Overload retVal="void" descr="Close window and unload OpenGL context"></Overload>
  17. </KeyWord>
  18. <KeyWord name="IsWindowReady" func="yes">
  19. <Overload retVal="bool" descr="Check if window has been initialized successfully"></Overload>
  20. </KeyWord>
  21. <KeyWord name="IsWindowFullscreen" func="yes">
  22. <Overload retVal="bool" descr="Check if window is currently fullscreen"></Overload>
  23. </KeyWord>
  24. <KeyWord name="IsWindowHidden" func="yes">
  25. <Overload retVal="bool" descr="Check if window is currently hidden (only PLATFORM_DESKTOP)"></Overload>
  26. </KeyWord>
  27. <KeyWord name="IsWindowMinimized" func="yes">
  28. <Overload retVal="bool" descr="Check if window is currently minimized (only PLATFORM_DESKTOP)"></Overload>
  29. </KeyWord>
  30. <KeyWord name="IsWindowMaximized" func="yes">
  31. <Overload retVal="bool" descr="Check if window is currently maximized (only PLATFORM_DESKTOP)"></Overload>
  32. </KeyWord>
  33. <KeyWord name="IsWindowFocused" func="yes">
  34. <Overload retVal="bool" descr="Check if window is currently focused (only PLATFORM_DESKTOP)"></Overload>
  35. </KeyWord>
  36. <KeyWord name="IsWindowResized" func="yes">
  37. <Overload retVal="bool" descr="Check if window has been resized last frame"></Overload>
  38. </KeyWord>
  39. <KeyWord name="IsWindowState" func="yes">
  40. <Overload retVal="bool" descr="Check if one specific window flag is enabled">
  41. <Param name="unsigned int flag" />
  42. </Overload>
  43. </KeyWord>
  44. <KeyWord name="SetWindowState" func="yes">
  45. <Overload retVal="void" descr="Set window configuration state using flags (only PLATFORM_DESKTOP)">
  46. <Param name="unsigned int flags" />
  47. </Overload>
  48. </KeyWord>
  49. <KeyWord name="ClearWindowState" func="yes">
  50. <Overload retVal="void" descr="Clear window configuration state flags">
  51. <Param name="unsigned int flags" />
  52. </Overload>
  53. </KeyWord>
  54. <KeyWord name="ToggleFullscreen" func="yes">
  55. <Overload retVal="void" descr="Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)"></Overload>
  56. </KeyWord>
  57. <KeyWord name="MaximizeWindow" func="yes">
  58. <Overload retVal="void" descr="Set window state: maximized, if resizable (only PLATFORM_DESKTOP)"></Overload>
  59. </KeyWord>
  60. <KeyWord name="MinimizeWindow" func="yes">
  61. <Overload retVal="void" descr="Set window state: minimized, if resizable (only PLATFORM_DESKTOP)"></Overload>
  62. </KeyWord>
  63. <KeyWord name="RestoreWindow" func="yes">
  64. <Overload retVal="void" descr="Set window state: not minimized/maximized (only PLATFORM_DESKTOP)"></Overload>
  65. </KeyWord>
  66. <KeyWord name="SetWindowIcon" func="yes">
  67. <Overload retVal="void" descr="Set icon for window (only PLATFORM_DESKTOP)">
  68. <Param name="Image image" />
  69. </Overload>
  70. </KeyWord>
  71. <KeyWord name="SetWindowTitle" func="yes">
  72. <Overload retVal="void" descr="Set title for window (only PLATFORM_DESKTOP)">
  73. <Param name="const char *title" />
  74. </Overload>
  75. </KeyWord>
  76. <KeyWord name="SetWindowPosition" func="yes">
  77. <Overload retVal="void" descr="Set window position on screen (only PLATFORM_DESKTOP)">
  78. <Param name="int x" />
  79. <Param name="int y" />
  80. </Overload>
  81. </KeyWord>
  82. <KeyWord name="SetWindowMonitor" func="yes">
  83. <Overload retVal="void" descr="Set monitor for the current window (fullscreen mode)">
  84. <Param name="int monitor" />
  85. </Overload>
  86. </KeyWord>
  87. <KeyWord name="SetWindowMinSize" func="yes">
  88. <Overload retVal="void" descr="Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)">
  89. <Param name="int width" />
  90. <Param name="int height" />
  91. </Overload>
  92. </KeyWord>
  93. <KeyWord name="SetWindowSize" func="yes">
  94. <Overload retVal="void" descr="Set window dimensions">
  95. <Param name="int width" />
  96. <Param name="int height" />
  97. </Overload>
  98. </KeyWord>
  99. <KeyWord name="SetWindowOpacity" func="yes">
  100. <Overload retVal="void" descr="Set window opacity [0.0f..1.0f] (only PLATFORM_DESKTOP)">
  101. <Param name="float opacity" />
  102. </Overload>
  103. </KeyWord>
  104. <KeyWord name="GetWindowHandle" func="yes">
  105. <Overload retVal="void" descr="Get native window handle"></Overload>
  106. </KeyWord>
  107. <KeyWord name="GetScreenWidth" func="yes">
  108. <Overload retVal="int" descr="Get current screen width"></Overload>
  109. </KeyWord>
  110. <KeyWord name="GetScreenHeight" func="yes">
  111. <Overload retVal="int" descr="Get current screen height"></Overload>
  112. </KeyWord>
  113. <KeyWord name="GetRenderWidth" func="yes">
  114. <Overload retVal="int" descr="Get current render width (it considers HiDPI)"></Overload>
  115. </KeyWord>
  116. <KeyWord name="GetRenderHeight" func="yes">
  117. <Overload retVal="int" descr="Get current render height (it considers HiDPI)"></Overload>
  118. </KeyWord>
  119. <KeyWord name="GetMonitorCount" func="yes">
  120. <Overload retVal="int" descr="Get number of connected monitors"></Overload>
  121. </KeyWord>
  122. <KeyWord name="GetCurrentMonitor" func="yes">
  123. <Overload retVal="int" descr="Get current connected monitor"></Overload>
  124. </KeyWord>
  125. <KeyWord name="GetMonitorPosition" func="yes">
  126. <Overload retVal="Vector2" descr="Get specified monitor position">
  127. <Param name="int monitor" />
  128. </Overload>
  129. </KeyWord>
  130. <KeyWord name="GetMonitorWidth" func="yes">
  131. <Overload retVal="int" descr="Get specified monitor width (current video mode used by monitor)">
  132. <Param name="int monitor" />
  133. </Overload>
  134. </KeyWord>
  135. <KeyWord name="GetMonitorHeight" func="yes">
  136. <Overload retVal="int" descr="Get specified monitor height (current video mode used by monitor)">
  137. <Param name="int monitor" />
  138. </Overload>
  139. </KeyWord>
  140. <KeyWord name="GetMonitorPhysicalWidth" func="yes">
  141. <Overload retVal="int" descr="Get specified monitor physical width in millimetres">
  142. <Param name="int monitor" />
  143. </Overload>
  144. </KeyWord>
  145. <KeyWord name="GetMonitorPhysicalHeight" func="yes">
  146. <Overload retVal="int" descr="Get specified monitor physical height in millimetres">
  147. <Param name="int monitor" />
  148. </Overload>
  149. </KeyWord>
  150. <KeyWord name="GetMonitorRefreshRate" func="yes">
  151. <Overload retVal="int" descr="Get specified monitor refresh rate">
  152. <Param name="int monitor" />
  153. </Overload>
  154. </KeyWord>
  155. <KeyWord name="GetWindowPosition" func="yes">
  156. <Overload retVal="Vector2" descr="Get window position XY on monitor"></Overload>
  157. </KeyWord>
  158. <KeyWord name="GetWindowScaleDPI" func="yes">
  159. <Overload retVal="Vector2" descr="Get window scale DPI factor"></Overload>
  160. </KeyWord>
  161. <KeyWord name="GetMonitorName" func="yes">
  162. <Overload retVal="const char" descr="Get the human-readable, UTF-8 encoded name of the primary monitor">
  163. <Param name="int monitor" />
  164. </Overload>
  165. </KeyWord>
  166. <KeyWord name="SetClipboardText" func="yes">
  167. <Overload retVal="void" descr="Set clipboard text content">
  168. <Param name="const char *text" />
  169. </Overload>
  170. </KeyWord>
  171. <KeyWord name="GetClipboardText" func="yes">
  172. <Overload retVal="const char" descr="Get clipboard text content"></Overload>
  173. </KeyWord>
  174. <KeyWord name="EnableEventWaiting" func="yes">
  175. <Overload retVal="void" descr="Enable waiting for events on EndDrawing(), no automatic event polling"></Overload>
  176. </KeyWord>
  177. <KeyWord name="DisableEventWaiting" func="yes">
  178. <Overload retVal="void" descr="Disable waiting for events on EndDrawing(), automatic events polling"></Overload>
  179. </KeyWord>
  180. <!-- Custom frame control functions -->
  181. <!-- NOTE: Those functions are intended for advance users that want full control over the frame processing -->
  182. <!-- By default EndDrawing() does this job: draws everything + SwapScreenBuffer() + manage frame timming + PollInputEvents() -->
  183. <!-- To avoid that behaviour and control frame processes manually, enable in config.h: SUPPORT_CUSTOM_FRAME_CONTROL -->
  184. <KeyWord name="SwapScreenBuffer" func="yes">
  185. <Overload retVal="void" descr="Swap back buffer with front buffer (screen drawing)"></Overload>
  186. </KeyWord>
  187. <KeyWord name="PollInputEvents" func="yes">
  188. <Overload retVal="void" descr="Register all input events"></Overload>
  189. </KeyWord>
  190. <KeyWord name="WaitTime" func="yes">
  191. <Overload retVal="void" descr="Wait for some time (halt program execution)">
  192. <Param name="double seconds" />
  193. </Overload>
  194. </KeyWord>
  195. <!-- Cursor-related functions -->
  196. <KeyWord name="ShowCursor" func="yes">
  197. <Overload retVal="void" descr="Shows cursor"></Overload>
  198. </KeyWord>
  199. <KeyWord name="HideCursor" func="yes">
  200. <Overload retVal="void" descr="Hides cursor"></Overload>
  201. </KeyWord>
  202. <KeyWord name="IsCursorHidden" func="yes">
  203. <Overload retVal="bool" descr="Check if cursor is not visible"></Overload>
  204. </KeyWord>
  205. <KeyWord name="EnableCursor" func="yes">
  206. <Overload retVal="void" descr="Enables cursor (unlock cursor)"></Overload>
  207. </KeyWord>
  208. <KeyWord name="DisableCursor" func="yes">
  209. <Overload retVal="void" descr="Disables cursor (lock cursor)"></Overload>
  210. </KeyWord>
  211. <KeyWord name="IsCursorOnScreen" func="yes">
  212. <Overload retVal="bool" descr="Check if cursor is on the screen"></Overload>
  213. </KeyWord>
  214. <!-- Drawing-related functions -->
  215. <KeyWord name="ClearBackground" func="yes">
  216. <Overload retVal="void" descr="Set background color (framebuffer clear color)">
  217. <Param name="Color color" />
  218. </Overload>
  219. </KeyWord>
  220. <KeyWord name="BeginDrawing" func="yes">
  221. <Overload retVal="void" descr="Setup canvas (framebuffer) to start drawing"></Overload>
  222. </KeyWord>
  223. <KeyWord name="EndDrawing" func="yes">
  224. <Overload retVal="void" descr="End canvas drawing and swap buffers (double buffering)"></Overload>
  225. </KeyWord>
  226. <KeyWord name="BeginMode2D" func="yes">
  227. <Overload retVal="void" descr="Begin 2D mode with custom camera (2D)">
  228. <Param name="Camera2D camera" />
  229. </Overload>
  230. </KeyWord>
  231. <KeyWord name="EndMode2D" func="yes">
  232. <Overload retVal="void" descr="Ends 2D mode with custom camera"></Overload>
  233. </KeyWord>
  234. <KeyWord name="BeginMode3D" func="yes">
  235. <Overload retVal="void" descr="Begin 3D mode with custom camera (3D)">
  236. <Param name="Camera3D camera" />
  237. </Overload>
  238. </KeyWord>
  239. <KeyWord name="EndMode3D" func="yes">
  240. <Overload retVal="void" descr="Ends 3D mode and returns to default 2D orthographic mode"></Overload>
  241. </KeyWord>
  242. <KeyWord name="BeginTextureMode" func="yes">
  243. <Overload retVal="void" descr="Begin drawing to render texture">
  244. <Param name="RenderTexture2D target" />
  245. </Overload>
  246. </KeyWord>
  247. <KeyWord name="EndTextureMode" func="yes">
  248. <Overload retVal="void" descr="Ends drawing to render texture"></Overload>
  249. </KeyWord>
  250. <KeyWord name="BeginShaderMode" func="yes">
  251. <Overload retVal="void" descr="Begin custom shader drawing">
  252. <Param name="Shader shader" />
  253. </Overload>
  254. </KeyWord>
  255. <KeyWord name="EndShaderMode" func="yes">
  256. <Overload retVal="void" descr="End custom shader drawing (use default shader)"></Overload>
  257. </KeyWord>
  258. <KeyWord name="BeginBlendMode" func="yes">
  259. <Overload retVal="void" descr="Begin blending mode (alpha, additive, multiplied, subtract, custom)">
  260. <Param name="int mode" />
  261. </Overload>
  262. </KeyWord>
  263. <KeyWord name="EndBlendMode" func="yes">
  264. <Overload retVal="void" descr="End blending mode (reset to default: alpha blending)"></Overload>
  265. </KeyWord>
  266. <KeyWord name="BeginScissorMode" func="yes">
  267. <Overload retVal="void" descr="Begin scissor mode (define screen area for following drawing)">
  268. <Param name="int x" />
  269. <Param name="int y" />
  270. <Param name="int width" />
  271. <Param name="int height" />
  272. </Overload>
  273. </KeyWord>
  274. <KeyWord name="EndScissorMode" func="yes">
  275. <Overload retVal="void" descr="End scissor mode"></Overload>
  276. </KeyWord>
  277. <KeyWord name="BeginVrStereoMode" func="yes">
  278. <Overload retVal="void" descr="Begin stereo rendering (requires VR simulator)">
  279. <Param name="VrStereoConfig config" />
  280. </Overload>
  281. </KeyWord>
  282. <KeyWord name="EndVrStereoMode" func="yes">
  283. <Overload retVal="void" descr="End stereo rendering (requires VR simulator)"></Overload>
  284. </KeyWord>
  285. <!-- VR stereo config functions for VR simulator -->
  286. <KeyWord name="LoadVrStereoConfig" func="yes">
  287. <Overload retVal="VrStereoConfig" descr="Load VR stereo config for VR simulator device parameters">
  288. <Param name="VrDeviceInfo device" />
  289. </Overload>
  290. </KeyWord>
  291. <KeyWord name="UnloadVrStereoConfig" func="yes">
  292. <Overload retVal="void" descr="Unload VR stereo config">
  293. <Param name="VrStereoConfig config" />
  294. </Overload>
  295. </KeyWord>
  296. <!-- Shader management functions -->
  297. <!-- NOTE: Shader functionality is not available on OpenGL 1.1 -->
  298. <KeyWord name="LoadShader" func="yes">
  299. <Overload retVal="Shader" descr="Load shader from files and bind default locations">
  300. <Param name="const char *vsFileName" />
  301. <Param name="const char *fsFileName" />
  302. </Overload>
  303. </KeyWord>
  304. <KeyWord name="LoadShaderFromMemory" func="yes">
  305. <Overload retVal="Shader" descr="Load shader from code strings and bind default locations">
  306. <Param name="const char *vsCode" />
  307. <Param name="const char *fsCode" />
  308. </Overload>
  309. </KeyWord>
  310. <KeyWord name="GetShaderLocation" func="yes">
  311. <Overload retVal="int" descr="Get shader uniform location">
  312. <Param name="Shader shader" />
  313. <Param name="const char *uniformName" />
  314. </Overload>
  315. </KeyWord>
  316. <KeyWord name="GetShaderLocationAttrib" func="yes">
  317. <Overload retVal="int" descr="Get shader attribute location">
  318. <Param name="Shader shader" />
  319. <Param name="const char *attribName" />
  320. </Overload>
  321. </KeyWord>
  322. <KeyWord name="SetShaderValue" func="yes">
  323. <Overload retVal="void" descr="Set shader uniform value">
  324. <Param name="Shader shader" />
  325. <Param name="int locIndex" />
  326. <Param name="const void *value" />
  327. <Param name="int uniformType" />
  328. </Overload>
  329. </KeyWord>
  330. <KeyWord name="SetShaderValueV" func="yes">
  331. <Overload retVal="void" descr="Set shader uniform value vector">
  332. <Param name="Shader shader" />
  333. <Param name="int locIndex" />
  334. <Param name="const void *value" />
  335. <Param name="int uniformType" />
  336. <Param name="int count" />
  337. </Overload>
  338. </KeyWord>
  339. <KeyWord name="SetShaderValueMatrix" func="yes">
  340. <Overload retVal="void" descr="Set shader uniform value (matrix 4x4)">
  341. <Param name="Shader shader" />
  342. <Param name="int locIndex" />
  343. <Param name="Matrix mat" />
  344. </Overload>
  345. </KeyWord>
  346. <KeyWord name="SetShaderValueTexture" func="yes">
  347. <Overload retVal="void" descr="Set shader uniform value for texture (sampler2d)">
  348. <Param name="Shader shader" />
  349. <Param name="int locIndex" />
  350. <Param name="Texture2D texture" />
  351. </Overload>
  352. </KeyWord>
  353. <KeyWord name="UnloadShader" func="yes">
  354. <Overload retVal="void" descr="Unload shader from GPU memory (VRAM)">
  355. <Param name="Shader shader" />
  356. </Overload>
  357. </KeyWord>
  358. <!-- Screen-space-related functions -->
  359. <KeyWord name="GetMouseRay" func="yes">
  360. <Overload retVal="Ray" descr="Get a ray trace from mouse position">
  361. <Param name="Vector2 mousePosition" />
  362. <Param name="Camera camera" />
  363. </Overload>
  364. </KeyWord>
  365. <KeyWord name="GetCameraMatrix" func="yes">
  366. <Overload retVal="Matrix" descr="Get camera transform matrix (view matrix)">
  367. <Param name="Camera camera" />
  368. </Overload>
  369. </KeyWord>
  370. <KeyWord name="GetCameraMatrix2D" func="yes">
  371. <Overload retVal="Matrix" descr="Get camera 2d transform matrix">
  372. <Param name="Camera2D camera" />
  373. </Overload>
  374. </KeyWord>
  375. <KeyWord name="GetWorldToScreen" func="yes">
  376. <Overload retVal="Vector2" descr="Get the screen space position for a 3d world space position">
  377. <Param name="Vector3 position" />
  378. <Param name="Camera camera" />
  379. </Overload>
  380. </KeyWord>
  381. <KeyWord name="GetScreenToWorld2D" func="yes">
  382. <Overload retVal="Vector2" descr="Get the world space position for a 2d camera screen space position">
  383. <Param name="Vector2 position" />
  384. <Param name="Camera2D camera" />
  385. </Overload>
  386. </KeyWord>
  387. <KeyWord name="GetWorldToScreenEx" func="yes">
  388. <Overload retVal="Vector2" descr="Get size position for a 3d world space position">
  389. <Param name="Vector3 position" />
  390. <Param name="Camera camera" />
  391. <Param name="int width" />
  392. <Param name="int height" />
  393. </Overload>
  394. </KeyWord>
  395. <KeyWord name="GetWorldToScreen2D" func="yes">
  396. <Overload retVal="Vector2" descr="Get the screen space position for a 2d camera world space position">
  397. <Param name="Vector2 position" />
  398. <Param name="Camera2D camera" />
  399. </Overload>
  400. </KeyWord>
  401. <!-- Timing-related functions -->
  402. <KeyWord name="SetTargetFPS" func="yes">
  403. <Overload retVal="void" descr="Set target FPS (maximum)">
  404. <Param name="int fps" />
  405. </Overload>
  406. </KeyWord>
  407. <KeyWord name="GetFPS" func="yes">
  408. <Overload retVal="int" descr="Get current FPS"></Overload>
  409. </KeyWord>
  410. <KeyWord name="GetFrameTime" func="yes">
  411. <Overload retVal="float" descr="Get time in seconds for last frame drawn (delta time)"></Overload>
  412. </KeyWord>
  413. <KeyWord name="GetTime" func="yes">
  414. <Overload retVal="double" descr="Get elapsed time in seconds since InitWindow()"></Overload>
  415. </KeyWord>
  416. <!-- Misc. functions -->
  417. <KeyWord name="GetRandomValue" func="yes">
  418. <Overload retVal="int" descr="Get a random value between min and max (both included)">
  419. <Param name="int min" />
  420. <Param name="int max" />
  421. </Overload>
  422. </KeyWord>
  423. <KeyWord name="SetRandomSeed" func="yes">
  424. <Overload retVal="void" descr="Set the seed for the random number generator">
  425. <Param name="unsigned int seed" />
  426. </Overload>
  427. </KeyWord>
  428. <KeyWord name="TakeScreenshot" func="yes">
  429. <Overload retVal="void" descr="Takes a screenshot of current screen (filename extension defines format)">
  430. <Param name="const char *fileName" />
  431. </Overload>
  432. </KeyWord>
  433. <KeyWord name="SetConfigFlags" func="yes">
  434. <Overload retVal="void" descr="Setup init configuration flags (view FLAGS)">
  435. <Param name="unsigned int flags" />
  436. </Overload>
  437. </KeyWord>
  438. <KeyWord name="TraceLog" func="yes">
  439. <Overload retVal="void" descr="Show trace log messages (LOG_DEBUG, LOG_INFO, LOG_WARNING, LOG_ERROR...)">
  440. <Param name="int logLevel" />
  441. <Param name="const char *text" />
  442. <Param name="..." />
  443. </Overload>
  444. </KeyWord>
  445. <KeyWord name="SetTraceLogLevel" func="yes">
  446. <Overload retVal="void" descr="Set the current threshold (minimum) log level">
  447. <Param name="int logLevel" />
  448. </Overload>
  449. </KeyWord>
  450. <KeyWord name="MemAlloc" func="yes">
  451. <Overload retVal="void" descr="Internal memory allocator">
  452. <Param name="int size" />
  453. </Overload>
  454. </KeyWord>
  455. <KeyWord name="MemRealloc" func="yes">
  456. <Overload retVal="void" descr="Internal memory reallocator"></Overload>
  457. </KeyWord>
  458. <KeyWord name="MemFree" func="yes">
  459. <Overload retVal="void" descr="Internal memory free"></Overload>
  460. </KeyWord>
  461. <KeyWord name="OpenURL" func="yes">
  462. <Overload retVal="void" descr="Open URL with default system browser (if available)">
  463. <Param name="const char *url" />
  464. </Overload>
  465. </KeyWord>
  466. <!-- Set custom callbacks -->
  467. <!-- WARNING: Callbacks setup is intended for advance users -->
  468. <KeyWord name="SetTraceLogCallback" func="yes">
  469. <Overload retVal="void" descr="Set custom trace log">
  470. <Param name="TraceLogCallback callback" />
  471. </Overload>
  472. </KeyWord>
  473. <KeyWord name="SetLoadFileDataCallback" func="yes">
  474. <Overload retVal="void" descr="Set custom file binary data loader">
  475. <Param name="LoadFileDataCallback callback" />
  476. </Overload>
  477. </KeyWord>
  478. <KeyWord name="SetSaveFileDataCallback" func="yes">
  479. <Overload retVal="void" descr="Set custom file binary data saver">
  480. <Param name="SaveFileDataCallback callback" />
  481. </Overload>
  482. </KeyWord>
  483. <KeyWord name="SetLoadFileTextCallback" func="yes">
  484. <Overload retVal="void" descr="Set custom file text data loader">
  485. <Param name="LoadFileTextCallback callback" />
  486. </Overload>
  487. </KeyWord>
  488. <KeyWord name="SetSaveFileTextCallback" func="yes">
  489. <Overload retVal="void" descr="Set custom file text data saver">
  490. <Param name="SaveFileTextCallback callback" />
  491. </Overload>
  492. </KeyWord>
  493. <!-- Files management functions -->
  494. <KeyWord name="char *LoadFileData" func="yes">
  495. <Overload retVal="unsigned" descr="Load file data as byte array (read)">
  496. <Param name="const char *fileName" />
  497. <Param name="unsigned int *bytesRead" />
  498. </Overload>
  499. </KeyWord>
  500. <KeyWord name="UnloadFileData" func="yes">
  501. <Overload retVal="void" descr="Unload file data allocated by LoadFileData()">
  502. <Param name="unsigned char *data" />
  503. </Overload>
  504. </KeyWord>
  505. <KeyWord name="SaveFileData" func="yes">
  506. <Overload retVal="bool" descr="Save data to file from byte array (write), returns true on success">
  507. <Param name="const char *fileName" /></Overload>
  508. </KeyWord>
  509. <KeyWord name="ExportDataAsCode" func="yes">
  510. <Overload retVal="bool" descr="Export data to code (.h), returns true on success">
  511. <Param name="const char *data" />
  512. <Param name="unsigned int size" />
  513. <Param name="const char *fileName" />
  514. </Overload>
  515. </KeyWord>
  516. <KeyWord name="LoadFileText" func="yes">
  517. <Overload retVal="char" descr="Load text data from file (read), returns a '\0' terminated string">
  518. <Param name="const char *fileName" />
  519. </Overload>
  520. </KeyWord>
  521. <KeyWord name="UnloadFileText" func="yes">
  522. <Overload retVal="void" descr="Unload file text data allocated by LoadFileText()">
  523. <Param name="char *text" />
  524. </Overload>
  525. </KeyWord>
  526. <KeyWord name="SaveFileText" func="yes">
  527. <Overload retVal="bool" descr="Save text data to file (write), string must be '\0' terminated, returns true on success">
  528. <Param name="const char *fileName" />
  529. <Param name="char *text" />
  530. </Overload>
  531. </KeyWord>
  532. <KeyWord name="FileExists" func="yes">
  533. <Overload retVal="bool" descr="Check if file exists">
  534. <Param name="const char *fileName" />
  535. </Overload>
  536. </KeyWord>
  537. <KeyWord name="DirectoryExists" func="yes">
  538. <Overload retVal="bool" descr="Check if a directory path exists">
  539. <Param name="const char *dirPath" />
  540. </Overload>
  541. </KeyWord>
  542. <KeyWord name="IsFileExtension" func="yes">
  543. <Overload retVal="bool" descr="Check file extension (including point: .png, .wav)">
  544. <Param name="const char *fileName" />
  545. <Param name="const char *ext" />
  546. </Overload>
  547. </KeyWord>
  548. <KeyWord name="GetFileLength" func="yes">
  549. <Overload retVal="int" descr="Get file length in bytes (NOTE: GetFileSize() conflicts with windows.h)">
  550. <Param name="const char *fileName" />
  551. </Overload>
  552. </KeyWord>
  553. <KeyWord name="GetFileExtension" func="yes">
  554. <Overload retVal="const char" descr="Get pointer to extension for a filename string (includes dot: '.png')">
  555. <Param name="const char *fileName" />
  556. </Overload>
  557. </KeyWord>
  558. <KeyWord name="GetFileName" func="yes">
  559. <Overload retVal="const char" descr="Get pointer to filename for a path string">
  560. <Param name="const char *filePath" />
  561. </Overload>
  562. </KeyWord>
  563. <KeyWord name="GetFileNameWithoutExt" func="yes">
  564. <Overload retVal="const char" descr="Get filename string without extension (uses static string)">
  565. <Param name="const char *filePath" />
  566. </Overload>
  567. </KeyWord>
  568. <KeyWord name="GetDirectoryPath" func="yes">
  569. <Overload retVal="const char" descr="Get full path for a given fileName with path (uses static string)">
  570. <Param name="const char *filePath" />
  571. </Overload>
  572. </KeyWord>
  573. <KeyWord name="GetPrevDirectoryPath" func="yes">
  574. <Overload retVal="const char" descr="Get previous directory path for a given path (uses static string)">
  575. <Param name="const char *dirPath" />
  576. </Overload>
  577. </KeyWord>
  578. <KeyWord name="GetWorkingDirectory" func="yes">
  579. <Overload retVal="const char" descr="Get current working directory (uses static string)"></Overload>
  580. </KeyWord>
  581. <KeyWord name="GetApplicationDirectory" func="yes">
  582. <Overload retVal="const char" descr="Get the directory if the running application (uses static string)"></Overload>
  583. </KeyWord>
  584. <KeyWord name="ChangeDirectory" func="yes">
  585. <Overload retVal="bool" descr="Change working directory, return true on success">
  586. <Param name="const char *dir" />
  587. </Overload>
  588. </KeyWord>
  589. <KeyWord name="IsPathFile" func="yes">
  590. <Overload retVal="bool" descr="Check if a given path is a file or a directory">
  591. <Param name="const char *path" />
  592. </Overload>
  593. </KeyWord>
  594. <KeyWord name="LoadDirectoryFiles" func="yes">
  595. <Overload retVal="FilePathList" descr="Load directory filepaths">
  596. <Param name="const char *dirPath" />
  597. </Overload>
  598. </KeyWord>
  599. <KeyWord name="LoadDirectoryFilesEx" func="yes">
  600. <Overload retVal="FilePathList" descr="Load directory filepaths with extension filtering and recursive directory scan">
  601. <Param name="const char *basePath" />
  602. <Param name="const char *filter" />
  603. <Param name="bool scanSubdirs" />
  604. </Overload>
  605. </KeyWord>
  606. <KeyWord name="UnloadDirectoryFiles" func="yes">
  607. <Overload retVal="void" descr="Unload filepaths">
  608. <Param name="FilePathList files" />
  609. </Overload>
  610. </KeyWord>
  611. <KeyWord name="IsFileDropped" func="yes">
  612. <Overload retVal="bool" descr="Check if a file has been dropped into window"></Overload>
  613. </KeyWord>
  614. <KeyWord name="LoadDroppedFiles" func="yes">
  615. <Overload retVal="FilePathList" descr="Load dropped filepaths"></Overload>
  616. </KeyWord>
  617. <KeyWord name="UnloadDroppedFiles" func="yes">
  618. <Overload retVal="void" descr="Unload dropped filepaths">
  619. <Param name="FilePathList files" />
  620. </Overload>
  621. </KeyWord>
  622. <KeyWord name="GetFileModTime" func="yes">
  623. <Overload retVal="long" descr="Get file modification time (last write time)">
  624. <Param name="const char *fileName" />
  625. </Overload>
  626. </KeyWord>
  627. <!-- Compression/Encoding functionality -->
  628. <KeyWord name="char *CompressData" func="yes">
  629. <Overload retVal="unsigned" descr="Compress data (DEFLATE algorithm), memory must be MemFree()">
  630. <Param name="const unsigned char" />
  631. <Param name="int dataSize" />
  632. <Param name="int *compDataSize" />
  633. </Overload>
  634. </KeyWord>
  635. <KeyWord name="char *DecompressData" func="yes">
  636. <Overload retVal="unsigned" descr="Decompress data (DEFLATE algorithm), memory must be MemFree()">
  637. <Param name="const unsigned char" />
  638. <Param name="int compDataSize" />
  639. <Param name="int *dataSize" />
  640. </Overload>
  641. </KeyWord>
  642. <KeyWord name="EncodeDataBase64" func="yes">
  643. <Overload retVal="char" descr="Encode data to Base64 string, memory must be MemFree()">
  644. <Param name="const unsigned char" />
  645. <Param name="int dataSize" />
  646. <Param name="int *outputSize" />
  647. </Overload>
  648. </KeyWord>
  649. <KeyWord name="char *DecodeDataBase64" func="yes">
  650. <Overload retVal="unsigned" descr="Decode Base64 string data, memory must be MemFree()">
  651. <Param name="const unsigned char" />
  652. <Param name="int *outputSize" />
  653. </Overload>
  654. </KeyWord>
  655. <!-------------------------------------------------------------------------------------- -->
  656. <!-- Input Handling Functions (Module: core) -->
  657. <!-------------------------------------------------------------------------------------- -->
  658. <!-- Input-related functions: keyboard -->
  659. <KeyWord name="IsKeyPressed" func="yes">
  660. <Overload retVal="bool" descr="Check if a key has been pressed once">
  661. <Param name="int key" />
  662. </Overload>
  663. </KeyWord>
  664. <KeyWord name="IsKeyDown" func="yes">
  665. <Overload retVal="bool" descr="Check if a key is being pressed">
  666. <Param name="int key" />
  667. </Overload>
  668. </KeyWord>
  669. <KeyWord name="IsKeyReleased" func="yes">
  670. <Overload retVal="bool" descr="Check if a key has been released once">
  671. <Param name="int key" />
  672. </Overload>
  673. </KeyWord>
  674. <KeyWord name="IsKeyUp" func="yes">
  675. <Overload retVal="bool" descr="Check if a key is NOT being pressed">
  676. <Param name="int key" />
  677. </Overload>
  678. </KeyWord>
  679. <KeyWord name="SetExitKey" func="yes">
  680. <Overload retVal="void" descr="Set a custom key to exit program (default is ESC)">
  681. <Param name="int key" />
  682. </Overload>
  683. </KeyWord>
  684. <KeyWord name="GetKeyPressed" func="yes">
  685. <Overload retVal="int" descr="Get key pressed (keycode), call it multiple times for keys queued, returns 0 when the queue is empty"></Overload>
  686. </KeyWord>
  687. <KeyWord name="GetCharPressed" func="yes">
  688. <Overload retVal="int" descr="Get char pressed (unicode), call it multiple times for chars queued, returns 0 when the queue is empty"></Overload>
  689. </KeyWord>
  690. <!-- Input-related functions: gamepads -->
  691. <KeyWord name="IsGamepadAvailable" func="yes">
  692. <Overload retVal="bool" descr="Check if a gamepad is available">
  693. <Param name="int gamepad" />
  694. </Overload>
  695. </KeyWord>
  696. <KeyWord name="GetGamepadName" func="yes">
  697. <Overload retVal="const char" descr="Get gamepad internal name id">
  698. <Param name="int gamepad" />
  699. </Overload>
  700. </KeyWord>
  701. <KeyWord name="IsGamepadButtonPressed" func="yes">
  702. <Overload retVal="bool" descr="Check if a gamepad button has been pressed once">
  703. <Param name="int gamepad" />
  704. <Param name="int button" />
  705. </Overload>
  706. </KeyWord>
  707. <KeyWord name="IsGamepadButtonDown" func="yes">
  708. <Overload retVal="bool" descr="Check if a gamepad button is being pressed">
  709. <Param name="int gamepad" />
  710. <Param name="int button" />
  711. </Overload>
  712. </KeyWord>
  713. <KeyWord name="IsGamepadButtonReleased" func="yes">
  714. <Overload retVal="bool" descr="Check if a gamepad button has been released once">
  715. <Param name="int gamepad" />
  716. <Param name="int button" />
  717. </Overload>
  718. </KeyWord>
  719. <KeyWord name="IsGamepadButtonUp" func="yes">
  720. <Overload retVal="bool" descr="Check if a gamepad button is NOT being pressed">
  721. <Param name="int gamepad" />
  722. <Param name="int button" />
  723. </Overload>
  724. </KeyWord>
  725. <KeyWord name="GetGamepadButtonPressed" func="yes">
  726. <Overload retVal="int" descr="Get the last gamepad button pressed"></Overload>
  727. </KeyWord>
  728. <KeyWord name="GetGamepadAxisCount" func="yes">
  729. <Overload retVal="int" descr="Get gamepad axis count for a gamepad">
  730. <Param name="int gamepad" />
  731. </Overload>
  732. </KeyWord>
  733. <KeyWord name="GetGamepadAxisMovement" func="yes">
  734. <Overload retVal="float" descr="Get axis movement value for a gamepad axis">
  735. <Param name="int gamepad" />
  736. <Param name="int axis" />
  737. </Overload>
  738. </KeyWord>
  739. <KeyWord name="SetGamepadMappings" func="yes">
  740. <Overload retVal="int" descr="Set internal gamepad mappings (SDL_GameControllerDB)">
  741. <Param name="const char *mappings" />
  742. </Overload>
  743. </KeyWord>
  744. <!-- Input-related functions: mouse -->
  745. <KeyWord name="IsMouseButtonPressed" func="yes">
  746. <Overload retVal="bool" descr="Check if a mouse button has been pressed once">
  747. <Param name="int button" />
  748. </Overload>
  749. </KeyWord>
  750. <KeyWord name="IsMouseButtonDown" func="yes">
  751. <Overload retVal="bool" descr="Check if a mouse button is being pressed">
  752. <Param name="int button" />
  753. </Overload>
  754. </KeyWord>
  755. <KeyWord name="IsMouseButtonReleased" func="yes">
  756. <Overload retVal="bool" descr="Check if a mouse button has been released once">
  757. <Param name="int button" />
  758. </Overload>
  759. </KeyWord>
  760. <KeyWord name="IsMouseButtonUp" func="yes">
  761. <Overload retVal="bool" descr="Check if a mouse button is NOT being pressed">
  762. <Param name="int button" />
  763. </Overload>
  764. </KeyWord>
  765. <KeyWord name="GetMouseX" func="yes">
  766. <Overload retVal="int" descr="Get mouse position X"></Overload>
  767. </KeyWord>
  768. <KeyWord name="GetMouseY" func="yes">
  769. <Overload retVal="int" descr="Get mouse position Y"></Overload>
  770. </KeyWord>
  771. <KeyWord name="GetMousePosition" func="yes">
  772. <Overload retVal="Vector2" descr="Get mouse position XY"></Overload>
  773. </KeyWord>
  774. <KeyWord name="GetMouseDelta" func="yes">
  775. <Overload retVal="Vector2" descr="Get mouse delta between frames"></Overload>
  776. </KeyWord>
  777. <KeyWord name="SetMousePosition" func="yes">
  778. <Overload retVal="void" descr="Set mouse position XY">
  779. <Param name="int x" />
  780. <Param name="int y" />
  781. </Overload>
  782. </KeyWord>
  783. <KeyWord name="SetMouseOffset" func="yes">
  784. <Overload retVal="void" descr="Set mouse offset">
  785. <Param name="int offsetX" />
  786. <Param name="int offsetY" />
  787. </Overload>
  788. </KeyWord>
  789. <KeyWord name="SetMouseScale" func="yes">
  790. <Overload retVal="void" descr="Set mouse scaling">
  791. <Param name="float scaleX" />
  792. <Param name="float scaleY" />
  793. </Overload>
  794. </KeyWord>
  795. <KeyWord name="GetMouseWheelMove" func="yes">
  796. <Overload retVal="float" descr="Get mouse wheel movement for X or Y, whichever is larger"></Overload>
  797. </KeyWord>
  798. <KeyWord name="GetMouseWheelMoveV" func="yes">
  799. <Overload retVal="Vector2" descr="Get mouse wheel movement for both X and Y"></Overload>
  800. </KeyWord>
  801. <KeyWord name="SetMouseCursor" func="yes">
  802. <Overload retVal="void" descr="Set mouse cursor">
  803. <Param name="int cursor" />
  804. </Overload>
  805. </KeyWord>
  806. <!-- Input-related functions: touch -->
  807. <KeyWord name="GetTouchX" func="yes">
  808. <Overload retVal="int" descr="Get touch position X for touch point 0 (relative to screen size)"></Overload>
  809. </KeyWord>
  810. <KeyWord name="GetTouchY" func="yes">
  811. <Overload retVal="int" descr="Get touch position Y for touch point 0 (relative to screen size)"></Overload>
  812. </KeyWord>
  813. <KeyWord name="GetTouchPosition" func="yes">
  814. <Overload retVal="Vector2" descr="Get touch position XY for a touch point index (relative to screen size)">
  815. <Param name="int index" />
  816. </Overload>
  817. </KeyWord>
  818. <KeyWord name="GetTouchPointId" func="yes">
  819. <Overload retVal="int" descr="Get touch point identifier for given index">
  820. <Param name="int index" />
  821. </Overload>
  822. </KeyWord>
  823. <KeyWord name="GetTouchPointCount" func="yes">
  824. <Overload retVal="int" descr="Get number of touch points"></Overload>
  825. </KeyWord>
  826. <!-------------------------------------------------------------------------------------- -->
  827. <!-- Gestures and Touch Handling Functions (Module: rgestures) -->
  828. <!-------------------------------------------------------------------------------------- -->
  829. <KeyWord name="SetGesturesEnabled" func="yes">
  830. <Overload retVal="void" descr="Enable a set of gestures using flags">
  831. <Param name="unsigned int flags" />
  832. </Overload>
  833. </KeyWord>
  834. <KeyWord name="IsGestureDetected" func="yes">
  835. <Overload retVal="bool" descr="Check if a gesture have been detected">
  836. <Param name="int gesture" />
  837. </Overload>
  838. </KeyWord>
  839. <KeyWord name="GetGestureDetected" func="yes">
  840. <Overload retVal="int" descr="Get latest detected gesture"></Overload>
  841. </KeyWord>
  842. <KeyWord name="GetGestureHoldDuration" func="yes">
  843. <Overload retVal="float" descr="Get gesture hold time in milliseconds"></Overload>
  844. </KeyWord>
  845. <KeyWord name="GetGestureDragVector" func="yes">
  846. <Overload retVal="Vector2" descr="Get gesture drag vector"></Overload>
  847. </KeyWord>
  848. <KeyWord name="GetGestureDragAngle" func="yes">
  849. <Overload retVal="float" descr="Get gesture drag angle"></Overload>
  850. </KeyWord>
  851. <KeyWord name="GetGesturePinchVector" func="yes">
  852. <Overload retVal="Vector2" descr="Get gesture pinch delta"></Overload>
  853. </KeyWord>
  854. <KeyWord name="GetGesturePinchAngle" func="yes">
  855. <Overload retVal="float" descr="Get gesture pinch angle"></Overload>
  856. </KeyWord>
  857. <!-------------------------------------------------------------------------------------- -->
  858. <!-- Camera System Functions (Module: rcamera) -->
  859. <!-------------------------------------------------------------------------------------- -->
  860. <KeyWord name="SetCameraMode" func="yes">
  861. <Overload retVal="void" descr="Set camera mode (multiple camera modes available)">
  862. <Param name="Camera camera" />
  863. <Param name="int mode" />
  864. </Overload>
  865. </KeyWord>
  866. <KeyWord name="UpdateCamera" func="yes">
  867. <Overload retVal="void" descr="Update camera position for selected mode">
  868. <Param name="Camera *camera" />
  869. </Overload>
  870. </KeyWord>
  871. <KeyWord name="SetCameraPanControl" func="yes">
  872. <Overload retVal="void" descr="Set camera pan key to combine with mouse movement (free camera)">
  873. <Param name="int keyPan" />
  874. </Overload>
  875. </KeyWord>
  876. <KeyWord name="SetCameraAltControl" func="yes">
  877. <Overload retVal="void" descr="Set camera alt key to combine with mouse movement (free camera)">
  878. <Param name="int keyAlt" />
  879. </Overload>
  880. </KeyWord>
  881. <KeyWord name="SetCameraSmoothZoomControl" func="yes">
  882. <Overload retVal="void" descr="Set camera smooth zoom key to combine with mouse (free camera)">
  883. <Param name="int keySmoothZoom" />
  884. </Overload>
  885. </KeyWord>
  886. <KeyWord name="SetCameraMoveControls" func="yes">
  887. <Overload retVal="void" descr="Set camera move controls (1st person and 3rd person cameras)">
  888. <Param name="int keyFront" />
  889. <Param name="int keyBack" />
  890. <Param name="int keyRight" />
  891. <Param name="int keyLeft" />
  892. <Param name="int keyUp" />
  893. <Param name="int keyDown" />
  894. </Overload>
  895. </KeyWord>
  896. <!-------------------------------------------------------------------------------------- -->
  897. <!-- Basic Shapes Drawing Functions (Module: shapes) -->
  898. <!-------------------------------------------------------------------------------------- -->
  899. <!-- Set texture and rectangle to be used on shapes drawing -->
  900. <!-- NOTE: It can be useful when using basic shapes and one single font, -->
  901. <!-- defining a font char white rectangle would allow drawing everything in a single draw call -->
  902. <KeyWord name="SetShapesTexture" func="yes">
  903. <Overload retVal="void" descr="Set texture and rectangle to be used on shapes drawing">
  904. <Param name="Texture2D texture" />
  905. <Param name="Rectangle source" />
  906. </Overload>
  907. </KeyWord>
  908. <!-- Basic shapes drawing functions -->
  909. <KeyWord name="DrawPixel" func="yes">
  910. <Overload retVal="void" descr="Draw a pixel">
  911. <Param name="int posX" />
  912. <Param name="int posY" />
  913. <Param name="Color color" />
  914. </Overload>
  915. </KeyWord>
  916. <KeyWord name="DrawPixelV" func="yes">
  917. <Overload retVal="void" descr="Draw a pixel (Vector version)">
  918. <Param name="Vector2 position" />
  919. <Param name="Color color" />
  920. </Overload>
  921. </KeyWord>
  922. <KeyWord name="DrawLine" func="yes">
  923. <Overload retVal="void" descr="Draw a line">
  924. <Param name="int startPosX" />
  925. <Param name="int startPosY" />
  926. <Param name="int endPosX" />
  927. <Param name="int endPosY" />
  928. <Param name="Color color" />
  929. </Overload>
  930. </KeyWord>
  931. <KeyWord name="DrawLineV" func="yes">
  932. <Overload retVal="void" descr="Draw a line (Vector version)">
  933. <Param name="Vector2 startPos" />
  934. <Param name="Vector2 endPos" />
  935. <Param name="Color color" />
  936. </Overload>
  937. </KeyWord>
  938. <KeyWord name="DrawLineEx" func="yes">
  939. <Overload retVal="void" descr="Draw a line defining thickness">
  940. <Param name="Vector2 startPos" />
  941. <Param name="Vector2 endPos" />
  942. <Param name="float thick" />
  943. <Param name="Color color" />
  944. </Overload>
  945. </KeyWord>
  946. <KeyWord name="DrawLineBezier" func="yes">
  947. <Overload retVal="void" descr="Draw a line using cubic-bezier curves in-out">
  948. <Param name="Vector2 startPos" />
  949. <Param name="Vector2 endPos" />
  950. <Param name="float thick" />
  951. <Param name="Color color" />
  952. </Overload>
  953. </KeyWord>
  954. <KeyWord name="DrawLineBezierQuad" func="yes">
  955. <Overload retVal="void" descr="Draw line using quadratic bezier curves with a control point">
  956. <Param name="Vector2 startPos" />
  957. <Param name="Vector2 endPos" />
  958. <Param name="Vector2 controlPos" />
  959. <Param name="float thick" />
  960. <Param name="Color color" />
  961. </Overload>
  962. </KeyWord>
  963. <KeyWord name="DrawLineBezierCubic" func="yes">
  964. <Overload retVal="void" descr="Draw line using cubic bezier curves with 2 control points">
  965. <Param name="Vector2 startPos" />
  966. <Param name="Vector2 endPos" />
  967. <Param name="Vector2 startControlPos" />
  968. <Param name="Vector2 endControlPos" />
  969. <Param name="float thick" />
  970. <Param name="Color color" />
  971. </Overload>
  972. </KeyWord>
  973. <KeyWord name="DrawLineStrip" func="yes">
  974. <Overload retVal="void" descr="Draw lines sequence">
  975. <Param name="Vector2 *points" />
  976. <Param name="int pointCount" />
  977. <Param name="Color color" />
  978. </Overload>
  979. </KeyWord>
  980. <KeyWord name="DrawCircle" func="yes">
  981. <Overload retVal="void" descr="Draw a color-filled circle">
  982. <Param name="int centerX" />
  983. <Param name="int centerY" />
  984. <Param name="float radius" />
  985. <Param name="Color color" />
  986. </Overload>
  987. </KeyWord>
  988. <KeyWord name="DrawCircleSector" func="yes">
  989. <Overload retVal="void" descr="Draw a piece of a circle">
  990. <Param name="Vector2 center" />
  991. <Param name="float radius" />
  992. <Param name="float startAngle" />
  993. <Param name="float endAngle" />
  994. <Param name="int segments" />
  995. <Param name="Color color" />
  996. </Overload>
  997. </KeyWord>
  998. <KeyWord name="DrawCircleSectorLines" func="yes">
  999. <Overload retVal="void" descr="Draw circle sector outline">
  1000. <Param name="Vector2 center" />
  1001. <Param name="float radius" />
  1002. <Param name="float startAngle" />
  1003. <Param name="float endAngle" />
  1004. <Param name="int segments" />
  1005. <Param name="Color color" />
  1006. </Overload>
  1007. </KeyWord>
  1008. <KeyWord name="DrawCircleGradient" func="yes">
  1009. <Overload retVal="void" descr="Draw a gradient-filled circle">
  1010. <Param name="int centerX" />
  1011. <Param name="int centerY" />
  1012. <Param name="float radius" />
  1013. <Param name="Color color1" />
  1014. <Param name="Color color2" />
  1015. </Overload>
  1016. </KeyWord>
  1017. <KeyWord name="DrawCircleV" func="yes">
  1018. <Overload retVal="void" descr="Draw a color-filled circle (Vector version)">
  1019. <Param name="Vector2 center" />
  1020. <Param name="float radius" />
  1021. <Param name="Color color" />
  1022. </Overload>
  1023. </KeyWord>
  1024. <KeyWord name="DrawCircleLines" func="yes">
  1025. <Overload retVal="void" descr="Draw circle outline">
  1026. <Param name="int centerX" />
  1027. <Param name="int centerY" />
  1028. <Param name="float radius" />
  1029. <Param name="Color color" />
  1030. </Overload>
  1031. </KeyWord>
  1032. <KeyWord name="DrawEllipse" func="yes">
  1033. <Overload retVal="void" descr="Draw ellipse">
  1034. <Param name="int centerX" />
  1035. <Param name="int centerY" />
  1036. <Param name="float radiusH" />
  1037. <Param name="float radiusV" />
  1038. <Param name="Color color" />
  1039. </Overload>
  1040. </KeyWord>
  1041. <KeyWord name="DrawEllipseLines" func="yes">
  1042. <Overload retVal="void" descr="Draw ellipse outline">
  1043. <Param name="int centerX" />
  1044. <Param name="int centerY" />
  1045. <Param name="float radiusH" />
  1046. <Param name="float radiusV" />
  1047. <Param name="Color color" />
  1048. </Overload>
  1049. </KeyWord>
  1050. <KeyWord name="DrawRing" func="yes">
  1051. <Overload retVal="void" descr="Draw ring">
  1052. <Param name="Vector2 center" />
  1053. <Param name="float innerRadius" />
  1054. <Param name="float outerRadius" />
  1055. <Param name="float startAngle" />
  1056. <Param name="float endAngle" />
  1057. <Param name="int segments" />
  1058. <Param name="Color color" />
  1059. </Overload>
  1060. </KeyWord>
  1061. <KeyWord name="DrawRingLines" func="yes">
  1062. <Overload retVal="void" descr="Draw ring outline">
  1063. <Param name="Vector2 center" />
  1064. <Param name="float innerRadius" />
  1065. <Param name="float outerRadius" />
  1066. <Param name="float startAngle" />
  1067. <Param name="float endAngle" />
  1068. <Param name="int segments" />
  1069. <Param name="Color color" />
  1070. </Overload>
  1071. </KeyWord>
  1072. <KeyWord name="DrawRectangle" func="yes">
  1073. <Overload retVal="void" descr="Draw a color-filled rectangle">
  1074. <Param name="int posX" />
  1075. <Param name="int posY" />
  1076. <Param name="int width" />
  1077. <Param name="int height" />
  1078. <Param name="Color color" />
  1079. </Overload>
  1080. </KeyWord>
  1081. <KeyWord name="DrawRectangleV" func="yes">
  1082. <Overload retVal="void" descr="Draw a color-filled rectangle (Vector version)">
  1083. <Param name="Vector2 position" />
  1084. <Param name="Vector2 size" />
  1085. <Param name="Color color" />
  1086. </Overload>
  1087. </KeyWord>
  1088. <KeyWord name="DrawRectangleRec" func="yes">
  1089. <Overload retVal="void" descr="Draw a color-filled rectangle">
  1090. <Param name="Rectangle rec" />
  1091. <Param name="Color color" />
  1092. </Overload>
  1093. </KeyWord>
  1094. <KeyWord name="DrawRectanglePro" func="yes">
  1095. <Overload retVal="void" descr="Draw a color-filled rectangle with pro parameters">
  1096. <Param name="Rectangle rec" />
  1097. <Param name="Vector2 origin" />
  1098. <Param name="float rotation" />
  1099. <Param name="Color color" />
  1100. </Overload>
  1101. </KeyWord>
  1102. <KeyWord name="DrawRectangleGradientV" func="yes">
  1103. <Overload retVal="void" descr="Draw a vertical-gradient-filled rectangle">
  1104. <Param name="int posX" />
  1105. <Param name="int posY" />
  1106. <Param name="int width" />
  1107. <Param name="int height" />
  1108. <Param name="Color color1" />
  1109. <Param name="Color color2" />
  1110. </Overload>
  1111. </KeyWord>
  1112. <KeyWord name="DrawRectangleGradientH" func="yes">
  1113. <Overload retVal="void" descr="Draw a horizontal-gradient-filled rectangle">
  1114. <Param name="int posX" />
  1115. <Param name="int posY" />
  1116. <Param name="int width" />
  1117. <Param name="int height" />
  1118. <Param name="Color color1" />
  1119. <Param name="Color color2" />
  1120. </Overload>
  1121. </KeyWord>
  1122. <KeyWord name="DrawRectangleGradientEx" func="yes">
  1123. <Overload retVal="void" descr="Draw a gradient-filled rectangle with custom vertex colors">
  1124. <Param name="Rectangle rec" />
  1125. <Param name="Color col1" />
  1126. <Param name="Color col2" />
  1127. <Param name="Color col3" />
  1128. <Param name="Color col4" />
  1129. </Overload>
  1130. </KeyWord>
  1131. <KeyWord name="DrawRectangleLines" func="yes">
  1132. <Overload retVal="void" descr="Draw rectangle outline">
  1133. <Param name="int posX" />
  1134. <Param name="int posY" />
  1135. <Param name="int width" />
  1136. <Param name="int height" />
  1137. <Param name="Color color" />
  1138. </Overload>
  1139. </KeyWord>
  1140. <KeyWord name="DrawRectangleLinesEx" func="yes">
  1141. <Overload retVal="void" descr="Draw rectangle outline with extended parameters">
  1142. <Param name="Rectangle rec" />
  1143. <Param name="float lineThick" />
  1144. <Param name="Color color" />
  1145. </Overload>
  1146. </KeyWord>
  1147. <KeyWord name="DrawRectangleRounded" func="yes">
  1148. <Overload retVal="void" descr="Draw rectangle with rounded edges">
  1149. <Param name="Rectangle rec" />
  1150. <Param name="float roundness" />
  1151. <Param name="int segments" />
  1152. <Param name="Color color" />
  1153. </Overload>
  1154. </KeyWord>
  1155. <KeyWord name="DrawRectangleRoundedLines" func="yes">
  1156. <Overload retVal="void" descr="Draw rectangle with rounded edges outline">
  1157. <Param name="Rectangle rec" />
  1158. <Param name="float roundness" />
  1159. <Param name="int segments" />
  1160. <Param name="float lineThick" />
  1161. <Param name="Color color" />
  1162. </Overload>
  1163. </KeyWord>
  1164. <KeyWord name="DrawTriangle" func="yes">
  1165. <Overload retVal="void" descr="Draw a color-filled triangle (vertex in counter-clockwise order!)">
  1166. <Param name="Vector2 v1" />
  1167. <Param name="Vector2 v2" />
  1168. <Param name="Vector2 v3" />
  1169. <Param name="Color color" />
  1170. </Overload>
  1171. </KeyWord>
  1172. <KeyWord name="DrawTriangleLines" func="yes">
  1173. <Overload retVal="void" descr="Draw triangle outline (vertex in counter-clockwise order!)">
  1174. <Param name="Vector2 v1" />
  1175. <Param name="Vector2 v2" />
  1176. <Param name="Vector2 v3" />
  1177. <Param name="Color color" />
  1178. </Overload>
  1179. </KeyWord>
  1180. <KeyWord name="DrawTriangleFan" func="yes">
  1181. <Overload retVal="void" descr="Draw a triangle fan defined by points (first vertex is the center)">
  1182. <Param name="Vector2 *points" />
  1183. <Param name="int pointCount" />
  1184. <Param name="Color color" />
  1185. </Overload>
  1186. </KeyWord>
  1187. <KeyWord name="DrawTriangleStrip" func="yes">
  1188. <Overload retVal="void" descr="Draw a triangle strip defined by points">
  1189. <Param name="Vector2 *points" />
  1190. <Param name="int pointCount" />
  1191. <Param name="Color color" />
  1192. </Overload>
  1193. </KeyWord>
  1194. <KeyWord name="DrawPoly" func="yes">
  1195. <Overload retVal="void" descr="Draw a regular polygon (Vector version)">
  1196. <Param name="Vector2 center" />
  1197. <Param name="int sides" />
  1198. <Param name="float radius" />
  1199. <Param name="float rotation" />
  1200. <Param name="Color color" />
  1201. </Overload>
  1202. </KeyWord>
  1203. <KeyWord name="DrawPolyLines" func="yes">
  1204. <Overload retVal="void" descr="Draw a polygon outline of n sides">
  1205. <Param name="Vector2 center" />
  1206. <Param name="int sides" />
  1207. <Param name="float radius" />
  1208. <Param name="float rotation" />
  1209. <Param name="Color color" />
  1210. </Overload>
  1211. </KeyWord>
  1212. <KeyWord name="DrawPolyLinesEx" func="yes">
  1213. <Overload retVal="void" descr="Draw a polygon outline of n sides with extended parameters">
  1214. <Param name="Vector2 center" />
  1215. <Param name="int sides" />
  1216. <Param name="float radius" />
  1217. <Param name="float rotation" />
  1218. <Param name="float lineThick" />
  1219. <Param name="Color color" />
  1220. </Overload>
  1221. </KeyWord>
  1222. <!-- Basic shapes collision detection functions -->
  1223. <KeyWord name="CheckCollisionRecs" func="yes">
  1224. <Overload retVal="bool" descr="Check collision between two rectangles">
  1225. <Param name="Rectangle rec1" />
  1226. <Param name="Rectangle rec2" />
  1227. </Overload>
  1228. </KeyWord>
  1229. <KeyWord name="CheckCollisionCircles" func="yes">
  1230. <Overload retVal="bool" descr="Check collision between two circles">
  1231. <Param name="Vector2 center1" />
  1232. <Param name="float radius1" />
  1233. <Param name="Vector2 center2" />
  1234. <Param name="float radius2" />
  1235. </Overload>
  1236. </KeyWord>
  1237. <KeyWord name="CheckCollisionCircleRec" func="yes">
  1238. <Overload retVal="bool" descr="Check collision between circle and rectangle">
  1239. <Param name="Vector2 center" />
  1240. <Param name="float radius" />
  1241. <Param name="Rectangle rec" />
  1242. </Overload>
  1243. </KeyWord>
  1244. <KeyWord name="CheckCollisionPointRec" func="yes">
  1245. <Overload retVal="bool" descr="Check if point is inside rectangle">
  1246. <Param name="Vector2 point" />
  1247. <Param name="Rectangle rec" />
  1248. </Overload>
  1249. </KeyWord>
  1250. <KeyWord name="CheckCollisionPointCircle" func="yes">
  1251. <Overload retVal="bool" descr="Check if point is inside circle">
  1252. <Param name="Vector2 point" />
  1253. <Param name="Vector2 center" />
  1254. <Param name="float radius" />
  1255. </Overload>
  1256. </KeyWord>
  1257. <KeyWord name="CheckCollisionPointTriangle" func="yes">
  1258. <Overload retVal="bool" descr="Check if point is inside a triangle">
  1259. <Param name="Vector2 point" />
  1260. <Param name="Vector2 p1" />
  1261. <Param name="Vector2 p2" />
  1262. <Param name="Vector2 p3" />
  1263. </Overload>
  1264. </KeyWord>
  1265. <KeyWord name="CheckCollisionLines" func="yes">
  1266. <Overload retVal="bool" descr="Check the collision between two lines defined by two points each, returns collision point by reference">
  1267. <Param name="Vector2 startPos1" />
  1268. <Param name="Vector2 endPos1" />
  1269. <Param name="Vector2 startPos2" />
  1270. <Param name="Vector2 endPos2" />
  1271. <Param name="Vector2 *collisionPoint" />
  1272. </Overload>
  1273. </KeyWord>
  1274. <KeyWord name="CheckCollisionPointLine" func="yes">
  1275. <Overload retVal="bool" descr="Check if point belongs to line created between two points [p1] and [p2] with defined margin in pixels [threshold]">
  1276. <Param name="Vector2 point" />
  1277. <Param name="Vector2 p1" />
  1278. <Param name="Vector2 p2" />
  1279. <Param name="int threshold" />
  1280. </Overload>
  1281. </KeyWord>
  1282. <KeyWord name="GetCollisionRec" func="yes">
  1283. <Overload retVal="Rectangle" descr="Get collision rectangle for two rectangles collision">
  1284. <Param name="Rectangle rec1" />
  1285. <Param name="Rectangle rec2" />
  1286. </Overload>
  1287. </KeyWord>
  1288. <!-------------------------------------------------------------------------------------- -->
  1289. <!-- Texture Loading and Drawing Functions (Module: textures) -->
  1290. <!-------------------------------------------------------------------------------------- -->
  1291. <!-- Image loading functions -->
  1292. <!-- NOTE: This functions do not require GPU access -->
  1293. <KeyWord name="LoadImage" func="yes">
  1294. <Overload retVal="Image" descr="Load image from file into CPU memory (RAM)">
  1295. <Param name="const char *fileName" />
  1296. </Overload>
  1297. </KeyWord>
  1298. <KeyWord name="LoadImageRaw" func="yes">
  1299. <Overload retVal="Image" descr="Load image from RAW file data">
  1300. <Param name="const char *fileName" />
  1301. <Param name="int width" />
  1302. <Param name="int height" />
  1303. <Param name="int format" />
  1304. <Param name="int headerSize" />
  1305. </Overload>
  1306. </KeyWord>
  1307. <KeyWord name="LoadImageAnim" func="yes">
  1308. <Overload retVal="Image" descr="Load image sequence from file (frames appended to image.data)">
  1309. <Param name="const char *fileName" />
  1310. <Param name="int *frames" />
  1311. </Overload>
  1312. </KeyWord>
  1313. <KeyWord name="LoadImageFromMemory" func="yes">
  1314. <Overload retVal="Image" descr="Load image from memory buffer, fileType refers to extension: i.e. '.png'">
  1315. <Param name="const char *fileType" />
  1316. <Param name="const unsigned char" />
  1317. <Param name="int dataSize" />
  1318. </Overload>
  1319. </KeyWord>
  1320. <KeyWord name="LoadImageFromTexture" func="yes">
  1321. <Overload retVal="Image" descr="Load image from GPU texture data">
  1322. <Param name="Texture2D texture" />
  1323. </Overload>
  1324. </KeyWord>
  1325. <KeyWord name="LoadImageFromScreen" func="yes">
  1326. <Overload retVal="Image" descr="Load image from screen buffer and (screenshot)"></Overload>
  1327. </KeyWord>
  1328. <KeyWord name="UnloadImage" func="yes">
  1329. <Overload retVal="void" descr="Unload image from CPU memory (RAM)">
  1330. <Param name="Image image" />
  1331. </Overload>
  1332. </KeyWord>
  1333. <KeyWord name="ExportImage" func="yes">
  1334. <Overload retVal="bool" descr="Export image data to file, returns true on success">
  1335. <Param name="Image image" />
  1336. <Param name="const char *fileName" />
  1337. </Overload>
  1338. </KeyWord>
  1339. <KeyWord name="ExportImageAsCode" func="yes">
  1340. <Overload retVal="bool" descr="Export image as code file defining an array of bytes, returns true on success">
  1341. <Param name="Image image" />
  1342. <Param name="const char *fileName" />
  1343. </Overload>
  1344. </KeyWord>
  1345. <!-- Image generation functions -->
  1346. <KeyWord name="GenImageColor" func="yes">
  1347. <Overload retVal="Image" descr="Generate image: plain color">
  1348. <Param name="int width" />
  1349. <Param name="int height" />
  1350. <Param name="Color color" />
  1351. </Overload>
  1352. </KeyWord>
  1353. <KeyWord name="GenImageGradientV" func="yes">
  1354. <Overload retVal="Image" descr="Generate image: vertical gradient">
  1355. <Param name="int width" />
  1356. <Param name="int height" />
  1357. <Param name="Color top" />
  1358. <Param name="Color bottom" />
  1359. </Overload>
  1360. </KeyWord>
  1361. <KeyWord name="GenImageGradientH" func="yes">
  1362. <Overload retVal="Image" descr="Generate image: horizontal gradient">
  1363. <Param name="int width" />
  1364. <Param name="int height" />
  1365. <Param name="Color left" />
  1366. <Param name="Color right" />
  1367. </Overload>
  1368. </KeyWord>
  1369. <KeyWord name="GenImageGradientRadial" func="yes">
  1370. <Overload retVal="Image" descr="Generate image: radial gradient">
  1371. <Param name="int width" />
  1372. <Param name="int height" />
  1373. <Param name="float density" />
  1374. <Param name="Color inner" />
  1375. <Param name="Color outer" />
  1376. </Overload>
  1377. </KeyWord>
  1378. <KeyWord name="GenImageChecked" func="yes">
  1379. <Overload retVal="Image" descr="Generate image: checked">
  1380. <Param name="int width" />
  1381. <Param name="int height" />
  1382. <Param name="int checksX" />
  1383. <Param name="int checksY" />
  1384. <Param name="Color col1" />
  1385. <Param name="Color col2" />
  1386. </Overload>
  1387. </KeyWord>
  1388. <KeyWord name="GenImageWhiteNoise" func="yes">
  1389. <Overload retVal="Image" descr="Generate image: white noise">
  1390. <Param name="int width" />
  1391. <Param name="int height" />
  1392. <Param name="float factor" />
  1393. </Overload>
  1394. </KeyWord>
  1395. <KeyWord name="GenImageCellular" func="yes">
  1396. <Overload retVal="Image" descr="Generate image: cellular algorithm, bigger tileSize means bigger cells">
  1397. <Param name="int width" />
  1398. <Param name="int height" />
  1399. <Param name="int tileSize" />
  1400. </Overload>
  1401. </KeyWord>
  1402. <!-- Image manipulation functions -->
  1403. <KeyWord name="ImageCopy" func="yes">
  1404. <Overload retVal="Image" descr="Create an image duplicate (useful for transformations)">
  1405. <Param name="Image image" />
  1406. </Overload>
  1407. </KeyWord>
  1408. <KeyWord name="ImageFromImage" func="yes">
  1409. <Overload retVal="Image" descr="Create an image from another image piece">
  1410. <Param name="Image image" />
  1411. <Param name="Rectangle rec" />
  1412. </Overload>
  1413. </KeyWord>
  1414. <KeyWord name="ImageText" func="yes">
  1415. <Overload retVal="Image" descr="Create an image from text (default font)">
  1416. <Param name="const char *text" />
  1417. <Param name="int fontSize" />
  1418. <Param name="Color color" />
  1419. </Overload>
  1420. </KeyWord>
  1421. <KeyWord name="ImageTextEx" func="yes">
  1422. <Overload retVal="Image" descr="Create an image from text (custom sprite font)">
  1423. <Param name="Font font" />
  1424. <Param name="const char *text" />
  1425. <Param name="float fontSize" />
  1426. <Param name="float spacing" />
  1427. <Param name="Color tint" />
  1428. </Overload>
  1429. </KeyWord>
  1430. <KeyWord name="ImageFormat" func="yes">
  1431. <Overload retVal="void" descr="Convert image data to desired format">
  1432. <Param name="Image *image" />
  1433. <Param name="int newFormat" />
  1434. </Overload>
  1435. </KeyWord>
  1436. <KeyWord name="ImageToPOT" func="yes">
  1437. <Overload retVal="void" descr="Convert image to POT (power-of-two)">
  1438. <Param name="Image *image" />
  1439. <Param name="Color fill" />
  1440. </Overload>
  1441. </KeyWord>
  1442. <KeyWord name="ImageCrop" func="yes">
  1443. <Overload retVal="void" descr="Crop an image to a defined rectangle">
  1444. <Param name="Image *image" />
  1445. <Param name="Rectangle crop" />
  1446. </Overload>
  1447. </KeyWord>
  1448. <KeyWord name="ImageAlphaCrop" func="yes">
  1449. <Overload retVal="void" descr="Crop image depending on alpha value">
  1450. <Param name="Image *image" />
  1451. <Param name="float threshold" />
  1452. </Overload>
  1453. </KeyWord>
  1454. <KeyWord name="ImageAlphaClear" func="yes">
  1455. <Overload retVal="void" descr="Clear alpha channel to desired color">
  1456. <Param name="Image *image" />
  1457. <Param name="Color color" />
  1458. <Param name="float threshold" />
  1459. </Overload>
  1460. </KeyWord>
  1461. <KeyWord name="ImageAlphaMask" func="yes">
  1462. <Overload retVal="void" descr="Apply alpha mask to image">
  1463. <Param name="Image *image" />
  1464. <Param name="Image alphaMask" />
  1465. </Overload>
  1466. </KeyWord>
  1467. <KeyWord name="ImageAlphaPremultiply" func="yes">
  1468. <Overload retVal="void" descr="Premultiply alpha channel">
  1469. <Param name="Image *image" />
  1470. </Overload>
  1471. </KeyWord>
  1472. <KeyWord name="ImageResize" func="yes">
  1473. <Overload retVal="void" descr="Resize image (Bicubic scaling algorithm)">
  1474. <Param name="Image *image" />
  1475. <Param name="int newWidth" />
  1476. <Param name="int newHeight" />
  1477. </Overload>
  1478. </KeyWord>
  1479. <KeyWord name="ImageResizeNN" func="yes">
  1480. <Overload retVal="void" descr="Resize image (Nearest-Neighbor scaling algorithm)">
  1481. <Param name="Image *image" />
  1482. <Param name="int newWidth" />
  1483. <Param name="int newHeight" />
  1484. </Overload>
  1485. </KeyWord>
  1486. <KeyWord name="ImageResizeCanvas" func="yes">
  1487. <Overload retVal="void" descr="Resize canvas and fill with color">
  1488. <Param name="Image *image" />
  1489. <Param name="int newWidth" />
  1490. <Param name="int newHeight" />
  1491. <Param name="int offsetX" />
  1492. <Param name="int offsetY" />
  1493. <Param name="Color fill" />
  1494. </Overload>
  1495. </KeyWord>
  1496. <KeyWord name="ImageMipmaps" func="yes">
  1497. <Overload retVal="void" descr="Compute all mipmap levels for a provided image">
  1498. <Param name="Image *image" />
  1499. </Overload>
  1500. </KeyWord>
  1501. <KeyWord name="ImageDither" func="yes">
  1502. <Overload retVal="void" descr="Dither image data to 16bpp or lower (Floyd-Steinberg dithering)">
  1503. <Param name="Image *image" />
  1504. <Param name="int rBpp" />
  1505. <Param name="int gBpp" />
  1506. <Param name="int bBpp" />
  1507. <Param name="int aBpp" />
  1508. </Overload>
  1509. </KeyWord>
  1510. <KeyWord name="ImageFlipVertical" func="yes">
  1511. <Overload retVal="void" descr="Flip image vertically">
  1512. <Param name="Image *image" />
  1513. </Overload>
  1514. </KeyWord>
  1515. <KeyWord name="ImageFlipHorizontal" func="yes">
  1516. <Overload retVal="void" descr="Flip image horizontally">
  1517. <Param name="Image *image" />
  1518. </Overload>
  1519. </KeyWord>
  1520. <KeyWord name="ImageRotateCW" func="yes">
  1521. <Overload retVal="void" descr="Rotate image clockwise 90deg">
  1522. <Param name="Image *image" />
  1523. </Overload>
  1524. </KeyWord>
  1525. <KeyWord name="ImageRotateCCW" func="yes">
  1526. <Overload retVal="void" descr="Rotate image counter-clockwise 90deg">
  1527. <Param name="Image *image" />
  1528. </Overload>
  1529. </KeyWord>
  1530. <KeyWord name="ImageColorTint" func="yes">
  1531. <Overload retVal="void" descr="Modify image color: tint">
  1532. <Param name="Image *image" />
  1533. <Param name="Color color" />
  1534. </Overload>
  1535. </KeyWord>
  1536. <KeyWord name="ImageColorInvert" func="yes">
  1537. <Overload retVal="void" descr="Modify image color: invert">
  1538. <Param name="Image *image" />
  1539. </Overload>
  1540. </KeyWord>
  1541. <KeyWord name="ImageColorGrayscale" func="yes">
  1542. <Overload retVal="void" descr="Modify image color: grayscale">
  1543. <Param name="Image *image" />
  1544. </Overload>
  1545. </KeyWord>
  1546. <KeyWord name="ImageColorContrast" func="yes">
  1547. <Overload retVal="void" descr="Modify image color: contrast (-100 to 100)">
  1548. <Param name="Image *image" />
  1549. <Param name="float contrast" />
  1550. </Overload>
  1551. </KeyWord>
  1552. <KeyWord name="ImageColorBrightness" func="yes">
  1553. <Overload retVal="void" descr="Modify image color: brightness (-255 to 255)">
  1554. <Param name="Image *image" />
  1555. <Param name="int brightness" />
  1556. </Overload>
  1557. </KeyWord>
  1558. <KeyWord name="ImageColorReplace" func="yes">
  1559. <Overload retVal="void" descr="Modify image color: replace color">
  1560. <Param name="Image *image" />
  1561. <Param name="Color color" />
  1562. <Param name="Color replace" />
  1563. </Overload>
  1564. </KeyWord>
  1565. <KeyWord name="LoadImageColors" func="yes">
  1566. <Overload retVal="Color" descr="Load color data from image as a Color array (RGBA - 32bit)">
  1567. <Param name="Image image" />
  1568. </Overload>
  1569. </KeyWord>
  1570. <KeyWord name="LoadImagePalette" func="yes">
  1571. <Overload retVal="Color" descr="Load colors palette from image as a Color array (RGBA - 32bit)">
  1572. <Param name="Image image" />
  1573. <Param name="int maxPaletteSize" />
  1574. <Param name="int *colorCount" />
  1575. </Overload>
  1576. </KeyWord>
  1577. <KeyWord name="UnloadImageColors" func="yes">
  1578. <Overload retVal="void" descr="Unload color data loaded with LoadImageColors()">
  1579. <Param name="Color *colors" />
  1580. </Overload>
  1581. </KeyWord>
  1582. <KeyWord name="UnloadImagePalette" func="yes">
  1583. <Overload retVal="void" descr="Unload colors palette loaded with LoadImagePalette()">
  1584. <Param name="Color *colors" />
  1585. </Overload>
  1586. </KeyWord>
  1587. <KeyWord name="GetImageAlphaBorder" func="yes">
  1588. <Overload retVal="Rectangle" descr="Get image alpha border rectangle">
  1589. <Param name="Image image" />
  1590. <Param name="float threshold" />
  1591. </Overload>
  1592. </KeyWord>
  1593. <KeyWord name="GetImageColor" func="yes">
  1594. <Overload retVal="Color" descr="Get image pixel color at (x, y) position">
  1595. <Param name="Image image" />
  1596. <Param name="int x" />
  1597. <Param name="int y" />
  1598. </Overload>
  1599. </KeyWord>
  1600. <!-- Image drawing functions -->
  1601. <!-- NOTE: Image software-rendering functions (CPU) -->
  1602. <KeyWord name="ImageClearBackground" func="yes">
  1603. <Overload retVal="void" descr="Clear image background with given color">
  1604. <Param name="Image *dst" />
  1605. <Param name="Color color" />
  1606. </Overload>
  1607. </KeyWord>
  1608. <KeyWord name="ImageDrawPixel" func="yes">
  1609. <Overload retVal="void" descr="Draw pixel within an image">
  1610. <Param name="Image *dst" />
  1611. <Param name="int posX" />
  1612. <Param name="int posY" />
  1613. <Param name="Color color" />
  1614. </Overload>
  1615. </KeyWord>
  1616. <KeyWord name="ImageDrawPixelV" func="yes">
  1617. <Overload retVal="void" descr="Draw pixel within an image (Vector version)">
  1618. <Param name="Image *dst" />
  1619. <Param name="Vector2 position" />
  1620. <Param name="Color color" />
  1621. </Overload>
  1622. </KeyWord>
  1623. <KeyWord name="ImageDrawLine" func="yes">
  1624. <Overload retVal="void" descr="Draw line within an image">
  1625. <Param name="Image *dst" />
  1626. <Param name="int startPosX" />
  1627. <Param name="int startPosY" />
  1628. <Param name="int endPosX" />
  1629. <Param name="int endPosY" />
  1630. <Param name="Color color" />
  1631. </Overload>
  1632. </KeyWord>
  1633. <KeyWord name="ImageDrawLineV" func="yes">
  1634. <Overload retVal="void" descr="Draw line within an image (Vector version)">
  1635. <Param name="Image *dst" />
  1636. <Param name="Vector2 start" />
  1637. <Param name="Vector2 end" />
  1638. <Param name="Color color" />
  1639. </Overload>
  1640. </KeyWord>
  1641. <KeyWord name="ImageDrawCircle" func="yes">
  1642. <Overload retVal="void" descr="Draw circle within an image">
  1643. <Param name="Image *dst" />
  1644. <Param name="int centerX" />
  1645. <Param name="int centerY" />
  1646. <Param name="int radius" />
  1647. <Param name="Color color" />
  1648. </Overload>
  1649. </KeyWord>
  1650. <KeyWord name="ImageDrawCircleV" func="yes">
  1651. <Overload retVal="void" descr="Draw circle within an image (Vector version)">
  1652. <Param name="Image *dst" />
  1653. <Param name="Vector2 center" />
  1654. <Param name="int radius" />
  1655. <Param name="Color color" />
  1656. </Overload>
  1657. </KeyWord>
  1658. <KeyWord name="ImageDrawRectangle" func="yes">
  1659. <Overload retVal="void" descr="Draw rectangle within an image">
  1660. <Param name="Image *dst" />
  1661. <Param name="int posX" />
  1662. <Param name="int posY" />
  1663. <Param name="int width" />
  1664. <Param name="int height" />
  1665. <Param name="Color color" />
  1666. </Overload>
  1667. </KeyWord>
  1668. <KeyWord name="ImageDrawRectangleV" func="yes">
  1669. <Overload retVal="void" descr="Draw rectangle within an image (Vector version)">
  1670. <Param name="Image *dst" />
  1671. <Param name="Vector2 position" />
  1672. <Param name="Vector2 size" />
  1673. <Param name="Color color" />
  1674. </Overload>
  1675. </KeyWord>
  1676. <KeyWord name="ImageDrawRectangleRec" func="yes">
  1677. <Overload retVal="void" descr="Draw rectangle within an image">
  1678. <Param name="Image *dst" />
  1679. <Param name="Rectangle rec" />
  1680. <Param name="Color color" />
  1681. </Overload>
  1682. </KeyWord>
  1683. <KeyWord name="ImageDrawRectangleLines" func="yes">
  1684. <Overload retVal="void" descr="Draw rectangle lines within an image">
  1685. <Param name="Image *dst" />
  1686. <Param name="Rectangle rec" />
  1687. <Param name="int thick" />
  1688. <Param name="Color color" />
  1689. </Overload>
  1690. </KeyWord>
  1691. <KeyWord name="ImageDraw" func="yes">
  1692. <Overload retVal="void" descr="Draw a source image within a destination image (tint applied to source)">
  1693. <Param name="Image *dst" />
  1694. <Param name="Image src" />
  1695. <Param name="Rectangle srcRec" />
  1696. <Param name="Rectangle dstRec" />
  1697. <Param name="Color tint" />
  1698. </Overload>
  1699. </KeyWord>
  1700. <KeyWord name="ImageDrawText" func="yes">
  1701. <Overload retVal="void" descr="Draw text (using default font) within an image (destination)">
  1702. <Param name="Image *dst" />
  1703. <Param name="const char *text" />
  1704. <Param name="int posX" />
  1705. <Param name="int posY" />
  1706. <Param name="int fontSize" />
  1707. <Param name="Color color" />
  1708. </Overload>
  1709. </KeyWord>
  1710. <KeyWord name="ImageDrawTextEx" func="yes">
  1711. <Overload retVal="void" descr="Draw text (custom sprite font) within an image (destination)">
  1712. <Param name="Image *dst" />
  1713. <Param name="Font font" />
  1714. <Param name="const char *text" />
  1715. <Param name="Vector2 position" />
  1716. <Param name="float fontSize" />
  1717. <Param name="float spacing" />
  1718. <Param name="Color tint" />
  1719. </Overload>
  1720. </KeyWord>
  1721. <!-- Texture loading functions -->
  1722. <!-- NOTE: These functions require GPU access -->
  1723. <KeyWord name="LoadTexture" func="yes">
  1724. <Overload retVal="Texture2D" descr="Load texture from file into GPU memory (VRAM)">
  1725. <Param name="const char *fileName" />
  1726. </Overload>
  1727. </KeyWord>
  1728. <KeyWord name="LoadTextureFromImage" func="yes">
  1729. <Overload retVal="Texture2D" descr="Load texture from image data">
  1730. <Param name="Image image" />
  1731. </Overload>
  1732. </KeyWord>
  1733. <KeyWord name="LoadTextureCubemap" func="yes">
  1734. <Overload retVal="TextureCubemap" descr="Load cubemap from image, multiple image cubemap layouts supported">
  1735. <Param name="Image image" />
  1736. <Param name="int layout" />
  1737. </Overload>
  1738. </KeyWord>
  1739. <KeyWord name="LoadRenderTexture" func="yes">
  1740. <Overload retVal="RenderTexture2D" descr="Load texture for rendering (framebuffer)">
  1741. <Param name="int width" />
  1742. <Param name="int height" />
  1743. </Overload>
  1744. </KeyWord>
  1745. <KeyWord name="UnloadTexture" func="yes">
  1746. <Overload retVal="void" descr="Unload texture from GPU memory (VRAM)">
  1747. <Param name="Texture2D texture" />
  1748. </Overload>
  1749. </KeyWord>
  1750. <KeyWord name="UnloadRenderTexture" func="yes">
  1751. <Overload retVal="void" descr="Unload render texture from GPU memory (VRAM)">
  1752. <Param name="RenderTexture2D target" />
  1753. </Overload>
  1754. </KeyWord>
  1755. <KeyWord name="UpdateTexture" func="yes">
  1756. <Overload retVal="void" descr="Update GPU texture with new data">
  1757. <Param name="Texture2D texture" />
  1758. <Param name="const void *pixels" />
  1759. </Overload>
  1760. </KeyWord>
  1761. <KeyWord name="UpdateTextureRec" func="yes">
  1762. <Overload retVal="void" descr="Update GPU texture rectangle with new data">
  1763. <Param name="Texture2D texture" />
  1764. <Param name="Rectangle rec" />
  1765. <Param name="const void *pixels" />
  1766. </Overload>
  1767. </KeyWord>
  1768. <!-- Texture configuration functions -->
  1769. <KeyWord name="GenTextureMipmaps" func="yes">
  1770. <Overload retVal="void" descr="Generate GPU mipmaps for a texture">
  1771. <Param name="Texture2D *texture" />
  1772. </Overload>
  1773. </KeyWord>
  1774. <KeyWord name="SetTextureFilter" func="yes">
  1775. <Overload retVal="void" descr="Set texture scaling filter mode">
  1776. <Param name="Texture2D texture" />
  1777. <Param name="int filter" />
  1778. </Overload>
  1779. </KeyWord>
  1780. <KeyWord name="SetTextureWrap" func="yes">
  1781. <Overload retVal="void" descr="Set texture wrapping mode">
  1782. <Param name="Texture2D texture" />
  1783. <Param name="int wrap" />
  1784. </Overload>
  1785. </KeyWord>
  1786. <!-- Texture drawing functions -->
  1787. <KeyWord name="DrawTexture" func="yes">
  1788. <Overload retVal="void" descr="Draw a Texture2D">
  1789. <Param name="Texture2D texture" />
  1790. <Param name="int posX" />
  1791. <Param name="int posY" />
  1792. <Param name="Color tint" />
  1793. </Overload>
  1794. </KeyWord>
  1795. <KeyWord name="DrawTextureV" func="yes">
  1796. <Overload retVal="void" descr="Draw a Texture2D with position defined as Vector2">
  1797. <Param name="Texture2D texture" />
  1798. <Param name="Vector2 position" />
  1799. <Param name="Color tint" />
  1800. </Overload>
  1801. </KeyWord>
  1802. <KeyWord name="DrawTextureEx" func="yes">
  1803. <Overload retVal="void" descr="Draw a Texture2D with extended parameters">
  1804. <Param name="Texture2D texture" />
  1805. <Param name="Vector2 position" />
  1806. <Param name="float rotation" />
  1807. <Param name="float scale" />
  1808. <Param name="Color tint" />
  1809. </Overload>
  1810. </KeyWord>
  1811. <KeyWord name="DrawTextureRec" func="yes">
  1812. <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle">
  1813. <Param name="Texture2D texture" />
  1814. <Param name="Rectangle source" />
  1815. <Param name="Vector2 position" />
  1816. <Param name="Color tint" />
  1817. </Overload>
  1818. </KeyWord>
  1819. <KeyWord name="DrawTextureQuad" func="yes">
  1820. <Overload retVal="void" descr="Draw texture quad with tiling and offset parameters">
  1821. <Param name="Texture2D texture" />
  1822. <Param name="Vector2 tiling" />
  1823. <Param name="Vector2 offset" />
  1824. <Param name="Rectangle quad" />
  1825. <Param name="Color tint" />
  1826. </Overload>
  1827. </KeyWord>
  1828. <KeyWord name="DrawTextureTiled" func="yes">
  1829. <Overload retVal="void" descr="Draw part of a texture (defined by a rectangle) with rotation and scale tiled into dest.">
  1830. <Param name="Texture2D texture" />
  1831. <Param name="Rectangle source" />
  1832. <Param name="Rectangle dest" />
  1833. <Param name="Vector2 origin" />
  1834. <Param name="float rotation" />
  1835. <Param name="float scale" />
  1836. <Param name="Color tint" />
  1837. </Overload>
  1838. </KeyWord>
  1839. <KeyWord name="DrawTexturePro" func="yes">
  1840. <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle with 'pro' parameters">
  1841. <Param name="Texture2D texture" />
  1842. <Param name="Rectangle source" />
  1843. <Param name="Rectangle dest" />
  1844. <Param name="Vector2 origin" />
  1845. <Param name="float rotation" />
  1846. <Param name="Color tint" />
  1847. </Overload>
  1848. </KeyWord>
  1849. <KeyWord name="DrawTextureNPatch" func="yes">
  1850. <Overload retVal="void" descr="Draws a texture (or part of it) that stretches or shrinks nicely">
  1851. <Param name="Texture2D texture" />
  1852. <Param name="NPatchInfo nPatchInfo" />
  1853. <Param name="Rectangle dest" />
  1854. <Param name="Vector2 origin" />
  1855. <Param name="float rotation" />
  1856. <Param name="Color tint" />
  1857. </Overload>
  1858. </KeyWord>
  1859. <KeyWord name="DrawTexturePoly" func="yes">
  1860. <Overload retVal="void" descr="Draw a textured polygon">
  1861. <Param name="Texture2D texture" />
  1862. <Param name="Vector2 center" />
  1863. <Param name="Vector2 *points" />
  1864. <Param name="Vector2 *texcoords" />
  1865. <Param name="int pointCount" />
  1866. <Param name="Color tint" />
  1867. </Overload>
  1868. </KeyWord>
  1869. <!-- Color/pixel related functions -->
  1870. <KeyWord name="Fade" func="yes">
  1871. <Overload retVal="Color" descr="Get color with alpha applied, alpha goes from 0.0f to 1.0f">
  1872. <Param name="Color color" />
  1873. <Param name="float alpha" />
  1874. </Overload>
  1875. </KeyWord>
  1876. <KeyWord name="ColorToInt" func="yes">
  1877. <Overload retVal="int" descr="Get hexadecimal value for a Color">
  1878. <Param name="Color color" />
  1879. </Overload>
  1880. </KeyWord>
  1881. <KeyWord name="ColorNormalize" func="yes">
  1882. <Overload retVal="Vector4" descr="Get Color normalized as float [0..1]">
  1883. <Param name="Color color" />
  1884. </Overload>
  1885. </KeyWord>
  1886. <KeyWord name="ColorFromNormalized" func="yes">
  1887. <Overload retVal="Color" descr="Get Color from normalized values [0..1]">
  1888. <Param name="Vector4 normalized" />
  1889. </Overload>
  1890. </KeyWord>
  1891. <KeyWord name="ColorToHSV" func="yes">
  1892. <Overload retVal="Vector3" descr="Get HSV values for a Color, hue [0..360], saturation/value [0..1]">
  1893. <Param name="Color color" />
  1894. </Overload>
  1895. </KeyWord>
  1896. <KeyWord name="ColorFromHSV" func="yes">
  1897. <Overload retVal="Color" descr="Get a Color from HSV values, hue [0..360], saturation/value [0..1]">
  1898. <Param name="float hue" />
  1899. <Param name="float saturation" />
  1900. <Param name="float value" />
  1901. </Overload>
  1902. </KeyWord>
  1903. <KeyWord name="ColorAlpha" func="yes">
  1904. <Overload retVal="Color" descr="Get color with alpha applied, alpha goes from 0.0f to 1.0f">
  1905. <Param name="Color color" />
  1906. <Param name="float alpha" />
  1907. </Overload>
  1908. </KeyWord>
  1909. <KeyWord name="ColorAlphaBlend" func="yes">
  1910. <Overload retVal="Color" descr="Get src alpha-blended into dst color with tint">
  1911. <Param name="Color dst" />
  1912. <Param name="Color src" />
  1913. <Param name="Color tint" />
  1914. </Overload>
  1915. </KeyWord>
  1916. <KeyWord name="GetColor" func="yes">
  1917. <Overload retVal="Color" descr="Get Color structure from hexadecimal value">
  1918. <Param name="unsigned int hexValue" />
  1919. </Overload>
  1920. </KeyWord>
  1921. <KeyWord name="GetPixelColor" func="yes">
  1922. <Overload retVal="Color" descr="Get Color from a source pixel pointer of certain format"></Overload>
  1923. </KeyWord>
  1924. <KeyWord name="SetPixelColor" func="yes">
  1925. <Overload retVal="void" descr="Set color formatted into destination pixel pointer"></Overload>
  1926. </KeyWord>
  1927. <KeyWord name="GetPixelDataSize" func="yes">
  1928. <Overload retVal="int" descr="Get pixel data size in bytes for certain format">
  1929. <Param name="int width" />
  1930. <Param name="int height" />
  1931. <Param name="int format" />
  1932. </Overload>
  1933. </KeyWord>
  1934. <!-------------------------------------------------------------------------------------- -->
  1935. <!-- Font Loading and Text Drawing Functions (Module: text) -->
  1936. <!-------------------------------------------------------------------------------------- -->
  1937. <!-- Font loading/unloading functions -->
  1938. <KeyWord name="GetFontDefault" func="yes">
  1939. <Overload retVal="Font" descr="Get the default Font"></Overload>
  1940. </KeyWord>
  1941. <KeyWord name="LoadFont" func="yes">
  1942. <Overload retVal="Font" descr="Load font from file into GPU memory (VRAM)">
  1943. <Param name="const char *fileName" />
  1944. </Overload>
  1945. </KeyWord>
  1946. <KeyWord name="LoadFontEx" func="yes">
  1947. <Overload retVal="Font" descr="Load font from file with extended parameters, use NULL for fontChars and 0 for glyphCount to load the default character set">
  1948. <Param name="const char *fileName" />
  1949. <Param name="int fontSize" />
  1950. <Param name="int *fontChars" />
  1951. <Param name="int glyphCount" />
  1952. </Overload>
  1953. </KeyWord>
  1954. <KeyWord name="LoadFontFromImage" func="yes">
  1955. <Overload retVal="Font" descr="Load font from Image (XNA style)">
  1956. <Param name="Image image" />
  1957. <Param name="Color key" />
  1958. <Param name="int firstChar" />
  1959. </Overload>
  1960. </KeyWord>
  1961. <KeyWord name="LoadFontFromMemory" func="yes">
  1962. <Overload retVal="Font" descr="Load font from memory buffer, fileType refers to extension: i.e. '.ttf'">
  1963. <Param name="const char *fileType" />
  1964. <Param name="const unsigned char" />
  1965. <Param name="int dataSize" />
  1966. <Param name="int fontSize" />
  1967. <Param name="int *fontChars" />
  1968. <Param name="int glyphCount" />
  1969. </Overload>
  1970. </KeyWord>
  1971. <KeyWord name="LoadFontData" func="yes">
  1972. <Overload retVal="GlyphInfo" descr="Load font data for further use">
  1973. <Param name="const unsigned char" />
  1974. <Param name="int dataSize" />
  1975. <Param name="int fontSize" />
  1976. <Param name="int *fontChars" />
  1977. <Param name="int glyphCount" />
  1978. <Param name="int type" />
  1979. </Overload>
  1980. </KeyWord>
  1981. <KeyWord name="GenImageFontAtlas" func="yes">
  1982. <Overload retVal="Image" descr="Generate image font atlas using chars info">
  1983. <Param name="const GlyphInfo *chars" />
  1984. <Param name="Rectangle **recs" />
  1985. <Param name="int glyphCount" />
  1986. <Param name="int fontSize" />
  1987. <Param name="int padding" />
  1988. <Param name="int packMethod" />
  1989. </Overload>
  1990. </KeyWord>
  1991. <KeyWord name="UnloadFontData" func="yes">
  1992. <Overload retVal="void" descr="Unload font chars info data (RAM)">
  1993. <Param name="GlyphInfo *chars" />
  1994. <Param name="int glyphCount" />
  1995. </Overload>
  1996. </KeyWord>
  1997. <KeyWord name="UnloadFont" func="yes">
  1998. <Overload retVal="void" descr="Unload font from GPU memory (VRAM)">
  1999. <Param name="Font font" />
  2000. </Overload>
  2001. </KeyWord>
  2002. <KeyWord name="ExportFontAsCode" func="yes">
  2003. <Overload retVal="bool" descr="Export font as code file, returns true on success">
  2004. <Param name="Font font" />
  2005. <Param name="const char *fileName" />
  2006. </Overload>
  2007. </KeyWord>
  2008. <!-- Text drawing functions -->
  2009. <KeyWord name="DrawFPS" func="yes">
  2010. <Overload retVal="void" descr="Draw current FPS">
  2011. <Param name="int posX" />
  2012. <Param name="int posY" />
  2013. </Overload>
  2014. </KeyWord>
  2015. <KeyWord name="DrawText" func="yes">
  2016. <Overload retVal="void" descr="Draw text (using default font)">
  2017. <Param name="const char *text" />
  2018. <Param name="int posX" />
  2019. <Param name="int posY" />
  2020. <Param name="int fontSize" />
  2021. <Param name="Color color" />
  2022. </Overload>
  2023. </KeyWord>
  2024. <KeyWord name="DrawTextEx" func="yes">
  2025. <Overload retVal="void" descr="Draw text using font and additional parameters">
  2026. <Param name="Font font" />
  2027. <Param name="const char *text" />
  2028. <Param name="Vector2 position" />
  2029. <Param name="float fontSize" />
  2030. <Param name="float spacing" />
  2031. <Param name="Color tint" />
  2032. </Overload>
  2033. </KeyWord>
  2034. <KeyWord name="DrawTextPro" func="yes">
  2035. <Overload retVal="void" descr="Draw text using Font and pro parameters (rotation)">
  2036. <Param name="Font font" />
  2037. <Param name="const char *text" />
  2038. <Param name="Vector2 position" />
  2039. <Param name="Vector2 origin" />
  2040. <Param name="float rotation" />
  2041. <Param name="float fontSize" />
  2042. <Param name="float spacing" />
  2043. <Param name="Color tint" />
  2044. </Overload>
  2045. </KeyWord>
  2046. <KeyWord name="DrawTextCodepoint" func="yes">
  2047. <Overload retVal="void" descr="Draw one character (codepoint)">
  2048. <Param name="Font font" />
  2049. <Param name="int codepoint" />
  2050. <Param name="Vector2 position" />
  2051. <Param name="float fontSize" />
  2052. <Param name="Color tint" />
  2053. </Overload>
  2054. </KeyWord>
  2055. <KeyWord name="DrawTextCodepoints" func="yes">
  2056. <Overload retVal="void" descr="Draw multiple character (codepoint)">
  2057. <Param name="Font font" />
  2058. <Param name="const int *codepoints" />
  2059. <Param name="int count" />
  2060. <Param name="Vector2 position" />
  2061. <Param name="float fontSize" />
  2062. <Param name="float spacing" />
  2063. <Param name="Color tint" />
  2064. </Overload>
  2065. </KeyWord>
  2066. <!-- Text font info functions -->
  2067. <KeyWord name="MeasureText" func="yes">
  2068. <Overload retVal="int" descr="Measure string width for default font">
  2069. <Param name="const char *text" />
  2070. <Param name="int fontSize" />
  2071. </Overload>
  2072. </KeyWord>
  2073. <KeyWord name="MeasureTextEx" func="yes">
  2074. <Overload retVal="Vector2" descr="Measure string size for Font">
  2075. <Param name="Font font" />
  2076. <Param name="const char *text" />
  2077. <Param name="float fontSize" />
  2078. <Param name="float spacing" />
  2079. </Overload>
  2080. </KeyWord>
  2081. <KeyWord name="GetGlyphIndex" func="yes">
  2082. <Overload retVal="int" descr="Get glyph index position in font for a codepoint (unicode character), fallback to '?' if not found">
  2083. <Param name="Font font" />
  2084. <Param name="int codepoint" />
  2085. </Overload>
  2086. </KeyWord>
  2087. <KeyWord name="GetGlyphInfo" func="yes">
  2088. <Overload retVal="GlyphInfo" descr="Get glyph font info data for a codepoint (unicode character), fallback to '?' if not found">
  2089. <Param name="Font font" />
  2090. <Param name="int codepoint" />
  2091. </Overload>
  2092. </KeyWord>
  2093. <KeyWord name="GetGlyphAtlasRec" func="yes">
  2094. <Overload retVal="Rectangle" descr="Get glyph rectangle in font atlas for a codepoint (unicode character), fallback to '?' if not found">
  2095. <Param name="Font font" />
  2096. <Param name="int codepoint" />
  2097. </Overload>
  2098. </KeyWord>
  2099. <!-- Text codepoints management functions (unicode characters) -->
  2100. <KeyWord name="LoadCodepoints" func="yes">
  2101. <Overload retVal="int" descr="Load all codepoints from a UTF-8 text string, codepoints count returned by parameter">
  2102. <Param name="const char *text" />
  2103. <Param name="int *count" />
  2104. </Overload>
  2105. </KeyWord>
  2106. <KeyWord name="UnloadCodepoints" func="yes">
  2107. <Overload retVal="void" descr="Unload codepoints data from memory">
  2108. <Param name="int *codepoints" />
  2109. </Overload>
  2110. </KeyWord>
  2111. <KeyWord name="GetCodepointCount" func="yes">
  2112. <Overload retVal="int" descr="Get total number of codepoints in a UTF-8 encoded string">
  2113. <Param name="const char *text" />
  2114. </Overload>
  2115. </KeyWord>
  2116. <KeyWord name="GetCodepoint" func="yes">
  2117. <Overload retVal="int" descr="Get next codepoint in a UTF-8 encoded string, 0x3f('?') is returned on failure">
  2118. <Param name="const char *text" />
  2119. <Param name="int *bytesProcessed" />
  2120. </Overload>
  2121. </KeyWord>
  2122. <KeyWord name="CodepointToUTF8" func="yes">
  2123. <Overload retVal="const char" descr="Encode one codepoint into UTF-8 byte array (array length returned as parameter)">
  2124. <Param name="int codepoint" />
  2125. <Param name="int *byteSize" />
  2126. </Overload>
  2127. </KeyWord>
  2128. <KeyWord name="TextCodepointsToUTF8" func="yes">
  2129. <Overload retVal="char" descr="Encode text as codepoints array into UTF-8 text string (WARNING: memory must be freed!)">
  2130. <Param name="const int *codepoints" />
  2131. <Param name="int length" />
  2132. </Overload>
  2133. </KeyWord>
  2134. <!-- Text strings management functions (no UTF-8 strings, only byte chars) -->
  2135. <!-- NOTE: Some strings allocate memory internally for returned strings, just be careful! -->
  2136. <KeyWord name="TextCopy" func="yes">
  2137. <Overload retVal="int" descr="Copy one string to another, returns bytes copied">
  2138. <Param name="char *dst" />
  2139. <Param name="const char *src" />
  2140. </Overload>
  2141. </KeyWord>
  2142. <KeyWord name="TextIsEqual" func="yes">
  2143. <Overload retVal="bool" descr="Check if two text string are equal">
  2144. <Param name="const char *text1" />
  2145. <Param name="const char *text2" />
  2146. </Overload>
  2147. </KeyWord>
  2148. <KeyWord name="int TextLength" func="yes">
  2149. <Overload retVal="unsigned" descr="Get text length, checks for '\0' ending">
  2150. <Param name="const char *text" />
  2151. </Overload>
  2152. </KeyWord>
  2153. <KeyWord name="TextFormat" func="yes">
  2154. <Overload retVal="const char" descr="Text formatting with variables (sprintf() style)">
  2155. <Param name="const char *text" />
  2156. <Param name="..." />
  2157. </Overload>
  2158. </KeyWord>
  2159. <KeyWord name="TextSubtext" func="yes">
  2160. <Overload retVal="const char" descr="Get a piece of a text string">
  2161. <Param name="const char *text" />
  2162. <Param name="int position" />
  2163. <Param name="int length" />
  2164. </Overload>
  2165. </KeyWord>
  2166. <KeyWord name="TextReplace" func="yes">
  2167. <Overload retVal="char" descr="Replace text string (WARNING: memory must be freed!)">
  2168. <Param name="char *text" />
  2169. <Param name="const char *replace" />
  2170. <Param name="const char *by" />
  2171. </Overload>
  2172. </KeyWord>
  2173. <KeyWord name="TextInsert" func="yes">
  2174. <Overload retVal="char" descr="Insert text in a position (WARNING: memory must be freed!)">
  2175. <Param name="const char *text" />
  2176. <Param name="const char *insert" />
  2177. <Param name="int position" />
  2178. </Overload>
  2179. </KeyWord>
  2180. <KeyWord name="TextJoin" func="yes">
  2181. <Overload retVal="const char" descr="Join text strings with delimiter">
  2182. <Param name="const char **textList" />
  2183. <Param name="int count" />
  2184. <Param name="const char *delimiter" />
  2185. </Overload>
  2186. </KeyWord>
  2187. <KeyWord name="TextSplit" func="yes">
  2188. <Overload retVal="const char" descr="Split text into multiple strings">
  2189. <Param name="const char *text" />
  2190. <Param name="char delimiter" />
  2191. <Param name="int *count" />
  2192. </Overload>
  2193. </KeyWord>
  2194. <KeyWord name="TextAppend" func="yes">
  2195. <Overload retVal="void" descr="Append text at specific position and move cursor!">
  2196. <Param name="char *text" />
  2197. <Param name="const char *append" />
  2198. <Param name="int *position" />
  2199. </Overload>
  2200. </KeyWord>
  2201. <KeyWord name="TextFindIndex" func="yes">
  2202. <Overload retVal="int" descr="Find first text occurrence within a string">
  2203. <Param name="const char *text" />
  2204. <Param name="const char *find" />
  2205. </Overload>
  2206. </KeyWord>
  2207. <KeyWord name="TextToUpper" func="yes">
  2208. <Overload retVal="const char" descr="Get upper case version of provided string">
  2209. <Param name="const char *text" />
  2210. </Overload>
  2211. </KeyWord>
  2212. <KeyWord name="TextToLower" func="yes">
  2213. <Overload retVal="const char" descr="Get lower case version of provided string">
  2214. <Param name="const char *text" />
  2215. </Overload>
  2216. </KeyWord>
  2217. <KeyWord name="TextToPascal" func="yes">
  2218. <Overload retVal="const char" descr="Get Pascal case notation version of provided string">
  2219. <Param name="const char *text" />
  2220. </Overload>
  2221. </KeyWord>
  2222. <KeyWord name="TextToInteger" func="yes">
  2223. <Overload retVal="int" descr="Get integer value from text (negative values not supported)">
  2224. <Param name="const char *text" />
  2225. </Overload>
  2226. </KeyWord>
  2227. <!-------------------------------------------------------------------------------------- -->
  2228. <!-- Basic 3d Shapes Drawing Functions (Module: models) -->
  2229. <!-------------------------------------------------------------------------------------- -->
  2230. <!-- Basic geometric 3D shapes drawing functions -->
  2231. <KeyWord name="DrawLine3D" func="yes">
  2232. <Overload retVal="void" descr="Draw a line in 3D world space">
  2233. <Param name="Vector3 startPos" />
  2234. <Param name="Vector3 endPos" />
  2235. <Param name="Color color" />
  2236. </Overload>
  2237. </KeyWord>
  2238. <KeyWord name="DrawPoint3D" func="yes">
  2239. <Overload retVal="void" descr="Draw a point in 3D space, actually a small line">
  2240. <Param name="Vector3 position" />
  2241. <Param name="Color color" />
  2242. </Overload>
  2243. </KeyWord>
  2244. <KeyWord name="DrawCircle3D" func="yes">
  2245. <Overload retVal="void" descr="Draw a circle in 3D world space">
  2246. <Param name="Vector3 center" />
  2247. <Param name="float radius" />
  2248. <Param name="Vector3 rotationAxis" />
  2249. <Param name="float rotationAngle" />
  2250. <Param name="Color color" />
  2251. </Overload>
  2252. </KeyWord>
  2253. <KeyWord name="DrawTriangle3D" func="yes">
  2254. <Overload retVal="void" descr="Draw a color-filled triangle (vertex in counter-clockwise order!)">
  2255. <Param name="Vector3 v1" />
  2256. <Param name="Vector3 v2" />
  2257. <Param name="Vector3 v3" />
  2258. <Param name="Color color" />
  2259. </Overload>
  2260. </KeyWord>
  2261. <KeyWord name="DrawTriangleStrip3D" func="yes">
  2262. <Overload retVal="void" descr="Draw a triangle strip defined by points">
  2263. <Param name="Vector3 *points" />
  2264. <Param name="int pointCount" />
  2265. <Param name="Color color" />
  2266. </Overload>
  2267. </KeyWord>
  2268. <KeyWord name="DrawCube" func="yes">
  2269. <Overload retVal="void" descr="Draw cube">
  2270. <Param name="Vector3 position" />
  2271. <Param name="float width" />
  2272. <Param name="float height" />
  2273. <Param name="float length" />
  2274. <Param name="Color color" />
  2275. </Overload>
  2276. </KeyWord>
  2277. <KeyWord name="DrawCubeV" func="yes">
  2278. <Overload retVal="void" descr="Draw cube (Vector version)">
  2279. <Param name="Vector3 position" />
  2280. <Param name="Vector3 size" />
  2281. <Param name="Color color" />
  2282. </Overload>
  2283. </KeyWord>
  2284. <KeyWord name="DrawCubeWires" func="yes">
  2285. <Overload retVal="void" descr="Draw cube wires">
  2286. <Param name="Vector3 position" />
  2287. <Param name="float width" />
  2288. <Param name="float height" />
  2289. <Param name="float length" />
  2290. <Param name="Color color" />
  2291. </Overload>
  2292. </KeyWord>
  2293. <KeyWord name="DrawCubeWiresV" func="yes">
  2294. <Overload retVal="void" descr="Draw cube wires (Vector version)">
  2295. <Param name="Vector3 position" />
  2296. <Param name="Vector3 size" />
  2297. <Param name="Color color" />
  2298. </Overload>
  2299. </KeyWord>
  2300. <KeyWord name="DrawCubeTexture" func="yes">
  2301. <Overload retVal="void" descr="Draw cube textured">
  2302. <Param name="Texture2D texture" />
  2303. <Param name="Vector3 position" />
  2304. <Param name="float width" />
  2305. <Param name="float height" />
  2306. <Param name="float length" />
  2307. <Param name="Color color" />
  2308. </Overload>
  2309. </KeyWord>
  2310. <KeyWord name="DrawCubeTextureRec" func="yes">
  2311. <Overload retVal="void" descr="Draw cube with a region of a texture">
  2312. <Param name="Texture2D texture" />
  2313. <Param name="Rectangle source" />
  2314. <Param name="Vector3 position" />
  2315. <Param name="float width" />
  2316. <Param name="float height" />
  2317. <Param name="float length" />
  2318. <Param name="Color color" />
  2319. </Overload>
  2320. </KeyWord>
  2321. <KeyWord name="DrawSphere" func="yes">
  2322. <Overload retVal="void" descr="Draw sphere">
  2323. <Param name="Vector3 centerPos" />
  2324. <Param name="float radius" />
  2325. <Param name="Color color" />
  2326. </Overload>
  2327. </KeyWord>
  2328. <KeyWord name="DrawSphereEx" func="yes">
  2329. <Overload retVal="void" descr="Draw sphere with extended parameters">
  2330. <Param name="Vector3 centerPos" />
  2331. <Param name="float radius" />
  2332. <Param name="int rings" />
  2333. <Param name="int slices" />
  2334. <Param name="Color color" />
  2335. </Overload>
  2336. </KeyWord>
  2337. <KeyWord name="DrawSphereWires" func="yes">
  2338. <Overload retVal="void" descr="Draw sphere wires">
  2339. <Param name="Vector3 centerPos" />
  2340. <Param name="float radius" />
  2341. <Param name="int rings" />
  2342. <Param name="int slices" />
  2343. <Param name="Color color" />
  2344. </Overload>
  2345. </KeyWord>
  2346. <KeyWord name="DrawCylinder" func="yes">
  2347. <Overload retVal="void" descr="Draw a cylinder/cone">
  2348. <Param name="Vector3 position" />
  2349. <Param name="float radiusTop" />
  2350. <Param name="float radiusBottom" />
  2351. <Param name="float height" />
  2352. <Param name="int slices" />
  2353. <Param name="Color color" />
  2354. </Overload>
  2355. </KeyWord>
  2356. <KeyWord name="DrawCylinderEx" func="yes">
  2357. <Overload retVal="void" descr="Draw a cylinder with base at startPos and top at endPos">
  2358. <Param name="Vector3 startPos" />
  2359. <Param name="Vector3 endPos" />
  2360. <Param name="float startRadius" />
  2361. <Param name="float endRadius" />
  2362. <Param name="int sides" />
  2363. <Param name="Color color" />
  2364. </Overload>
  2365. </KeyWord>
  2366. <KeyWord name="DrawCylinderWires" func="yes">
  2367. <Overload retVal="void" descr="Draw a cylinder/cone wires">
  2368. <Param name="Vector3 position" />
  2369. <Param name="float radiusTop" />
  2370. <Param name="float radiusBottom" />
  2371. <Param name="float height" />
  2372. <Param name="int slices" />
  2373. <Param name="Color color" />
  2374. </Overload>
  2375. </KeyWord>
  2376. <KeyWord name="DrawCylinderWiresEx" func="yes">
  2377. <Overload retVal="void" descr="Draw a cylinder wires with base at startPos and top at endPos">
  2378. <Param name="Vector3 startPos" />
  2379. <Param name="Vector3 endPos" />
  2380. <Param name="float startRadius" />
  2381. <Param name="float endRadius" />
  2382. <Param name="int sides" />
  2383. <Param name="Color color" />
  2384. </Overload>
  2385. </KeyWord>
  2386. <KeyWord name="DrawPlane" func="yes">
  2387. <Overload retVal="void" descr="Draw a plane XZ">
  2388. <Param name="Vector3 centerPos" />
  2389. <Param name="Vector2 size" />
  2390. <Param name="Color color" />
  2391. </Overload>
  2392. </KeyWord>
  2393. <KeyWord name="DrawRay" func="yes">
  2394. <Overload retVal="void" descr="Draw a ray line">
  2395. <Param name="Ray ray" />
  2396. <Param name="Color color" />
  2397. </Overload>
  2398. </KeyWord>
  2399. <KeyWord name="DrawGrid" func="yes">
  2400. <Overload retVal="void" descr="Draw a grid (centered at (0, 0, 0))">
  2401. <Param name="int slices" />
  2402. <Param name="float spacing" />
  2403. </Overload>
  2404. </KeyWord>
  2405. <!-------------------------------------------------------------------------------------- -->
  2406. <!-- Model 3d Loading and Drawing Functions (Module: models) -->
  2407. <!-------------------------------------------------------------------------------------- -->
  2408. <!-- Model management functions -->
  2409. <KeyWord name="LoadModel" func="yes">
  2410. <Overload retVal="Model" descr="Load model from files (meshes and materials)">
  2411. <Param name="const char *fileName" />
  2412. </Overload>
  2413. </KeyWord>
  2414. <KeyWord name="LoadModelFromMesh" func="yes">
  2415. <Overload retVal="Model" descr="Load model from generated mesh (default material)">
  2416. <Param name="Mesh mesh" />
  2417. </Overload>
  2418. </KeyWord>
  2419. <KeyWord name="UnloadModel" func="yes">
  2420. <Overload retVal="void" descr="Unload model (including meshes) from memory (RAM and/or VRAM)">
  2421. <Param name="Model model" />
  2422. </Overload>
  2423. </KeyWord>
  2424. <KeyWord name="UnloadModelKeepMeshes" func="yes">
  2425. <Overload retVal="void" descr="Unload model (but not meshes) from memory (RAM and/or VRAM)">
  2426. <Param name="Model model" />
  2427. </Overload>
  2428. </KeyWord>
  2429. <KeyWord name="GetModelBoundingBox" func="yes">
  2430. <Overload retVal="BoundingBox" descr="Compute model bounding box limits (considers all meshes)">
  2431. <Param name="Model model" />
  2432. </Overload>
  2433. </KeyWord>
  2434. <!-- Model drawing functions -->
  2435. <KeyWord name="DrawModel" func="yes">
  2436. <Overload retVal="void" descr="Draw a model (with texture if set)">
  2437. <Param name="Model model" />
  2438. <Param name="Vector3 position" />
  2439. <Param name="float scale" />
  2440. <Param name="Color tint" />
  2441. </Overload>
  2442. </KeyWord>
  2443. <KeyWord name="DrawModelEx" func="yes">
  2444. <Overload retVal="void" descr="Draw a model with extended parameters">
  2445. <Param name="Model model" />
  2446. <Param name="Vector3 position" />
  2447. <Param name="Vector3 rotationAxis" />
  2448. <Param name="float rotationAngle" />
  2449. <Param name="Vector3 scale" />
  2450. <Param name="Color tint" />
  2451. </Overload>
  2452. </KeyWord>
  2453. <KeyWord name="DrawModelWires" func="yes">
  2454. <Overload retVal="void" descr="Draw a model wires (with texture if set)">
  2455. <Param name="Model model" />
  2456. <Param name="Vector3 position" />
  2457. <Param name="float scale" />
  2458. <Param name="Color tint" />
  2459. </Overload>
  2460. </KeyWord>
  2461. <KeyWord name="DrawModelWiresEx" func="yes">
  2462. <Overload retVal="void" descr="Draw a model wires (with texture if set) with extended parameters">
  2463. <Param name="Model model" />
  2464. <Param name="Vector3 position" />
  2465. <Param name="Vector3 rotationAxis" />
  2466. <Param name="float rotationAngle" />
  2467. <Param name="Vector3 scale" />
  2468. <Param name="Color tint" />
  2469. </Overload>
  2470. </KeyWord>
  2471. <KeyWord name="DrawBoundingBox" func="yes">
  2472. <Overload retVal="void" descr="Draw bounding box (wires)">
  2473. <Param name="BoundingBox box" />
  2474. <Param name="Color color" />
  2475. </Overload>
  2476. </KeyWord>
  2477. <KeyWord name="DrawBillboard" func="yes">
  2478. <Overload retVal="void" descr="Draw a billboard texture">
  2479. <Param name="Camera camera" />
  2480. <Param name="Texture2D texture" />
  2481. <Param name="Vector3 position" />
  2482. <Param name="float size" />
  2483. <Param name="Color tint" />
  2484. </Overload>
  2485. </KeyWord>
  2486. <KeyWord name="DrawBillboardRec" func="yes">
  2487. <Overload retVal="void" descr="Draw a billboard texture defined by source">
  2488. <Param name="Camera camera" />
  2489. <Param name="Texture2D texture" />
  2490. <Param name="Rectangle source" />
  2491. <Param name="Vector3 position" />
  2492. <Param name="Vector2 size" />
  2493. <Param name="Color tint" />
  2494. </Overload>
  2495. </KeyWord>
  2496. <KeyWord name="DrawBillboardPro" func="yes">
  2497. <Overload retVal="void" descr="Draw a billboard texture defined by source and rotation">
  2498. <Param name="Camera camera" />
  2499. <Param name="Texture2D texture" />
  2500. <Param name="Rectangle source" />
  2501. <Param name="Vector3 position" />
  2502. <Param name="Vector3 up" />
  2503. <Param name="Vector2 size" />
  2504. <Param name="Vector2 origin" />
  2505. <Param name="float rotation" />
  2506. <Param name="Color tint" />
  2507. </Overload>
  2508. </KeyWord>
  2509. <!-- Mesh management functions -->
  2510. <KeyWord name="UploadMesh" func="yes">
  2511. <Overload retVal="void" descr="Upload mesh vertex data in GPU and provide VAO/VBO ids">
  2512. <Param name="Mesh *mesh" />
  2513. <Param name="bool dynamic" />
  2514. </Overload>
  2515. </KeyWord>
  2516. <KeyWord name="UpdateMeshBuffer" func="yes">
  2517. <Overload retVal="void" descr="Update mesh vertex data in GPU for a specific buffer index">
  2518. <Param name="Mesh mesh" />
  2519. <Param name="int index" />
  2520. <Param name="const void *data" />
  2521. <Param name="int dataSize" />
  2522. <Param name="int offset" />
  2523. </Overload>
  2524. </KeyWord>
  2525. <KeyWord name="UnloadMesh" func="yes">
  2526. <Overload retVal="void" descr="Unload mesh data from CPU and GPU">
  2527. <Param name="Mesh mesh" />
  2528. </Overload>
  2529. </KeyWord>
  2530. <KeyWord name="DrawMesh" func="yes">
  2531. <Overload retVal="void" descr="Draw a 3d mesh with material and transform">
  2532. <Param name="Mesh mesh" />
  2533. <Param name="Material material" />
  2534. <Param name="Matrix transform" />
  2535. </Overload>
  2536. </KeyWord>
  2537. <KeyWord name="DrawMeshInstanced" func="yes">
  2538. <Overload retVal="void" descr="Draw multiple mesh instances with material and different transforms">
  2539. <Param name="Mesh mesh" />
  2540. <Param name="Material material" />
  2541. <Param name="const Matrix *transforms" />
  2542. <Param name="int instances" />
  2543. </Overload>
  2544. </KeyWord>
  2545. <KeyWord name="ExportMesh" func="yes">
  2546. <Overload retVal="bool" descr="Export mesh data to file, returns true on success">
  2547. <Param name="Mesh mesh" />
  2548. <Param name="const char *fileName" />
  2549. </Overload>
  2550. </KeyWord>
  2551. <KeyWord name="GetMeshBoundingBox" func="yes">
  2552. <Overload retVal="BoundingBox" descr="Compute mesh bounding box limits">
  2553. <Param name="Mesh mesh" />
  2554. </Overload>
  2555. </KeyWord>
  2556. <KeyWord name="GenMeshTangents" func="yes">
  2557. <Overload retVal="void" descr="Compute mesh tangents">
  2558. <Param name="Mesh *mesh" />
  2559. </Overload>
  2560. </KeyWord>
  2561. <!-- Mesh generation functions -->
  2562. <KeyWord name="GenMeshPoly" func="yes">
  2563. <Overload retVal="Mesh" descr="Generate polygonal mesh">
  2564. <Param name="int sides" />
  2565. <Param name="float radius" />
  2566. </Overload>
  2567. </KeyWord>
  2568. <KeyWord name="GenMeshPlane" func="yes">
  2569. <Overload retVal="Mesh" descr="Generate plane mesh (with subdivisions)">
  2570. <Param name="float width" />
  2571. <Param name="float length" />
  2572. <Param name="int resX" />
  2573. <Param name="int resZ" />
  2574. </Overload>
  2575. </KeyWord>
  2576. <KeyWord name="GenMeshCube" func="yes">
  2577. <Overload retVal="Mesh" descr="Generate cuboid mesh">
  2578. <Param name="float width" />
  2579. <Param name="float height" />
  2580. <Param name="float length" />
  2581. </Overload>
  2582. </KeyWord>
  2583. <KeyWord name="GenMeshSphere" func="yes">
  2584. <Overload retVal="Mesh" descr="Generate sphere mesh (standard sphere)">
  2585. <Param name="float radius" />
  2586. <Param name="int rings" />
  2587. <Param name="int slices" />
  2588. </Overload>
  2589. </KeyWord>
  2590. <KeyWord name="GenMeshHemiSphere" func="yes">
  2591. <Overload retVal="Mesh" descr="Generate half-sphere mesh (no bottom cap)">
  2592. <Param name="float radius" />
  2593. <Param name="int rings" />
  2594. <Param name="int slices" />
  2595. </Overload>
  2596. </KeyWord>
  2597. <KeyWord name="GenMeshCylinder" func="yes">
  2598. <Overload retVal="Mesh" descr="Generate cylinder mesh">
  2599. <Param name="float radius" />
  2600. <Param name="float height" />
  2601. <Param name="int slices" />
  2602. </Overload>
  2603. </KeyWord>
  2604. <KeyWord name="GenMeshCone" func="yes">
  2605. <Overload retVal="Mesh" descr="Generate cone/pyramid mesh">
  2606. <Param name="float radius" />
  2607. <Param name="float height" />
  2608. <Param name="int slices" />
  2609. </Overload>
  2610. </KeyWord>
  2611. <KeyWord name="GenMeshTorus" func="yes">
  2612. <Overload retVal="Mesh" descr="Generate torus mesh">
  2613. <Param name="float radius" />
  2614. <Param name="float size" />
  2615. <Param name="int radSeg" />
  2616. <Param name="int sides" />
  2617. </Overload>
  2618. </KeyWord>
  2619. <KeyWord name="GenMeshKnot" func="yes">
  2620. <Overload retVal="Mesh" descr="Generate trefoil knot mesh">
  2621. <Param name="float radius" />
  2622. <Param name="float size" />
  2623. <Param name="int radSeg" />
  2624. <Param name="int sides" />
  2625. </Overload>
  2626. </KeyWord>
  2627. <KeyWord name="GenMeshHeightmap" func="yes">
  2628. <Overload retVal="Mesh" descr="Generate heightmap mesh from image data">
  2629. <Param name="Image heightmap" />
  2630. <Param name="Vector3 size" />
  2631. </Overload>
  2632. </KeyWord>
  2633. <KeyWord name="GenMeshCubicmap" func="yes">
  2634. <Overload retVal="Mesh" descr="Generate cubes-based map mesh from image data">
  2635. <Param name="Image cubicmap" />
  2636. <Param name="Vector3 cubeSize" />
  2637. </Overload>
  2638. </KeyWord>
  2639. <!-- Material loading/unloading functions -->
  2640. <KeyWord name="LoadMaterials" func="yes">
  2641. <Overload retVal="Material" descr="Load materials from model file">
  2642. <Param name="const char *fileName" />
  2643. <Param name="int *materialCount" />
  2644. </Overload>
  2645. </KeyWord>
  2646. <KeyWord name="LoadMaterialDefault" func="yes">
  2647. <Overload retVal="Material" descr="Load default material (Supports: DIFFUSE, SPECULAR, NORMAL maps)"></Overload>
  2648. </KeyWord>
  2649. <KeyWord name="UnloadMaterial" func="yes">
  2650. <Overload retVal="void" descr="Unload material from GPU memory (VRAM)">
  2651. <Param name="Material material" />
  2652. </Overload>
  2653. </KeyWord>
  2654. <KeyWord name="SetMaterialTexture" func="yes">
  2655. <Overload retVal="void" descr="Set texture for a material map type (MATERIAL_MAP_DIFFUSE, MATERIAL_MAP_SPECULAR...)">
  2656. <Param name="Material *material" />
  2657. <Param name="int mapType" />
  2658. <Param name="Texture2D texture" />
  2659. </Overload>
  2660. </KeyWord>
  2661. <KeyWord name="SetModelMeshMaterial" func="yes">
  2662. <Overload retVal="void" descr="Set material for a mesh">
  2663. <Param name="Model *model" />
  2664. <Param name="int meshId" />
  2665. <Param name="int materialId" />
  2666. </Overload>
  2667. </KeyWord>
  2668. <!-- Model animations loading/unloading functions -->
  2669. <KeyWord name="LoadModelAnimations" func="yes">
  2670. <Overload retVal="ModelAnimation" descr="Load model animations from file">
  2671. <Param name="const char *fileName" />
  2672. <Param name="unsigned int *animCount" />
  2673. </Overload>
  2674. </KeyWord>
  2675. <KeyWord name="UpdateModelAnimation" func="yes">
  2676. <Overload retVal="void" descr="Update model animation pose">
  2677. <Param name="Model model" />
  2678. <Param name="ModelAnimation anim" />
  2679. <Param name="int frame" />
  2680. </Overload>
  2681. </KeyWord>
  2682. <KeyWord name="UnloadModelAnimation" func="yes">
  2683. <Overload retVal="void" descr="Unload animation data">
  2684. <Param name="ModelAnimation anim" />
  2685. </Overload>
  2686. </KeyWord>
  2687. <KeyWord name="UnloadModelAnimations" func="yes">
  2688. <Overload retVal="void" descr="Unload animation array data">
  2689. <Param name="ModelAnimation *animations" />
  2690. <Param name="unsigned int count" />
  2691. </Overload>
  2692. </KeyWord>
  2693. <KeyWord name="IsModelAnimationValid" func="yes">
  2694. <Overload retVal="bool" descr="Check model animation skeleton match">
  2695. <Param name="Model model" />
  2696. <Param name="ModelAnimation anim" />
  2697. </Overload>
  2698. </KeyWord>
  2699. <!-- Collision detection functions -->
  2700. <KeyWord name="CheckCollisionSpheres" func="yes">
  2701. <Overload retVal="bool" descr="Check collision between two spheres">
  2702. <Param name="Vector3 center1" />
  2703. <Param name="float radius1" />
  2704. <Param name="Vector3 center2" />
  2705. <Param name="float radius2" />
  2706. </Overload>
  2707. </KeyWord>
  2708. <KeyWord name="CheckCollisionBoxes" func="yes">
  2709. <Overload retVal="bool" descr="Check collision between two bounding boxes">
  2710. <Param name="BoundingBox box1" />
  2711. <Param name="BoundingBox box2" />
  2712. </Overload>
  2713. </KeyWord>
  2714. <KeyWord name="CheckCollisionBoxSphere" func="yes">
  2715. <Overload retVal="bool" descr="Check collision between box and sphere">
  2716. <Param name="BoundingBox box" />
  2717. <Param name="Vector3 center" />
  2718. <Param name="float radius" />
  2719. </Overload>
  2720. </KeyWord>
  2721. <KeyWord name="GetRayCollisionSphere" func="yes">
  2722. <Overload retVal="RayCollision" descr="Get collision info between ray and sphere">
  2723. <Param name="Ray ray" />
  2724. <Param name="Vector3 center" />
  2725. <Param name="float radius" />
  2726. </Overload>
  2727. </KeyWord>
  2728. <KeyWord name="GetRayCollisionBox" func="yes">
  2729. <Overload retVal="RayCollision" descr="Get collision info between ray and box">
  2730. <Param name="Ray ray" />
  2731. <Param name="BoundingBox box" />
  2732. </Overload>
  2733. </KeyWord>
  2734. <KeyWord name="GetRayCollisionMesh" func="yes">
  2735. <Overload retVal="RayCollision" descr="Get collision info between ray and mesh">
  2736. <Param name="Ray ray" />
  2737. <Param name="Mesh mesh" />
  2738. <Param name="Matrix transform" />
  2739. </Overload>
  2740. </KeyWord>
  2741. <KeyWord name="GetRayCollisionTriangle" func="yes">
  2742. <Overload retVal="RayCollision" descr="Get collision info between ray and triangle">
  2743. <Param name="Ray ray" />
  2744. <Param name="Vector3 p1" />
  2745. <Param name="Vector3 p2" />
  2746. <Param name="Vector3 p3" />
  2747. </Overload>
  2748. </KeyWord>
  2749. <KeyWord name="GetRayCollisionQuad" func="yes">
  2750. <Overload retVal="RayCollision" descr="Get collision info between ray and quad">
  2751. <Param name="Ray ray" />
  2752. <Param name="Vector3 p1" />
  2753. <Param name="Vector3 p2" />
  2754. <Param name="Vector3 p3" />
  2755. <Param name="Vector3 p4" />
  2756. </Overload>
  2757. </KeyWord>
  2758. <!-------------------------------------------------------------------------------------- -->
  2759. <!-- Audio Loading and Playing Functions (Module: audio) -->
  2760. <!-------------------------------------------------------------------------------------- -->
  2761. <!-- Audio device management functions -->
  2762. <KeyWord name="InitAudioDevice" func="yes">
  2763. <Overload retVal="void" descr="Initialize audio device and context"></Overload>
  2764. </KeyWord>
  2765. <KeyWord name="CloseAudioDevice" func="yes">
  2766. <Overload retVal="void" descr="Close the audio device and context"></Overload>
  2767. </KeyWord>
  2768. <KeyWord name="IsAudioDeviceReady" func="yes">
  2769. <Overload retVal="bool" descr="Check if audio device has been initialized successfully"></Overload>
  2770. </KeyWord>
  2771. <KeyWord name="SetMasterVolume" func="yes">
  2772. <Overload retVal="void" descr="Set master volume (listener)">
  2773. <Param name="float volume" />
  2774. </Overload>
  2775. </KeyWord>
  2776. <!-- Wave/Sound loading/unloading functions -->
  2777. <KeyWord name="LoadWave" func="yes">
  2778. <Overload retVal="Wave" descr="Load wave data from file">
  2779. <Param name="const char *fileName" />
  2780. </Overload>
  2781. </KeyWord>
  2782. <KeyWord name="LoadWaveFromMemory" func="yes">
  2783. <Overload retVal="Wave" descr="Load wave from memory buffer, fileType refers to extension: i.e. '.wav'">
  2784. <Param name="const char *fileType" />
  2785. <Param name="const unsigned char" />
  2786. <Param name="int dataSize" />
  2787. </Overload>
  2788. </KeyWord>
  2789. <KeyWord name="LoadSound" func="yes">
  2790. <Overload retVal="Sound" descr="Load sound from file">
  2791. <Param name="const char *fileName" />
  2792. </Overload>
  2793. </KeyWord>
  2794. <KeyWord name="LoadSoundFromWave" func="yes">
  2795. <Overload retVal="Sound" descr="Load sound from wave data">
  2796. <Param name="Wave wave" />
  2797. </Overload>
  2798. </KeyWord>
  2799. <KeyWord name="UpdateSound" func="yes">
  2800. <Overload retVal="void" descr="Update sound buffer with new data">
  2801. <Param name="Sound sound" />
  2802. <Param name="const void *data" />
  2803. <Param name="int sampleCount" />
  2804. </Overload>
  2805. </KeyWord>
  2806. <KeyWord name="UnloadWave" func="yes">
  2807. <Overload retVal="void" descr="Unload wave data">
  2808. <Param name="Wave wave" />
  2809. </Overload>
  2810. </KeyWord>
  2811. <KeyWord name="UnloadSound" func="yes">
  2812. <Overload retVal="void" descr="Unload sound">
  2813. <Param name="Sound sound" />
  2814. </Overload>
  2815. </KeyWord>
  2816. <KeyWord name="ExportWave" func="yes">
  2817. <Overload retVal="bool" descr="Export wave data to file, returns true on success">
  2818. <Param name="Wave wave" />
  2819. <Param name="const char *fileName" />
  2820. </Overload>
  2821. </KeyWord>
  2822. <KeyWord name="ExportWaveAsCode" func="yes">
  2823. <Overload retVal="bool" descr="Export wave sample data to code (.h), returns true on success">
  2824. <Param name="Wave wave" />
  2825. <Param name="const char *fileName" />
  2826. </Overload>
  2827. </KeyWord>
  2828. <!-- Wave/Sound management functions -->
  2829. <KeyWord name="PlaySound" func="yes">
  2830. <Overload retVal="void" descr="Play a sound">
  2831. <Param name="Sound sound" />
  2832. </Overload>
  2833. </KeyWord>
  2834. <KeyWord name="StopSound" func="yes">
  2835. <Overload retVal="void" descr="Stop playing a sound">
  2836. <Param name="Sound sound" />
  2837. </Overload>
  2838. </KeyWord>
  2839. <KeyWord name="PauseSound" func="yes">
  2840. <Overload retVal="void" descr="Pause a sound">
  2841. <Param name="Sound sound" />
  2842. </Overload>
  2843. </KeyWord>
  2844. <KeyWord name="ResumeSound" func="yes">
  2845. <Overload retVal="void" descr="Resume a paused sound">
  2846. <Param name="Sound sound" />
  2847. </Overload>
  2848. </KeyWord>
  2849. <KeyWord name="PlaySoundMulti" func="yes">
  2850. <Overload retVal="void" descr="Play a sound (using multichannel buffer pool)">
  2851. <Param name="Sound sound" />
  2852. </Overload>
  2853. </KeyWord>
  2854. <KeyWord name="StopSoundMulti" func="yes">
  2855. <Overload retVal="void" descr="Stop any sound playing (using multichannel buffer pool)"></Overload>
  2856. </KeyWord>
  2857. <KeyWord name="GetSoundsPlaying" func="yes">
  2858. <Overload retVal="int" descr="Get number of sounds playing in the multichannel"></Overload>
  2859. </KeyWord>
  2860. <KeyWord name="IsSoundPlaying" func="yes">
  2861. <Overload retVal="bool" descr="Check if a sound is currently playing">
  2862. <Param name="Sound sound" />
  2863. </Overload>
  2864. </KeyWord>
  2865. <KeyWord name="SetSoundVolume" func="yes">
  2866. <Overload retVal="void" descr="Set volume for a sound (1.0 is max level)">
  2867. <Param name="Sound sound" />
  2868. <Param name="float volume" />
  2869. </Overload>
  2870. </KeyWord>
  2871. <KeyWord name="SetSoundPitch" func="yes">
  2872. <Overload retVal="void" descr="Set pitch for a sound (1.0 is base level)">
  2873. <Param name="Sound sound" />
  2874. <Param name="float pitch" />
  2875. </Overload>
  2876. </KeyWord>
  2877. <KeyWord name="SetSoundPan" func="yes">
  2878. <Overload retVal="void" descr="Set pan for a sound (0.5 is center)">
  2879. <Param name="Sound sound" />
  2880. <Param name="float pan" />
  2881. </Overload>
  2882. </KeyWord>
  2883. <KeyWord name="WaveCopy" func="yes">
  2884. <Overload retVal="Wave" descr="Copy a wave to a new wave">
  2885. <Param name="Wave wave" />
  2886. </Overload>
  2887. </KeyWord>
  2888. <KeyWord name="WaveCrop" func="yes">
  2889. <Overload retVal="void" descr="Crop a wave to defined samples range">
  2890. <Param name="Wave *wave" />
  2891. <Param name="int initSample" />
  2892. <Param name="int finalSample" />
  2893. </Overload>
  2894. </KeyWord>
  2895. <KeyWord name="WaveFormat" func="yes">
  2896. <Overload retVal="void" descr="Convert wave data to desired format">
  2897. <Param name="Wave *wave" />
  2898. <Param name="int sampleRate" />
  2899. <Param name="int sampleSize" />
  2900. <Param name="int channels" />
  2901. </Overload>
  2902. </KeyWord>
  2903. <KeyWord name="LoadWaveSamples" func="yes">
  2904. <Overload retVal="float" descr="Load samples data from wave as a 32bit float data array">
  2905. <Param name="Wave wave" />
  2906. </Overload>
  2907. </KeyWord>
  2908. <KeyWord name="UnloadWaveSamples" func="yes">
  2909. <Overload retVal="void" descr="Unload samples data loaded with LoadWaveSamples()">
  2910. <Param name="float *samples" />
  2911. </Overload>
  2912. </KeyWord>
  2913. <!-- Music management functions -->
  2914. <KeyWord name="LoadMusicStream" func="yes">
  2915. <Overload retVal="Music" descr="Load music stream from file">
  2916. <Param name="const char *fileName" />
  2917. </Overload>
  2918. </KeyWord>
  2919. <KeyWord name="LoadMusicStreamFromMemory" func="yes">
  2920. <Overload retVal="Music" descr="Load music stream from data">
  2921. <Param name="const char *fileType" />
  2922. <Param name="const unsigned char" />
  2923. <Param name="int dataSize" />
  2924. </Overload>
  2925. </KeyWord>
  2926. <KeyWord name="UnloadMusicStream" func="yes">
  2927. <Overload retVal="void" descr="Unload music stream">
  2928. <Param name="Music music" />
  2929. </Overload>
  2930. </KeyWord>
  2931. <KeyWord name="PlayMusicStream" func="yes">
  2932. <Overload retVal="void" descr="Start music playing">
  2933. <Param name="Music music" />
  2934. </Overload>
  2935. </KeyWord>
  2936. <KeyWord name="IsMusicStreamPlaying" func="yes">
  2937. <Overload retVal="bool" descr="Check if music is playing">
  2938. <Param name="Music music" />
  2939. </Overload>
  2940. </KeyWord>
  2941. <KeyWord name="UpdateMusicStream" func="yes">
  2942. <Overload retVal="void" descr="Updates buffers for music streaming">
  2943. <Param name="Music music" />
  2944. </Overload>
  2945. </KeyWord>
  2946. <KeyWord name="StopMusicStream" func="yes">
  2947. <Overload retVal="void" descr="Stop music playing">
  2948. <Param name="Music music" />
  2949. </Overload>
  2950. </KeyWord>
  2951. <KeyWord name="PauseMusicStream" func="yes">
  2952. <Overload retVal="void" descr="Pause music playing">
  2953. <Param name="Music music" />
  2954. </Overload>
  2955. </KeyWord>
  2956. <KeyWord name="ResumeMusicStream" func="yes">
  2957. <Overload retVal="void" descr="Resume playing paused music">
  2958. <Param name="Music music" />
  2959. </Overload>
  2960. </KeyWord>
  2961. <KeyWord name="SeekMusicStream" func="yes">
  2962. <Overload retVal="void" descr="Seek music to a position (in seconds)">
  2963. <Param name="Music music" />
  2964. <Param name="float position" />
  2965. </Overload>
  2966. </KeyWord>
  2967. <KeyWord name="SetMusicVolume" func="yes">
  2968. <Overload retVal="void" descr="Set volume for music (1.0 is max level)">
  2969. <Param name="Music music" />
  2970. <Param name="float volume" />
  2971. </Overload>
  2972. </KeyWord>
  2973. <KeyWord name="SetMusicPitch" func="yes">
  2974. <Overload retVal="void" descr="Set pitch for a music (1.0 is base level)">
  2975. <Param name="Music music" />
  2976. <Param name="float pitch" />
  2977. </Overload>
  2978. </KeyWord>
  2979. <KeyWord name="SetMusicPan" func="yes">
  2980. <Overload retVal="void" descr="Set pan for a music (0.5 is center)">
  2981. <Param name="Music music" />
  2982. <Param name="float pan" />
  2983. </Overload>
  2984. </KeyWord>
  2985. <KeyWord name="GetMusicTimeLength" func="yes">
  2986. <Overload retVal="float" descr="Get music time length (in seconds)">
  2987. <Param name="Music music" />
  2988. </Overload>
  2989. </KeyWord>
  2990. <KeyWord name="GetMusicTimePlayed" func="yes">
  2991. <Overload retVal="float" descr="Get current music time played (in seconds)">
  2992. <Param name="Music music" />
  2993. </Overload>
  2994. </KeyWord>
  2995. <!-- AudioStream management functions -->
  2996. <KeyWord name="LoadAudioStream" func="yes">
  2997. <Overload retVal="AudioStream" descr="Load audio stream (to stream raw audio pcm data)">
  2998. <Param name="unsigned int sampleRate" />
  2999. <Param name="unsigned int sampleSize" />
  3000. <Param name="unsigned int channels" />
  3001. </Overload>
  3002. </KeyWord>
  3003. <KeyWord name="UnloadAudioStream" func="yes">
  3004. <Overload retVal="void" descr="Unload audio stream and free memory">
  3005. <Param name="AudioStream stream" />
  3006. </Overload>
  3007. </KeyWord>
  3008. <KeyWord name="UpdateAudioStream" func="yes">
  3009. <Overload retVal="void" descr="Update audio stream buffers with data">
  3010. <Param name="AudioStream stream" />
  3011. <Param name="const void *data" />
  3012. <Param name="int frameCount" />
  3013. </Overload>
  3014. </KeyWord>
  3015. <KeyWord name="IsAudioStreamProcessed" func="yes">
  3016. <Overload retVal="bool" descr="Check if any audio stream buffers requires refill">
  3017. <Param name="AudioStream stream" />
  3018. </Overload>
  3019. </KeyWord>
  3020. <KeyWord name="PlayAudioStream" func="yes">
  3021. <Overload retVal="void" descr="Play audio stream">
  3022. <Param name="AudioStream stream" />
  3023. </Overload>
  3024. </KeyWord>
  3025. <KeyWord name="PauseAudioStream" func="yes">
  3026. <Overload retVal="void" descr="Pause audio stream">
  3027. <Param name="AudioStream stream" />
  3028. </Overload>
  3029. </KeyWord>
  3030. <KeyWord name="ResumeAudioStream" func="yes">
  3031. <Overload retVal="void" descr="Resume audio stream">
  3032. <Param name="AudioStream stream" />
  3033. </Overload>
  3034. </KeyWord>
  3035. <KeyWord name="IsAudioStreamPlaying" func="yes">
  3036. <Overload retVal="bool" descr="Check if audio stream is playing">
  3037. <Param name="AudioStream stream" />
  3038. </Overload>
  3039. </KeyWord>
  3040. <KeyWord name="StopAudioStream" func="yes">
  3041. <Overload retVal="void" descr="Stop audio stream">
  3042. <Param name="AudioStream stream" />
  3043. </Overload>
  3044. </KeyWord>
  3045. <KeyWord name="SetAudioStreamVolume" func="yes">
  3046. <Overload retVal="void" descr="Set volume for audio stream (1.0 is max level)">
  3047. <Param name="AudioStream stream" />
  3048. <Param name="float volume" />
  3049. </Overload>
  3050. </KeyWord>
  3051. <KeyWord name="SetAudioStreamPitch" func="yes">
  3052. <Overload retVal="void" descr="Set pitch for audio stream (1.0 is base level)">
  3053. <Param name="AudioStream stream" />
  3054. <Param name="float pitch" />
  3055. </Overload>
  3056. </KeyWord>
  3057. <KeyWord name="SetAudioStreamPan" func="yes">
  3058. <Overload retVal="void" descr="Set pan for audio stream (0.5 is centered)">
  3059. <Param name="AudioStream stream" />
  3060. <Param name="float pan" />
  3061. </Overload>
  3062. </KeyWord>
  3063. <KeyWord name="SetAudioStreamBufferSizeDefault" func="yes">
  3064. <Overload retVal="void" descr="Default size for new audio streams">
  3065. <Param name="int size" />
  3066. </Overload>
  3067. </KeyWord>
  3068. <KeyWord name="SetAudioStreamCallback" func="yes">
  3069. <Overload retVal="void" descr="Audio thread callback to request new data">
  3070. <Param name="AudioStream stream" />
  3071. <Param name="AudioCallback callback" />
  3072. </Overload>
  3073. </KeyWord>
  3074. <KeyWord name="AttachAudioStreamProcessor" func="yes">
  3075. <Overload retVal="void" descr="Attach audio stream processor to stream">
  3076. <Param name="AudioStream stream" />
  3077. <Param name="AudioCallback processor" />
  3078. </Overload>
  3079. </KeyWord>
  3080. <KeyWord name="DetachAudioStreamProcessor" func="yes">
  3081. <Overload retVal="void" descr="Detach audio stream processor from stream">
  3082. <Param name="AudioStream stream" />
  3083. <Param name="AudioCallback processor" />
  3084. </Overload>
  3085. </KeyWord>