raylib_npp.xml 148 KB

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