raylib_npp.xml 147 KB

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