You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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