raylib_npp.xml 119 KB

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