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.

2116 lines
94 KiB

  1. <?xml version="1.0" encoding="Windows-1252" ?>
  2. <NotepadPlus>
  3. <AutoComplete language="C">
  4. <Environment ignoreCase="no" startFunc="(" stopFunc=")" paramSeparator="," terminal=";" additionalWordChar = "."/>
  5. <!-- raylib Autocompletion -->
  6. <!-- raylib data types -->
  7. <KeyWord name="bool" />
  8. <KeyWord name="Vector2" />
  9. <KeyWord name="Vector3" />
  10. <KeyWord name="Vector4" />
  11. <KeyWord name="Quaternion" />
  12. <KeyWord name="Matrix" />
  13. <KeyWord name="Color" />
  14. <KeyWord name="Rectangle" />
  15. <KeyWord name="Image" />
  16. <KeyWord name="Texture2D" />
  17. <KeyWord name="RenderTexture2D" />
  18. <KeyWord name="Font" />
  19. <KeyWord name="Camera3D" />
  20. <KeyWord name="Camera2D" />
  21. <KeyWord name="BoundingBox" />
  22. <KeyWord name="Mesh" />
  23. <KeyWord name="Shader" />
  24. <KeyWord name="Material" />
  25. <KeyWord name="Model" />
  26. <KeyWord name="Ray" />
  27. <KeyWord name="RayHitInfo" />
  28. <KeyWord name="Wave" />
  29. <KeyWord name="Sound" />
  30. <KeyWord name="Music" />
  31. <KeyWord name="AudioStream" />
  32. <KeyWord name="VrDeviceInfo" />
  33. <!-------------------------------------------------------------------------------------- -->
  34. <!-- Window and Graphics Device Functions (Module: core) -->
  35. <!-------------------------------------------------------------------------------------- -->
  36. <!-- Window-related functions -->
  37. <KeyWord name="InitWindow" func="yes">
  38. <Overload retVal="void" descr="Initialize window and OpenGL context">
  39. <Param name="int width" />
  40. <Param name="int height" />
  41. <Param name="const char *title" />
  42. </Overload>
  43. </KeyWord>
  44. <KeyWord name="CloseWindow" func="yes">
  45. <Overload retVal="void" descr="Close window and unload OpenGL context"></Overload>
  46. </KeyWord>
  47. <KeyWord name="IsWindowReady" func="yes">
  48. <Overload retVal="bool" descr="Check if window has been initialized successfully"></Overload>
  49. </KeyWord>
  50. <KeyWord name="WindowShouldClose" func="yes">
  51. <Overload retVal="bool" descr="Check if KEY_ESCAPE pressed or Close icon pressed"></Overload>
  52. </KeyWord>
  53. <KeyWord name="IsWindowMinimized" func="yes">
  54. <Overload retVal="bool" descr="Check if window has been minimized (or lost focus)"></Overload>
  55. </KeyWord>
  56. <KeyWord name="ToggleFullscreen" func="yes">
  57. <Overload retVal="void" descr="Toggle fullscreen mode (only PLATFORM_DESKTOP)"></Overload>
  58. </KeyWord>
  59. <KeyWord name="SetWindowIcon" func="yes">
  60. <Overload retVal="void" descr="Set icon for window (only PLATFORM_DESKTOP)">
  61. <Param name="Image image" />
  62. </Overload>
  63. </KeyWord>
  64. <KeyWord name="SetWindowTitle" func="yes">
  65. <Overload retVal="void" descr="Set title for window (only PLATFORM_DESKTOP)">
  66. <Param name="const char *title" />
  67. </Overload>
  68. </KeyWord>
  69. <KeyWord name="SetWindowPosition" func="yes">
  70. <Overload retVal="void" descr="Set window position on screen (only PLATFORM_DESKTOP)">
  71. <Param name="int x" />
  72. <Param name="int y" />
  73. </Overload>
  74. </KeyWord>
  75. <KeyWord name="SetWindowMonitor" func="yes">
  76. <Overload retVal="void" descr="Set monitor for the current window (fullscreen mode)">
  77. <Param name="int monitor" />
  78. </Overload>
  79. </KeyWord>
  80. <KeyWord name="SetWindowMinSize" func="yes">
  81. <Overload retVal="void" descr="Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)">
  82. <Param name="int width" />
  83. <Param name="int height" />
  84. </Overload>
  85. </KeyWord>
  86. <KeyWord name="SetWindowSize" func="yes">
  87. <Overload retVal="void" descr="Set window dimensions">
  88. <Param name="int width" />
  89. <Param name="int height" />
  90. </Overload>
  91. </KeyWord>
  92. <KeyWord name="GetScreenWidth" func="yes">
  93. <Overload retVal="int" descr="Get current screen width"></Overload>
  94. </KeyWord>
  95. <KeyWord name="GetScreenHeight" func="yes">
  96. <Overload retVal="int" descr="Get current screen height"></Overload>
  97. </KeyWord>
  98. <!-- Cursor-related functions -->
  99. <KeyWord name="ShowCursor" func="yes">
  100. <Overload retVal="void" descr="Shows cursor"></Overload>
  101. </KeyWord>
  102. <KeyWord name="HideCursor" func="yes">
  103. <Overload retVal="void" descr="Hides cursor"></Overload>
  104. </KeyWord>
  105. <KeyWord name="IsCursorHidden" func="yes">
  106. <Overload retVal="bool" descr="Check if cursor is not visible"></Overload>
  107. </KeyWord>
  108. <KeyWord name="EnableCursor" func="yes">
  109. <Overload retVal="void" descr="Enables cursor (unlock cursor)"></Overload>
  110. </KeyWord>
  111. <KeyWord name="DisableCursor" func="yes">
  112. <Overload retVal="void" descr="Disables cursor (lock cursor)"></Overload>
  113. </KeyWord>
  114. <!-- Drawing-related functions -->
  115. <KeyWord name="ClearBackground" func="yes">
  116. <Overload retVal="void" descr="Set background color (framebuffer clear color)">
  117. <Param name="Color color" />
  118. </Overload>
  119. </KeyWord>
  120. <KeyWord name="BeginDrawing" func="yes">
  121. <Overload retVal="void" descr="Setup canvas (framebuffer) to start drawing"></Overload>
  122. </KeyWord>
  123. <KeyWord name="EndDrawing" func="yes">
  124. <Overload retVal="void" descr="End canvas drawing and swap buffers (double buffering)"></Overload>
  125. </KeyWord>
  126. <KeyWord name="BeginMode2D" func="yes">
  127. <Overload retVal="void" descr="Initialize 2D mode with custom camera (2D)">
  128. <Param name="Camera2D camera" />
  129. </Overload>
  130. </KeyWord>
  131. <KeyWord name="EndMode2D" func="yes">
  132. <Overload retVal="void" descr="Ends 2D mode with custom camera"></Overload>
  133. </KeyWord>
  134. <KeyWord name="BeginMode3D" func="yes">
  135. <Overload retVal="void" descr="Initializes 3D mode with custom camera (3D)">
  136. <Param name="Camera3D camera" />
  137. </Overload>
  138. </KeyWord>
  139. <KeyWord name="EndMode3D" func="yes">
  140. <Overload retVal="void" descr="Ends 3D mode and returns to default 2D orthographic mode"></Overload>
  141. </KeyWord>
  142. <KeyWord name="BeginTextureMode" func="yes">
  143. <Overload retVal="void" descr="Initializes render texture for drawing">
  144. <Param name="RenderTexture2D target" />
  145. </Overload>
  146. </KeyWord>
  147. <KeyWord name="EndTextureMode" func="yes">
  148. <Overload retVal="void" descr="Ends drawing to render texture"></Overload>
  149. </KeyWord>
  150. <!-- Screen-space-related functions -->
  151. <KeyWord name="GetMouseRay" func="yes">
  152. <Overload retVal="Ray" descr="Returns a ray trace from mouse position">
  153. <Param name="Vector2 mousePosition" />
  154. <Param name="Camera camera" />
  155. </Overload>
  156. </KeyWord>
  157. <KeyWord name="GetWorldToScreen" func="yes">
  158. <Overload retVal="Vector2" descr="Returns the screen space position for a 3d world space position">
  159. <Param name="Vector3 position" />
  160. <Param name="Camera camera" />
  161. </Overload>
  162. </KeyWord>
  163. <KeyWord name="GetCameraMatrix" func="yes">
  164. <Overload retVal="Matrix" descr="Returns camera transform matrix (view matrix)">
  165. <Param name="Camera camera" />
  166. </Overload>
  167. </KeyWord>
  168. <!-- Timing-related functions -->
  169. <KeyWord name="SetTargetFPS" func="yes">
  170. <Overload retVal="void" descr="Set target FPS (maximum)">
  171. <Param name="int fps" />
  172. </Overload>
  173. </KeyWord>
  174. <KeyWord name="GetFPS" func="yes">
  175. <Overload retVal="int" descr="Returns current FPS"></Overload>
  176. </KeyWord>
  177. <KeyWord name="GetFrameTime" func="yes">
  178. <Overload retVal="float" descr="Returns time in seconds for last frame drawn"></Overload>
  179. </KeyWord>
  180. <KeyWord name="GetTime" func="yes">
  181. <Overload retVal="double" descr="Returns elapsed time in seconds since InitWindow()"></Overload>
  182. </KeyWord>
  183. <!-- Color-related functions -->
  184. <KeyWord name="ColorToInt" func="yes">
  185. <Overload retVal="int" descr="Returns hexadecimal value for a Color">
  186. <Param name="Color color" />
  187. </Overload>
  188. </KeyWord>
  189. <KeyWord name="ColorNormalize" func="yes">
  190. <Overload retVal="Vector4" descr="Returns color normalized as float [0..1]">
  191. <Param name="Color color" />
  192. </Overload>
  193. </KeyWord>
  194. <KeyWord name="ColorToHSV" func="yes">
  195. <Overload retVal="Vector3" descr="Returns HSV values for a Color">
  196. <Param name="Color color" />
  197. </Overload>
  198. </KeyWord>
  199. <KeyWord name="GetColor" func="yes">
  200. <Overload retVal="Color" descr="Returns a Color struct from hexadecimal value">
  201. <Param name="int hexValue" />
  202. </Overload>
  203. </KeyWord>
  204. <KeyWord name="Fade" func="yes">
  205. <Overload retVal="Color" descr="Color fade-in or fade-out, alpha goes from 0.0f to 1.0f">
  206. <Param name="Color color" />
  207. <Param name="float alpha" />
  208. </Overload>
  209. </KeyWord>
  210. <!-- Misc. functions -->
  211. <KeyWord name="ShowLogo" func="yes">
  212. <Overload retVal="void" descr="Activate raylib logo at startup (can be done with flags)"></Overload>
  213. </KeyWord>
  214. <KeyWord name="SetConfigFlags" func="yes">
  215. <Overload retVal="void" descr="Setup window configuration flags (view FLAGS)">
  216. <Param name="unsigned char flags" />
  217. </Overload>
  218. </KeyWord>
  219. <KeyWord name="SetTraceLog" func="yes">
  220. <Overload retVal="void" descr="Enable trace log message types (bit flags based)">
  221. <Param name="unsigned char types" />
  222. </Overload>
  223. </KeyWord>
  224. <KeyWord name="TraceLog" func="yes">
  225. <Overload retVal="void" descr="Show trace log messages (LOG_INFO, LOG_WARNING, LOG_ERROR, LOG_DEBUG)">
  226. <Param name="int logType" />
  227. <Param name="const char *text" />
  228. <Param name="..." />
  229. </Overload>
  230. </KeyWord>
  231. <KeyWord name="TakeScreenshot" func="yes">
  232. <Overload retVal="void" descr="Takes a screenshot of current screen (saved a .png)">
  233. <Param name="const char *fileName" />
  234. </Overload>
  235. </KeyWord>
  236. <KeyWord name="GetRandomValue" func="yes">
  237. <Overload retVal="int" descr="Returns a random value between min and max (both included)">
  238. <Param name="int min" />
  239. <Param name="int max" />
  240. </Overload>
  241. </KeyWord>
  242. <!-- Files management functions -->
  243. <KeyWord name="IsFileExtension" func="yes">
  244. <Overload retVal="bool" descr="Check file extension">
  245. <Param name="const char *fileName" />
  246. <Param name="const char *ext" />
  247. </Overload>
  248. </KeyWord>
  249. <KeyWord name="GetExtension" func="yes">
  250. <Overload retVal="const char" descr="Get pointer to extension for a filename string">
  251. <Param name="const char *fileName" />
  252. </Overload>
  253. </KeyWord>
  254. <KeyWord name="GetFileName" func="yes">
  255. <Overload retVal="const char" descr="Get pointer to filename for a path string">
  256. <Param name="const char *filePath" />
  257. </Overload>
  258. </KeyWord>
  259. <KeyWord name="GetDirectoryPath" func="yes">
  260. <Overload retVal="const char" descr="Get full path for a given fileName (uses static string)">
  261. <Param name="const char *fileName" />
  262. </Overload>
  263. </KeyWord>
  264. <KeyWord name="GetWorkingDirectory" func="yes">
  265. <Overload retVal="const char" descr="Get current working directory (uses static string)"></Overload>
  266. </KeyWord>
  267. <KeyWord name="ChangeDirectory" func="yes">
  268. <Overload retVal="bool" descr="Change working directory, returns true if success">
  269. <Param name="const char *dir" />
  270. </Overload>
  271. </KeyWord>
  272. <KeyWord name="IsFileDropped" func="yes">
  273. <Overload retVal="bool" descr="Check if a file has been dropped into window"></Overload>
  274. </KeyWord>
  275. <KeyWord name="GetDroppedFiles" func="yes">
  276. <Overload retVal="char" descr="Get dropped files names">
  277. <Param name="int *count" />
  278. </Overload>
  279. </KeyWord>
  280. <KeyWord name="ClearDroppedFiles" func="yes">
  281. <Overload retVal="void" descr="Clear dropped files paths buffer"></Overload>
  282. </KeyWord>
  283. <!-- Persistent storage management -->
  284. <KeyWord name="StorageSaveValue" func="yes">
  285. <Overload retVal="void" descr="Save integer value to storage file (to defined position)">
  286. <Param name="int position" />
  287. <Param name="int value" />
  288. </Overload>
  289. </KeyWord>
  290. <KeyWord name="StorageLoadValue" func="yes">
  291. <Overload retVal="int" descr="Load integer value from storage file (from defined position)">
  292. <Param name="int position" />
  293. </Overload>
  294. </KeyWord>
  295. <!-------------------------------------------------------------------------------------- -->
  296. <!-- Input Handling Functions (Module: core) -->
  297. <!-------------------------------------------------------------------------------------- -->
  298. <!-- Input-related functions: keyboard -->
  299. <KeyWord name="IsKeyPressed" func="yes">
  300. <Overload retVal="bool" descr="Detect if a key has been pressed once">
  301. <Param name="int key" />
  302. </Overload>
  303. </KeyWord>
  304. <KeyWord name="IsKeyDown" func="yes">
  305. <Overload retVal="bool" descr="Detect if a key is being pressed">
  306. <Param name="int key" />
  307. </Overload>
  308. </KeyWord>
  309. <KeyWord name="IsKeyReleased" func="yes">
  310. <Overload retVal="bool" descr="Detect if a key has been released once">
  311. <Param name="int key" />
  312. </Overload>
  313. </KeyWord>
  314. <KeyWord name="IsKeyUp" func="yes">
  315. <Overload retVal="bool" descr="Detect if a key is NOT being pressed">
  316. <Param name="int key" />
  317. </Overload>
  318. </KeyWord>
  319. <KeyWord name="GetKeyPressed" func="yes">
  320. <Overload retVal="int" descr="Get latest key pressed"></Overload>
  321. </KeyWord>
  322. <KeyWord name="SetExitKey" func="yes">
  323. <Overload retVal="void" descr="Set a custom key to exit program (default is ESC)">
  324. <Param name="int key" />
  325. </Overload>
  326. </KeyWord>
  327. <!-- Input-related functions: gamepads -->
  328. <KeyWord name="IsGamepadAvailable" func="yes">
  329. <Overload retVal="bool" descr="Detect if a gamepad is available">
  330. <Param name="int gamepad" />
  331. </Overload>
  332. </KeyWord>
  333. <KeyWord name="IsGamepadName" func="yes">
  334. <Overload retVal="bool" descr="Check gamepad name (if available)">
  335. <Param name="int gamepad" />
  336. <Param name="const char *name" />
  337. </Overload>
  338. </KeyWord>
  339. <KeyWord name="GetGamepadName" func="yes">
  340. <Overload retVal="const char" descr="Return gamepad internal name id">
  341. <Param name="int gamepad" />
  342. </Overload>
  343. </KeyWord>
  344. <KeyWord name="IsGamepadButtonPressed" func="yes">
  345. <Overload retVal="bool" descr="Detect if a gamepad button has been pressed once">
  346. <Param name="int gamepad" />
  347. <Param name="int button" />
  348. </Overload>
  349. </KeyWord>
  350. <KeyWord name="IsGamepadButtonDown" func="yes">
  351. <Overload retVal="bool" descr="Detect if a gamepad button is being pressed">
  352. <Param name="int gamepad" />
  353. <Param name="int button" />
  354. </Overload>
  355. </KeyWord>
  356. <KeyWord name="IsGamepadButtonReleased" func="yes">
  357. <Overload retVal="bool" descr="Detect if a gamepad button has been released once">
  358. <Param name="int gamepad" />
  359. <Param name="int button" />
  360. </Overload>
  361. </KeyWord>
  362. <KeyWord name="IsGamepadButtonUp" func="yes">
  363. <Overload retVal="bool" descr="Detect if a gamepad button is NOT being pressed">
  364. <Param name="int gamepad" />
  365. <Param name="int button" />
  366. </Overload>
  367. </KeyWord>
  368. <KeyWord name="GetGamepadButtonPressed" func="yes">
  369. <Overload retVal="int" descr="Get the last gamepad button pressed"></Overload>
  370. </KeyWord>
  371. <KeyWord name="GetGamepadAxisCount" func="yes">
  372. <Overload retVal="int" descr="Return gamepad axis count for a gamepad">
  373. <Param name="int gamepad" />
  374. </Overload>
  375. </KeyWord>
  376. <KeyWord name="GetGamepadAxisMovement" func="yes">
  377. <Overload retVal="float" descr="Return axis movement value for a gamepad axis">
  378. <Param name="int gamepad" />
  379. <Param name="int axis" />
  380. </Overload>
  381. </KeyWord>
  382. <!-- Input-related functions: mouse -->
  383. <KeyWord name="IsMouseButtonPressed" func="yes">
  384. <Overload retVal="bool" descr="Detect if a mouse button has been pressed once">
  385. <Param name="int button" />
  386. </Overload>
  387. </KeyWord>
  388. <KeyWord name="IsMouseButtonDown" func="yes">
  389. <Overload retVal="bool" descr="Detect if a mouse button is being pressed">
  390. <Param name="int button" />
  391. </Overload>
  392. </KeyWord>
  393. <KeyWord name="IsMouseButtonReleased" func="yes">
  394. <Overload retVal="bool" descr="Detect if a mouse button has been released once">
  395. <Param name="int button" />
  396. </Overload>
  397. </KeyWord>
  398. <KeyWord name="IsMouseButtonUp" func="yes">
  399. <Overload retVal="bool" descr="Detect if a mouse button is NOT being pressed">
  400. <Param name="int button" />
  401. </Overload>
  402. </KeyWord>
  403. <KeyWord name="GetMouseX" func="yes">
  404. <Overload retVal="int" descr="Returns mouse position X"></Overload>
  405. </KeyWord>
  406. <KeyWord name="GetMouseY" func="yes">
  407. <Overload retVal="int" descr="Returns mouse position Y"></Overload>
  408. </KeyWord>
  409. <KeyWord name="GetMousePosition" func="yes">
  410. <Overload retVal="Vector2" descr="Returns mouse position XY"></Overload>
  411. </KeyWord>
  412. <KeyWord name="SetMousePosition" func="yes">
  413. <Overload retVal="void" descr="Set mouse position XY">
  414. <Param name="Vector2 position" />
  415. </Overload>
  416. </KeyWord>
  417. <KeyWord name="SetMouseScale" func="yes">
  418. <Overload retVal="void" descr="Set mouse scaling">
  419. <Param name="float scale" />
  420. </Overload>
  421. </KeyWord>
  422. <KeyWord name="GetMouseWheelMove" func="yes">
  423. <Overload retVal="int" descr="Returns mouse wheel movement Y"></Overload>
  424. </KeyWord>
  425. <!-- Input-related functions: touch -->
  426. <KeyWord name="GetTouchX" func="yes">
  427. <Overload retVal="int" descr="Returns touch position X for touch point 0 (relative to screen size)"></Overload>
  428. </KeyWord>
  429. <KeyWord name="GetTouchY" func="yes">
  430. <Overload retVal="int" descr="Returns touch position Y for touch point 0 (relative to screen size)"></Overload>
  431. </KeyWord>
  432. <KeyWord name="GetTouchPosition" func="yes">
  433. <Overload retVal="Vector2" descr="Returns touch position XY for a touch point index (relative to screen size)">
  434. <Param name="int index" />
  435. </Overload>
  436. </KeyWord>
  437. <!-------------------------------------------------------------------------------------- -->
  438. <!-- Gestures and Touch Handling Functions (Module: gestures) -->
  439. <!-------------------------------------------------------------------------------------- -->
  440. <KeyWord name="SetGesturesEnabled" func="yes">
  441. <Overload retVal="void" descr="Enable a set of gestures using flags">
  442. <Param name="unsigned int gestureFlags" />
  443. </Overload>
  444. </KeyWord>
  445. <KeyWord name="IsGestureDetected" func="yes">
  446. <Overload retVal="bool" descr="Check if a gesture have been detected">
  447. <Param name="int gesture" />
  448. </Overload>
  449. </KeyWord>
  450. <KeyWord name="GetGestureDetected" func="yes">
  451. <Overload retVal="int" descr="Get latest detected gesture"></Overload>
  452. </KeyWord>
  453. <KeyWord name="GetTouchPointsCount" func="yes">
  454. <Overload retVal="int" descr="Get touch points count"></Overload>
  455. </KeyWord>
  456. <KeyWord name="GetGestureHoldDuration" func="yes">
  457. <Overload retVal="float" descr="Get gesture hold time in milliseconds"></Overload>
  458. </KeyWord>
  459. <KeyWord name="GetGestureDragVector" func="yes">
  460. <Overload retVal="Vector2" descr="Get gesture drag vector"></Overload>
  461. </KeyWord>
  462. <KeyWord name="GetGestureDragAngle" func="yes">
  463. <Overload retVal="float" descr="Get gesture drag angle"></Overload>
  464. </KeyWord>
  465. <KeyWord name="GetGesturePinchVector" func="yes">
  466. <Overload retVal="Vector2" descr="Get gesture pinch delta"></Overload>
  467. </KeyWord>
  468. <KeyWord name="GetGesturePinchAngle" func="yes">
  469. <Overload retVal="float" descr="Get gesture pinch angle"></Overload>
  470. </KeyWord>
  471. <!-------------------------------------------------------------------------------------- -->
  472. <!-- Camera System Functions (Module: camera) -->
  473. <!-------------------------------------------------------------------------------------- -->
  474. <KeyWord name="SetCameraMode" func="yes">
  475. <Overload retVal="void" descr="Set camera mode (multiple camera modes available)">
  476. <Param name="Camera camera" />
  477. <Param name="int mode" />
  478. </Overload>
  479. </KeyWord>
  480. <KeyWord name="UpdateCamera" func="yes">
  481. <Overload retVal="void" descr="Update camera position for selected mode">
  482. <Param name="Camera *camera" />
  483. </Overload>
  484. </KeyWord>
  485. <KeyWord name="SetCameraPanControl" func="yes">
  486. <Overload retVal="void" descr="Set camera pan key to combine with mouse movement (free camera)">
  487. <Param name="int panKey" />
  488. </Overload>
  489. </KeyWord>
  490. <KeyWord name="SetCameraAltControl" func="yes">
  491. <Overload retVal="void" descr="Set camera alt key to combine with mouse movement (free camera)">
  492. <Param name="int altKey" />
  493. </Overload>
  494. </KeyWord>
  495. <KeyWord name="SetCameraSmoothZoomControl" func="yes">
  496. <Overload retVal="void" descr="Set camera smooth zoom key to combine with mouse (free camera)">
  497. <Param name="int szKey" />
  498. </Overload>
  499. </KeyWord>
  500. <KeyWord name="SetCameraMoveControls" func="yes">
  501. <Overload retVal="void" descr="Set camera move controls (1st person and 3rd person cameras)">
  502. <Param name="int frontKey" />
  503. <Param name="int backKey" />
  504. <Param name="int rightKey" />
  505. <Param name="int leftKey" />
  506. <Param name="int upKey" />
  507. <Param name="int downKey" />
  508. </Overload>
  509. </KeyWord>
  510. <!-------------------------------------------------------------------------------------- -->
  511. <!-- Basic Shapes Drawing Functions (Module: shapes) -->
  512. <!-------------------------------------------------------------------------------------- -->
  513. <!-- Basic shapes drawing functions -->
  514. <KeyWord name="DrawPixel" func="yes">
  515. <Overload retVal="void" descr="Draw a pixel">
  516. <Param name="int posX" />
  517. <Param name="int posY" />
  518. <Param name="Color color" />
  519. </Overload>
  520. </KeyWord>
  521. <KeyWord name="DrawPixelV" func="yes">
  522. <Overload retVal="void" descr="Draw a pixel (Vector version)">
  523. <Param name="Vector2 position" />
  524. <Param name="Color color" />
  525. </Overload>
  526. </KeyWord>
  527. <KeyWord name="DrawLine" func="yes">
  528. <Overload retVal="void" descr="Draw a line">
  529. <Param name="int startPosX" />
  530. <Param name="int startPosY" />
  531. <Param name="int endPosX" />
  532. <Param name="int endPosY" />
  533. <Param name="Color color" />
  534. </Overload>
  535. </KeyWord>
  536. <KeyWord name="DrawLineV" func="yes">
  537. <Overload retVal="void" descr="Draw a line (Vector version)">
  538. <Param name="Vector2 startPos" />
  539. <Param name="Vector2 endPos" />
  540. <Param name="Color color" />
  541. </Overload>
  542. </KeyWord>
  543. <KeyWord name="DrawLineEx" func="yes">
  544. <Overload retVal="void" descr="Draw a line defining thickness">
  545. <Param name="Vector2 startPos" />
  546. <Param name="Vector2 endPos" />
  547. <Param name="float thick" />
  548. <Param name="Color color" />
  549. </Overload>
  550. </KeyWord>
  551. <KeyWord name="DrawLineBezier" func="yes">
  552. <Overload retVal="void" descr="Draw a line using cubic-bezier curves in-out">
  553. <Param name="Vector2 startPos" />
  554. <Param name="Vector2 endPos" />
  555. <Param name="float thick" />
  556. <Param name="Color color" />
  557. </Overload>
  558. </KeyWord>
  559. <KeyWord name="DrawCircle" func="yes">
  560. <Overload retVal="void" descr="Draw a color-filled circle">
  561. <Param name="int centerX" />
  562. <Param name="int centerY" />
  563. <Param name="float radius" />
  564. <Param name="Color color" />
  565. </Overload>
  566. </KeyWord>
  567. <KeyWord name="DrawCircleGradient" func="yes">
  568. <Overload retVal="void" descr="Draw a gradient-filled circle">
  569. <Param name="int centerX" />
  570. <Param name="int centerY" />
  571. <Param name="float radius" />
  572. <Param name="Color color1" />
  573. <Param name="Color color2" />
  574. </Overload>
  575. </KeyWord>
  576. <KeyWord name="DrawCircleV" func="yes">
  577. <Overload retVal="void" descr="Draw a color-filled circle (Vector version)">
  578. <Param name="Vector2 center" />
  579. <Param name="float radius" />
  580. <Param name="Color color" />
  581. </Overload>
  582. </KeyWord>
  583. <KeyWord name="DrawCircleLines" func="yes">
  584. <Overload retVal="void" descr="Draw circle outline">
  585. <Param name="int centerX" />
  586. <Param name="int centerY" />
  587. <Param name="float radius" />
  588. <Param name="Color color" />
  589. </Overload>
  590. </KeyWord>
  591. <KeyWord name="DrawRectangle" func="yes">
  592. <Overload retVal="void" descr="Draw a color-filled rectangle">
  593. <Param name="int posX" />
  594. <Param name="int posY" />
  595. <Param name="int width" />
  596. <Param name="int height" />
  597. <Param name="Color color" />
  598. </Overload>
  599. </KeyWord>
  600. <KeyWord name="DrawRectangleV" func="yes">
  601. <Overload retVal="void" descr="Draw a color-filled rectangle (Vector version)">
  602. <Param name="Vector2 position" />
  603. <Param name="Vector2 size" />
  604. <Param name="Color color" />
  605. </Overload>
  606. </KeyWord>
  607. <KeyWord name="DrawRectangleRec" func="yes">
  608. <Overload retVal="void" descr="Draw a color-filled rectangle">
  609. <Param name="Rectangle rec" />
  610. <Param name="Color color" />
  611. </Overload>
  612. </KeyWord>
  613. <KeyWord name="DrawRectanglePro" func="yes">
  614. <Overload retVal="void" descr="Draw a color-filled rectangle with pro parameters">
  615. <Param name="Rectangle rec" />
  616. <Param name="Vector2 origin" />
  617. <Param name="float rotation" />
  618. <Param name="Color color" />
  619. </Overload>
  620. </KeyWord>
  621. <KeyWord name="DrawRectangleGradientV" func="yes">
  622. <Overload retVal="void" descr="Draw a vertical-gradient-filled rectangle">
  623. <Param name="int posX" />
  624. <Param name="int posY" />
  625. <Param name="int width" />
  626. <Param name="int height" />
  627. <Param name="Color color1" />
  628. <Param name="Color color2" />
  629. </Overload>
  630. </KeyWord>
  631. <KeyWord name="DrawRectangleGradientH" func="yes">
  632. <Overload retVal="void" descr="Draw a horizontal-gradient-filled rectangle">
  633. <Param name="int posX" />
  634. <Param name="int posY" />
  635. <Param name="int width" />
  636. <Param name="int height" />
  637. <Param name="Color color1" />
  638. <Param name="Color color2" />
  639. </Overload>
  640. </KeyWord>
  641. <KeyWord name="DrawRectangleGradientEx" func="yes">
  642. <Overload retVal="void" descr="Draw a gradient-filled rectangle with custom vertex colors">
  643. <Param name="Rectangle rec" />
  644. <Param name="Color col1" />
  645. <Param name="Color col2" />
  646. <Param name="Color col3" />
  647. <Param name="Color col4" />
  648. </Overload>
  649. </KeyWord>
  650. <KeyWord name="DrawRectangleLines" func="yes">
  651. <Overload retVal="void" descr="Draw rectangle outline">
  652. <Param name="int posX" />
  653. <Param name="int posY" />
  654. <Param name="int width" />
  655. <Param name="int height" />
  656. <Param name="Color color" />
  657. </Overload>
  658. </KeyWord>
  659. <KeyWord name="DrawRectangleLinesEx" func="yes">
  660. <Overload retVal="void" descr="Draw rectangle outline with extended parameters">
  661. <Param name="Rectangle rec" />
  662. <Param name="int lineThick" />
  663. <Param name="Color color" />
  664. </Overload>
  665. </KeyWord>
  666. <KeyWord name="DrawTriangle" func="yes">
  667. <Overload retVal="void" descr="Draw a color-filled triangle">
  668. <Param name="Vector2 v1" />
  669. <Param name="Vector2 v2" />
  670. <Param name="Vector2 v3" />
  671. <Param name="Color color" />
  672. </Overload>
  673. </KeyWord>
  674. <KeyWord name="DrawTriangleLines" func="yes">
  675. <Overload retVal="void" descr="Draw triangle outline">
  676. <Param name="Vector2 v1" />
  677. <Param name="Vector2 v2" />
  678. <Param name="Vector2 v3" />
  679. <Param name="Color color" />
  680. </Overload>
  681. </KeyWord>
  682. <KeyWord name="DrawPoly" func="yes">
  683. <Overload retVal="void" descr="Draw a regular polygon (Vector version)">
  684. <Param name="Vector2 center" />
  685. <Param name="int sides" />
  686. <Param name="float radius" />
  687. <Param name="float rotation" />
  688. <Param name="Color color" />
  689. </Overload>
  690. </KeyWord>
  691. <KeyWord name="DrawPolyEx" func="yes">
  692. <Overload retVal="void" descr="Draw a closed polygon defined by points">
  693. <Param name="Vector2 *points" />
  694. <Param name="int numPoints" />
  695. <Param name="Color color" />
  696. </Overload>
  697. </KeyWord>
  698. <KeyWord name="DrawPolyExLines" func="yes">
  699. <Overload retVal="void" descr="Draw polygon lines">
  700. <Param name="Vector2 *points" />
  701. <Param name="int numPoints" />
  702. <Param name="Color color" />
  703. </Overload>
  704. </KeyWord>
  705. <!-- Basic shapes collision detection functions -->
  706. <KeyWord name="CheckCollisionRecs" func="yes">
  707. <Overload retVal="bool" descr="Check collision between two rectangles">
  708. <Param name="Rectangle rec1" />
  709. <Param name="Rectangle rec2" />
  710. </Overload>
  711. </KeyWord>
  712. <KeyWord name="CheckCollisionCircles" func="yes">
  713. <Overload retVal="bool" descr="Check collision between two circles">
  714. <Param name="Vector2 center1" />
  715. <Param name="float radius1" />
  716. <Param name="Vector2 center2" />
  717. <Param name="float radius2" />
  718. </Overload>
  719. </KeyWord>
  720. <KeyWord name="CheckCollisionCircleRec" func="yes">
  721. <Overload retVal="bool" descr="Check collision between circle and rectangle">
  722. <Param name="Vector2 center" />
  723. <Param name="float radius" />
  724. <Param name="Rectangle rec" />
  725. </Overload>
  726. </KeyWord>
  727. <KeyWord name="GetCollisionRec" func="yes">
  728. <Overload retVal="Rectangle" descr="Get collision rectangle for two rectangles collision">
  729. <Param name="Rectangle rec1" />
  730. <Param name="Rectangle rec2" />
  731. </Overload>
  732. </KeyWord>
  733. <KeyWord name="CheckCollisionPointRec" func="yes">
  734. <Overload retVal="bool" descr="Check if point is inside rectangle">
  735. <Param name="Vector2 point" />
  736. <Param name="Rectangle rec" />
  737. </Overload>
  738. </KeyWord>
  739. <KeyWord name="CheckCollisionPointCircle" func="yes">
  740. <Overload retVal="bool" descr="Check if point is inside circle">
  741. <Param name="Vector2 point" />
  742. <Param name="Vector2 center" />
  743. <Param name="float radius" />
  744. </Overload>
  745. </KeyWord>
  746. <KeyWord name="CheckCollisionPointTriangle" func="yes">
  747. <Overload retVal="bool" descr="Check if point is inside a triangle">
  748. <Param name="Vector2 point" />
  749. <Param name="Vector2 p1" />
  750. <Param name="Vector2 p2" />
  751. <Param name="Vector2 p3" />
  752. </Overload>
  753. </KeyWord>
  754. <!-------------------------------------------------------------------------------------- -->
  755. <!-- Texture Loading and Drawing Functions (Module: textures) -->
  756. <!-------------------------------------------------------------------------------------- -->
  757. <!-- Image/Texture2D data loading/unloading/saving functions -->
  758. <KeyWord name="LoadImage" func="yes">
  759. <Overload retVal="Image" descr="Load image from file into CPU memory (RAM)">
  760. <Param name="const char *fileName" />
  761. </Overload>
  762. </KeyWord>
  763. <KeyWord name="LoadImageEx" func="yes">
  764. <Overload retVal="Image" descr="Load image from Color array data (RGBA - 32bit)">
  765. <Param name="Color *pixels" />
  766. <Param name="int width" />
  767. <Param name="int height" />
  768. </Overload>
  769. </KeyWord>
  770. <KeyWord name="LoadImagePro" func="yes">
  771. <Overload retVal="Image" descr="Load image from raw data with parameters"></Overload>
  772. </KeyWord>
  773. <KeyWord name="LoadImageRaw" func="yes">
  774. <Overload retVal="Image" descr="Load image from RAW file data">
  775. <Param name="const char *fileName" />
  776. <Param name="int width" />
  777. <Param name="int height" />
  778. <Param name="int format" />
  779. <Param name="int headerSize" />
  780. </Overload>
  781. </KeyWord>
  782. <KeyWord name="ExportImage" func="yes">
  783. <Overload retVal="void" descr="Export image as a PNG file">
  784. <Param name="const char *fileName" />
  785. <Param name="Image image" />
  786. </Overload>
  787. </KeyWord>
  788. <KeyWord name="LoadTexture" func="yes">
  789. <Overload retVal="Texture2D" descr="Load texture from file into GPU memory (VRAM)">
  790. <Param name="const char *fileName" />
  791. </Overload>
  792. </KeyWord>
  793. <KeyWord name="LoadTextureFromImage" func="yes">
  794. <Overload retVal="Texture2D" descr="Load texture from image data">
  795. <Param name="Image image" />
  796. </Overload>
  797. </KeyWord>
  798. <KeyWord name="LoadRenderTexture" func="yes">
  799. <Overload retVal="RenderTexture2D" descr="Load texture for rendering (framebuffer)">
  800. <Param name="int width" />
  801. <Param name="int height" />
  802. </Overload>
  803. </KeyWord>
  804. <KeyWord name="UnloadImage" func="yes">
  805. <Overload retVal="void" descr="Unload image from CPU memory (RAM)">
  806. <Param name="Image image" />
  807. </Overload>
  808. </KeyWord>
  809. <KeyWord name="UnloadTexture" func="yes">
  810. <Overload retVal="void" descr="Unload texture from GPU memory (VRAM)">
  811. <Param name="Texture2D texture" />
  812. </Overload>
  813. </KeyWord>
  814. <KeyWord name="UnloadRenderTexture" func="yes">
  815. <Overload retVal="void" descr="Unload render texture from GPU memory (VRAM)">
  816. <Param name="RenderTexture2D target" />
  817. </Overload>
  818. </KeyWord>
  819. <KeyWord name="GetImageData" func="yes">
  820. <Overload retVal="Color" descr="Get pixel data from image as a Color struct array">
  821. <Param name="Image image" />
  822. </Overload>
  823. </KeyWord>
  824. <KeyWord name="GetImageDataNormalized" func="yes">
  825. <Overload retVal="Vector4" descr="Get pixel data from image as Vector4 array (float normalized)">
  826. <Param name="Image image" />
  827. </Overload>
  828. </KeyWord>
  829. <KeyWord name="GetPixelDataSize" func="yes">
  830. <Overload retVal="int" descr="Get pixel data size in bytes (image or texture)">
  831. <Param name="int width" />
  832. <Param name="int height" />
  833. <Param name="int format" />
  834. </Overload>
  835. </KeyWord>
  836. <KeyWord name="GetTextureData" func="yes">
  837. <Overload retVal="Image" descr="Get pixel data from GPU texture and return an Image">
  838. <Param name="Texture2D texture" />
  839. </Overload>
  840. </KeyWord>
  841. <KeyWord name="UpdateTexture" func="yes">
  842. <Overload retVal="void" descr="Update GPU texture with new data">
  843. <Param name="Texture2D texture" />
  844. <Param name="const void *pixels" />
  845. </Overload>
  846. </KeyWord>
  847. <!-- Image manipulation functions -->
  848. <KeyWord name="ImageCopy" func="yes">
  849. <Overload retVal="Image" descr="Create an image duplicate (useful for transformations)">
  850. <Param name="Image image" />
  851. </Overload>
  852. </KeyWord>
  853. <KeyWord name="ImageToPOT" func="yes">
  854. <Overload retVal="void" descr="Convert image to POT (power-of-two)">
  855. <Param name="Image *image" />
  856. <Param name="Color fillColor" />
  857. </Overload>
  858. </KeyWord>
  859. <KeyWord name="ImageFormat" func="yes">
  860. <Overload retVal="void" descr="Convert image data to desired format">
  861. <Param name="Image *image" />
  862. <Param name="int newFormat" />
  863. </Overload>
  864. </KeyWord>
  865. <KeyWord name="ImageAlphaMask" func="yes">
  866. <Overload retVal="void" descr="Apply alpha mask to image">
  867. <Param name="Image *image" />
  868. <Param name="Image alphaMask" />
  869. </Overload>
  870. </KeyWord>
  871. <KeyWord name="ImageAlphaClear" func="yes">
  872. <Overload retVal="void" descr="Clear alpha channel to desired color">
  873. <Param name="Image *image" />
  874. <Param name="Color color" />
  875. <Param name="float threshold" />
  876. </Overload>
  877. </KeyWord>
  878. <KeyWord name="ImageAlphaCrop" func="yes">
  879. <Overload retVal="void" descr="Crop image depending on alpha value">
  880. <Param name="Image *image" />
  881. <Param name="float threshold" />
  882. </Overload>
  883. </KeyWord>
  884. <KeyWord name="ImageAlphaPremultiply" func="yes">
  885. <Overload retVal="void" descr="Premultiply alpha channel">
  886. <Param name="Image *image" />
  887. </Overload>
  888. </KeyWord>
  889. <KeyWord name="ImageCrop" func="yes">
  890. <Overload retVal="void" descr="Crop an image to a defined rectangle">
  891. <Param name="Image *image" />
  892. <Param name="Rectangle crop" />
  893. </Overload>
  894. </KeyWord>
  895. <KeyWord name="ImageResize" func="yes">
  896. <Overload retVal="void" descr="Resize and image (bilinear filtering)">
  897. <Param name="Image *image" />
  898. <Param name="int newWidth" />
  899. <Param name="int newHeight" />
  900. </Overload>
  901. </KeyWord>
  902. <KeyWord name="ImageResizeNN" func="yes">
  903. <Overload retVal="void" descr="Resize and image (Nearest-Neighbor scaling algorithm)">
  904. <Param name="Image *image" />
  905. <Param name="int newWidth" />
  906. <Param name="int newHeight" />
  907. </Overload>
  908. </KeyWord>
  909. <KeyWord name="ImageResizeCanvas" func="yes">
  910. <Overload retVal="void" descr="Resize canvas and fill with color">
  911. <Param name="Image *image" />
  912. <Param name="int newWidth" />
  913. <Param name="int newHeight" />
  914. <Param name="int offsetX" />
  915. <Param name="int offsetY" />
  916. <Param name="Color color" />
  917. </Overload>
  918. </KeyWord>
  919. <KeyWord name="ImageMipmaps" func="yes">
  920. <Overload retVal="void" descr="Generate all mipmap levels for a provided image">
  921. <Param name="Image *image" />
  922. </Overload>
  923. </KeyWord>
  924. <KeyWord name="ImageDither" func="yes">
  925. <Overload retVal="void" descr="Dither image data to 16bpp or lower (Floyd-Steinberg dithering)">
  926. <Param name="Image *image" />
  927. <Param name="int rBpp" />
  928. <Param name="int gBpp" />
  929. <Param name="int bBpp" />
  930. <Param name="int aBpp" />
  931. </Overload>
  932. </KeyWord>
  933. <KeyWord name="ImageText" func="yes">
  934. <Overload retVal="Image" descr="Create an image from text (default font)">
  935. <Param name="const char *text" />
  936. <Param name="int fontSize" />
  937. <Param name="Color color" />
  938. </Overload>
  939. </KeyWord>
  940. <KeyWord name="ImageTextEx" func="yes">
  941. <Overload retVal="Image" descr="Create an image from text (custom sprite font)">
  942. <Param name="Font font" />
  943. <Param name="const char *text" />
  944. <Param name="float fontSize" />
  945. <Param name="float spacing" />
  946. <Param name="Color tint" />
  947. </Overload>
  948. </KeyWord>
  949. <KeyWord name="ImageDraw" func="yes">
  950. <Overload retVal="void" descr="Draw a source image within a destination image">
  951. <Param name="Image *dst" />
  952. <Param name="Image src" />
  953. <Param name="Rectangle srcRec" />
  954. <Param name="Rectangle dstRec" />
  955. </Overload>
  956. </KeyWord>
  957. <KeyWord name="ImageDrawRectangle" func="yes">
  958. <Overload retVal="void" descr="Draw rectangle within an image">
  959. <Param name="Image *dst" />
  960. <Param name="Vector2 position" />
  961. <Param name="Rectangle rec" />
  962. <Param name="Color color" />
  963. </Overload>
  964. </KeyWord>
  965. <KeyWord name="ImageDrawText" func="yes">
  966. <Overload retVal="void" descr="Draw text (default font) within an image (destination)">
  967. <Param name="Image *dst" />
  968. <Param name="Vector2 position" />
  969. <Param name="const char *text" />
  970. <Param name="int fontSize" />
  971. <Param name="Color color" />
  972. </Overload>
  973. </KeyWord>
  974. <KeyWord name="ImageDrawTextEx" func="yes">
  975. <Overload retVal="void" descr="Draw text (custom sprite font) within an image (destination)">
  976. <Param name="Image *dst" />
  977. <Param name="Vector2 position" />
  978. <Param name="Font font" />
  979. <Param name="const char *text" />
  980. <Param name="float fontSize" />
  981. <Param name="float spacing" />
  982. <Param name="Color color" />
  983. </Overload>
  984. </KeyWord>
  985. <KeyWord name="ImageFlipVertical" func="yes">
  986. <Overload retVal="void" descr="Flip image vertically">
  987. <Param name="Image *image" />
  988. </Overload>
  989. </KeyWord>
  990. <KeyWord name="ImageFlipHorizontal" func="yes">
  991. <Overload retVal="void" descr="Flip image horizontally">
  992. <Param name="Image *image" />
  993. </Overload>
  994. </KeyWord>
  995. <KeyWord name="ImageRotateCW" func="yes">
  996. <Overload retVal="void" descr="Rotate image clockwise 90deg">
  997. <Param name="Image *image" />
  998. </Overload>
  999. </KeyWord>
  1000. <KeyWord name="ImageRotateCCW" func="yes">
  1001. <Overload retVal="void" descr="Rotate image counter-clockwise 90deg">
  1002. <Param name="Image *image" />
  1003. </Overload>
  1004. </KeyWord>
  1005. <KeyWord name="ImageColorTint" func="yes">
  1006. <Overload retVal="void" descr="Modify image color: tint">
  1007. <Param name="Image *image" />
  1008. <Param name="Color color" />
  1009. </Overload>
  1010. </KeyWord>
  1011. <KeyWord name="ImageColorInvert" func="yes">
  1012. <Overload retVal="void" descr="Modify image color: invert">
  1013. <Param name="Image *image" />
  1014. </Overload>
  1015. </KeyWord>
  1016. <KeyWord name="ImageColorGrayscale" func="yes">
  1017. <Overload retVal="void" descr="Modify image color: grayscale">
  1018. <Param name="Image *image" />
  1019. </Overload>
  1020. </KeyWord>
  1021. <KeyWord name="ImageColorContrast" func="yes">
  1022. <Overload retVal="void" descr="Modify image color: contrast (-100 to 100)">
  1023. <Param name="Image *image" />
  1024. <Param name="float contrast" />
  1025. </Overload>
  1026. </KeyWord>
  1027. <KeyWord name="ImageColorBrightness" func="yes">
  1028. <Overload retVal="void" descr="Modify image color: brightness (-255 to 255)">
  1029. <Param name="Image *image" />
  1030. <Param name="int brightness" />
  1031. </Overload>
  1032. </KeyWord>
  1033. <KeyWord name="ImageColorReplace" func="yes">
  1034. <Overload retVal="void" descr="Modify image color: replace color">
  1035. <Param name="Image *image" />
  1036. <Param name="Color color" />
  1037. <Param name="Color replace" />
  1038. </Overload>
  1039. </KeyWord>
  1040. <!-- Image generation functions -->
  1041. <KeyWord name="GenImageColor" func="yes">
  1042. <Overload retVal="Image" descr="Generate image: plain color">
  1043. <Param name="int width" />
  1044. <Param name="int height" />
  1045. <Param name="Color color" />
  1046. </Overload>
  1047. </KeyWord>
  1048. <KeyWord name="GenImageGradientV" func="yes">
  1049. <Overload retVal="Image" descr="Generate image: vertical gradient">
  1050. <Param name="int width" />
  1051. <Param name="int height" />
  1052. <Param name="Color top" />
  1053. <Param name="Color bottom" />
  1054. </Overload>
  1055. </KeyWord>
  1056. <KeyWord name="GenImageGradientH" func="yes">
  1057. <Overload retVal="Image" descr="Generate image: horizontal gradient">
  1058. <Param name="int width" />
  1059. <Param name="int height" />
  1060. <Param name="Color left" />
  1061. <Param name="Color right" />
  1062. </Overload>
  1063. </KeyWord>
  1064. <KeyWord name="GenImageGradientRadial" func="yes">
  1065. <Overload retVal="Image" descr="Generate image: radial gradient">
  1066. <Param name="int width" />
  1067. <Param name="int height" />
  1068. <Param name="float density" />
  1069. <Param name="Color inner" />
  1070. <Param name="Color outer" />
  1071. </Overload>
  1072. </KeyWord>
  1073. <KeyWord name="GenImageChecked" func="yes">
  1074. <Overload retVal="Image" descr="Generate image: checked">
  1075. <Param name="int width" />
  1076. <Param name="int height" />
  1077. <Param name="int checksX" />
  1078. <Param name="int checksY" />
  1079. <Param name="Color col1" />
  1080. <Param name="Color col2" />
  1081. </Overload>
  1082. </KeyWord>
  1083. <KeyWord name="GenImageWhiteNoise" func="yes">
  1084. <Overload retVal="Image" descr="Generate image: white noise">
  1085. <Param name="int width" />
  1086. <Param name="int height" />
  1087. <Param name="float factor" />
  1088. </Overload>
  1089. </KeyWord>
  1090. <KeyWord name="GenImagePerlinNoise" func="yes">
  1091. <Overload retVal="Image" descr="Generate image: perlin noise">
  1092. <Param name="int width" />
  1093. <Param name="int height" />
  1094. <Param name="int offsetX" />
  1095. <Param name="int offsetY" />
  1096. <Param name="float scale" />
  1097. </Overload>
  1098. </KeyWord>
  1099. <KeyWord name="GenImageCellular" func="yes">
  1100. <Overload retVal="Image" descr="Generate image: cellular algorithm. Bigger tileSize means bigger cells">
  1101. <Param name="int width" />
  1102. <Param name="int height" />
  1103. <Param name="int tileSize" />
  1104. </Overload>
  1105. </KeyWord>
  1106. <!-- Texture2D configuration functions -->
  1107. <KeyWord name="GenTextureMipmaps" func="yes">
  1108. <Overload retVal="void" descr="Generate GPU mipmaps for a texture">
  1109. <Param name="Texture2D *texture" />
  1110. </Overload>
  1111. </KeyWord>
  1112. <KeyWord name="SetTextureFilter" func="yes">
  1113. <Overload retVal="void" descr="Set texture scaling filter mode">
  1114. <Param name="Texture2D texture" />
  1115. <Param name="int filterMode" />
  1116. </Overload>
  1117. </KeyWord>
  1118. <KeyWord name="SetTextureWrap" func="yes">
  1119. <Overload retVal="void" descr="Set texture wrapping mode">
  1120. <Param name="Texture2D texture" />
  1121. <Param name="int wrapMode" />
  1122. </Overload>
  1123. </KeyWord>
  1124. <!-- Texture2D drawing functions -->
  1125. <KeyWord name="DrawTexture" func="yes">
  1126. <Overload retVal="void" descr="Draw a Texture2D">
  1127. <Param name="Texture2D texture" />
  1128. <Param name="int posX" />
  1129. <Param name="int posY" />
  1130. <Param name="Color tint" />
  1131. </Overload>
  1132. </KeyWord>
  1133. <KeyWord name="DrawTextureV" func="yes">
  1134. <Overload retVal="void" descr="Draw a Texture2D with position defined as Vector2">
  1135. <Param name="Texture2D texture" />
  1136. <Param name="Vector2 position" />
  1137. <Param name="Color tint" />
  1138. </Overload>
  1139. </KeyWord>
  1140. <KeyWord name="DrawTextureEx" func="yes">
  1141. <Overload retVal="void" descr="Draw a Texture2D with extended parameters">
  1142. <Param name="Texture2D texture" />
  1143. <Param name="Vector2 position" />
  1144. <Param name="float rotation" />
  1145. <Param name="float scale" />
  1146. <Param name="Color tint" />
  1147. </Overload>
  1148. </KeyWord>
  1149. <KeyWord name="DrawTextureRec" func="yes">
  1150. <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle">
  1151. <Param name="Texture2D texture" />
  1152. <Param name="Rectangle sourceRec" />
  1153. <Param name="Vector2 position" />
  1154. <Param name="Color tint" />
  1155. </Overload>
  1156. </KeyWord>
  1157. <KeyWord name="DrawTexturePro" func="yes">
  1158. <Overload retVal="void" descr="Draw a part of a texture defined by a rectangle with 'pro' parameters">
  1159. <Param name="Texture2D texture" />
  1160. <Param name="Rectangle sourceRec" />
  1161. <Param name="Rectangle destRec" />
  1162. <Param name="Vector2 origin" />
  1163. <Param name="float rotation" />
  1164. <Param name="Color tint" />
  1165. </Overload>
  1166. </KeyWord>
  1167. <!-------------------------------------------------------------------------------------- -->
  1168. <!-- Font Loading and Text Drawing Functions (Module: text) -->
  1169. <!-------------------------------------------------------------------------------------- -->
  1170. <!-- Font loading/unloading functions -->
  1171. <KeyWord name="GetFontDefault" func="yes">
  1172. <Overload retVal="Font" descr="Get the default Font"></Overload>
  1173. </KeyWord>
  1174. <KeyWord name="LoadFont" func="yes">
  1175. <Overload retVal="Font" descr="Load font from file into GPU memory (VRAM)">
  1176. <Param name="const char *fileName" />
  1177. </Overload>
  1178. </KeyWord>
  1179. <KeyWord name="LoadFontEx" func="yes">
  1180. <Overload retVal="Font" descr="Load font from file with extended parameters">
  1181. <Param name="const char *fileName" />
  1182. <Param name="int fontSize" />
  1183. <Param name="int charsCount" />
  1184. <Param name="int *fontChars" />
  1185. </Overload>
  1186. </KeyWord>
  1187. <KeyWord name="LoadFontData" func="yes">
  1188. <Overload retVal="CharInfo" descr="Load font data for further use">
  1189. <Param name="const char *fileName" />
  1190. <Param name="int fontSize" />
  1191. <Param name="int *fontChars" />
  1192. <Param name="int charsCount" />
  1193. <Param name="bool sdf" />
  1194. </Overload>
  1195. </KeyWord>
  1196. <KeyWord name="GenImageFontAtlas" func="yes">
  1197. <Overload retVal="Image" descr="Generate image font atlas using chars info">
  1198. <Param name="CharInfo *chars" />
  1199. <Param name="int fontSize" />
  1200. <Param name="int charsCount" />
  1201. <Param name="int padding" />
  1202. <Param name="int packMethod" />
  1203. </Overload>
  1204. </KeyWord>
  1205. <KeyWord name="UnloadFont" func="yes">
  1206. <Overload retVal="void" descr="Unload Font from GPU memory (VRAM)">
  1207. <Param name="Font font" />
  1208. </Overload>
  1209. </KeyWord>
  1210. <!-- Text drawing functions -->
  1211. <KeyWord name="DrawFPS" func="yes">
  1212. <Overload retVal="void" descr="Shows current FPS">
  1213. <Param name="int posX" />
  1214. <Param name="int posY" />
  1215. </Overload>
  1216. </KeyWord>
  1217. <KeyWord name="DrawText" func="yes">
  1218. <Overload retVal="void" descr="Draw text (using default font)">
  1219. <Param name="const char *text" />
  1220. <Param name="int posX" />
  1221. <Param name="int posY" />
  1222. <Param name="int fontSize" />
  1223. <Param name="Color color" />
  1224. </Overload>
  1225. </KeyWord>
  1226. <KeyWord name="DrawTextEx" func="yes">
  1227. <Overload retVal="void" descr="Draw text using Font and additional parameters">
  1228. <Param name="Font font" />
  1229. <Param name="const char* text" />
  1230. <Param name="Vector2 position" />
  1231. <Param name="float fontSize" />
  1232. <Param name="float spacing" />
  1233. <Param name="Color tint" />
  1234. </Overload>
  1235. </KeyWord>
  1236. <!-- Text misc. functions -->
  1237. <KeyWord name="MeasureText" func="yes">
  1238. <Overload retVal="int" descr="Measure string width for default font">
  1239. <Param name="const char *text" />
  1240. <Param name="int fontSize" />
  1241. </Overload>
  1242. </KeyWord>
  1243. <KeyWord name="MeasureTextEx" func="yes">
  1244. <Overload retVal="Vector2" descr="Measure string size for Font">
  1245. <Param name="Font font" />
  1246. <Param name="const char *text" />
  1247. <Param name="float fontSize" />
  1248. <Param name="float spacing" />
  1249. </Overload>
  1250. </KeyWord>
  1251. <KeyWord name="FormatText" func="yes">
  1252. <Overload retVal="const char" descr="Formatting of text with variables to 'embed'">
  1253. <Param name="const char *text" />
  1254. <Param name="..." />
  1255. </Overload>
  1256. </KeyWord>
  1257. <KeyWord name="SubText" func="yes">
  1258. <Overload retVal="const char" descr="Get a piece of a text string">
  1259. <Param name="const char *text" />
  1260. <Param name="int position" />
  1261. <Param name="int length" />
  1262. </Overload>
  1263. </KeyWord>
  1264. <KeyWord name="GetGlyphIndex" func="yes">
  1265. <Overload retVal="int" descr="Returns index position for a unicode character on sprite font">
  1266. <Param name="Font font" />
  1267. <Param name="int character" />
  1268. </Overload>
  1269. </KeyWord>
  1270. <!-------------------------------------------------------------------------------------- -->
  1271. <!-- Basic 3d Shapes Drawing Functions (Module: models) -->
  1272. <!-------------------------------------------------------------------------------------- -->
  1273. <!-- Basic geometric 3D shapes drawing functions -->
  1274. <KeyWord name="DrawLine3D" func="yes">
  1275. <Overload retVal="void" descr="Draw a line in 3D world space">
  1276. <Param name="Vector3 startPos" />
  1277. <Param name="Vector3 endPos" />
  1278. <Param name="Color color" />
  1279. </Overload>
  1280. </KeyWord>
  1281. <KeyWord name="DrawCircle3D" func="yes">
  1282. <Overload retVal="void" descr="Draw a circle in 3D world space">
  1283. <Param name="Vector3 center" />
  1284. <Param name="float radius" />
  1285. <Param name="Vector3 rotationAxis" />
  1286. <Param name="float rotationAngle" />
  1287. <Param name="Color color" />
  1288. </Overload>
  1289. </KeyWord>
  1290. <KeyWord name="DrawCube" func="yes">
  1291. <Overload retVal="void" descr="Draw cube">
  1292. <Param name="Vector3 position" />
  1293. <Param name="float width" />
  1294. <Param name="float height" />
  1295. <Param name="float length" />
  1296. <Param name="Color color" />
  1297. </Overload>
  1298. </KeyWord>
  1299. <KeyWord name="DrawCubeV" func="yes">
  1300. <Overload retVal="void" descr="Draw cube (Vector version)">
  1301. <Param name="Vector3 position" />
  1302. <Param name="Vector3 size" />
  1303. <Param name="Color color" />
  1304. </Overload>
  1305. </KeyWord>
  1306. <KeyWord name="DrawCubeWires" func="yes">
  1307. <Overload retVal="void" descr="Draw cube wires">
  1308. <Param name="Vector3 position" />
  1309. <Param name="float width" />
  1310. <Param name="float height" />
  1311. <Param name="float length" />
  1312. <Param name="Color color" />
  1313. </Overload>
  1314. </KeyWord>
  1315. <KeyWord name="DrawCubeTexture" func="yes">
  1316. <Overload retVal="void" descr="Draw cube textured">
  1317. <Param name="Texture2D texture" />
  1318. <Param name="Vector3 position" />
  1319. <Param name="float width" />
  1320. <Param name="float height" />
  1321. <Param name="float length" />
  1322. <Param name="Color color" />
  1323. </Overload>
  1324. </KeyWord>
  1325. <KeyWord name="DrawSphere" func="yes">
  1326. <Overload retVal="void" descr="Draw sphere">
  1327. <Param name="Vector3 centerPos" />
  1328. <Param name="float radius" />
  1329. <Param name="Color color" />
  1330. </Overload>
  1331. </KeyWord>
  1332. <KeyWord name="DrawSphereEx" func="yes">
  1333. <Overload retVal="void" descr="Draw sphere with extended parameters">
  1334. <Param name="Vector3 centerPos" />
  1335. <Param name="float radius" />
  1336. <Param name="int rings" />
  1337. <Param name="int slices" />
  1338. <Param name="Color color" />
  1339. </Overload>
  1340. </KeyWord>
  1341. <KeyWord name="DrawSphereWires" func="yes">
  1342. <Overload retVal="void" descr="Draw sphere wires">
  1343. <Param name="Vector3 centerPos" />
  1344. <Param name="float radius" />
  1345. <Param name="int rings" />
  1346. <Param name="int slices" />
  1347. <Param name="Color color" />
  1348. </Overload>
  1349. </KeyWord>
  1350. <KeyWord name="DrawCylinder" func="yes">
  1351. <Overload retVal="void" descr="Draw a cylinder/cone">
  1352. <Param name="Vector3 position" />
  1353. <Param name="float radiusTop" />
  1354. <Param name="float radiusBottom" />
  1355. <Param name="float height" />
  1356. <Param name="int slices" />
  1357. <Param name="Color color" />
  1358. </Overload>
  1359. </KeyWord>
  1360. <KeyWord name="DrawCylinderWires" func="yes">
  1361. <Overload retVal="void" descr="Draw a cylinder/cone wires">
  1362. <Param name="Vector3 position" />
  1363. <Param name="float radiusTop" />
  1364. <Param name="float radiusBottom" />
  1365. <Param name="float height" />
  1366. <Param name="int slices" />
  1367. <Param name="Color color" />
  1368. </Overload>
  1369. </KeyWord>
  1370. <KeyWord name="DrawPlane" func="yes">
  1371. <Overload retVal="void" descr="Draw a plane XZ">
  1372. <Param name="Vector3 centerPos" />
  1373. <Param name="Vector2 size" />
  1374. <Param name="Color color" />
  1375. </Overload>
  1376. </KeyWord>
  1377. <KeyWord name="DrawRay" func="yes">
  1378. <Overload retVal="void" descr="Draw a ray line">
  1379. <Param name="Ray ray" />
  1380. <Param name="Color color" />
  1381. </Overload>
  1382. </KeyWord>
  1383. <KeyWord name="DrawGrid" func="yes">
  1384. <Overload retVal="void" descr="Draw a grid (centered at (0, 0, 0))">
  1385. <Param name="int slices" />
  1386. <Param name="float spacing" />
  1387. </Overload>
  1388. </KeyWord>
  1389. <KeyWord name="DrawGizmo" func="yes">
  1390. <Overload retVal="void" descr="Draw simple gizmo">
  1391. <Param name="Vector3 position" />
  1392. </Overload>
  1393. </KeyWord>
  1394. <!--DrawTorus(), DrawTeapot() could be useful? -->
  1395. <!-------------------------------------------------------------------------------------- -->
  1396. <!-- Model 3d Loading and Drawing Functions (Module: models) -->
  1397. <!-------------------------------------------------------------------------------------- -->
  1398. <!-- Model loading/unloading functions -->
  1399. <KeyWord name="LoadModel" func="yes">
  1400. <Overload retVal="Model" descr="Load model from files (mesh and material)">
  1401. <Param name="const char *fileName" />
  1402. </Overload>
  1403. </KeyWord>
  1404. <KeyWord name="LoadModelFromMesh" func="yes">
  1405. <Overload retVal="Model" descr="Load model from generated mesh">
  1406. <Param name="Mesh mesh" />
  1407. </Overload>
  1408. </KeyWord>
  1409. <KeyWord name="UnloadModel" func="yes">
  1410. <Overload retVal="void" descr="Unload model from memory (RAM and/or VRAM)">
  1411. <Param name="Model model" />
  1412. </Overload>
  1413. </KeyWord>
  1414. <!-- Mesh loading/unloading functions -->
  1415. <KeyWord name="LoadMesh" func="yes">
  1416. <Overload retVal="Mesh" descr="Load mesh from file">
  1417. <Param name="const char *fileName" />
  1418. </Overload>
  1419. </KeyWord>
  1420. <KeyWord name="UnloadMesh" func="yes">
  1421. <Overload retVal="void" descr="Unload mesh from memory (RAM and/or VRAM)">
  1422. <Param name="Mesh *mesh" />
  1423. </Overload>
  1424. </KeyWord>
  1425. <KeyWord name="ExportMesh" func="yes">
  1426. <Overload retVal="void" descr="Export mesh as an OBJ file">
  1427. <Param name="const char *fileName" />
  1428. <Param name="Mesh mesh" />
  1429. </Overload>
  1430. </KeyWord>
  1431. <!-- Mesh manipulation functions -->
  1432. <KeyWord name="MeshBoundingBox" func="yes">
  1433. <Overload retVal="BoundingBox" descr="Compute mesh bounding box limits">
  1434. <Param name="Mesh mesh" />
  1435. </Overload>
  1436. </KeyWord>
  1437. <KeyWord name="MeshTangents" func="yes">
  1438. <Overload retVal="void" descr="Compute mesh tangents ">
  1439. <Param name="Mesh *mesh" />
  1440. </Overload>
  1441. </KeyWord>
  1442. <KeyWord name="MeshBinormals" func="yes">
  1443. <Overload retVal="void" descr="Compute mesh binormals">
  1444. <Param name="Mesh *mesh" />
  1445. </Overload>
  1446. </KeyWord>
  1447. <!-- Mesh generation functions -->
  1448. <KeyWord name="GenMeshPlane" func="yes">
  1449. <Overload retVal="Mesh" descr="Generate plane mesh (with subdivisions)">
  1450. <Param name="float width" />
  1451. <Param name="float length" />
  1452. <Param name="int resX" />
  1453. <Param name="int resZ" />
  1454. </Overload>
  1455. </KeyWord>
  1456. <KeyWord name="GenMeshCube" func="yes">
  1457. <Overload retVal="Mesh" descr="Generate cuboid mesh">
  1458. <Param name="float width" />
  1459. <Param name="float height" />
  1460. <Param name="float length" />
  1461. </Overload>
  1462. </KeyWord>
  1463. <KeyWord name="GenMeshSphere" func="yes">
  1464. <Overload retVal="Mesh" descr="Generate sphere mesh (standard sphere)">
  1465. <Param name="float radius" />
  1466. <Param name="int rings" />
  1467. <Param name="int slices" />
  1468. </Overload>
  1469. </KeyWord>
  1470. <KeyWord name="GenMeshHemiSphere" func="yes">
  1471. <Overload retVal="Mesh" descr="Generate half-sphere mesh (no bottom cap)">
  1472. <Param name="float radius" />
  1473. <Param name="int rings" />
  1474. <Param name="int slices" />
  1475. </Overload>
  1476. </KeyWord>
  1477. <KeyWord name="GenMeshCylinder" func="yes">
  1478. <Overload retVal="Mesh" descr="Generate cylinder mesh">
  1479. <Param name="float radius" />
  1480. <Param name="float height" />
  1481. <Param name="int slices" />
  1482. </Overload>
  1483. </KeyWord>
  1484. <KeyWord name="GenMeshTorus" func="yes">
  1485. <Overload retVal="Mesh" descr="Generate torus mesh">
  1486. <Param name="float radius" />
  1487. <Param name="float size" />
  1488. <Param name="int radSeg" />
  1489. <Param name="int sides" />
  1490. </Overload>
  1491. </KeyWord>
  1492. <KeyWord name="GenMeshKnot" func="yes">
  1493. <Overload retVal="Mesh" descr="Generate trefoil knot mesh">
  1494. <Param name="float radius" />
  1495. <Param name="float size" />
  1496. <Param name="int radSeg" />
  1497. <Param name="int sides" />
  1498. </Overload>
  1499. </KeyWord>
  1500. <KeyWord name="GenMeshHeightmap" func="yes">
  1501. <Overload retVal="Mesh" descr="Generate heightmap mesh from image data">
  1502. <Param name="Image heightmap" />
  1503. <Param name="Vector3 size" />
  1504. </Overload>
  1505. </KeyWord>
  1506. <KeyWord name="GenMeshCubicmap" func="yes">
  1507. <Overload retVal="Mesh" descr="Generate cubes-based map mesh from image data">
  1508. <Param name="Image cubicmap" />
  1509. <Param name="Vector3 cubeSize" />
  1510. </Overload>
  1511. </KeyWord>
  1512. <!-- Material loading/unloading functions -->
  1513. <KeyWord name="LoadMaterial" func="yes">
  1514. <Overload retVal="Material" descr="Load material from file">
  1515. <Param name="const char *fileName" />
  1516. </Overload>
  1517. </KeyWord>
  1518. <KeyWord name="LoadMaterialDefault" func="yes">
  1519. <Overload retVal="Material" descr="Load default material (Supports: DIFFUSE, SPECULAR, NORMAL maps)"></Overload>
  1520. </KeyWord>
  1521. <KeyWord name="UnloadMaterial" func="yes">
  1522. <Overload retVal="void" descr="Unload material from GPU memory (VRAM)">
  1523. <Param name="Material material" />
  1524. </Overload>
  1525. </KeyWord>
  1526. <!-- Model drawing functions -->
  1527. <KeyWord name="DrawModel" func="yes">
  1528. <Overload retVal="void" descr="Draw a model (with texture if set)">
  1529. <Param name="Model model" />
  1530. <Param name="Vector3 position" />
  1531. <Param name="float scale" />
  1532. <Param name="Color tint" />
  1533. </Overload>
  1534. </KeyWord>
  1535. <KeyWord name="DrawModelEx" func="yes">
  1536. <Overload retVal="void" descr="Draw a model with extended parameters">
  1537. <Param name="Model model" />
  1538. <Param name="Vector3 position" />
  1539. <Param name="Vector3 rotationAxis" />
  1540. <Param name="float rotationAngle" />
  1541. <Param name="Vector3 scale" />
  1542. <Param name="Color tint" />
  1543. </Overload>
  1544. </KeyWord>
  1545. <KeyWord name="DrawModelWires" func="yes">
  1546. <Overload retVal="void" descr="Draw a model wires (with texture if set)">
  1547. <Param name="Model model" />
  1548. <Param name="Vector3 position" />
  1549. <Param name="float scale" />
  1550. <Param name="Color tint" />
  1551. </Overload>
  1552. </KeyWord>
  1553. <KeyWord name="DrawModelWiresEx" func="yes">
  1554. <Overload retVal="void" descr="Draw a model wires (with texture if set) with extended parameters">
  1555. <Param name="Model model" />
  1556. <Param name="Vector3 position" />
  1557. <Param name="Vector3 rotationAxis" />
  1558. <Param name="float rotationAngle" />
  1559. <Param name="Vector3 scale" />
  1560. <Param name="Color tint" />
  1561. </Overload>
  1562. </KeyWord>
  1563. <KeyWord name="DrawBoundingBox" func="yes">
  1564. <Overload retVal="void" descr="Draw bounding box (wires)">
  1565. <Param name="BoundingBox box" />
  1566. <Param name="Color color" />
  1567. </Overload>
  1568. </KeyWord>
  1569. <KeyWord name="DrawBillboard" func="yes">
  1570. <Overload retVal="void" descr="Draw a billboard texture">
  1571. <Param name="Camera camera" />
  1572. <Param name="Texture2D texture" />
  1573. <Param name="Vector3 center" />
  1574. <Param name="float size" />
  1575. <Param name="Color tint" />
  1576. </Overload>
  1577. </KeyWord>
  1578. <KeyWord name="DrawBillboardRec" func="yes">
  1579. <Overload retVal="void" descr="Draw a billboard texture defined by sourceRec">
  1580. <Param name="Camera camera" />
  1581. <Param name="Texture2D texture" />
  1582. <Param name="Rectangle sourceRec" />
  1583. <Param name="Vector3 center" />
  1584. <Param name="float size" />
  1585. <Param name="Color tint" />
  1586. </Overload>
  1587. </KeyWord>
  1588. <!-- Collision detection functions -->
  1589. <KeyWord name="CheckCollisionSpheres" func="yes">
  1590. <Overload retVal="bool" descr="Detect collision between two spheres">
  1591. <Param name="Vector3 centerA" />
  1592. <Param name="float radiusA" />
  1593. <Param name="Vector3 centerB" />
  1594. <Param name="float radiusB" />
  1595. </Overload>
  1596. </KeyWord>
  1597. <KeyWord name="CheckCollisionBoxes" func="yes">
  1598. <Overload retVal="bool" descr="Detect collision between two bounding boxes">
  1599. <Param name="BoundingBox box1" />
  1600. <Param name="BoundingBox box2" />
  1601. </Overload>
  1602. </KeyWord>
  1603. <KeyWord name="CheckCollisionBoxSphere" func="yes">
  1604. <Overload retVal="bool" descr="Detect collision between box and sphere">
  1605. <Param name="BoundingBox box" />
  1606. <Param name="Vector3 centerSphere" />
  1607. <Param name="float radiusSphere" />
  1608. </Overload>
  1609. </KeyWord>
  1610. <KeyWord name="CheckCollisionRaySphere" func="yes">
  1611. <Overload retVal="bool" descr="Detect collision between ray and sphere">
  1612. <Param name="Ray ray" />
  1613. <Param name="Vector3 spherePosition" />
  1614. <Param name="float sphereRadius" />
  1615. </Overload>
  1616. </KeyWord>
  1617. <KeyWord name="CheckCollisionRaySphereEx" func="yes">
  1618. <Overload retVal="bool" descr="Detect collision between ray and sphere, returns collision point">
  1619. <Param name="Ray ray" />
  1620. <Param name="Vector3 spherePosition" />
  1621. <Param name="float sphereRadius" />
  1622. <Param name="Vector3 *collisionPoint" />
  1623. </Overload>
  1624. </KeyWord>
  1625. <KeyWord name="CheckCollisionRayBox" func="yes">
  1626. <Overload retVal="bool" descr="Detect collision between ray and box">
  1627. <Param name="Ray ray" />
  1628. <Param name="BoundingBox box" />
  1629. </Overload>
  1630. </KeyWord>
  1631. <KeyWord name="GetCollisionRayModel" func="yes">
  1632. <Overload retVal="RayHitInfo" descr="Get collision info between ray and model">
  1633. <Param name="Ray ray" />
  1634. <Param name="Model *model" />
  1635. </Overload>
  1636. </KeyWord>
  1637. <KeyWord name="GetCollisionRayTriangle" func="yes">
  1638. <Overload retVal="RayHitInfo" descr="Get collision info between ray and triangle">
  1639. <Param name="Ray ray" />
  1640. <Param name="Vector3 p1" />
  1641. <Param name="Vector3 p2" />
  1642. <Param name="Vector3 p3" />
  1643. </Overload>
  1644. </KeyWord>
  1645. <KeyWord name="GetCollisionRayGround" func="yes">
  1646. <Overload retVal="RayHitInfo" descr="Get collision info between ray and ground plane (Y-normal plane)">
  1647. <Param name="Ray ray" />
  1648. <Param name="float groundHeight" />
  1649. </Overload>
  1650. </KeyWord>
  1651. <!-------------------------------------------------------------------------------------- -->
  1652. <!-- Shaders System Functions (Module: rlgl) -->
  1653. <!-- NOTE: This functions are useless when using OpenGL 1.1 -->
  1654. <!-------------------------------------------------------------------------------------- -->
  1655. <!-- Shader loading/unloading functions -->
  1656. <KeyWord name="LoadText" func="yes">
  1657. <Overload retVal="char" descr="Load chars array from text file">
  1658. <Param name="const char *fileName" />
  1659. </Overload>
  1660. </KeyWord>
  1661. <KeyWord name="LoadShader" func="yes">
  1662. <Overload retVal="Shader" descr="Load shader from files and bind default locations">
  1663. <Param name="const char *vsFileName" />
  1664. <Param name="const char *fsFileName" />
  1665. </Overload>
  1666. </KeyWord>
  1667. <KeyWord name="LoadShaderCode" func="yes">
  1668. <Overload retVal="Shader" descr="Load shader from code strings and bind default locations">
  1669. <Param name="char *vsCode" />
  1670. <Param name="char *fsCode" />
  1671. </Overload>
  1672. </KeyWord>
  1673. <KeyWord name="UnloadShader" func="yes">
  1674. <Overload retVal="void" descr="Unload shader from GPU memory (VRAM)">
  1675. <Param name="Shader shader" />
  1676. </Overload>
  1677. </KeyWord>
  1678. <KeyWord name="GetShaderDefault" func="yes">
  1679. <Overload retVal="Shader" descr="Get default shader"></Overload>
  1680. </KeyWord>
  1681. <KeyWord name="GetTextureDefault" func="yes">
  1682. <Overload retVal="Texture2D" descr="Get default texture"></Overload>
  1683. </KeyWord>
  1684. <!-- Shader configuration functions -->
  1685. <KeyWord name="GetShaderLocation" func="yes">
  1686. <Overload retVal="int" descr="Get shader uniform location">
  1687. <Param name="Shader shader" />
  1688. <Param name="const char *uniformName" />
  1689. </Overload>
  1690. </KeyWord>
  1691. <KeyWord name="SetShaderValue" func="yes">
  1692. <Overload retVal="void" descr="Set shader uniform value (float)">
  1693. <Param name="Shader shader" />
  1694. <Param name="int uniformLoc" />
  1695. <Param name="const float *value" />
  1696. <Param name="int size" />
  1697. </Overload>
  1698. </KeyWord>
  1699. <KeyWord name="SetShaderValuei" func="yes">
  1700. <Overload retVal="void" descr="Set shader uniform value (int)">
  1701. <Param name="Shader shader" />
  1702. <Param name="int uniformLoc" />
  1703. <Param name="const int *value" />
  1704. <Param name="int size" />
  1705. </Overload>
  1706. </KeyWord>
  1707. <KeyWord name="SetShaderValueMatrix" func="yes">
  1708. <Overload retVal="void" descr="Set shader uniform value (matrix 4x4)">
  1709. <Param name="Shader shader" />
  1710. <Param name="int uniformLoc" />
  1711. <Param name="Matrix mat" />
  1712. </Overload>
  1713. </KeyWord>
  1714. <KeyWord name="SetMatrixProjection" func="yes">
  1715. <Overload retVal="void" descr="Set a custom projection matrix (replaces internal projection matrix)">
  1716. <Param name="Matrix proj" />
  1717. </Overload>
  1718. </KeyWord>
  1719. <KeyWord name="SetMatrixModelview" func="yes">
  1720. <Overload retVal="void" descr="Set a custom modelview matrix (replaces internal modelview matrix)">
  1721. <Param name="Matrix view" />
  1722. </Overload>
  1723. </KeyWord>
  1724. <KeyWord name="GetMatrixModelview" func="yes">
  1725. <Overload retVal="Matrix" descr="Get internal modelview matrix">
  1726. <Param name="Matrix view" />
  1727. </Overload>
  1728. </KeyWord>
  1729. <!-- Texture maps generation (PBR) -->
  1730. <!-- NOTE: Required shaders should be provided -->
  1731. <KeyWord name="GenTextureCubemap" func="yes">
  1732. <Overload retVal="Texture2D" descr="Generate cubemap texture from HDR texture">
  1733. <Param name="Shader shader" />
  1734. <Param name="Texture2D skyHDR" />
  1735. <Param name="int size" />
  1736. </Overload>
  1737. </KeyWord>
  1738. <KeyWord name="GenTextureIrradiance" func="yes">
  1739. <Overload retVal="Texture2D" descr="Generate irradiance texture using cubemap data">
  1740. <Param name="Shader shader" />
  1741. <Param name="Texture2D cubemap" />
  1742. <Param name="int size" />
  1743. </Overload>
  1744. </KeyWord>
  1745. <KeyWord name="GenTexturePrefilter" func="yes">
  1746. <Overload retVal="Texture2D" descr="Generate prefilter texture using cubemap data">
  1747. <Param name="Shader shader" />
  1748. <Param name="Texture2D cubemap" />
  1749. <Param name="int size" />
  1750. </Overload>
  1751. </KeyWord>
  1752. <KeyWord name="GenTextureBRDF" func="yes">
  1753. <Overload retVal="Texture2D" descr="Generate BRDF texture using cubemap data">
  1754. <Param name="Shader shader" />
  1755. <Param name="Texture2D cubemap" />
  1756. <Param name="int size" />
  1757. </Overload>
  1758. </KeyWord>
  1759. <!-- Shading begin/end functions -->
  1760. <KeyWord name="BeginShaderMode" func="yes">
  1761. <Overload retVal="void" descr="Begin custom shader drawing">
  1762. <Param name="Shader shader" />
  1763. </Overload>
  1764. </KeyWord>
  1765. <KeyWord name="EndShaderMode" func="yes">
  1766. <Overload retVal="void" descr="End custom shader drawing (use default shader)"></Overload>
  1767. </KeyWord>
  1768. <KeyWord name="BeginBlendMode" func="yes">
  1769. <Overload retVal="void" descr="Begin blending mode (alpha, additive, multiplied)">
  1770. <Param name="int mode" />
  1771. </Overload>
  1772. </KeyWord>
  1773. <KeyWord name="EndBlendMode" func="yes">
  1774. <Overload retVal="void" descr="End blending mode (reset to default: alpha blending)"></Overload>
  1775. </KeyWord>
  1776. <!-- VR control functions -->
  1777. <KeyWord name="GetVrDeviceInfo" func="yes">
  1778. <Overload retVal="VrDeviceInfo" descr="Get VR device information for some standard devices">
  1779. <Param name="int vrDeviceType" />
  1780. </Overload>
  1781. </KeyWord>
  1782. <KeyWord name="InitVrSimulator" func="yes">
  1783. <Overload retVal="void" descr="Init VR simulator for selected device parameters">
  1784. <Param name="VrDeviceInfo info" />
  1785. </Overload>
  1786. </KeyWord>
  1787. <KeyWord name="CloseVrSimulator" func="yes">
  1788. <Overload retVal="void" descr="Close VR simulator for current device"></Overload>
  1789. </KeyWord>
  1790. <KeyWord name="IsVrSimulatorReady" func="yes">
  1791. <Overload retVal="bool" descr="Detect if VR simulator is ready"></Overload>
  1792. </KeyWord>
  1793. <KeyWord name="SetVrDistortionShader" func="yes">
  1794. <Overload retVal="void" descr="Set VR distortion shader for stereoscopic rendering">
  1795. <Param name="Shader shader" />
  1796. </Overload>
  1797. </KeyWord>
  1798. <KeyWord name="UpdateVrTracking" func="yes">
  1799. <Overload retVal="void" descr="Update VR tracking (position and orientation) and camera">
  1800. <Param name="Camera *camera" />
  1801. </Overload>
  1802. </KeyWord>
  1803. <KeyWord name="ToggleVrMode" func="yes">
  1804. <Overload retVal="void" descr="Enable/Disable VR experience"></Overload>
  1805. </KeyWord>
  1806. <KeyWord name="BeginVrDrawing" func="yes">
  1807. <Overload retVal="void" descr="Begin VR simulator stereo rendering"></Overload>
  1808. </KeyWord>
  1809. <KeyWord name="EndVrDrawing" func="yes">
  1810. <Overload retVal="void" descr="End VR simulator stereo rendering"></Overload>
  1811. </KeyWord>
  1812. <!-------------------------------------------------------------------------------------- -->
  1813. <!-- Audio Loading and Playing Functions (Module: audio) -->
  1814. <!-------------------------------------------------------------------------------------- -->
  1815. <!-- Audio device management functions -->
  1816. <KeyWord name="InitAudioDevice" func="yes">
  1817. <Overload retVal="void" descr="Initialize audio device and context"></Overload>
  1818. </KeyWord>
  1819. <KeyWord name="CloseAudioDevice" func="yes">
  1820. <Overload retVal="void" descr="Close the audio device and context"></Overload>
  1821. </KeyWord>
  1822. <KeyWord name="IsAudioDeviceReady" func="yes">
  1823. <Overload retVal="bool" descr="Check if audio device has been initialized successfully"></Overload>
  1824. </KeyWord>
  1825. <KeyWord name="SetMasterVolume" func="yes">
  1826. <Overload retVal="void" descr="Set master volume (listener)">
  1827. <Param name="float volume" />
  1828. </Overload>
  1829. </KeyWord>
  1830. <!-- Wave/Sound loading/unloading functions -->
  1831. <KeyWord name="LoadWave" func="yes">
  1832. <Overload retVal="Wave" descr="Load wave data from file">
  1833. <Param name="const char *fileName" />
  1834. </Overload>
  1835. </KeyWord>
  1836. <KeyWord name="LoadWaveEx" func="yes">
  1837. <Overload retVal="Wave" descr="Load wave data from raw array data"></Overload>
  1838. </KeyWord>
  1839. <KeyWord name="LoadSound" func="yes">
  1840. <Overload retVal="Sound" descr="Load sound from file">
  1841. <Param name="const char *fileName" />
  1842. </Overload>
  1843. </KeyWord>
  1844. <KeyWord name="LoadSoundFromWave" func="yes">
  1845. <Overload retVal="Sound" descr="Load sound from wave data">
  1846. <Param name="Wave wave" />
  1847. </Overload>
  1848. </KeyWord>
  1849. <KeyWord name="UpdateSound" func="yes">
  1850. <Overload retVal="void" descr="Update sound buffer with new data">
  1851. <Param name="Sound sound" />
  1852. <Param name="const void *data" />
  1853. <Param name="int samplesCount" />
  1854. </Overload>
  1855. </KeyWord>
  1856. <KeyWord name="UnloadWave" func="yes">
  1857. <Overload retVal="void" descr="Unload wave data">
  1858. <Param name="Wave wave" />
  1859. </Overload>
  1860. </KeyWord>
  1861. <KeyWord name="UnloadSound" func="yes">
  1862. <Overload retVal="void" descr="Unload sound">
  1863. <Param name="Sound sound" />
  1864. </Overload>
  1865. </KeyWord>
  1866. <!-- Wave/Sound management functions -->
  1867. <KeyWord name="PlaySound" func="yes">
  1868. <Overload retVal="void" descr="Play a sound">
  1869. <Param name="Sound sound" />
  1870. </Overload>
  1871. </KeyWord>
  1872. <KeyWord name="PauseSound" func="yes">
  1873. <Overload retVal="void" descr="Pause a sound">
  1874. <Param name="Sound sound" />
  1875. </Overload>
  1876. </KeyWord>
  1877. <KeyWord name="ResumeSound" func="yes">
  1878. <Overload retVal="void" descr="Resume a paused sound">
  1879. <Param name="Sound sound" />
  1880. </Overload>
  1881. </KeyWord>
  1882. <KeyWord name="StopSound" func="yes">
  1883. <Overload retVal="void" descr="Stop playing a sound">
  1884. <Param name="Sound sound" />
  1885. </Overload>
  1886. </KeyWord>
  1887. <KeyWord name="IsSoundPlaying" func="yes">
  1888. <Overload retVal="bool" descr="Check if a sound is currently playing">
  1889. <Param name="Sound sound" />
  1890. </Overload>
  1891. </KeyWord>
  1892. <KeyWord name="SetSoundVolume" func="yes">
  1893. <Overload retVal="void" descr="Set volume for a sound (1.0 is max level)">
  1894. <Param name="Sound sound" />
  1895. <Param name="float volume" />
  1896. </Overload>
  1897. </KeyWord>
  1898. <KeyWord name="SetSoundPitch" func="yes">
  1899. <Overload retVal="void" descr="Set pitch for a sound (1.0 is base level)">
  1900. <Param name="Sound sound" />
  1901. <Param name="float pitch" />
  1902. </Overload>
  1903. </KeyWord>
  1904. <KeyWord name="WaveFormat" func="yes">
  1905. <Overload retVal="void" descr="Convert wave data to desired format">
  1906. <Param name="Wave *wave" />
  1907. <Param name="int sampleRate" />
  1908. <Param name="int sampleSize" />
  1909. <Param name="int channels" />
  1910. </Overload>
  1911. </KeyWord>
  1912. <KeyWord name="WaveCopy" func="yes">
  1913. <Overload retVal="Wave" descr="Copy a wave to a new wave">
  1914. <Param name="Wave wave" />
  1915. </Overload>
  1916. </KeyWord>
  1917. <KeyWord name="WaveCrop" func="yes">
  1918. <Overload retVal="void" descr="Crop a wave to defined samples range">
  1919. <Param name="Wave *wave" />
  1920. <Param name="int initSample" />
  1921. <Param name="int finalSample" />
  1922. </Overload>
  1923. </KeyWord>
  1924. <KeyWord name="GetWaveData" func="yes">
  1925. <Overload retVal="float" descr="Get samples data from wave as a floats array">
  1926. <Param name="Wave wave" />
  1927. </Overload>
  1928. </KeyWord>
  1929. <!-- Music management functions -->
  1930. <KeyWord name="LoadMusicStream" func="yes">
  1931. <Overload retVal="Music" descr="Load music stream from file">
  1932. <Param name="const char *fileName" />
  1933. </Overload>
  1934. </KeyWord>
  1935. <KeyWord name="UnloadMusicStream" func="yes">
  1936. <Overload retVal="void" descr="Unload music stream">
  1937. <Param name="Music music" />
  1938. </Overload>
  1939. </KeyWord>
  1940. <KeyWord name="PlayMusicStream" func="yes">
  1941. <Overload retVal="void" descr="Start music playing">
  1942. <Param name="Music music" />
  1943. </Overload>
  1944. </KeyWord>
  1945. <KeyWord name="UpdateMusicStream" func="yes">
  1946. <Overload retVal="void" descr="Updates buffers for music streaming">
  1947. <Param name="Music music" />
  1948. </Overload>
  1949. </KeyWord>
  1950. <KeyWord name="StopMusicStream" func="yes">
  1951. <Overload retVal="void" descr="Stop music playing">
  1952. <Param name="Music music" />
  1953. </Overload>
  1954. </KeyWord>
  1955. <KeyWord name="PauseMusicStream" func="yes">
  1956. <Overload retVal="void" descr="Pause music playing">
  1957. <Param name="Music music" />
  1958. </Overload>
  1959. </KeyWord>
  1960. <KeyWord name="ResumeMusicStream" func="yes">
  1961. <Overload retVal="void" descr="Resume playing paused music">
  1962. <Param name="Music music" />
  1963. </Overload>
  1964. </KeyWord>
  1965. <KeyWord name="IsMusicPlaying" func="yes">
  1966. <Overload retVal="bool" descr="Check if music is playing">
  1967. <Param name="Music music" />
  1968. </Overload>
  1969. </KeyWord>
  1970. <KeyWord name="SetMusicVolume" func="yes">
  1971. <Overload retVal="void" descr="Set volume for music (1.0 is max level)">
  1972. <Param name="Music music" />
  1973. <Param name="float volume" />
  1974. </Overload>
  1975. </KeyWord>
  1976. <KeyWord name="SetMusicPitch" func="yes">
  1977. <Overload retVal="void" descr="Set pitch for a music (1.0 is base level)">
  1978. <Param name="Music music" />
  1979. <Param name="float pitch" />
  1980. </Overload>
  1981. </KeyWord>
  1982. <KeyWord name="SetMusicLoopCount" func="yes">
  1983. <Overload retVal="void" descr="Set music loop count (loop repeats)">
  1984. <Param name="Music music" />
  1985. <Param name="int count" />
  1986. </Overload>
  1987. </KeyWord>
  1988. <KeyWord name="GetMusicTimeLength" func="yes">
  1989. <Overload retVal="float" descr="Get music time length (in seconds)">
  1990. <Param name="Music music" />
  1991. </Overload>
  1992. </KeyWord>
  1993. <KeyWord name="GetMusicTimePlayed" func="yes">
  1994. <Overload retVal="float" descr="Get current music time played (in seconds)">
  1995. <Param name="Music music" />
  1996. </Overload>
  1997. </KeyWord>
  1998. <!-- AudioStream management functions -->
  1999. <KeyWord name="InitAudioStream" func="yes">
  2000. <Overload retVal="AudioStream" descr="Init audio stream (to stream raw audio pcm data)">
  2001. <Param name="unsigned int sampleRate" />
  2002. <Param name="unsigned int sampleSize" />
  2003. <Param name="unsigned int channels" />
  2004. </Overload>
  2005. </KeyWord>
  2006. <KeyWord name="UpdateAudioStream" func="yes">
  2007. <Overload retVal="void" descr="Update audio stream buffers with data">
  2008. <Param name="AudioStream stream" />
  2009. <Param name="const void *data" />
  2010. <Param name="int samplesCount" />
  2011. </Overload>
  2012. </KeyWord>
  2013. <KeyWord name="CloseAudioStream" func="yes">
  2014. <Overload retVal="void" descr="Close audio stream and free memory">
  2015. <Param name="AudioStream stream" />
  2016. </Overload>
  2017. </KeyWord>
  2018. <KeyWord name="IsAudioBufferProcessed" func="yes">
  2019. <Overload retVal="bool" descr="Check if any audio stream buffers requires refill">
  2020. <Param name="AudioStream stream" />
  2021. </Overload>
  2022. </KeyWord>
  2023. <KeyWord name="PlayAudioStream" func="yes">
  2024. <Overload retVal="void" descr="Play audio stream">
  2025. <Param name="AudioStream stream" />
  2026. </Overload>
  2027. </KeyWord>
  2028. <KeyWord name="PauseAudioStream" func="yes">
  2029. <Overload retVal="void" descr="Pause audio stream">
  2030. <Param name="AudioStream stream" />
  2031. </Overload>
  2032. </KeyWord>
  2033. <KeyWord name="ResumeAudioStream" func="yes">
  2034. <Overload retVal="void" descr="Resume audio stream">
  2035. <Param name="AudioStream stream" />
  2036. </Overload>
  2037. </KeyWord>
  2038. <KeyWord name="IsAudioStreamPlaying" func="yes">
  2039. <Overload retVal="bool" descr="Check if audio stream is playing">
  2040. <Param name="AudioStream stream" />
  2041. </Overload>
  2042. </KeyWord>
  2043. <KeyWord name="StopAudioStream" func="yes">
  2044. <Overload retVal="void" descr="Stop audio stream">
  2045. <Param name="AudioStream stream" />
  2046. </Overload>
  2047. </KeyWord>
  2048. <KeyWord name="SetAudioStreamVolume" func="yes">
  2049. <Overload retVal="void" descr="Set volume for audio stream (1.0 is max level)">
  2050. <Param name="AudioStream stream" />
  2051. <Param name="float volume" />
  2052. </Overload>
  2053. </KeyWord>
  2054. <KeyWord name="SetAudioStreamPitch" func="yes">
  2055. <Overload retVal="void" descr="Set pitch for audio stream (1.0 is base level)">
  2056. <Param name="AudioStream stream" />
  2057. <Param name="float pitch" />
  2058. </Overload>
  2059. </KeyWord>
  2060. </AutoComplete>
  2061. </NotepadPlus>