raylib_npp.xml 168 KB

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