raylib_npp.xml 134 KB

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