| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302 |
- unit glfw3;
- { This unit is automatically generated by Chet:
- https://github.com/neslib/Chet }
- {$MINENUMSIZE 4}
- interface
- const
- {$IF Defined(WIN64)}
- libglfw3 = 'glfw3';
- _PU = '';
- {$ELSE}
- {$MESSAGE Error 'Unsupported platform'}
- {$ENDIF}
- const
- (* APIENTRY __stdcall *)
- (* WINGDIAPI __declspec ( dllimport ) *)
- (* CALLBACK __stdcall *)
- GLFW_VERSION_MAJOR = 3;
- GLFW_VERSION_MINOR = 4;
- GLFW_VERSION_REVISION = 0;
- GLFW_TRUE = 1;
- GLFW_FALSE = 0;
- GLFW_RELEASE = 0;
- GLFW_PRESS = 1;
- GLFW_REPEAT = 2;
- GLFW_HAT_CENTERED = 0;
- GLFW_HAT_UP = 1;
- GLFW_HAT_RIGHT = 2;
- GLFW_HAT_DOWN = 4;
- GLFW_HAT_LEFT = 8;
- GLFW_HAT_RIGHT_UP = (GLFW_HAT_RIGHT or GLFW_HAT_UP);
- GLFW_HAT_RIGHT_DOWN = (GLFW_HAT_RIGHT or GLFW_HAT_DOWN);
- GLFW_HAT_LEFT_UP = (GLFW_HAT_LEFT or GLFW_HAT_UP);
- GLFW_HAT_LEFT_DOWN = (GLFW_HAT_LEFT or GLFW_HAT_DOWN);
- GLFW_KEY_UNKNOWN = -1;
- GLFW_KEY_SPACE = 32;
- GLFW_KEY_APOSTROPHE = 39;
- GLFW_KEY_COMMA = 44;
- GLFW_KEY_MINUS = 45;
- GLFW_KEY_PERIOD = 46;
- GLFW_KEY_SLASH = 47;
- GLFW_KEY_0 = 48;
- GLFW_KEY_1 = 49;
- GLFW_KEY_2 = 50;
- GLFW_KEY_3 = 51;
- GLFW_KEY_4 = 52;
- GLFW_KEY_5 = 53;
- GLFW_KEY_6 = 54;
- GLFW_KEY_7 = 55;
- GLFW_KEY_8 = 56;
- GLFW_KEY_9 = 57;
- GLFW_KEY_SEMICOLON = 59;
- GLFW_KEY_EQUAL = 61;
- GLFW_KEY_A = 65;
- GLFW_KEY_B = 66;
- GLFW_KEY_C = 67;
- GLFW_KEY_D = 68;
- GLFW_KEY_E = 69;
- GLFW_KEY_F = 70;
- GLFW_KEY_G = 71;
- GLFW_KEY_H = 72;
- GLFW_KEY_I = 73;
- GLFW_KEY_J = 74;
- GLFW_KEY_K = 75;
- GLFW_KEY_L = 76;
- GLFW_KEY_M = 77;
- GLFW_KEY_N = 78;
- GLFW_KEY_O = 79;
- GLFW_KEY_P = 80;
- GLFW_KEY_Q = 81;
- GLFW_KEY_R = 82;
- GLFW_KEY_S = 83;
- GLFW_KEY_T = 84;
- GLFW_KEY_U = 85;
- GLFW_KEY_V = 86;
- GLFW_KEY_W = 87;
- GLFW_KEY_X = 88;
- GLFW_KEY_Y = 89;
- GLFW_KEY_Z = 90;
- GLFW_KEY_LEFT_BRACKET = 91;
- GLFW_KEY_BACKSLASH = 92;
- GLFW_KEY_RIGHT_BRACKET = 93;
- GLFW_KEY_GRAVE_ACCENT = 96;
- GLFW_KEY_WORLD_1 = 161;
- GLFW_KEY_WORLD_2 = 162;
- GLFW_KEY_ESCAPE = 256;
- GLFW_KEY_ENTER = 257;
- GLFW_KEY_TAB = 258;
- GLFW_KEY_BACKSPACE = 259;
- GLFW_KEY_INSERT = 260;
- GLFW_KEY_DELETE = 261;
- GLFW_KEY_RIGHT = 262;
- GLFW_KEY_LEFT = 263;
- GLFW_KEY_DOWN = 264;
- GLFW_KEY_UP = 265;
- GLFW_KEY_PAGE_UP = 266;
- GLFW_KEY_PAGE_DOWN = 267;
- GLFW_KEY_HOME = 268;
- GLFW_KEY_END = 269;
- GLFW_KEY_CAPS_LOCK = 280;
- GLFW_KEY_SCROLL_LOCK = 281;
- GLFW_KEY_NUM_LOCK = 282;
- GLFW_KEY_PRINT_SCREEN = 283;
- GLFW_KEY_PAUSE = 284;
- GLFW_KEY_F1 = 290;
- GLFW_KEY_F2 = 291;
- GLFW_KEY_F3 = 292;
- GLFW_KEY_F4 = 293;
- GLFW_KEY_F5 = 294;
- GLFW_KEY_F6 = 295;
- GLFW_KEY_F7 = 296;
- GLFW_KEY_F8 = 297;
- GLFW_KEY_F9 = 298;
- GLFW_KEY_F10 = 299;
- GLFW_KEY_F11 = 300;
- GLFW_KEY_F12 = 301;
- GLFW_KEY_F13 = 302;
- GLFW_KEY_F14 = 303;
- GLFW_KEY_F15 = 304;
- GLFW_KEY_F16 = 305;
- GLFW_KEY_F17 = 306;
- GLFW_KEY_F18 = 307;
- GLFW_KEY_F19 = 308;
- GLFW_KEY_F20 = 309;
- GLFW_KEY_F21 = 310;
- GLFW_KEY_F22 = 311;
- GLFW_KEY_F23 = 312;
- GLFW_KEY_F24 = 313;
- GLFW_KEY_F25 = 314;
- GLFW_KEY_KP_0 = 320;
- GLFW_KEY_KP_1 = 321;
- GLFW_KEY_KP_2 = 322;
- GLFW_KEY_KP_3 = 323;
- GLFW_KEY_KP_4 = 324;
- GLFW_KEY_KP_5 = 325;
- GLFW_KEY_KP_6 = 326;
- GLFW_KEY_KP_7 = 327;
- GLFW_KEY_KP_8 = 328;
- GLFW_KEY_KP_9 = 329;
- GLFW_KEY_KP_DECIMAL = 330;
- GLFW_KEY_KP_DIVIDE = 331;
- GLFW_KEY_KP_MULTIPLY = 332;
- GLFW_KEY_KP_SUBTRACT = 333;
- GLFW_KEY_KP_ADD = 334;
- GLFW_KEY_KP_ENTER = 335;
- GLFW_KEY_KP_EQUAL = 336;
- GLFW_KEY_LEFT_SHIFT = 340;
- GLFW_KEY_LEFT_CONTROL = 341;
- GLFW_KEY_LEFT_ALT = 342;
- GLFW_KEY_LEFT_SUPER = 343;
- GLFW_KEY_RIGHT_SHIFT = 344;
- GLFW_KEY_RIGHT_CONTROL = 345;
- GLFW_KEY_RIGHT_ALT = 346;
- GLFW_KEY_RIGHT_SUPER = 347;
- GLFW_KEY_MENU = 348;
- GLFW_KEY_LAST = GLFW_KEY_MENU;
- GLFW_MOD_SHIFT = $0001;
- GLFW_MOD_CONTROL = $0002;
- GLFW_MOD_ALT = $0004;
- GLFW_MOD_SUPER = $0008;
- GLFW_MOD_CAPS_LOCK = $0010;
- GLFW_MOD_NUM_LOCK = $0020;
- GLFW_MOUSE_BUTTON_1 = 0;
- GLFW_MOUSE_BUTTON_2 = 1;
- GLFW_MOUSE_BUTTON_3 = 2;
- GLFW_MOUSE_BUTTON_4 = 3;
- GLFW_MOUSE_BUTTON_5 = 4;
- GLFW_MOUSE_BUTTON_6 = 5;
- GLFW_MOUSE_BUTTON_7 = 6;
- GLFW_MOUSE_BUTTON_8 = 7;
- GLFW_MOUSE_BUTTON_LAST = GLFW_MOUSE_BUTTON_8;
- GLFW_MOUSE_BUTTON_LEFT = GLFW_MOUSE_BUTTON_1;
- GLFW_MOUSE_BUTTON_RIGHT = GLFW_MOUSE_BUTTON_2;
- GLFW_MOUSE_BUTTON_MIDDLE = GLFW_MOUSE_BUTTON_3;
- GLFW_JOYSTICK_1 = 0;
- GLFW_JOYSTICK_2 = 1;
- GLFW_JOYSTICK_3 = 2;
- GLFW_JOYSTICK_4 = 3;
- GLFW_JOYSTICK_5 = 4;
- GLFW_JOYSTICK_6 = 5;
- GLFW_JOYSTICK_7 = 6;
- GLFW_JOYSTICK_8 = 7;
- GLFW_JOYSTICK_9 = 8;
- GLFW_JOYSTICK_10 = 9;
- GLFW_JOYSTICK_11 = 10;
- GLFW_JOYSTICK_12 = 11;
- GLFW_JOYSTICK_13 = 12;
- GLFW_JOYSTICK_14 = 13;
- GLFW_JOYSTICK_15 = 14;
- GLFW_JOYSTICK_16 = 15;
- GLFW_JOYSTICK_LAST = GLFW_JOYSTICK_16;
- GLFW_GAMEPAD_BUTTON_A = 0;
- GLFW_GAMEPAD_BUTTON_B = 1;
- GLFW_GAMEPAD_BUTTON_X = 2;
- GLFW_GAMEPAD_BUTTON_Y = 3;
- GLFW_GAMEPAD_BUTTON_LEFT_BUMPER = 4;
- GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER = 5;
- GLFW_GAMEPAD_BUTTON_BACK = 6;
- GLFW_GAMEPAD_BUTTON_START = 7;
- GLFW_GAMEPAD_BUTTON_GUIDE = 8;
- GLFW_GAMEPAD_BUTTON_LEFT_THUMB = 9;
- GLFW_GAMEPAD_BUTTON_RIGHT_THUMB = 10;
- GLFW_GAMEPAD_BUTTON_DPAD_UP = 11;
- GLFW_GAMEPAD_BUTTON_DPAD_RIGHT = 12;
- GLFW_GAMEPAD_BUTTON_DPAD_DOWN = 13;
- GLFW_GAMEPAD_BUTTON_DPAD_LEFT = 14;
- GLFW_GAMEPAD_BUTTON_LAST = GLFW_GAMEPAD_BUTTON_DPAD_LEFT;
- GLFW_GAMEPAD_BUTTON_CROSS = GLFW_GAMEPAD_BUTTON_A;
- GLFW_GAMEPAD_BUTTON_CIRCLE = GLFW_GAMEPAD_BUTTON_B;
- GLFW_GAMEPAD_BUTTON_SQUARE = GLFW_GAMEPAD_BUTTON_X;
- GLFW_GAMEPAD_BUTTON_TRIANGLE = GLFW_GAMEPAD_BUTTON_Y;
- GLFW_GAMEPAD_AXIS_LEFT_X = 0;
- GLFW_GAMEPAD_AXIS_LEFT_Y = 1;
- GLFW_GAMEPAD_AXIS_RIGHT_X = 2;
- GLFW_GAMEPAD_AXIS_RIGHT_Y = 3;
- GLFW_GAMEPAD_AXIS_LEFT_TRIGGER = 4;
- GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER = 5;
- GLFW_GAMEPAD_AXIS_LAST = GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER;
- GLFW_NO_ERROR = 0;
- GLFW_NOT_INITIALIZED = $00010001;
- GLFW_NO_CURRENT_CONTEXT = $00010002;
- GLFW_INVALID_ENUM = $00010003;
- GLFW_INVALID_VALUE = $00010004;
- GLFW_OUT_OF_MEMORY = $00010005;
- GLFW_API_UNAVAILABLE = $00010006;
- GLFW_VERSION_UNAVAILABLE = $00010007;
- GLFW_PLATFORM_ERROR = $00010008;
- GLFW_FORMAT_UNAVAILABLE = $00010009;
- GLFW_NO_WINDOW_CONTEXT = $0001000A;
- GLFW_CURSOR_UNAVAILABLE = $0001000B;
- GLFW_FEATURE_UNAVAILABLE = $0001000C;
- GLFW_FEATURE_UNIMPLEMENTED = $0001000D;
- GLFW_PLATFORM_UNAVAILABLE = $0001000E;
- GLFW_FOCUSED = $00020001;
- GLFW_ICONIFIED = $00020002;
- GLFW_RESIZABLE = $00020003;
- GLFW_VISIBLE = $00020004;
- GLFW_DECORATED = $00020005;
- GLFW_AUTO_ICONIFY = $00020006;
- GLFW_FLOATING = $00020007;
- GLFW_MAXIMIZED = $00020008;
- GLFW_CENTER_CURSOR = $00020009;
- GLFW_TRANSPARENT_FRAMEBUFFER = $0002000A;
- GLFW_HOVERED = $0002000B;
- GLFW_FOCUS_ON_SHOW = $0002000C;
- GLFW_MOUSE_PASSTHROUGH = $0002000D;
- GLFW_POSITION_X = $0002000E;
- GLFW_POSITION_Y = $0002000F;
- GLFW_RED_BITS = $00021001;
- GLFW_GREEN_BITS = $00021002;
- GLFW_BLUE_BITS = $00021003;
- GLFW_ALPHA_BITS = $00021004;
- GLFW_DEPTH_BITS = $00021005;
- GLFW_STENCIL_BITS = $00021006;
- GLFW_ACCUM_RED_BITS = $00021007;
- GLFW_ACCUM_GREEN_BITS = $00021008;
- GLFW_ACCUM_BLUE_BITS = $00021009;
- GLFW_ACCUM_ALPHA_BITS = $0002100A;
- GLFW_AUX_BUFFERS = $0002100B;
- GLFW_STEREO = $0002100C;
- GLFW_SAMPLES = $0002100D;
- GLFW_SRGB_CAPABLE = $0002100E;
- GLFW_REFRESH_RATE = $0002100F;
- GLFW_DOUBLEBUFFER = $00021010;
- GLFW_CLIENT_API = $00022001;
- GLFW_CONTEXT_VERSION_MAJOR = $00022002;
- GLFW_CONTEXT_VERSION_MINOR = $00022003;
- GLFW_CONTEXT_REVISION = $00022004;
- GLFW_CONTEXT_ROBUSTNESS = $00022005;
- GLFW_OPENGL_FORWARD_COMPAT = $00022006;
- GLFW_CONTEXT_DEBUG = $00022007;
- GLFW_OPENGL_DEBUG_CONTEXT = GLFW_CONTEXT_DEBUG;
- GLFW_OPENGL_PROFILE = $00022008;
- GLFW_CONTEXT_RELEASE_BEHAVIOR = $00022009;
- GLFW_CONTEXT_NO_ERROR = $0002200A;
- GLFW_CONTEXT_CREATION_API = $0002200B;
- GLFW_SCALE_TO_MONITOR = $0002200C;
- GLFW_COCOA_RETINA_FRAMEBUFFER = $00023001;
- GLFW_COCOA_FRAME_NAME = $00023002;
- GLFW_COCOA_GRAPHICS_SWITCHING = $00023003;
- GLFW_X11_CLASS_NAME = $00024001;
- GLFW_X11_INSTANCE_NAME = $00024002;
- GLFW_WIN32_KEYBOARD_MENU = $00025001;
- GLFW_WAYLAND_APP_ID = $00026001;
- GLFW_NO_API = 0;
- GLFW_OPENGL_API = $00030001;
- GLFW_OPENGL_ES_API = $00030002;
- GLFW_NO_ROBUSTNESS = 0;
- GLFW_NO_RESET_NOTIFICATION = $00031001;
- GLFW_LOSE_CONTEXT_ON_RESET = $00031002;
- GLFW_OPENGL_ANY_PROFILE = 0;
- GLFW_OPENGL_CORE_PROFILE = $00032001;
- GLFW_OPENGL_COMPAT_PROFILE = $00032002;
- GLFW_CURSOR = $00033001;
- GLFW_STICKY_KEYS = $00033002;
- GLFW_STICKY_MOUSE_BUTTONS = $00033003;
- GLFW_LOCK_KEY_MODS = $00033004;
- GLFW_RAW_MOUSE_MOTION = $00033005;
- GLFW_CURSOR_NORMAL = $00034001;
- GLFW_CURSOR_HIDDEN = $00034002;
- GLFW_CURSOR_DISABLED = $00034003;
- GLFW_CURSOR_CAPTURED = $00034004;
- GLFW_ANY_RELEASE_BEHAVIOR = 0;
- GLFW_RELEASE_BEHAVIOR_FLUSH = $00035001;
- GLFW_RELEASE_BEHAVIOR_NONE = $00035002;
- GLFW_NATIVE_CONTEXT_API = $00036001;
- GLFW_EGL_CONTEXT_API = $00036002;
- GLFW_OSMESA_CONTEXT_API = $00036003;
- GLFW_ANGLE_PLATFORM_TYPE_NONE = $00037001;
- GLFW_ANGLE_PLATFORM_TYPE_OPENGL = $00037002;
- GLFW_ANGLE_PLATFORM_TYPE_OPENGLES = $00037003;
- GLFW_ANGLE_PLATFORM_TYPE_D3D9 = $00037004;
- GLFW_ANGLE_PLATFORM_TYPE_D3D11 = $00037005;
- GLFW_ANGLE_PLATFORM_TYPE_VULKAN = $00037007;
- GLFW_ANGLE_PLATFORM_TYPE_METAL = $00037008;
- GLFW_WAYLAND_PREFER_LIBDECOR = $00038001;
- GLFW_WAYLAND_DISABLE_LIBDECOR = $00038002;
- GLFW_ANY_POSITION = $80000000;
- GLFW_ARROW_CURSOR = $00036001;
- GLFW_IBEAM_CURSOR = $00036002;
- GLFW_CROSSHAIR_CURSOR = $00036003;
- GLFW_POINTING_HAND_CURSOR = $00036004;
- GLFW_RESIZE_EW_CURSOR = $00036005;
- GLFW_RESIZE_NS_CURSOR = $00036006;
- GLFW_RESIZE_NWSE_CURSOR = $00036007;
- GLFW_RESIZE_NESW_CURSOR = $00036008;
- GLFW_RESIZE_ALL_CURSOR = $00036009;
- GLFW_NOT_ALLOWED_CURSOR = $0003600A;
- GLFW_HRESIZE_CURSOR = GLFW_RESIZE_EW_CURSOR;
- GLFW_VRESIZE_CURSOR = GLFW_RESIZE_NS_CURSOR;
- GLFW_HAND_CURSOR = GLFW_POINTING_HAND_CURSOR;
- GLFW_CONNECTED = $00040001;
- GLFW_DISCONNECTED = $00040002;
- GLFW_JOYSTICK_HAT_BUTTONS = $00050001;
- GLFW_ANGLE_PLATFORM_TYPE = $00050002;
- GLFW_PLATFORM = $00050003;
- GLFW_COCOA_CHDIR_RESOURCES = $00051001;
- GLFW_COCOA_MENUBAR = $00051002;
- GLFW_X11_XCB_VULKAN_SURFACE = $00052001;
- GLFW_WAYLAND_LIBDECOR = $00053001;
- GLFW_ANY_PLATFORM = $00060000;
- GLFW_PLATFORM_WIN32 = $00060001;
- GLFW_PLATFORM_COCOA = $00060002;
- GLFW_PLATFORM_WAYLAND = $00060003;
- GLFW_PLATFORM_X11 = $00060004;
- GLFW_PLATFORM_NULL = $00060005;
- GLFW_DONT_CARE = -1;
- (* GLAPIENTRY APIENTRY *)
- type
- // Forward declarations
- PPAnsiChar = ^PAnsiChar;
- PUInt32 = ^UInt32;
- PGLFWvidmode = ^GLFWvidmode;
- PGLFWgammaramp = ^GLFWgammaramp;
- PGLFWimage = ^GLFWimage;
- PGLFWgamepadstate = ^GLFWgamepadstate;
- PGLFWallocator = ^GLFWallocator;
- (*! @brief Client API function pointer type.
- *
- * Generic function pointer used for returning client API function pointers
- * without forcing a cast from a regular pointer.
- *
- * @sa @ref context_glext
- * @sa @ref glfwGetProcAddress
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- *)
- GLFWglproc = procedure(); cdecl;
- (*! @brief Vulkan API function pointer type.
- *
- * Generic function pointer used for returning Vulkan API function pointers
- * without forcing a cast from a regular pointer.
- *
- * @sa @ref vulkan_proc
- * @sa @ref glfwGetInstanceProcAddress
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- *)
- GLFWvkproc = procedure(); cdecl;
- PGLFWmonitor = Pointer;
- PPGLFWmonitor = ^PGLFWmonitor;
- PGLFWwindow = Pointer;
- PPGLFWwindow = ^PGLFWwindow;
- PGLFWcursor = Pointer;
- PPGLFWcursor = ^PGLFWcursor;
- (*! @brief The function pointer type for memory allocation callbacks.
- *
- * This is the function pointer type for memory allocation callbacks. A memory
- * allocation callback function has the following signature:
- * @code
- * void* function_name(size_t size, void* user)
- * @endcode
- *
- * This function must return either a memory block at least `size` bytes long,
- * or `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
- * failures gracefully yet.
- *
- * This function may be called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the
- * library is no longer flagged as initialized.
- *
- * Any memory allocated by this function will be deallocated during library
- * termination or earlier.
- *
- * The size will always be greater than zero. Allocations of size zero are filtered out
- * before reaching the custom allocator.
- *
- * @param[in] size The minimum size, in bytes, of the memory block.
- * @param[in] user The user-defined pointer from the allocator.
- * @return The address of the newly allocated memory block, or `NULL` if an
- * error occurred.
- *
- * @pointer_lifetime The returned memory block must be valid at least until it
- * is deallocated.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function may be called from any thread that calls GLFW functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- GLFWallocatefun = function(size: NativeUInt; user: Pointer): Pointer; cdecl;
- (*! @brief The function pointer type for memory reallocation callbacks.
- *
- * This is the function pointer type for memory reallocation callbacks.
- * A memory reallocation callback function has the following signature:
- * @code
- * void* function_name(void* block, size_t size, void* user)
- * @endcode
- *
- * This function must return a memory block at least `size` bytes long, or
- * `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
- * failures gracefully yet.
- *
- * This function may be called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the
- * library is no longer flagged as initialized.
- *
- * Any memory allocated by this function will be deallocated during library
- * termination or earlier.
- *
- * The block address will never be `NULL` and the size will always be greater than zero.
- * Reallocations of a block to size zero are converted into deallocations. Reallocations
- * of `NULL` to a non-zero size are converted into regular allocations.
- *
- * @param[in] block The address of the memory block to reallocate.
- * @param[in] size The new minimum size, in bytes, of the memory block.
- * @param[in] user The user-defined pointer from the allocator.
- * @return The address of the newly allocated or resized memory block, or
- * `NULL` if an error occurred.
- *
- * @pointer_lifetime The returned memory block must be valid at least until it
- * is deallocated.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function may be called from any thread that calls GLFW functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- GLFWreallocatefun = function(block: Pointer; size: NativeUInt; user: Pointer): Pointer; cdecl;
- (*! @brief The function pointer type for memory deallocation callbacks.
- *
- * This is the function pointer type for memory deallocation callbacks.
- * A memory deallocation callback function has the following signature:
- * @code
- * void function_name(void* block, void* user)
- * @endcode
- *
- * This function may deallocate the specified memory block. This memory block
- * will have been allocated with the same allocator.
- *
- * This function may be called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the
- * library is no longer flagged as initialized.
- *
- * The block address will never be `NULL`. Deallocations of `NULL` are filtered out
- * before reaching the custom allocator.
- *
- * @param[in] block The address of the memory block to deallocate.
- * @param[in] user The user-defined pointer from the allocator.
- *
- * @pointer_lifetime The specified memory block will not be accessed by GLFW
- * after this function is called.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function may be called from any thread that calls GLFW functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- GLFWdeallocatefun = procedure(block: Pointer; user: Pointer); cdecl;
- (*! @brief The function pointer type for error callbacks.
- *
- * This is the function pointer type for error callbacks. An error callback
- * function has the following signature:
- * @code
- * void callback_name(int error_code, const char* description)
- * @endcode
- *
- * @param[in] error_code An [error code](@ref errors). Future releases may add
- * more error codes.
- * @param[in] description A UTF-8 encoded string describing the error.
- *
- * @pointer_lifetime The error description string is valid until the callback
- * function returns.
- *
- * @sa @ref error_handling
- * @sa @ref glfwSetErrorCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- *)
- GLFWerrorfun = procedure(error_code: Integer; const description: PAnsiChar); cdecl;
- (*! @brief The function pointer type for window position callbacks.
- *
- * This is the function pointer type for window position callbacks. A window
- * position callback function has the following signature:
- * @code
- * void callback_name(GLFWwindow* window, int xpos, int ypos)
- * @endcode
- *
- * @param[in] window The window that was moved.
- * @param[in] xpos The new x-coordinate, in screen coordinates, of the
- * upper-left corner of the content area of the window.
- * @param[in] ypos The new y-coordinate, in screen coordinates, of the
- * upper-left corner of the content area of the window.
- *
- * @sa @ref window_pos
- * @sa @ref glfwSetWindowPosCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- GLFWwindowposfun = procedure(window: PGLFWwindow; xpos: Integer; ypos: Integer); cdecl;
- (*! @brief The function pointer type for window size callbacks.
- *
- * This is the function pointer type for window size callbacks. A window size
- * callback function has the following signature:
- * @code
- * void callback_name(GLFWwindow* window, int width, int height)
- * @endcode
- *
- * @param[in] window The window that was resized.
- * @param[in] width The new width, in screen coordinates, of the window.
- * @param[in] height The new height, in screen coordinates, of the window.
- *
- * @sa @ref window_size
- * @sa @ref glfwSetWindowSizeCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- GLFWwindowsizefun = procedure(window: PGLFWwindow; width: Integer; height: Integer); cdecl;
- (*! @brief The function pointer type for window close callbacks.
- *
- * This is the function pointer type for window close callbacks. A window
- * close callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window)
- * @endcode
- *
- * @param[in] window The window that the user attempted to close.
- *
- * @sa @ref window_close
- * @sa @ref glfwSetWindowCloseCallback
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- GLFWwindowclosefun = procedure(window: PGLFWwindow); cdecl;
- (*! @brief The function pointer type for window content refresh callbacks.
- *
- * This is the function pointer type for window content refresh callbacks.
- * A window content refresh callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window);
- * @endcode
- *
- * @param[in] window The window whose content needs to be refreshed.
- *
- * @sa @ref window_refresh
- * @sa @ref glfwSetWindowRefreshCallback
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- GLFWwindowrefreshfun = procedure(window: PGLFWwindow); cdecl;
- (*! @brief The function pointer type for window focus callbacks.
- *
- * This is the function pointer type for window focus callbacks. A window
- * focus callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int focused)
- * @endcode
- *
- * @param[in] window The window that gained or lost input focus.
- * @param[in] focused `GLFW_TRUE` if the window was given input focus, or
- * `GLFW_FALSE` if it lost it.
- *
- * @sa @ref window_focus
- * @sa @ref glfwSetWindowFocusCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- GLFWwindowfocusfun = procedure(window: PGLFWwindow; focused: Integer); cdecl;
- (*! @brief The function pointer type for window iconify callbacks.
- *
- * This is the function pointer type for window iconify callbacks. A window
- * iconify callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int iconified)
- * @endcode
- *
- * @param[in] window The window that was iconified or restored.
- * @param[in] iconified `GLFW_TRUE` if the window was iconified, or
- * `GLFW_FALSE` if it was restored.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwSetWindowIconifyCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- GLFWwindowiconifyfun = procedure(window: PGLFWwindow; iconified: Integer); cdecl;
- (*! @brief The function pointer type for window maximize callbacks.
- *
- * This is the function pointer type for window maximize callbacks. A window
- * maximize callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int maximized)
- * @endcode
- *
- * @param[in] window The window that was maximized or restored.
- * @param[in] maximized `GLFW_TRUE` if the window was maximized, or
- * `GLFW_FALSE` if it was restored.
- *
- * @sa @ref window_maximize
- * @sa glfwSetWindowMaximizeCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- GLFWwindowmaximizefun = procedure(window: PGLFWwindow; maximized: Integer); cdecl;
- (*! @brief The function pointer type for framebuffer size callbacks.
- *
- * This is the function pointer type for framebuffer size callbacks.
- * A framebuffer size callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- *
- * @param[in] window The window whose framebuffer was resized.
- * @param[in] width The new width, in pixels, of the framebuffer.
- * @param[in] height The new height, in pixels, of the framebuffer.
- *
- * @sa @ref window_fbsize
- * @sa @ref glfwSetFramebufferSizeCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- GLFWframebuffersizefun = procedure(window: PGLFWwindow; width: Integer; height: Integer); cdecl;
- (*! @brief The function pointer type for window content scale callbacks.
- *
- * This is the function pointer type for window content scale callbacks.
- * A window content scale callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, float xscale, float yscale)
- * @endcode
- *
- * @param[in] window The window whose content scale changed.
- * @param[in] xscale The new x-axis content scale of the window.
- * @param[in] yscale The new y-axis content scale of the window.
- *
- * @sa @ref window_scale
- * @sa @ref glfwSetWindowContentScaleCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- GLFWwindowcontentscalefun = procedure(window: PGLFWwindow; xscale: Single; yscale: Single); cdecl;
- (*! @brief The function pointer type for mouse button callbacks.
- *
- * This is the function pointer type for mouse button callback functions.
- * A mouse button callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int button, int action, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] button The [mouse button](@ref buttons) that was pressed or
- * released.
- * @param[in] action One of `GLFW_PRESS` or `GLFW_RELEASE`. Future releases
- * may add more actions.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_mouse_button
- * @sa @ref glfwSetMouseButtonCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle and modifier mask parameters.
- *
- * @ingroup input
- *)
- GLFWmousebuttonfun = procedure(window: PGLFWwindow; button: Integer; action: Integer; mods: Integer); cdecl;
- (*! @brief The function pointer type for cursor position callbacks.
- *
- * This is the function pointer type for cursor position callbacks. A cursor
- * position callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, double xpos, double ypos);
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] xpos The new cursor x-coordinate, relative to the left edge of
- * the content area.
- * @param[in] ypos The new cursor y-coordinate, relative to the top edge of the
- * content area.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwSetCursorPosCallback
- *
- * @since Added in version 3.0. Replaces `GLFWmouseposfun`.
- *
- * @ingroup input
- *)
- GLFWcursorposfun = procedure(window: PGLFWwindow; xpos: Double; ypos: Double); cdecl;
- (*! @brief The function pointer type for cursor enter/leave callbacks.
- *
- * This is the function pointer type for cursor enter/leave callbacks.
- * A cursor enter/leave callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int entered)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] entered `GLFW_TRUE` if the cursor entered the window's content
- * area, or `GLFW_FALSE` if it left it.
- *
- * @sa @ref cursor_enter
- * @sa @ref glfwSetCursorEnterCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- GLFWcursorenterfun = procedure(window: PGLFWwindow; entered: Integer); cdecl;
- (*! @brief The function pointer type for scroll callbacks.
- *
- * This is the function pointer type for scroll callbacks. A scroll callback
- * function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, double xoffset, double yoffset)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] xoffset The scroll offset along the x-axis.
- * @param[in] yoffset The scroll offset along the y-axis.
- *
- * @sa @ref scrolling
- * @sa @ref glfwSetScrollCallback
- *
- * @since Added in version 3.0. Replaces `GLFWmousewheelfun`.
- *
- * @ingroup input
- *)
- GLFWscrollfun = procedure(window: PGLFWwindow; xoffset: Double; yoffset: Double); cdecl;
- (*! @brief The function pointer type for keyboard key callbacks.
- *
- * This is the function pointer type for keyboard key callbacks. A keyboard
- * key callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] key The [keyboard key](@ref keys) that was pressed or released.
- * @param[in] scancode The platform-specific scancode of the key.
- * @param[in] action `GLFW_PRESS`, `GLFW_RELEASE` or `GLFW_REPEAT`. Future
- * releases may add more actions.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_key
- * @sa @ref glfwSetKeyCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle, scancode and modifier mask parameters.
- *
- * @ingroup input
- *)
- GLFWkeyfun = procedure(window: PGLFWwindow; key: Integer; scancode: Integer; action: Integer; mods: Integer); cdecl;
- (*! @brief The function pointer type for Unicode character callbacks.
- *
- * This is the function pointer type for Unicode character callbacks.
- * A Unicode character callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] codepoint The Unicode code point of the character.
- *
- * @sa @ref input_char
- * @sa @ref glfwSetCharCallback
- *
- * @since Added in version 2.4.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- *)
- GLFWcharfun = procedure(window: PGLFWwindow; codepoint: Cardinal); cdecl;
- (*! @brief The function pointer type for Unicode character with modifiers
- * callbacks.
- *
- * This is the function pointer type for Unicode character with modifiers
- * callbacks. It is called for each input character, regardless of what
- * modifier keys are held down. A Unicode character with modifiers callback
- * function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] codepoint The Unicode code point of the character.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_char
- * @sa @ref glfwSetCharModsCallback
- *
- * @deprecated Scheduled for removal in version 4.0.
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- GLFWcharmodsfun = procedure(window: PGLFWwindow; codepoint: Cardinal; mods: Integer); cdecl;
- (*! @brief The function pointer type for path drop callbacks.
- *
- * This is the function pointer type for path drop callbacks. A path drop
- * callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int path_count, const char* paths[])
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] path_count The number of dropped paths.
- * @param[in] paths The UTF-8 encoded file and/or directory path names.
- *
- * @pointer_lifetime The path array and its strings are valid until the
- * callback function returns.
- *
- * @sa @ref path_drop
- * @sa @ref glfwSetDropCallback
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- GLFWdropfun = procedure(window: PGLFWwindow; path_count: Integer; paths: PPAnsiChar); cdecl;
- (*! @brief The function pointer type for monitor configuration callbacks.
- *
- * This is the function pointer type for monitor configuration callbacks.
- * A monitor callback function has the following signature:
- * @code
- * void function_name(GLFWmonitor* monitor, int event)
- * @endcode
- *
- * @param[in] monitor The monitor that was connected or disconnected.
- * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
- * releases may add more events.
- *
- * @sa @ref monitor_event
- * @sa @ref glfwSetMonitorCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- GLFWmonitorfun = procedure(monitor: PGLFWmonitor; event: Integer); cdecl;
- (*! @brief The function pointer type for joystick configuration callbacks.
- *
- * This is the function pointer type for joystick configuration callbacks.
- * A joystick configuration callback function has the following signature:
- * @code
- * void function_name(int jid, int event)
- * @endcode
- *
- * @param[in] jid The joystick that was connected or disconnected.
- * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
- * releases may add more events.
- *
- * @sa @ref joystick_event
- * @sa @ref glfwSetJoystickCallback
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- *)
- GLFWjoystickfun = procedure(jid: Integer; event: Integer); cdecl;
- (*! @brief Video mode type.
- *
- * This describes a single video mode.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoMode
- * @sa @ref glfwGetVideoModes
- *
- * @since Added in version 1.0.
- * @glfw3 Added refresh rate member.
- *
- * @ingroup monitor
- *)
- GLFWvidmode = record
- (*! The width, in screen coordinates, of the video mode.
- *)
- width: Integer;
- (*! The height, in screen coordinates, of the video mode.
- *)
- height: Integer;
- (*! The bit depth of the red channel of the video mode.
- *)
- redBits: Integer;
- (*! The bit depth of the green channel of the video mode.
- *)
- greenBits: Integer;
- (*! The bit depth of the blue channel of the video mode.
- *)
- blueBits: Integer;
- (*! The refresh rate, in Hz, of the video mode.
- *)
- refreshRate: Integer;
- end;
- (*! @brief Gamma ramp.
- *
- * This describes the gamma ramp for a monitor.
- *
- * @sa @ref monitor_gamma
- * @sa @ref glfwGetGammaRamp
- * @sa @ref glfwSetGammaRamp
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- GLFWgammaramp = record
- (*! An array of value describing the response of the red channel.
- *)
- red: PWord;
- (*! An array of value describing the response of the green channel.
- *)
- green: PWord;
- (*! An array of value describing the response of the blue channel.
- *)
- blue: PWord;
- (*! The number of elements in each array.
- *)
- size: Cardinal;
- end;
- (*! @brief Image data.
- *
- * This describes a single 2D image. See the documentation for each related
- * function what the expected pixel format is.
- *
- * @sa @ref cursor_custom
- * @sa @ref window_icon
- *
- * @since Added in version 2.1.
- * @glfw3 Removed format and bytes-per-pixel members.
- *
- * @ingroup window
- *)
- GLFWimage = record
- (*! The width, in pixels, of this image.
- *)
- width: Integer;
- (*! The height, in pixels, of this image.
- *)
- height: Integer;
- (*! The pixel data of this image, arranged left-to-right, top-to-bottom.
- *)
- pixels: PByte;
- end;
- (*! @brief Gamepad input state
- *
- * This describes the input state of a gamepad.
- *
- * @sa @ref gamepad
- * @sa @ref glfwGetGamepadState
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- GLFWgamepadstate = record
- (*! The states of each [gamepad button](@ref gamepad_buttons), `GLFW_PRESS`
- * or `GLFW_RELEASE`.
- *)
- buttons: array [0..14] of Byte;
- (*! The states of each [gamepad axis](@ref gamepad_axes), in the range -1.0
- * to 1.0 inclusive.
- *)
- axes: array [0..5] of Single;
- end;
- (*! @brief
- *
- * @sa @ref init_allocator
- * @sa @ref glfwInitAllocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- GLFWallocator = record
- allocate: GLFWallocatefun;
- reallocate: GLFWreallocatefun;
- deallocate: GLFWdeallocatefun;
- user: Pointer;
- end;
- (*! @brief Initializes the GLFW library.
- *
- * This function initializes the GLFW library. Before most GLFW functions can
- * be used, GLFW must be initialized, and before an application terminates GLFW
- * should be terminated in order to free any resources allocated during or
- * after initialization.
- *
- * If this function fails, it calls @ref glfwTerminate before returning. If it
- * succeeds, you should call @ref glfwTerminate before the application exits.
- *
- * Additional calls to this function after successful initialization but before
- * termination will return `GLFW_TRUE` immediately.
- *
- * The @ref GLFW_PLATFORM init hint controls which platforms are considered during
- * initialization. This also depends on which platforms the library was compiled to
- * support.
- *
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_PLATFORM_UNAVAILABLE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos This function will change the current directory of the
- * application to the `Contents/Resources` subdirectory of the application's
- * bundle, if present. This can be disabled with the @ref
- * GLFW_COCOA_CHDIR_RESOURCES init hint.
- *
- * @remark @macos This function will create the main menu and dock icon for the
- * application. If GLFW finds a `MainMenu.nib` it is loaded and assumed to
- * contain a menu bar. Otherwise a minimal menu bar is created manually with
- * common commands like Hide, Quit and About. The About entry opens a minimal
- * about dialog with information from the application's bundle. The menu bar
- * and dock icon can be disabled entirely with the @ref GLFW_COCOA_MENUBAR init
- * hint.
- *
- * @remark @x11 This function will set the `LC_CTYPE` category of the
- * application locale according to the current environment if that category is
- * still "C". This is because the "C" locale breaks Unicode text input.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref intro_init
- * @sa @ref glfwInitHint
- * @sa @ref glfwInitAllocator
- * @sa @ref glfwTerminate
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- *)
- function glfwInit(): Integer; cdecl;
- external libglfw3 name _PU + 'glfwInit';
- (*! @brief Terminates the GLFW library.
- *
- * This function destroys all remaining windows and cursors, restores any
- * modified gamma ramps and frees any other allocated resources. Once this
- * function is called, you must again call @ref glfwInit successfully before
- * you will be able to use most GLFW functions.
- *
- * If GLFW has been successfully initialized, this function should be called
- * before the application exits. If initialization fails, there is no need to
- * call this function, as it is called by @ref glfwInit before it returns
- * failure.
- *
- * This function has no effect if GLFW is not initialized.
- *
- * @errors Possible errors include @ref GLFW_PLATFORM_ERROR.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @warning The contexts of any remaining windows must not be current on any
- * other thread when this function is called.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref intro_init
- * @sa @ref glfwInit
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- *)
- procedure glfwTerminate(); cdecl;
- external libglfw3 name _PU + 'glfwTerminate';
- (*! @brief Sets the specified init hint to the desired value.
- *
- * This function sets hints for the next initialization of GLFW.
- *
- * The values you set hints to are never reset by GLFW, but they only take
- * effect during initialization. Once GLFW has been initialized, any values
- * you set will be ignored until the library is terminated and initialized
- * again.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [init hint](@ref init_hints) to set.
- * @param[in] value The new value of the init hint.
- *
- * @errors Possible errors include @ref GLFW_INVALID_ENUM and @ref
- * GLFW_INVALID_VALUE.
- *
- * @remarks This function may be called before @ref glfwInit.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa init_hints
- * @sa glfwInit
- *
- * @since Added in version 3.3.
- *
- * @ingroup init
- *)
- procedure glfwInitHint(hint: Integer; value: Integer); cdecl;
- external libglfw3 name _PU + 'glfwInitHint';
- (*! @brief Sets the init allocator to the desired value.
- *
- * To use the default allocator, call this function with a `NULL` argument.
- *
- * If you specify an allocator struct, every member must be a valid function
- * pointer. If any member is `NULL`, this function emits @ref
- * GLFW_INVALID_VALUE and the init allocator is unchanged.
- *
- * @param[in] allocator The allocator to use at the next initialization, or
- * `NULL` to use the default one.
- *
- * @errors Possible errors include @ref GLFW_INVALID_VALUE.
- *
- * @pointer_lifetime The specified allocator is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref init_allocator
- * @sa @ref glfwInit
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- procedure glfwInitAllocator(const allocator: PGLFWallocator); cdecl;
- external libglfw3 name _PU + 'glfwInitAllocator';
- (*! @brief Retrieves the version of the GLFW library.
- *
- * This function retrieves the major, minor and revision numbers of the GLFW
- * library. It is intended for when you are using GLFW as a shared library and
- * want to ensure that you are using the minimum required version.
- *
- * Any or all of the version arguments may be `NULL`.
- *
- * @param[out] major Where to store the major version number, or `NULL`.
- * @param[out] minor Where to store the minor version number, or `NULL`.
- * @param[out] rev Where to store the revision number, or `NULL`.
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref intro_version
- * @sa @ref glfwGetVersionString
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- *)
- procedure glfwGetVersion(major: PInteger; minor: PInteger; rev: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetVersion';
- (*! @brief Returns a string describing the compile-time configuration.
- *
- * This function returns the compile-time generated
- * [version string](@ref intro_version_string) of the GLFW library binary. It describes
- * the version, platforms, compiler and any platform or operating system specific
- * compile-time options. It should not be confused with the OpenGL or OpenGL ES version
- * string, queried with `glGetString`.
- *
- * __Do not use the version string__ to parse the GLFW library version. The
- * @ref glfwGetVersion function provides the version of the running library
- * binary in numerical format.
- *
- * __Do not use the version string__ to parse what platforms are supported. The @ref
- * glfwPlatformSupported function lets you query platform support.
- *
- * @return The ASCII encoded GLFW version string.
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @pointer_lifetime The returned string is static and compile-time generated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref intro_version
- * @sa @ref glfwGetVersion
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- *)
- function glfwGetVersionString(): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetVersionString';
- (*! @brief Returns and clears the last error for the calling thread.
- *
- * This function returns and clears the [error code](@ref errors) of the last
- * error that occurred on the calling thread, and optionally a UTF-8 encoded
- * human-readable description of it. If no error has occurred since the last
- * call, it returns @ref GLFW_NO_ERROR (zero) and the description pointer is
- * set to `NULL`.
- *
- * @param[in] description Where to store the error description pointer, or `NULL`.
- * @return The last error code for the calling thread, or @ref GLFW_NO_ERROR
- * (zero).
- *
- * @errors None.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * next error occurs or the library is terminated.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref error_handling
- * @sa @ref glfwSetErrorCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup init
- *)
- function glfwGetError(description: PPAnsiChar): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetError';
- (*! @brief Sets the error callback.
- *
- * This function sets the error callback, which is called with an error code
- * and a human-readable description each time a GLFW error occurs.
- *
- * The error code is set before the callback is called. Calling @ref
- * glfwGetError from the error callback will return the same value as the error
- * code argument.
- *
- * The error callback is called on the thread where the error occurred. If you
- * are using GLFW from multiple threads, your error callback needs to be
- * written accordingly.
- *
- * Because the description string may have been generated specifically for that
- * error, it is not guaranteed to be valid after the callback has returned. If
- * you wish to use it after the callback returns, you need to make a copy.
- *
- * Once set, the error callback remains set even after the library has been
- * terminated.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set.
- *
- * @callback_signature
- * @code
- * void callback_name(int error_code, const char* description)
- * @endcode
- * For more information about the callback parameters, see the
- * [callback pointer type](@ref GLFWerrorfun).
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref error_handling
- * @sa @ref glfwGetError
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- *)
- function glfwSetErrorCallback(callback: GLFWerrorfun): GLFWerrorfun; cdecl;
- external libglfw3 name _PU + 'glfwSetErrorCallback';
- (*! @brief Returns the currently selected platform.
- *
- * This function returns the platform that was selected during initialization. The
- * returned value will be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
- * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
- *
- * @return The currently selected platform, or zero if an error occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref platform
- * @sa @ref glfwPlatformSupported
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- function glfwGetPlatform(): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetPlatform';
- (*! @brief Returns whether the library includes support for the specified platform.
- *
- * This function returns whether the library was compiled with support for the specified
- * platform. The platform must be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
- * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
- *
- * @param[in] platform The platform to query.
- * @return `GLFW_TRUE` if the platform is supported, or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_INVALID_ENUM.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref platform
- * @sa @ref glfwGetPlatform
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- *)
- function glfwPlatformSupported(platform_: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwPlatformSupported';
- (*! @brief Returns the currently connected monitors.
- *
- * This function returns an array of handles for all currently connected
- * monitors. The primary monitor is always first in the returned array. If no
- * monitors were found, this function returns `NULL`.
- *
- * @param[out] count Where to store the number of monitors in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of monitor handles, or `NULL` if no monitors were found or
- * if an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * monitor configuration changes or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_monitors
- * @sa @ref monitor_event
- * @sa @ref glfwGetPrimaryMonitor
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- function glfwGetMonitors(count: PInteger): PPGLFWmonitor; cdecl;
- external libglfw3 name _PU + 'glfwGetMonitors';
- (*! @brief Returns the primary monitor.
- *
- * This function returns the primary monitor. This is usually the monitor
- * where elements like the task bar or global menu bar are located.
- *
- * @return The primary monitor, or `NULL` if no monitors were found or if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @remark The primary monitor is always first in the array returned by @ref
- * glfwGetMonitors.
- *
- * @sa @ref monitor_monitors
- * @sa @ref glfwGetMonitors
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- function glfwGetPrimaryMonitor(): PGLFWmonitor; cdecl;
- external libglfw3 name _PU + 'glfwGetPrimaryMonitor';
- (*! @brief Returns the position of the monitor's viewport on the virtual screen.
- *
- * This function returns the position, in screen coordinates, of the upper-left
- * corner of the specified monitor.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
- * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- procedure glfwGetMonitorPos(monitor: PGLFWmonitor; xpos: PInteger; ypos: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorPos';
- (*! @brief Retrieves the work area of the monitor.
- *
- * This function returns the position, in screen coordinates, of the upper-left
- * corner of the work area of the specified monitor along with the work area
- * size in screen coordinates. The work area is defined as the area of the
- * monitor not occluded by the window system task bar where present. If no
- * task bar exists then the work area is the monitor resolution in screen
- * coordinates.
- *
- * Any or all of the position and size arguments may be `NULL`. If an error
- * occurs, all non-`NULL` position and size arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
- * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
- * @param[out] width Where to store the monitor width, or `NULL`.
- * @param[out] height Where to store the monitor height, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_workarea
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- *)
- procedure glfwGetMonitorWorkarea(monitor: PGLFWmonitor; xpos: PInteger; ypos: PInteger; width: PInteger; height: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorWorkarea';
- (*! @brief Returns the physical size of the monitor.
- *
- * This function returns the size, in millimetres, of the display area of the
- * specified monitor.
- *
- * Some platforms do not provide accurate monitor size information, either
- * because the monitor
- * [EDID](https://en.wikipedia.org/wiki/Extended_display_identification_data)
- * data is incorrect or because the driver does not report it accurately.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] widthMM Where to store the width, in millimetres, of the
- * monitor's display area, or `NULL`.
- * @param[out] heightMM Where to store the height, in millimetres, of the
- * monitor's display area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @win32 On Windows 8 and earlier the physical size is calculated from
- * the current resolution and system DPI instead of querying the monitor EDID data.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- procedure glfwGetMonitorPhysicalSize(monitor: PGLFWmonitor; widthMM: PInteger; heightMM: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorPhysicalSize';
- (*! @brief Retrieves the content scale for the specified monitor.
- *
- * This function retrieves the content scale for the specified monitor. The
- * content scale is the ratio between the current DPI and the platform's
- * default DPI. This is especially important for text and any UI elements. If
- * the pixel dimensions of your UI scaled by this look appropriate on your
- * machine then it should appear at a reasonable size on other machines
- * regardless of their DPI and scaling settings. This relies on the system DPI
- * and scaling settings being somewhat correct.
- *
- * The content scale may depend on both the monitor resolution and pixel
- * density and on user settings. It may be very different from the raw DPI
- * calculated from the physical size and current resolution.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
- * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_scale
- * @sa @ref glfwGetWindowContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- *)
- procedure glfwGetMonitorContentScale(monitor: PGLFWmonitor; xscale: PSingle; yscale: PSingle); cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorContentScale';
- (*! @brief Returns the name of the specified monitor.
- *
- * This function returns a human-readable name, encoded as UTF-8, of the
- * specified monitor. The name typically reflects the make and model of the
- * monitor and is not guaranteed to be unique among the connected monitors.
- *
- * @param[in] monitor The monitor to query.
- * @return The UTF-8 encoded name of the monitor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- function glfwGetMonitorName(monitor: PGLFWmonitor): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorName';
- (*! @brief Sets the user pointer of the specified monitor.
- *
- * This function sets the user-defined pointer of the specified monitor. The
- * current value is retained until the monitor is disconnected. The initial
- * value is `NULL`.
- *
- * This function may be called from the monitor callback, even for a monitor
- * that is being disconnected.
- *
- * @param[in] monitor The monitor whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref monitor_userptr
- * @sa @ref glfwGetMonitorUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- *)
- procedure glfwSetMonitorUserPointer(monitor: PGLFWmonitor; pointer: Pointer); cdecl;
- external libglfw3 name _PU + 'glfwSetMonitorUserPointer';
- (*! @brief Returns the user pointer of the specified monitor.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified monitor. The initial value is `NULL`.
- *
- * This function may be called from the monitor callback, even for a monitor
- * that is being disconnected.
- *
- * @param[in] monitor The monitor whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref monitor_userptr
- * @sa @ref glfwSetMonitorUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- *)
- function glfwGetMonitorUserPointer(monitor: PGLFWmonitor): Pointer; cdecl;
- external libglfw3 name _PU + 'glfwGetMonitorUserPointer';
- (*! @brief Sets the monitor configuration callback.
- *
- * This function sets the monitor configuration callback, or removes the
- * currently set callback. This is called when a monitor is connected to or
- * disconnected from the system.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWmonitor* monitor, int event)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWmonitorfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_event
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- function glfwSetMonitorCallback(callback: GLFWmonitorfun): GLFWmonitorfun; cdecl;
- external libglfw3 name _PU + 'glfwSetMonitorCallback';
- (*! @brief Returns the available video modes for the specified monitor.
- *
- * This function returns an array of all video modes supported by the specified
- * monitor. The returned array is sorted in ascending order, first by color
- * bit depth (the sum of all channel depths), then by resolution area (the
- * product of width and height), then resolution width and finally by refresh
- * rate.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] count Where to store the number of video modes in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of video modes, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected, this function is called again for that monitor or the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoMode
- *
- * @since Added in version 1.0.
- * @glfw3 Changed to return an array of modes for a specific monitor.
- *
- * @ingroup monitor
- *)
- function glfwGetVideoModes(monitor: PGLFWmonitor; count: PInteger): PGLFWvidmode; cdecl;
- external libglfw3 name _PU + 'glfwGetVideoModes';
- (*! @brief Returns the current mode of the specified monitor.
- *
- * This function returns the current video mode of the specified monitor. If
- * you have created a full screen window for that monitor, the return value
- * will depend on whether that window is iconified.
- *
- * @param[in] monitor The monitor to query.
- * @return The current mode of the monitor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoModes
- *
- * @since Added in version 3.0. Replaces `glfwGetDesktopMode`.
- *
- * @ingroup monitor
- *)
- function glfwGetVideoMode(monitor: PGLFWmonitor): PGLFWvidmode; cdecl;
- external libglfw3 name _PU + 'glfwGetVideoMode';
- (*! @brief Generates a gamma ramp and sets it for the specified monitor.
- *
- * This function generates an appropriately sized gamma ramp from the specified
- * exponent and then calls @ref glfwSetGammaRamp with it. The value must be
- * a finite number greater than zero.
- *
- * The software controlled gamma ramp is applied _in addition_ to the hardware
- * gamma correction, which today is usually an approximation of sRGB gamma.
- * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
- * the default (usually sRGB-like) behavior.
- *
- * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
- * GLFW_SRGB_CAPABLE hint.
- *
- * @param[in] monitor The monitor whose gamma ramp to set.
- * @param[in] gamma The desired exponent.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_INVALID_VALUE,
- * @ref GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- procedure glfwSetGamma(monitor: PGLFWmonitor; gamma: Single); cdecl;
- external libglfw3 name _PU + 'glfwSetGamma';
- (*! @brief Returns the current gamma ramp for the specified monitor.
- *
- * This function returns the current gamma ramp of the specified monitor.
- *
- * @param[in] monitor The monitor to query.
- * @return The current gamma ramp, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
- * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE while
- * returning `NULL`.
- *
- * @pointer_lifetime The returned structure and its arrays are allocated and
- * freed by GLFW. You should not free them yourself. They are valid until the
- * specified monitor is disconnected, this function is called again for that
- * monitor or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- function glfwGetGammaRamp(monitor: PGLFWmonitor): PGLFWgammaramp; cdecl;
- external libglfw3 name _PU + 'glfwGetGammaRamp';
- (*! @brief Sets the current gamma ramp for the specified monitor.
- *
- * This function sets the current gamma ramp for the specified monitor. The
- * original gamma ramp for that monitor is saved by GLFW the first time this
- * function is called and is restored by @ref glfwTerminate.
- *
- * The software controlled gamma ramp is applied _in addition_ to the hardware
- * gamma correction, which today is usually an approximation of sRGB gamma.
- * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
- * the default (usually sRGB-like) behavior.
- *
- * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
- * GLFW_SRGB_CAPABLE hint.
- *
- * @param[in] monitor The monitor whose gamma ramp to set.
- * @param[in] ramp The gamma ramp to use.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
- * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark The size of the specified gamma ramp should match the size of the
- * current ramp for that monitor.
- *
- * @remark @win32 The gamma ramp size must be 256.
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @pointer_lifetime The specified gamma ramp is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- *)
- procedure glfwSetGammaRamp(monitor: PGLFWmonitor; const ramp: PGLFWgammaramp); cdecl;
- external libglfw3 name _PU + 'glfwSetGammaRamp';
- (*! @brief Resets all window hints to their default values.
- *
- * This function resets all window hints to their
- * [default values](@ref window_hints_values).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHint
- * @sa @ref glfwWindowHintString
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwDefaultWindowHints(); cdecl;
- external libglfw3 name _PU + 'glfwDefaultWindowHints';
- (*! @brief Sets the specified window hint to the desired value.
- *
- * This function sets hints for the next call to @ref glfwCreateWindow. The
- * hints, once set, retain their values until changed by a call to this
- * function or @ref glfwDefaultWindowHints, or until the library is terminated.
- *
- * Only integer value hints can be set with this function. String value hints
- * are set with @ref glfwWindowHintString.
- *
- * This function does not check whether the specified hint values are valid.
- * If you set hints to invalid values this will instead be reported by the next
- * call to @ref glfwCreateWindow.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [window hint](@ref window_hints) to set.
- * @param[in] value The new value of the window hint.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHintString
- * @sa @ref glfwDefaultWindowHints
- *
- * @since Added in version 3.0. Replaces `glfwOpenWindowHint`.
- *
- * @ingroup window
- *)
- procedure glfwWindowHint(hint: Integer; value: Integer); cdecl;
- external libglfw3 name _PU + 'glfwWindowHint';
- (*! @brief Sets the specified window hint to the desired value.
- *
- * This function sets hints for the next call to @ref glfwCreateWindow. The
- * hints, once set, retain their values until changed by a call to this
- * function or @ref glfwDefaultWindowHints, or until the library is terminated.
- *
- * Only string type hints can be set with this function. Integer value hints
- * are set with @ref glfwWindowHint.
- *
- * This function does not check whether the specified hint values are valid.
- * If you set hints to invalid values this will instead be reported by the next
- * call to @ref glfwCreateWindow.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [window hint](@ref window_hints) to set.
- * @param[in] value The new value of the window hint.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @pointer_lifetime The specified string is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHint
- * @sa @ref glfwDefaultWindowHints
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- procedure glfwWindowHintString(hint: Integer; const value: PAnsiChar); cdecl;
- external libglfw3 name _PU + 'glfwWindowHintString';
- (*! @brief Creates a window and its associated context.
- *
- * This function creates a window and its associated OpenGL or OpenGL ES
- * context. Most of the options controlling how the window and its context
- * should be created are specified with [window hints](@ref window_hints).
- *
- * Successful creation does not change which context is current. Before you
- * can use the newly created context, you need to
- * [make it current](@ref context_current). For information about the `share`
- * parameter, see @ref context_sharing.
- *
- * The created window, framebuffer and context may differ from what you
- * requested, as not all parameters and hints are
- * [hard constraints](@ref window_hints_hard). This includes the size of the
- * window, especially for full screen windows. To query the actual attributes
- * of the created window, framebuffer and context, see @ref
- * glfwGetWindowAttrib, @ref glfwGetWindowSize and @ref glfwGetFramebufferSize.
- *
- * To create a full screen window, you need to specify the monitor the window
- * will cover. If no monitor is specified, the window will be windowed mode.
- * Unless you have a way for the user to choose a specific monitor, it is
- * recommended that you pick the primary monitor. For more information on how
- * to query connected monitors, see @ref monitor_monitors.
- *
- * For full screen windows, the specified size becomes the resolution of the
- * window's _desired video mode_. As long as a full screen window is not
- * iconified, the supported video mode most closely matching the desired video
- * mode is set for the specified monitor. For more information about full
- * screen windows, including the creation of so called _windowed full screen_
- * or _borderless full screen_ windows, see @ref window_windowed_full_screen.
- *
- * Once you have created the window, you can switch it between windowed and
- * full screen mode with @ref glfwSetWindowMonitor. This will not affect its
- * OpenGL or OpenGL ES context.
- *
- * By default, newly created windows use the placement recommended by the
- * window system. To create the window at a specific position, set the @ref
- * GLFW_POSITION_X and @ref GLFW_POSITION_Y window hints before creation. To
- * restore the default behavior, set either or both hints back to
- * `GLFW_ANY_POSITION`.
- *
- * As long as at least one full screen window is not iconified, the screensaver
- * is prohibited from starting.
- *
- * Window systems put limits on window sizes. Very large or very small window
- * dimensions may be overridden by the window system on creation. Check the
- * actual [size](@ref window_size) after creation.
- *
- * The [swap interval](@ref buffer_swap) is not set during window creation and
- * the initial value may vary depending on driver settings and defaults.
- *
- * @param[in] width The desired width, in screen coordinates, of the window.
- * This must be greater than zero.
- * @param[in] height The desired height, in screen coordinates, of the window.
- * This must be greater than zero.
- * @param[in] title The initial, UTF-8 encoded window title.
- * @param[in] monitor The monitor to use for full screen mode, or `NULL` for
- * windowed mode.
- * @param[in] share The window whose context to share resources with, or `NULL`
- * to not share resources.
- * @return The handle of the created window, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_API_UNAVAILABLE, @ref
- * GLFW_VERSION_UNAVAILABLE, @ref GLFW_FORMAT_UNAVAILABLE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @win32 Window creation will fail if the Microsoft GDI software
- * OpenGL implementation is the only one available.
- *
- * @remark @win32 If the executable has an icon resource named `GLFW_ICON,` it
- * will be set as the initial icon for the window. If no such icon is present,
- * the `IDI_APPLICATION` icon will be used instead. To set a different icon,
- * see @ref glfwSetWindowIcon.
- *
- * @remark @win32 The context to share resources with must not be current on
- * any other thread.
- *
- * @remark @macos The OS only supports core profile contexts for OpenGL
- * versions 3.2 and later. Before creating an OpenGL context of version 3.2 or
- * later you must set the [GLFW_OPENGL_PROFILE](@ref GLFW_OPENGL_PROFILE_hint)
- * hint accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all
- * on macOS.
- *
- * @remark @macos The GLFW window has no icon, as it is not a document
- * window, but the dock icon will be the same as the application bundle's icon.
- * For more information on bundles, see the
- * [Bundle Programming Guide](https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/)
- * in the Mac Developer Library.
- *
- * @remark @macos On OS X 10.10 and later the window frame will not be rendered
- * at full resolution on Retina displays unless the
- * [GLFW_COCOA_RETINA_FRAMEBUFFER](@ref GLFW_COCOA_RETINA_FRAMEBUFFER_hint)
- * hint is `GLFW_TRUE` and the `NSHighResolutionCapable` key is enabled in the
- * application bundle's `Info.plist`. For more information, see
- * [High Resolution Guidelines for OS X](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html)
- * in the Mac Developer Library. The GLFW test and example programs use
- * a custom `Info.plist` template for this, which can be found as
- * `CMake/Info.plist.in` in the source tree.
- *
- * @remark @macos When activating frame autosaving with
- * [GLFW_COCOA_FRAME_NAME](@ref GLFW_COCOA_FRAME_NAME_hint), the specified
- * window size and position may be overridden by previously saved values.
- *
- * @remark @x11 Some window managers will not respect the placement of
- * initially hidden windows.
- *
- * @remark @x11 Due to the asynchronous nature of X11, it may take a moment for
- * a window to reach its requested state. This means you may not be able to
- * query the final size, position or other attributes directly after window
- * creation.
- *
- * @remark @x11 The class part of the `WM_CLASS` window property will by
- * default be set to the window title passed to this function. The instance
- * part will use the contents of the `RESOURCE_NAME` environment variable, if
- * present and not empty, or fall back to the window title. Set the
- * [GLFW_X11_CLASS_NAME](@ref GLFW_X11_CLASS_NAME_hint) and
- * [GLFW_X11_INSTANCE_NAME](@ref GLFW_X11_INSTANCE_NAME_hint) window hints to
- * override this.
- *
- * @remark @wayland Compositors should implement the xdg-decoration protocol
- * for GLFW to decorate the window properly. If this protocol isn't
- * supported, or if the compositor prefers client-side decorations, a very
- * simple fallback frame will be drawn using the wp_viewporter protocol. A
- * compositor can still emit close, maximize or fullscreen events, using for
- * instance a keybind mechanism. If neither of these protocols is supported,
- * the window won't be decorated.
- *
- * @remark @wayland A full screen window will not attempt to change the mode,
- * no matter what the requested size or refresh rate.
- *
- * @remark @wayland Screensaver inhibition requires the idle-inhibit protocol
- * to be implemented in the user's compositor.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_creation
- * @sa @ref glfwDestroyWindow
- *
- * @since Added in version 3.0. Replaces `glfwOpenWindow`.
- *
- * @ingroup window
- *)
- function glfwCreateWindow(width: Integer; height: Integer; const title: PAnsiChar; monitor: PGLFWmonitor; share: PGLFWwindow): PGLFWwindow; cdecl;
- external libglfw3 name _PU + 'glfwCreateWindow';
- (*! @brief Destroys the specified window and its context.
- *
- * This function destroys the specified window and its context. On calling
- * this function, no further callbacks will be called for that window.
- *
- * If the context of the specified window is current on the main thread, it is
- * detached before being destroyed.
- *
- * @param[in] window The window to destroy.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @note The context of the specified window must not be current on any other
- * thread when this function is called.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_creation
- * @sa @ref glfwCreateWindow
- *
- * @since Added in version 3.0. Replaces `glfwCloseWindow`.
- *
- * @ingroup window
- *)
- procedure glfwDestroyWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwDestroyWindow';
- (*! @brief Checks the close flag of the specified window.
- *
- * This function returns the value of the close flag of the specified window.
- *
- * @param[in] window The window to query.
- * @return The value of the close flag.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_close
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwWindowShouldClose(window: PGLFWwindow): Integer; cdecl;
- external libglfw3 name _PU + 'glfwWindowShouldClose';
- (*! @brief Sets the close flag of the specified window.
- *
- * This function sets the value of the close flag of the specified window.
- * This can be used to override the user's attempt to close the window, or
- * to signal that it should be closed.
- *
- * @param[in] window The window whose flag to change.
- * @param[in] value The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_close
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowShouldClose(window: PGLFWwindow; value: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowShouldClose';
- (*! @brief Sets the title of the specified window.
- *
- * This function sets the window title, encoded as UTF-8, of the specified
- * window.
- *
- * @param[in] window The window whose title to change.
- * @param[in] title The UTF-8 encoded window title.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos The window title will not be updated until the next time you
- * process events.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_title
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowTitle(window: PGLFWwindow; const title: PAnsiChar); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowTitle';
- (*! @brief Sets the icon for the specified window.
- *
- * This function sets the icon of the specified window. If passed an array of
- * candidate images, those of or closest to the sizes desired by the system are
- * selected. If no images are specified, the window reverts to its default
- * icon.
- *
- * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
- * bits per channel with the red channel first. They are arranged canonically
- * as packed sequential rows, starting from the top-left corner.
- *
- * The desired image sizes varies depending on platform and system settings.
- * The selected images will be rescaled as needed. Good sizes include 16x16,
- * 32x32 and 48x48.
- *
- * @param[in] window The window whose icon to set.
- * @param[in] count The number of images in the specified array, or zero to
- * revert to the default window icon.
- * @param[in] images The images to create the icon from. This is ignored if
- * count is zero.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @pointer_lifetime The specified image data is copied before this function
- * returns.
- *
- * @remark @macos Regular windows do not have icons on macOS. This function
- * will emit @ref GLFW_FEATURE_UNAVAILABLE. The dock icon will be the same as
- * the application bundle's icon. For more information on bundles, see the
- * [Bundle Programming Guide](https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/)
- * in the Mac Developer Library.
- *
- * @remark @wayland There is no existing protocol to change an icon, the
- * window will thus inherit the one defined in the application's desktop file.
- * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_icon
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowIcon(window: PGLFWwindow; count: Integer; const images: PGLFWimage); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowIcon';
- (*! @brief Retrieves the position of the content area of the specified window.
- *
- * This function retrieves the position, in screen coordinates, of the
- * upper-left corner of the content area of the specified window.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] window The window to query.
- * @param[out] xpos Where to store the x-coordinate of the upper-left corner of
- * the content area, or `NULL`.
- * @param[out] ypos Where to store the y-coordinate of the upper-left corner of
- * the content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way for an application to retrieve the global
- * position of its windows. This function will emit @ref
- * GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- * @sa @ref glfwSetWindowPos
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwGetWindowPos(window: PGLFWwindow; xpos: PInteger; ypos: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetWindowPos';
- (*! @brief Sets the position of the content area of the specified window.
- *
- * This function sets the position, in screen coordinates, of the upper-left
- * corner of the content area of the specified windowed mode window. If the
- * window is a full screen window, this function does nothing.
- *
- * __Do not use this function__ to move an already visible window unless you
- * have very good reasons for doing so, as it will confuse and annoy the user.
- *
- * The window manager may put limits on what positions are allowed. GLFW
- * cannot and should not override these limits.
- *
- * @param[in] window The window to query.
- * @param[in] xpos The x-coordinate of the upper-left corner of the content area.
- * @param[in] ypos The y-coordinate of the upper-left corner of the content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way for an application to set the global
- * position of its windows. This function will emit @ref
- * GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- * @sa @ref glfwGetWindowPos
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowPos(window: PGLFWwindow; xpos: Integer; ypos: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowPos';
- (*! @brief Retrieves the size of the content area of the specified window.
- *
- * This function retrieves the size, in screen coordinates, of the content area
- * of the specified window. If you wish to retrieve the size of the
- * framebuffer of the window in pixels, see @ref glfwGetFramebufferSize.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose size to retrieve.
- * @param[out] width Where to store the width, in screen coordinates, of the
- * content area, or `NULL`.
- * @param[out] height Where to store the height, in screen coordinates, of the
- * content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- * @sa @ref glfwSetWindowSize
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwGetWindowSize(window: PGLFWwindow; width: PInteger; height: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetWindowSize';
- (*! @brief Sets the size limits of the specified window.
- *
- * This function sets the size limits of the content area of the specified
- * window. If the window is full screen, the size limits only take effect
- * once it is made windowed. If the window is not resizable, this function
- * does nothing.
- *
- * The size limits are applied immediately to a windowed mode window and may
- * cause it to be resized.
- *
- * The maximum dimensions must be greater than or equal to the minimum
- * dimensions and all must be greater than or equal to zero.
- *
- * @param[in] window The window to set limits for.
- * @param[in] minwidth The minimum width, in screen coordinates, of the content
- * area, or `GLFW_DONT_CARE`.
- * @param[in] minheight The minimum height, in screen coordinates, of the
- * content area, or `GLFW_DONT_CARE`.
- * @param[in] maxwidth The maximum width, in screen coordinates, of the content
- * area, or `GLFW_DONT_CARE`.
- * @param[in] maxheight The maximum height, in screen coordinates, of the
- * content area, or `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark If you set size limits and an aspect ratio that conflict, the
- * results are undefined.
- *
- * @remark @wayland The size limits will not be applied until the window is
- * actually resized, either by the user or by the compositor.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_sizelimits
- * @sa @ref glfwSetWindowAspectRatio
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowSizeLimits(window: PGLFWwindow; minwidth: Integer; minheight: Integer; maxwidth: Integer; maxheight: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowSizeLimits';
- (*! @brief Sets the aspect ratio of the specified window.
- *
- * This function sets the required aspect ratio of the content area of the
- * specified window. If the window is full screen, the aspect ratio only takes
- * effect once it is made windowed. If the window is not resizable, this
- * function does nothing.
- *
- * The aspect ratio is specified as a numerator and a denominator and both
- * values must be greater than zero. For example, the common 16:9 aspect ratio
- * is specified as 16 and 9, respectively.
- *
- * If the numerator and denominator is set to `GLFW_DONT_CARE` then the aspect
- * ratio limit is disabled.
- *
- * The aspect ratio is applied immediately to a windowed mode window and may
- * cause it to be resized.
- *
- * @param[in] window The window to set limits for.
- * @param[in] numer The numerator of the desired aspect ratio, or
- * `GLFW_DONT_CARE`.
- * @param[in] denom The denominator of the desired aspect ratio, or
- * `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark If you set size limits and an aspect ratio that conflict, the
- * results are undefined.
- *
- * @remark @wayland The aspect ratio will not be applied until the window is
- * actually resized, either by the user or by the compositor.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_sizelimits
- * @sa @ref glfwSetWindowSizeLimits
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowAspectRatio(window: PGLFWwindow; numer: Integer; denom: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowAspectRatio';
- (*! @brief Sets the size of the content area of the specified window.
- *
- * This function sets the size, in screen coordinates, of the content area of
- * the specified window.
- *
- * For full screen windows, this function updates the resolution of its desired
- * video mode and switches to the video mode closest to it, without affecting
- * the window's context. As the context is unaffected, the bit depths of the
- * framebuffer remain unchanged.
- *
- * If you wish to update the refresh rate of the desired video mode in addition
- * to its resolution, see @ref glfwSetWindowMonitor.
- *
- * The window manager may put limits on what sizes are allowed. GLFW cannot
- * and should not override these limits.
- *
- * @param[in] window The window to resize.
- * @param[in] width The desired width, in screen coordinates, of the window
- * content area.
- * @param[in] height The desired height, in screen coordinates, of the window
- * content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland A full screen window will not attempt to change the mode,
- * no matter what the requested size.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- * @sa @ref glfwGetWindowSize
- * @sa @ref glfwSetWindowMonitor
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowSize(window: PGLFWwindow; width: Integer; height: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowSize';
- (*! @brief Retrieves the size of the framebuffer of the specified window.
- *
- * This function retrieves the size, in pixels, of the framebuffer of the
- * specified window. If you wish to retrieve the size of the window in screen
- * coordinates, see @ref glfwGetWindowSize.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose framebuffer to query.
- * @param[out] width Where to store the width, in pixels, of the framebuffer,
- * or `NULL`.
- * @param[out] height Where to store the height, in pixels, of the framebuffer,
- * or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_fbsize
- * @sa @ref glfwSetFramebufferSizeCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwGetFramebufferSize(window: PGLFWwindow; width: PInteger; height: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetFramebufferSize';
- (*! @brief Retrieves the size of the frame of the window.
- *
- * This function retrieves the size, in screen coordinates, of each edge of the
- * frame of the specified window. This size includes the title bar, if the
- * window has one. The size of the frame may vary depending on the
- * [window-related hints](@ref window_hints_wnd) used to create it.
- *
- * Because this function retrieves the size of each window frame edge and not
- * the offset along a particular coordinate axis, the retrieved values will
- * always be zero or positive.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose frame size to query.
- * @param[out] left Where to store the size, in screen coordinates, of the left
- * edge of the window frame, or `NULL`.
- * @param[out] top Where to store the size, in screen coordinates, of the top
- * edge of the window frame, or `NULL`.
- * @param[out] right Where to store the size, in screen coordinates, of the
- * right edge of the window frame, or `NULL`.
- * @param[out] bottom Where to store the size, in screen coordinates, of the
- * bottom edge of the window frame, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- *
- * @since Added in version 3.1.
- *
- * @ingroup window
- *)
- procedure glfwGetWindowFrameSize(window: PGLFWwindow; left: PInteger; top: PInteger; right: PInteger; bottom: PInteger); cdecl;
- external libglfw3 name _PU + 'glfwGetWindowFrameSize';
- (*! @brief Retrieves the content scale for the specified window.
- *
- * This function retrieves the content scale for the specified window. The
- * content scale is the ratio between the current DPI and the platform's
- * default DPI. This is especially important for text and any UI elements. If
- * the pixel dimensions of your UI scaled by this look appropriate on your
- * machine then it should appear at a reasonable size on other machines
- * regardless of their DPI and scaling settings. This relies on the system DPI
- * and scaling settings being somewhat correct.
- *
- * On platforms where each monitors can have its own content scale, the window
- * content scale will depend on which monitor the system considers the window
- * to be on.
- *
- * @param[in] window The window to query.
- * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
- * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_scale
- * @sa @ref glfwSetWindowContentScaleCallback
- * @sa @ref glfwGetMonitorContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- procedure glfwGetWindowContentScale(window: PGLFWwindow; xscale: PSingle; yscale: PSingle); cdecl;
- external libglfw3 name _PU + 'glfwGetWindowContentScale';
- (*! @brief Returns the opacity of the whole window.
- *
- * This function returns the opacity of the window, including any decorations.
- *
- * The opacity (or alpha) value is a positive finite number between zero and
- * one, where zero is fully transparent and one is fully opaque. If the system
- * does not support whole window transparency, this function always returns one.
- *
- * The initial opacity value for newly created windows is one.
- *
- * @param[in] window The window to query.
- * @return The opacity value of the specified window.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_transparency
- * @sa @ref glfwSetWindowOpacity
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- function glfwGetWindowOpacity(window: PGLFWwindow): Single; cdecl;
- external libglfw3 name _PU + 'glfwGetWindowOpacity';
- (*! @brief Sets the opacity of the whole window.
- *
- * This function sets the opacity of the window, including any decorations.
- *
- * The opacity (or alpha) value is a positive finite number between zero and
- * one, where zero is fully transparent and one is fully opaque.
- *
- * The initial opacity value for newly created windows is one.
- *
- * A window created with framebuffer transparency may not use whole window
- * transparency. The results of doing this are undefined.
- *
- * @param[in] window The window to set the opacity for.
- * @param[in] opacity The desired opacity of the specified window.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way to set an opacity factor for a window.
- * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_transparency
- * @sa @ref glfwGetWindowOpacity
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowOpacity(window: PGLFWwindow; opacity: Single); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowOpacity';
- (*! @brief Iconifies the specified window.
- *
- * This function iconifies (minimizes) the specified window if it was
- * previously restored. If the window is already iconified, this function does
- * nothing.
- *
- * If the specified window is a full screen window, GLFW restores the original
- * video mode of the monitor. The window's desired video mode is set again
- * when the window is restored.
- *
- * @param[in] window The window to iconify.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland Once a window is iconified, @ref glfwRestoreWindow won’t
- * be able to restore it. This is a design decision of the xdg-shell
- * protocol.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwRestoreWindow
- * @sa @ref glfwMaximizeWindow
- *
- * @since Added in version 2.1.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwIconifyWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwIconifyWindow';
- (*! @brief Restores the specified window.
- *
- * This function restores the specified window if it was previously iconified
- * (minimized) or maximized. If the window is already restored, this function
- * does nothing.
- *
- * If the specified window is an iconified full screen window, its desired
- * video mode is set again for its monitor when the window is restored.
- *
- * @param[in] window The window to restore.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwIconifyWindow
- * @sa @ref glfwMaximizeWindow
- *
- * @since Added in version 2.1.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwRestoreWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwRestoreWindow';
- (*! @brief Maximizes the specified window.
- *
- * This function maximizes the specified window if it was previously not
- * maximized. If the window is already maximized, this function does nothing.
- *
- * If the specified window is a full screen window, this function does nothing.
- *
- * @param[in] window The window to maximize.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @par Thread Safety
- * This function may only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwIconifyWindow
- * @sa @ref glfwRestoreWindow
- *
- * @since Added in GLFW 3.2.
- *
- * @ingroup window
- *)
- procedure glfwMaximizeWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwMaximizeWindow';
- (*! @brief Makes the specified window visible.
- *
- * This function makes the specified window visible if it was previously
- * hidden. If the window is already visible or is in full screen mode, this
- * function does nothing.
- *
- * By default, windowed mode windows are focused when shown
- * Set the [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) window hint
- * to change this behavior for all newly created windows, or change the
- * behavior for an existing window with @ref glfwSetWindowAttrib.
- *
- * @param[in] window The window to make visible.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland Because Wayland wants every frame of the desktop to be
- * complete, this function does not immediately make the window visible.
- * Instead it will become visible the next time the window framebuffer is
- * updated after this call.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hide
- * @sa @ref glfwHideWindow
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwShowWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwShowWindow';
- (*! @brief Hides the specified window.
- *
- * This function hides the specified window if it was previously visible. If
- * the window is already hidden or is in full screen mode, this function does
- * nothing.
- *
- * @param[in] window The window to hide.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hide
- * @sa @ref glfwShowWindow
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwHideWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwHideWindow';
- (*! @brief Brings the specified window to front and sets input focus.
- *
- * This function brings the specified window to front and sets input focus.
- * The window should already be visible and not iconified.
- *
- * By default, both windowed and full screen mode windows are focused when
- * initially created. Set the [GLFW_FOCUSED](@ref GLFW_FOCUSED_hint) to
- * disable this behavior.
- *
- * Also by default, windowed mode windows are focused when shown
- * with @ref glfwShowWindow. Set the
- * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) to disable this behavior.
- *
- * __Do not use this function__ to steal focus from other applications unless
- * you are certain that is what the user wants. Focus stealing can be
- * extremely disruptive.
- *
- * For a less disruptive way of getting the user's attention, see
- * [attention requests](@ref window_attention).
- *
- * @param[in] window The window to give input focus.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland It is not possible for an application to set the input
- * focus. This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_focus
- * @sa @ref window_attention
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwFocusWindow(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwFocusWindow';
- (*! @brief Requests user attention to the specified window.
- *
- * This function requests user attention to the specified window. On
- * platforms where this is not supported, attention is requested to the
- * application as a whole.
- *
- * Once the user has given attention, usually by focusing the window or
- * application, the system will end the request automatically.
- *
- * @param[in] window The window to request attention to.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos Attention is requested to the application as a whole, not the
- * specific window.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attention
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- procedure glfwRequestWindowAttention(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwRequestWindowAttention';
- (*! @brief Returns the monitor that the window uses for full screen mode.
- *
- * This function returns the handle of the monitor that the specified window is
- * in full screen on.
- *
- * @param[in] window The window to query.
- * @return The monitor, or `NULL` if the window is in windowed mode or an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_monitor
- * @sa @ref glfwSetWindowMonitor
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwGetWindowMonitor(window: PGLFWwindow): PGLFWmonitor; cdecl;
- external libglfw3 name _PU + 'glfwGetWindowMonitor';
- (*! @brief Sets the mode, monitor, video mode and placement of a window.
- *
- * This function sets the monitor that the window uses for full screen mode or,
- * if the monitor is `NULL`, makes it windowed mode.
- *
- * When setting a monitor, this function updates the width, height and refresh
- * rate of the desired video mode and switches to the video mode closest to it.
- * The window position is ignored when setting a monitor.
- *
- * When the monitor is `NULL`, the position, width and height are used to
- * place the window content area. The refresh rate is ignored when no monitor
- * is specified.
- *
- * If you only wish to update the resolution of a full screen window or the
- * size of a windowed mode window, see @ref glfwSetWindowSize.
- *
- * When a window transitions from full screen to windowed mode, this function
- * restores any previous window settings such as whether it is decorated,
- * floating, resizable, has size or aspect ratio limits, etc.
- *
- * @param[in] window The window whose monitor, size or video mode to set.
- * @param[in] monitor The desired monitor, or `NULL` to set windowed mode.
- * @param[in] xpos The desired x-coordinate of the upper-left corner of the
- * content area.
- * @param[in] ypos The desired y-coordinate of the upper-left corner of the
- * content area.
- * @param[in] width The desired with, in screen coordinates, of the content
- * area or video mode.
- * @param[in] height The desired height, in screen coordinates, of the content
- * area or video mode.
- * @param[in] refreshRate The desired refresh rate, in Hz, of the video mode,
- * or `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark The OpenGL or OpenGL ES context will not be destroyed or otherwise
- * affected by any resizing or mode switching, although you may need to update
- * your viewport if the framebuffer size has changed.
- *
- * @remark @wayland The desired window position is ignored, as there is no way
- * for an application to set this property.
- *
- * @remark @wayland Setting the window to full screen will not attempt to
- * change the mode, no matter what the requested size or refresh rate.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_monitor
- * @sa @ref window_full_screen
- * @sa @ref glfwGetWindowMonitor
- * @sa @ref glfwSetWindowSize
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowMonitor(window: PGLFWwindow; monitor: PGLFWmonitor; xpos: Integer; ypos: Integer; width: Integer; height: Integer; refreshRate: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowMonitor';
- (*! @brief Returns an attribute of the specified window.
- *
- * This function returns the value of an attribute of the specified window or
- * its OpenGL or OpenGL ES context.
- *
- * @param[in] window The window to query.
- * @param[in] attrib The [window attribute](@ref window_attribs) whose value to
- * return.
- * @return The value of the attribute, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark Framebuffer related hints are not window attributes. See @ref
- * window_attribs_fb for more information.
- *
- * @remark Zero is a valid value for many window and context related
- * attributes so you cannot use a return value of zero as an indication of
- * errors. However, this function should not fail as long as it is passed
- * valid arguments and the library has been [initialized](@ref intro_init).
- *
- * @remark @wayland The Wayland protocol provides no way to check whether a
- * window is iconfied, so @ref GLFW_ICONIFIED always returns `GLFW_FALSE`.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attribs
- * @sa @ref glfwSetWindowAttrib
- *
- * @since Added in version 3.0. Replaces `glfwGetWindowParam` and
- * `glfwGetGLVersion`.
- *
- * @ingroup window
- *)
- function glfwGetWindowAttrib(window: PGLFWwindow; attrib: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetWindowAttrib';
- (*! @brief Sets an attribute of the specified window.
- *
- * This function sets the value of an attribute of the specified window.
- *
- * The supported attributes are [GLFW_DECORATED](@ref GLFW_DECORATED_attrib),
- * [GLFW_RESIZABLE](@ref GLFW_RESIZABLE_attrib),
- * [GLFW_FLOATING](@ref GLFW_FLOATING_attrib),
- * [GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_attrib) and
- * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_attrib).
- * [GLFW_MOUSE_PASSTHROUGH](@ref GLFW_MOUSE_PASSTHROUGH_attrib)
- *
- * Some of these attributes are ignored for full screen windows. The new
- * value will take effect if the window is later made windowed.
- *
- * Some of these attributes are ignored for windowed mode windows. The new
- * value will take effect if the window is later made full screen.
- *
- * @param[in] window The window to set the attribute for.
- * @param[in] attrib A supported window attribute.
- * @param[in] value `GLFW_TRUE` or `GLFW_FALSE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE.
- *
- * @remark Calling @ref glfwGetWindowAttrib will always return the latest
- * value, even if that value is ignored by the current mode of the window.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attribs
- * @sa @ref glfwGetWindowAttrib
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowAttrib(window: PGLFWwindow; attrib: Integer; value: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowAttrib';
- (*! @brief Sets the user pointer of the specified window.
- *
- * This function sets the user-defined pointer of the specified window. The
- * current value is retained until the window is destroyed. The initial value
- * is `NULL`.
- *
- * @param[in] window The window whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_userptr
- * @sa @ref glfwGetWindowUserPointer
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- procedure glfwSetWindowUserPointer(window: PGLFWwindow; pointer: Pointer); cdecl;
- external libglfw3 name _PU + 'glfwSetWindowUserPointer';
- (*! @brief Returns the user pointer of the specified window.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified window. The initial value is `NULL`.
- *
- * @param[in] window The window whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_userptr
- * @sa @ref glfwSetWindowUserPointer
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwGetWindowUserPointer(window: PGLFWwindow): Pointer; cdecl;
- external libglfw3 name _PU + 'glfwGetWindowUserPointer';
- (*! @brief Sets the position callback for the specified window.
- *
- * This function sets the position callback of the specified window, which is
- * called when the window is moved. The callback is provided with the
- * position, in screen coordinates, of the upper-left corner of the content
- * area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int xpos, int ypos)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowposfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @wayland This callback will never be called, as there is no way for
- * an application to know its global position.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwSetWindowPosCallback(window: PGLFWwindow; callback: GLFWwindowposfun): GLFWwindowposfun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowPosCallback';
- (*! @brief Sets the size callback for the specified window.
- *
- * This function sets the size callback of the specified window, which is
- * called when the window is resized. The callback is provided with the size,
- * in screen coordinates, of the content area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowsizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- *)
- function glfwSetWindowSizeCallback(window: PGLFWwindow; callback: GLFWwindowsizefun): GLFWwindowsizefun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowSizeCallback';
- (*! @brief Sets the close callback for the specified window.
- *
- * This function sets the close callback of the specified window, which is
- * called when the user attempts to close the window, for example by clicking
- * the close widget in the title bar.
- *
- * The close flag is set before this callback is called, but you can modify it
- * at any time with @ref glfwSetWindowShouldClose.
- *
- * The close callback is not triggered by @ref glfwDestroyWindow.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowclosefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @macos Selecting Quit from the application menu will trigger the
- * close callback for all windows.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_close
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- *)
- function glfwSetWindowCloseCallback(window: PGLFWwindow; callback: GLFWwindowclosefun): GLFWwindowclosefun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowCloseCallback';
- (*! @brief Sets the refresh callback for the specified window.
- *
- * This function sets the refresh callback of the specified window, which is
- * called when the content area of the window needs to be redrawn, for example
- * if the window has been exposed after having been covered by another window.
- *
- * On compositing window systems such as Aero, Compiz, Aqua or Wayland, where
- * the window contents are saved off-screen, this callback may be called only
- * very infrequently or never at all.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window);
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowrefreshfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_refresh
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- *)
- function glfwSetWindowRefreshCallback(window: PGLFWwindow; callback: GLFWwindowrefreshfun): GLFWwindowrefreshfun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowRefreshCallback';
- (*! @brief Sets the focus callback for the specified window.
- *
- * This function sets the focus callback of the specified window, which is
- * called when the window gains or loses input focus.
- *
- * After the focus callback is called for a window that lost input focus,
- * synthetic key and mouse button release events will be generated for all such
- * that had been pressed. For more information, see @ref glfwSetKeyCallback
- * and @ref glfwSetMouseButtonCallback.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int focused)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowfocusfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_focus
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwSetWindowFocusCallback(window: PGLFWwindow; callback: GLFWwindowfocusfun): GLFWwindowfocusfun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowFocusCallback';
- (*! @brief Sets the iconify callback for the specified window.
- *
- * This function sets the iconification callback of the specified window, which
- * is called when the window is iconified or restored.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int iconified)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowiconifyfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwSetWindowIconifyCallback(window: PGLFWwindow; callback: GLFWwindowiconifyfun): GLFWwindowiconifyfun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowIconifyCallback';
- (*! @brief Sets the maximize callback for the specified window.
- *
- * This function sets the maximization callback of the specified window, which
- * is called when the window is maximized or restored.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int maximized)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowmaximizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_maximize
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- function glfwSetWindowMaximizeCallback(window: PGLFWwindow; callback: GLFWwindowmaximizefun): GLFWwindowmaximizefun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowMaximizeCallback';
- (*! @brief Sets the framebuffer resize callback for the specified window.
- *
- * This function sets the framebuffer resize callback of the specified window,
- * which is called when the framebuffer of the specified window is resized.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWframebuffersizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_fbsize
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- *)
- function glfwSetFramebufferSizeCallback(window: PGLFWwindow; callback: GLFWframebuffersizefun): GLFWframebuffersizefun; cdecl;
- external libglfw3 name _PU + 'glfwSetFramebufferSizeCallback';
- (*! @brief Sets the window content scale callback for the specified window.
- *
- * This function sets the window content scale callback of the specified window,
- * which is called when the content scale of the specified window changes.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, float xscale, float yscale)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowcontentscalefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_scale
- * @sa @ref glfwGetWindowContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- *)
- function glfwSetWindowContentScaleCallback(window: PGLFWwindow; callback: GLFWwindowcontentscalefun): GLFWwindowcontentscalefun; cdecl;
- external libglfw3 name _PU + 'glfwSetWindowContentScaleCallback';
- (*! @brief Processes all pending events.
- *
- * This function processes only those events that are already in the event
- * queue and then returns immediately. Processing events will cause the window
- * and input callbacks associated with those events to be called.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwWaitEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 1.0.
- *
- * @ingroup window
- *)
- procedure glfwPollEvents(); cdecl;
- external libglfw3 name _PU + 'glfwPollEvents';
- (*! @brief Waits until events are queued and processes them.
- *
- * This function puts the calling thread to sleep until at least one event is
- * available in the event queue. Once one or more events are available,
- * it behaves exactly like @ref glfwPollEvents, i.e. the events in the queue
- * are processed and the function then returns immediately. Processing events
- * will cause the window and input callbacks associated with those events to be
- * called.
- *
- * Since not all events are associated with callbacks, this function may return
- * without a callback having been called even if you are monitoring all
- * callbacks.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwPollEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 2.5.
- *
- * @ingroup window
- *)
- procedure glfwWaitEvents(); cdecl;
- external libglfw3 name _PU + 'glfwWaitEvents';
- (*! @brief Waits with timeout until events are queued and processes them.
- *
- * This function puts the calling thread to sleep until at least one event is
- * available in the event queue, or until the specified timeout is reached. If
- * one or more events are available, it behaves exactly like @ref
- * glfwPollEvents, i.e. the events in the queue are processed and the function
- * then returns immediately. Processing events will cause the window and input
- * callbacks associated with those events to be called.
- *
- * The timeout value must be a positive finite number.
- *
- * Since not all events are associated with callbacks, this function may return
- * without a callback having been called even if you are monitoring all
- * callbacks.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @param[in] timeout The maximum amount of time, in seconds, to wait.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwPollEvents
- * @sa @ref glfwWaitEvents
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- *)
- procedure glfwWaitEventsTimeout(timeout: Double); cdecl;
- external libglfw3 name _PU + 'glfwWaitEventsTimeout';
- (*! @brief Posts an empty event to the event queue.
- *
- * This function posts an empty event from the current thread to the event
- * queue, causing @ref glfwWaitEvents or @ref glfwWaitEventsTimeout to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref events
- * @sa @ref glfwWaitEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 3.1.
- *
- * @ingroup window
- *)
- procedure glfwPostEmptyEvent(); cdecl;
- external libglfw3 name _PU + 'glfwPostEmptyEvent';
- (*! @brief Returns the value of an input option for the specified window.
- *
- * This function returns the value of an input option for the specified window.
- * The mode must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
- * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS or
- * @ref GLFW_RAW_MOUSE_MOTION.
- *
- * @param[in] window The window to query.
- * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
- * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
- * `GLFW_RAW_MOUSE_MOTION`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref glfwSetInputMode
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- function glfwGetInputMode(window: PGLFWwindow; mode: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetInputMode';
- (*! @brief Sets an input option for the specified window.
- *
- * This function sets an input mode option for the specified window. The mode
- * must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
- * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS or
- * @ref GLFW_RAW_MOUSE_MOTION.
- *
- * If the mode is `GLFW_CURSOR`, the value must be one of the following cursor
- * modes:
- * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
- * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the
- * content area of the window but does not restrict the cursor from leaving.
- * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual
- * and unlimited cursor movement. This is useful for implementing for
- * example 3D camera controls.
- * - `GLFW_CURSOR_CAPTURED` makes the cursor visible and confines it to the
- * content area of the window.
- *
- * If the mode is `GLFW_STICKY_KEYS`, the value must be either `GLFW_TRUE` to
- * enable sticky keys, or `GLFW_FALSE` to disable it. If sticky keys are
- * enabled, a key press will ensure that @ref glfwGetKey returns `GLFW_PRESS`
- * the next time it is called even if the key had been released before the
- * call. This is useful when you are only interested in whether keys have been
- * pressed but not when or in which order.
- *
- * If the mode is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either
- * `GLFW_TRUE` to enable sticky mouse buttons, or `GLFW_FALSE` to disable it.
- * If sticky mouse buttons are enabled, a mouse button press will ensure that
- * @ref glfwGetMouseButton returns `GLFW_PRESS` the next time it is called even
- * if the mouse button had been released before the call. This is useful when
- * you are only interested in whether mouse buttons have been pressed but not
- * when or in which order.
- *
- * If the mode is `GLFW_LOCK_KEY_MODS`, the value must be either `GLFW_TRUE` to
- * enable lock key modifier bits, or `GLFW_FALSE` to disable them. If enabled,
- * callbacks that receive modifier bits will also have the @ref
- * GLFW_MOD_CAPS_LOCK bit set when the event was generated with Caps Lock on,
- * and the @ref GLFW_MOD_NUM_LOCK bit when Num Lock was on.
- *
- * If the mode is `GLFW_RAW_MOUSE_MOTION`, the value must be either `GLFW_TRUE`
- * to enable raw (unscaled and unaccelerated) mouse motion when the cursor is
- * disabled, or `GLFW_FALSE` to disable it. If raw motion is not supported,
- * attempting to set this will emit @ref GLFW_FEATURE_UNAVAILABLE. Call @ref
- * glfwRawMouseMotionSupported to check for support.
- *
- * @param[in] window The window whose input mode to set.
- * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
- * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
- * `GLFW_RAW_MOUSE_MOTION`.
- * @param[in] value The new value of the specified input mode.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE (see above).
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref glfwGetInputMode
- *
- * @since Added in version 3.0. Replaces `glfwEnable` and `glfwDisable`.
- *
- * @ingroup input
- *)
- procedure glfwSetInputMode(window: PGLFWwindow; mode: Integer; value: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSetInputMode';
- (*! @brief Returns whether raw mouse motion is supported.
- *
- * This function returns whether raw mouse motion is supported on the current
- * system. This status does not change after GLFW has been initialized so you
- * only need to check this once. If you attempt to enable raw motion on
- * a system that does not support it, @ref GLFW_PLATFORM_ERROR will be emitted.
- *
- * Raw mouse motion is closer to the actual motion of the mouse across
- * a surface. It is not affected by the scaling and acceleration applied to
- * the motion of the desktop cursor. That processing is suitable for a cursor
- * while raw motion is better for controlling for example a 3D camera. Because
- * of this, raw mouse motion is only provided when the cursor is disabled.
- *
- * @return `GLFW_TRUE` if raw mouse motion is supported on the current machine,
- * or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref raw_mouse_motion
- * @sa @ref glfwSetInputMode
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwRawMouseMotionSupported(): Integer; cdecl;
- external libglfw3 name _PU + 'glfwRawMouseMotionSupported';
- (*! @brief Returns the layout-specific name of the specified printable key.
- *
- * This function returns the name of the specified printable key, encoded as
- * UTF-8. This is typically the character that key would produce without any
- * modifier keys, intended for displaying key bindings to the user. For dead
- * keys, it is typically the diacritic it would add to a character.
- *
- * __Do not use this function__ for [text input](@ref input_char). You will
- * break text input for many languages even if it happens to work for yours.
- *
- * If the key is `GLFW_KEY_UNKNOWN`, the scancode is used to identify the key,
- * otherwise the scancode is ignored. If you specify a non-printable key, or
- * `GLFW_KEY_UNKNOWN` and a scancode that maps to a non-printable key, this
- * function returns `NULL` but does not emit an error.
- *
- * This behavior allows you to always pass in the arguments in the
- * [key callback](@ref input_key) without modification.
- *
- * The printable keys are:
- * - `GLFW_KEY_APOSTROPHE`
- * - `GLFW_KEY_COMMA`
- * - `GLFW_KEY_MINUS`
- * - `GLFW_KEY_PERIOD`
- * - `GLFW_KEY_SLASH`
- * - `GLFW_KEY_SEMICOLON`
- * - `GLFW_KEY_EQUAL`
- * - `GLFW_KEY_LEFT_BRACKET`
- * - `GLFW_KEY_RIGHT_BRACKET`
- * - `GLFW_KEY_BACKSLASH`
- * - `GLFW_KEY_WORLD_1`
- * - `GLFW_KEY_WORLD_2`
- * - `GLFW_KEY_0` to `GLFW_KEY_9`
- * - `GLFW_KEY_A` to `GLFW_KEY_Z`
- * - `GLFW_KEY_KP_0` to `GLFW_KEY_KP_9`
- * - `GLFW_KEY_KP_DECIMAL`
- * - `GLFW_KEY_KP_DIVIDE`
- * - `GLFW_KEY_KP_MULTIPLY`
- * - `GLFW_KEY_KP_SUBTRACT`
- * - `GLFW_KEY_KP_ADD`
- * - `GLFW_KEY_KP_EQUAL`
- *
- * Names for printable keys depend on keyboard layout, while names for
- * non-printable keys are the same across layouts but depend on the application
- * language and should be localized along with other user interface text.
- *
- * @param[in] key The key to query, or `GLFW_KEY_UNKNOWN`.
- * @param[in] scancode The scancode of the key to query.
- * @return The UTF-8 encoded, layout-specific name of the key, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark The contents of the returned string may change when a keyboard
- * layout change event is received.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key_name
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- *)
- function glfwGetKeyName(key: Integer; scancode: Integer): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetKeyName';
- (*! @brief Returns the platform-specific scancode of the specified key.
- *
- * This function returns the platform-specific scancode of the specified key.
- *
- * If the key is `GLFW_KEY_UNKNOWN` or does not exist on the keyboard this
- * method will return `-1`.
- *
- * @param[in] key Any [named key](@ref keys).
- * @return The platform-specific scancode for the key, or `-1` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetKeyScancode(key: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetKeyScancode';
- (*! @brief Returns the last reported state of a keyboard key for the specified
- * window.
- *
- * This function returns the last state reported for the specified key to the
- * specified window. The returned state is one of `GLFW_PRESS` or
- * `GLFW_RELEASE`. The action `GLFW_REPEAT` is only reported to the key callback.
- *
- * If the @ref GLFW_STICKY_KEYS input mode is enabled, this function returns
- * `GLFW_PRESS` the first time you call it for a key that was pressed, even if
- * that key has already been released.
- *
- * The key functions deal with physical keys, with [key tokens](@ref keys)
- * named after their use on the standard US keyboard layout. If you want to
- * input text, use the Unicode character callback instead.
- *
- * The [modifier key bit masks](@ref mods) are not key tokens and cannot be
- * used with this function.
- *
- * __Do not use this function__ to implement [text input](@ref input_char).
- *
- * @param[in] window The desired window.
- * @param[in] key The desired [keyboard key](@ref keys). `GLFW_KEY_UNKNOWN` is
- * not a valid key for this function.
- * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- *)
- function glfwGetKey(window: PGLFWwindow; key: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetKey';
- (*! @brief Returns the last reported state of a mouse button for the specified
- * window.
- *
- * This function returns the last state reported for the specified mouse button
- * to the specified window. The returned state is one of `GLFW_PRESS` or
- * `GLFW_RELEASE`.
- *
- * If the @ref GLFW_STICKY_MOUSE_BUTTONS input mode is enabled, this function
- * returns `GLFW_PRESS` the first time you call it for a mouse button that was
- * pressed, even if that mouse button has already been released.
- *
- * @param[in] window The desired window.
- * @param[in] button The desired [mouse button](@ref buttons).
- * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_mouse_button
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- *)
- function glfwGetMouseButton(window: PGLFWwindow; button: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetMouseButton';
- (*! @brief Retrieves the position of the cursor relative to the content area of
- * the window.
- *
- * This function returns the position of the cursor, in screen coordinates,
- * relative to the upper-left corner of the content area of the specified
- * window.
- *
- * If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor
- * position is unbounded and limited only by the minimum and maximum values of
- * a `double`.
- *
- * The coordinate can be converted to their integer equivalents with the
- * `floor` function. Casting directly to an integer type works for positive
- * coordinates, but fails for negative ones.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] window The desired window.
- * @param[out] xpos Where to store the cursor x-coordinate, relative to the
- * left edge of the content area, or `NULL`.
- * @param[out] ypos Where to store the cursor y-coordinate, relative to the to
- * top edge of the content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwSetCursorPos
- *
- * @since Added in version 3.0. Replaces `glfwGetMousePos`.
- *
- * @ingroup input
- *)
- procedure glfwGetCursorPos(window: PGLFWwindow; xpos: PDouble; ypos: PDouble); cdecl;
- external libglfw3 name _PU + 'glfwGetCursorPos';
- (*! @brief Sets the position of the cursor, relative to the content area of the
- * window.
- *
- * This function sets the position, in screen coordinates, of the cursor
- * relative to the upper-left corner of the content area of the specified
- * window. The window must have input focus. If the window does not have
- * input focus when this function is called, it fails silently.
- *
- * __Do not use this function__ to implement things like camera controls. GLFW
- * already provides the `GLFW_CURSOR_DISABLED` cursor mode that hides the
- * cursor, transparently re-centers it and provides unconstrained cursor
- * motion. See @ref glfwSetInputMode for more information.
- *
- * If the cursor mode is `GLFW_CURSOR_DISABLED` then the cursor position is
- * unconstrained and limited only by the minimum and maximum values of
- * a `double`.
- *
- * @param[in] window The desired window.
- * @param[in] xpos The desired x-coordinate, relative to the left edge of the
- * content area.
- * @param[in] ypos The desired y-coordinate, relative to the top edge of the
- * content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland This function will only work when the cursor mode is
- * `GLFW_CURSOR_DISABLED`, otherwise it will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwGetCursorPos
- *
- * @since Added in version 3.0. Replaces `glfwSetMousePos`.
- *
- * @ingroup input
- *)
- procedure glfwSetCursorPos(window: PGLFWwindow; xpos: Double; ypos: Double); cdecl;
- external libglfw3 name _PU + 'glfwSetCursorPos';
- (*! @brief Creates a custom cursor.
- *
- * Creates a new custom cursor image that can be set for a window with @ref
- * glfwSetCursor. The cursor can be destroyed with @ref glfwDestroyCursor.
- * Any remaining cursors are destroyed by @ref glfwTerminate.
- *
- * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
- * bits per channel with the red channel first. They are arranged canonically
- * as packed sequential rows, starting from the top-left corner.
- *
- * The cursor hotspot is specified in pixels, relative to the upper-left corner
- * of the cursor image. Like all other coordinate systems in GLFW, the X-axis
- * points to the right and the Y-axis points down.
- *
- * @param[in] image The desired cursor image.
- * @param[in] xhot The desired x-coordinate, in pixels, of the cursor hotspot.
- * @param[in] yhot The desired y-coordinate, in pixels, of the cursor hotspot.
- * @return The handle of the created cursor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The specified image data is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- * @sa @ref glfwDestroyCursor
- * @sa @ref glfwCreateStandardCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- function glfwCreateCursor(const image: PGLFWimage; xhot: Integer; yhot: Integer): PGLFWcursor; cdecl;
- external libglfw3 name _PU + 'glfwCreateCursor';
- (*! @brief Creates a cursor with a standard shape.
- *
- * Returns a cursor with a standard shape, that can be set for a window with
- * @ref glfwSetCursor. The images for these cursors come from the system
- * cursor theme and their exact appearance will vary between platforms.
- *
- * Most of these shapes are guaranteed to exist on every supported platform but
- * a few may not be present. See the table below for details.
- *
- * Cursor shape | Windows | macOS | X11 | Wayland
- * ------------------------------ | ------- | ----- | ------ | -------
- * @ref GLFW_ARROW_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_IBEAM_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_CROSSHAIR_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_POINTING_HAND_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_EW_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_NS_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_NWSE_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- * @ref GLFW_RESIZE_NESW_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- * @ref GLFW_RESIZE_ALL_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_NOT_ALLOWED_CURSOR | Yes | Yes | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- *
- * 1) This uses a private system API and may fail in the future.
- *
- * 2) This uses a newer standard that not all cursor themes support.
- *
- * If the requested shape is not available, this function emits a @ref
- * GLFW_CURSOR_UNAVAILABLE error and returns `NULL`.
- *
- * @param[in] shape One of the [standard shapes](@ref shapes).
- * @return A new cursor ready to use or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_CURSOR_UNAVAILABLE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_standard
- * @sa @ref glfwCreateCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- function glfwCreateStandardCursor(shape: Integer): PGLFWcursor; cdecl;
- external libglfw3 name _PU + 'glfwCreateStandardCursor';
- (*! @brief Destroys a cursor.
- *
- * This function destroys a cursor previously created with @ref
- * glfwCreateCursor. Any remaining cursors will be destroyed by @ref
- * glfwTerminate.
- *
- * If the specified cursor is current for any window, that window will be
- * reverted to the default cursor. This does not affect the cursor mode.
- *
- * @param[in] cursor The cursor object to destroy.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- * @sa @ref glfwCreateCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- procedure glfwDestroyCursor(cursor: PGLFWcursor); cdecl;
- external libglfw3 name _PU + 'glfwDestroyCursor';
- (*! @brief Sets the cursor for the window.
- *
- * This function sets the cursor image to be used when the cursor is over the
- * content area of the specified window. The set cursor will only be visible
- * when the [cursor mode](@ref cursor_mode) of the window is
- * `GLFW_CURSOR_NORMAL`.
- *
- * On some platforms, the set cursor may not be visible unless the window also
- * has input focus.
- *
- * @param[in] window The window to set the cursor for.
- * @param[in] cursor The cursor to set, or `NULL` to switch back to the default
- * arrow cursor.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- procedure glfwSetCursor(window: PGLFWwindow; cursor: PGLFWcursor); cdecl;
- external libglfw3 name _PU + 'glfwSetCursor';
- (*! @brief Sets the key callback.
- *
- * This function sets the key callback of the specified window, which is called
- * when a key is pressed, repeated or released.
- *
- * The key functions deal with physical keys, with layout independent
- * [key tokens](@ref keys) named after their values in the standard US keyboard
- * layout. If you want to input text, use the
- * [character callback](@ref glfwSetCharCallback) instead.
- *
- * When a window loses input focus, it will generate synthetic key release
- * events for all pressed named keys. You can tell these events from
- * user-generated events by the fact that the synthetic ones are generated
- * after the focus loss event has been processed, i.e. after the
- * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
- *
- * The scancode of a key is specific to that platform or sometimes even to that
- * machine. Scancodes are intended to allow users to bind keys that don't have
- * a GLFW key token. Such keys have `key` set to `GLFW_KEY_UNKNOWN`, their
- * state is not saved and so it cannot be queried with @ref glfwGetKey.
- *
- * Sometimes GLFW needs to generate synthetic key events, in which case the
- * scancode may be zero.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new key callback, or `NULL` to remove the currently
- * set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWkeyfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- *)
- function glfwSetKeyCallback(window: PGLFWwindow; callback: GLFWkeyfun): GLFWkeyfun; cdecl;
- external libglfw3 name _PU + 'glfwSetKeyCallback';
- (*! @brief Sets the Unicode character callback.
- *
- * This function sets the character callback of the specified window, which is
- * called when a Unicode character is input.
- *
- * The character callback is intended for Unicode text input. As it deals with
- * characters, it is keyboard layout dependent, whereas the
- * [key callback](@ref glfwSetKeyCallback) is not. Characters do not map 1:1
- * to physical keys, as a key may produce zero, one or more characters. If you
- * want to know whether a specific physical key was pressed or released, see
- * the key callback instead.
- *
- * The character callback behaves as system text input normally does and will
- * not be called if modifier keys are held down that would prevent normal text
- * input on that platform, for example a Super (Command) key on macOS or Alt key
- * on Windows.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcharfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_char
- *
- * @since Added in version 2.4.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- *)
- function glfwSetCharCallback(window: PGLFWwindow; callback: GLFWcharfun): GLFWcharfun; cdecl;
- external libglfw3 name _PU + 'glfwSetCharCallback';
- (*! @brief Sets the Unicode character with modifiers callback.
- *
- * This function sets the character with modifiers callback of the specified
- * window, which is called when a Unicode character is input regardless of what
- * modifier keys are used.
- *
- * The character with modifiers callback is intended for implementing custom
- * Unicode character input. For regular Unicode text input, see the
- * [character callback](@ref glfwSetCharCallback). Like the character
- * callback, the character with modifiers callback deals with characters and is
- * keyboard layout dependent. Characters do not map 1:1 to physical keys, as
- * a key may produce zero, one or more characters. If you want to know whether
- * a specific physical key was pressed or released, see the
- * [key callback](@ref glfwSetKeyCallback) instead.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * [error](@ref error_handling) occurred.
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcharmodsfun).
- *
- * @deprecated Scheduled for removal in version 4.0.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_char
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- function glfwSetCharModsCallback(window: PGLFWwindow; callback: GLFWcharmodsfun): GLFWcharmodsfun; cdecl;
- external libglfw3 name _PU + 'glfwSetCharModsCallback';
- (*! @brief Sets the mouse button callback.
- *
- * This function sets the mouse button callback of the specified window, which
- * is called when a mouse button is pressed or released.
- *
- * When a window loses input focus, it will generate synthetic mouse button
- * release events for all pressed mouse buttons. You can tell these events
- * from user-generated events by the fact that the synthetic ones are generated
- * after the focus loss event has been processed, i.e. after the
- * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int button, int action, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWmousebuttonfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_mouse_button
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- *)
- function glfwSetMouseButtonCallback(window: PGLFWwindow; callback: GLFWmousebuttonfun): GLFWmousebuttonfun; cdecl;
- external libglfw3 name _PU + 'glfwSetMouseButtonCallback';
- (*! @brief Sets the cursor position callback.
- *
- * This function sets the cursor position callback of the specified window,
- * which is called when the cursor is moved. The callback is provided with the
- * position, in screen coordinates, relative to the upper-left corner of the
- * content area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, double xpos, double ypos);
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcursorposfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- *
- * @since Added in version 3.0. Replaces `glfwSetMousePosCallback`.
- *
- * @ingroup input
- *)
- function glfwSetCursorPosCallback(window: PGLFWwindow; callback: GLFWcursorposfun): GLFWcursorposfun; cdecl;
- external libglfw3 name _PU + 'glfwSetCursorPosCallback';
- (*! @brief Sets the cursor enter/leave callback.
- *
- * This function sets the cursor boundary crossing callback of the specified
- * window, which is called when the cursor enters or leaves the content area of
- * the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int entered)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcursorenterfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_enter
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- function glfwSetCursorEnterCallback(window: PGLFWwindow; callback: GLFWcursorenterfun): GLFWcursorenterfun; cdecl;
- external libglfw3 name _PU + 'glfwSetCursorEnterCallback';
- (*! @brief Sets the scroll callback.
- *
- * This function sets the scroll callback of the specified window, which is
- * called when a scrolling device is used, such as a mouse wheel or scrolling
- * area of a touchpad.
- *
- * The scroll callback receives all scrolling input, like that from a mouse
- * wheel or a touchpad scrolling area.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new scroll callback, or `NULL` to remove the
- * currently set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, double xoffset, double yoffset)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWscrollfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref scrolling
- *
- * @since Added in version 3.0. Replaces `glfwSetMouseWheelCallback`.
- *
- * @ingroup input
- *)
- function glfwSetScrollCallback(window: PGLFWwindow; callback: GLFWscrollfun): GLFWscrollfun; cdecl;
- external libglfw3 name _PU + 'glfwSetScrollCallback';
- (*! @brief Sets the path drop callback.
- *
- * This function sets the path drop callback of the specified window, which is
- * called when one or more dragged paths are dropped on the window.
- *
- * Because the path array and its strings may have been generated specifically
- * for that event, they are not guaranteed to be valid after the callback has
- * returned. If you wish to use them after the callback returns, you need to
- * make a deep copy.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new file drop callback, or `NULL` to remove the
- * currently set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int path_count, const char* paths[])
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWdropfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @wayland File drop is currently unimplemented.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref path_drop
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- *)
- function glfwSetDropCallback(window: PGLFWwindow; callback: GLFWdropfun): GLFWdropfun; cdecl;
- external libglfw3 name _PU + 'glfwSetDropCallback';
- (*! @brief Returns whether the specified joystick is present.
- *
- * This function returns whether the specified joystick is present.
- *
- * There is no need to call this function before other functions that accept
- * a joystick ID, as they all check for presence before performing any other
- * work.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return `GLFW_TRUE` if the joystick is present, or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick
- *
- * @since Added in version 3.0. Replaces `glfwGetJoystickParam`.
- *
- * @ingroup input
- *)
- function glfwJoystickPresent(jid: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwJoystickPresent';
- (*! @brief Returns the values of all axes of the specified joystick.
- *
- * This function returns the values of all axes of the specified joystick.
- * Each element in the array is a value between -1.0 and 1.0.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of axis values in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of axis values, or `NULL` if the joystick is not present or
- * an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_axis
- *
- * @since Added in version 3.0. Replaces `glfwGetJoystickPos`.
- *
- * @ingroup input
- *)
- function glfwGetJoystickAxes(jid: Integer; count: PInteger): PSingle; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickAxes';
- (*! @brief Returns the state of all buttons of the specified joystick.
- *
- * This function returns the state of all buttons of the specified joystick.
- * Each element in the array is either `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * For backward compatibility with earlier versions that did not have @ref
- * glfwGetJoystickHats, the button array also includes all hats, each
- * represented as four buttons. The hats are in the same order as returned by
- * __glfwGetJoystickHats__ and are in the order _up_, _right_, _down_ and
- * _left_. To disable these extra buttons, set the @ref
- * GLFW_JOYSTICK_HAT_BUTTONS init hint before initialization.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of button states in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of button states, or `NULL` if the joystick is not present
- * or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_button
- *
- * @since Added in version 2.2.
- * @glfw3 Changed to return a dynamic array.
- *
- * @ingroup input
- *)
- function glfwGetJoystickButtons(jid: Integer; count: PInteger): PByte; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickButtons';
- (*! @brief Returns the state of all hats of the specified joystick.
- *
- * This function returns the state of all hats of the specified joystick.
- * Each element in the array is one of the following values:
- *
- * Name | Value
- * ---- | -----
- * `GLFW_HAT_CENTERED` | 0
- * `GLFW_HAT_UP` | 1
- * `GLFW_HAT_RIGHT` | 2
- * `GLFW_HAT_DOWN` | 4
- * `GLFW_HAT_LEFT` | 8
- * `GLFW_HAT_RIGHT_UP` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_UP`
- * `GLFW_HAT_RIGHT_DOWN` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_DOWN`
- * `GLFW_HAT_LEFT_UP` | `GLFW_HAT_LEFT` \| `GLFW_HAT_UP`
- * `GLFW_HAT_LEFT_DOWN` | `GLFW_HAT_LEFT` \| `GLFW_HAT_DOWN`
- *
- * The diagonal directions are bitwise combinations of the primary (up, right,
- * down and left) directions and you can test for these individually by ANDing
- * it with the corresponding direction.
- *
- * @code
- * if (hats[2] & GLFW_HAT_RIGHT)
- * {
- * // State of hat 2 could be right-up, right or right-down
- * }
- * @endcode
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of hat states in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of hat states, or `NULL` if the joystick is not present
- * or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected, this function is called again for that joystick or the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_hat
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetJoystickHats(jid: Integer; count: PInteger): PByte; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickHats';
- (*! @brief Returns the name of the specified joystick.
- *
- * This function returns the name, encoded as UTF-8, of the specified joystick.
- * The returned string is allocated and freed by GLFW. You should not free it
- * yourself.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick
- * is not present or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_name
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- function glfwGetJoystickName(jid: Integer): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickName';
- (*! @brief Returns the SDL compatible GUID of the specified joystick.
- *
- * This function returns the SDL compatible GUID, as a UTF-8 encoded
- * hexadecimal string, of the specified joystick. The returned string is
- * allocated and freed by GLFW. You should not free it yourself.
- *
- * The GUID is what connects a joystick to a gamepad mapping. A connected
- * joystick will always have a GUID even if there is no gamepad mapping
- * assigned to it.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * The GUID uses the format introduced in SDL 2.0.5. This GUID tries to
- * uniquely identify the make and model of a joystick but does not identify
- * a specific unit, e.g. all wired Xbox 360 controllers will have the same
- * GUID on that platform. The GUID for a unit may vary between platforms
- * depending on what hardware information the platform specific APIs provide.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded GUID of the joystick, or `NULL` if the joystick
- * is not present or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetJoystickGUID(jid: Integer): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickGUID';
- (*! @brief Sets the user pointer of the specified joystick.
- *
- * This function sets the user-defined pointer of the specified joystick. The
- * current value is retained until the joystick is disconnected. The initial
- * value is `NULL`.
- *
- * This function may be called from the joystick callback, even for a joystick
- * that is being disconnected.
- *
- * @param[in] jid The joystick whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref joystick_userptr
- * @sa @ref glfwGetJoystickUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- procedure glfwSetJoystickUserPointer(jid: Integer; pointer: Pointer); cdecl;
- external libglfw3 name _PU + 'glfwSetJoystickUserPointer';
- (*! @brief Returns the user pointer of the specified joystick.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified joystick. The initial value is `NULL`.
- *
- * This function may be called from the joystick callback, even for a joystick
- * that is being disconnected.
- *
- * @param[in] jid The joystick whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref joystick_userptr
- * @sa @ref glfwSetJoystickUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetJoystickUserPointer(jid: Integer): Pointer; cdecl;
- external libglfw3 name _PU + 'glfwGetJoystickUserPointer';
- (*! @brief Returns whether the specified joystick has a gamepad mapping.
- *
- * This function returns whether the specified joystick is both present and has
- * a gamepad mapping.
- *
- * If the specified joystick is present but does not have a gamepad mapping
- * this function will return `GLFW_FALSE` but will not generate an error. Call
- * @ref glfwJoystickPresent to check if a joystick is present regardless of
- * whether it has a mapping.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return `GLFW_TRUE` if a joystick is both present and has a gamepad mapping,
- * or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwGetGamepadState
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwJoystickIsGamepad(jid: Integer): Integer; cdecl;
- external libglfw3 name _PU + 'glfwJoystickIsGamepad';
- (*! @brief Sets the joystick configuration callback.
- *
- * This function sets the joystick configuration callback, or removes the
- * currently set callback. This is called when a joystick is connected to or
- * disconnected from the system.
- *
- * For joystick connection and disconnection events to be delivered on all
- * platforms, you need to call one of the [event processing](@ref events)
- * functions. Joystick disconnection may also be detected and the callback
- * called by joystick functions. The function will then return whatever it
- * returns if the joystick is not present.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(int jid, int event)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWjoystickfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_event
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- *)
- function glfwSetJoystickCallback(callback: GLFWjoystickfun): GLFWjoystickfun; cdecl;
- external libglfw3 name _PU + 'glfwSetJoystickCallback';
- (*! @brief Adds the specified SDL_GameControllerDB gamepad mappings.
- *
- * This function parses the specified ASCII encoded string and updates the
- * internal list with any gamepad mappings it finds. This string may
- * contain either a single gamepad mapping or many mappings separated by
- * newlines. The parser supports the full format of the `gamecontrollerdb.txt`
- * source file including empty lines and comments.
- *
- * See @ref gamepad_mapping for a description of the format.
- *
- * If there is already a gamepad mapping for a given GUID in the internal list,
- * it will be replaced by the one passed to this function. If the library is
- * terminated and re-initialized the internal list will revert to the built-in
- * default.
- *
- * @param[in] string The string containing the gamepad mappings.
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_VALUE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwJoystickIsGamepad
- * @sa @ref glfwGetGamepadName
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwUpdateGamepadMappings(const string_: PAnsiChar): Integer; cdecl;
- external libglfw3 name _PU + 'glfwUpdateGamepadMappings';
- (*! @brief Returns the human-readable gamepad name for the specified joystick.
- *
- * This function returns the human-readable name of the gamepad from the
- * gamepad mapping assigned to the specified joystick.
- *
- * If the specified joystick is not present or does not have a gamepad mapping
- * this function will return `NULL` but will not generate an error. Call
- * @ref glfwJoystickPresent to check whether it is present regardless of
- * whether it has a mapping.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded name of the gamepad, or `NULL` if the
- * joystick is not present, does not have a mapping or an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref GLFW_INVALID_ENUM.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected, the gamepad mappings are updated or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwJoystickIsGamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetGamepadName(jid: Integer): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetGamepadName';
- (*! @brief Retrieves the state of the specified joystick remapped as a gamepad.
- *
- * This function retrieves the state of the specified joystick remapped to
- * an Xbox-like gamepad.
- *
- * If the specified joystick is not present or does not have a gamepad mapping
- * this function will return `GLFW_FALSE` but will not generate an error. Call
- * @ref glfwJoystickPresent to check whether it is present regardless of
- * whether it has a mapping.
- *
- * The Guide button may not be available for input as it is often hooked by the
- * system or the Steam client.
- *
- * Not all devices have all the buttons or axes provided by @ref
- * GLFWgamepadstate. Unavailable buttons and axes will always report
- * `GLFW_RELEASE` and 0.0 respectively.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] state The gamepad input state of the joystick.
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if no joystick is
- * connected, it has no gamepad mapping or an [error](@ref error_handling)
- * occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwUpdateGamepadMappings
- * @sa @ref glfwJoystickIsGamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- *)
- function glfwGetGamepadState(jid: Integer; state: PGLFWgamepadstate): Integer; cdecl;
- external libglfw3 name _PU + 'glfwGetGamepadState';
- (*! @brief Sets the clipboard to the specified string.
- *
- * This function sets the system clipboard to the specified, UTF-8 encoded
- * string.
- *
- * @param[in] window Deprecated. Any valid window or `NULL`.
- * @param[in] string A UTF-8 encoded string.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The specified string is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref clipboard
- * @sa @ref glfwGetClipboardString
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- procedure glfwSetClipboardString(window: PGLFWwindow; const string_: PAnsiChar); cdecl;
- external libglfw3 name _PU + 'glfwSetClipboardString';
- (*! @brief Returns the contents of the clipboard as a string.
- *
- * This function returns the contents of the system clipboard, if it contains
- * or is convertible to a UTF-8 encoded string. If the clipboard is empty or
- * if its contents cannot be converted, `NULL` is returned and a @ref
- * GLFW_FORMAT_UNAVAILABLE error is generated.
- *
- * @param[in] window Deprecated. Any valid window or `NULL`.
- * @return The contents of the clipboard as a UTF-8 encoded string, or `NULL`
- * if an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_FORMAT_UNAVAILABLE and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the next call to @ref
- * glfwGetClipboardString or @ref glfwSetClipboardString, or until the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref clipboard
- * @sa @ref glfwSetClipboardString
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- *)
- function glfwGetClipboardString(window: PGLFWwindow): PAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetClipboardString';
- (*! @brief Returns the GLFW time.
- *
- * This function returns the current GLFW time, in seconds. Unless the time
- * has been set using @ref glfwSetTime it measures time elapsed since GLFW was
- * initialized.
- *
- * This function and @ref glfwSetTime are helper functions on top of @ref
- * glfwGetTimerFrequency and @ref glfwGetTimerValue.
- *
- * The resolution of the timer is system dependent, but is usually on the order
- * of a few micro- or nanoseconds. It uses the highest-resolution monotonic
- * time source on each operating system.
- *
- * @return The current time, in seconds, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Reading and
- * writing of the internal base time is not atomic, so it needs to be
- * externally synchronized with calls to @ref glfwSetTime.
- *
- * @sa @ref time
- *
- * @since Added in version 1.0.
- *
- * @ingroup input
- *)
- function glfwGetTime(): Double; cdecl;
- external libglfw3 name _PU + 'glfwGetTime';
- (*! @brief Sets the GLFW time.
- *
- * This function sets the current GLFW time, in seconds. The value must be
- * a positive finite number less than or equal to 18446744073.0, which is
- * approximately 584.5 years.
- *
- * This function and @ref glfwGetTime are helper functions on top of @ref
- * glfwGetTimerFrequency and @ref glfwGetTimerValue.
- *
- * @param[in] time The new value, in seconds.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_VALUE.
- *
- * @remark The upper limit of GLFW time is calculated as
- * floor((2<sup>64</sup> - 1) / 10<sup>9</sup>) and is due to implementations
- * storing nanoseconds in 64 bits. The limit may be increased in the future.
- *
- * @thread_safety This function may be called from any thread. Reading and
- * writing of the internal base time is not atomic, so it needs to be
- * externally synchronized with calls to @ref glfwGetTime.
- *
- * @sa @ref time
- *
- * @since Added in version 2.2.
- *
- * @ingroup input
- *)
- procedure glfwSetTime(time: Double); cdecl;
- external libglfw3 name _PU + 'glfwSetTime';
- (*! @brief Returns the current value of the raw timer.
- *
- * This function returns the current value of the raw timer, measured in
- * 1 / frequency seconds. To get the frequency, call @ref
- * glfwGetTimerFrequency.
- *
- * @return The value of the timer, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref time
- * @sa @ref glfwGetTimerFrequency
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- *)
- function glfwGetTimerValue(): UInt64; cdecl;
- external libglfw3 name _PU + 'glfwGetTimerValue';
- (*! @brief Returns the frequency, in Hz, of the raw timer.
- *
- * This function returns the frequency, in Hz, of the raw timer.
- *
- * @return The frequency of the timer, in Hz, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref time
- * @sa @ref glfwGetTimerValue
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- *)
- function glfwGetTimerFrequency(): UInt64; cdecl;
- external libglfw3 name _PU + 'glfwGetTimerFrequency';
- (*! @brief Makes the context of the specified window current for the calling
- * thread.
- *
- * This function makes the OpenGL or OpenGL ES context of the specified window
- * current on the calling thread. A context must only be made current on
- * a single thread at a time and each thread can have only a single current
- * context at a time.
- *
- * When moving a context between threads, you must make it non-current on the
- * old thread before making it current on the new one.
- *
- * By default, making a context non-current implicitly forces a pipeline flush.
- * On machines that support `GL_KHR_context_flush_control`, you can control
- * whether a context performs this flush by setting the
- * [GLFW_CONTEXT_RELEASE_BEHAVIOR](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint)
- * hint.
- *
- * The specified window must have an OpenGL or OpenGL ES context. Specifying
- * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
- * error.
- *
- * @param[in] window The window whose context to make current, or `NULL` to
- * detach the current context.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_current
- * @sa @ref glfwGetCurrentContext
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- *)
- procedure glfwMakeContextCurrent(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwMakeContextCurrent';
- (*! @brief Returns the window whose context is current on the calling thread.
- *
- * This function returns the window whose OpenGL or OpenGL ES context is
- * current on the calling thread.
- *
- * @return The window whose context is current, or `NULL` if no window's
- * context is current.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_current
- * @sa @ref glfwMakeContextCurrent
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- *)
- function glfwGetCurrentContext(): PGLFWwindow; cdecl;
- external libglfw3 name _PU + 'glfwGetCurrentContext';
- (*! @brief Swaps the front and back buffers of the specified window.
- *
- * This function swaps the front and back buffers of the specified window when
- * rendering with OpenGL or OpenGL ES. If the swap interval is greater than
- * zero, the GPU driver waits the specified number of screen updates before
- * swapping the buffers.
- *
- * The specified window must have an OpenGL or OpenGL ES context. Specifying
- * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
- * error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see `vkQueuePresentKHR` instead.
- *
- * @param[in] window The window whose buffers to swap.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark __EGL:__ The context of the specified window must be current on the
- * calling thread.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref buffer_swap
- * @sa @ref glfwSwapInterval
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- *)
- procedure glfwSwapBuffers(window: PGLFWwindow); cdecl;
- external libglfw3 name _PU + 'glfwSwapBuffers';
- (*! @brief Sets the swap interval for the current context.
- *
- * This function sets the swap interval for the current OpenGL or OpenGL ES
- * context, i.e. the number of screen updates to wait from the time @ref
- * glfwSwapBuffers was called before swapping the buffers and returning. This
- * is sometimes called _vertical synchronization_, _vertical retrace
- * synchronization_ or just _vsync_.
- *
- * A context that supports either of the `WGL_EXT_swap_control_tear` and
- * `GLX_EXT_swap_control_tear` extensions also accepts _negative_ swap
- * intervals, which allows the driver to swap immediately even if a frame
- * arrives a little bit late. You can check for these extensions with @ref
- * glfwExtensionSupported.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see the present mode of your swapchain instead.
- *
- * @param[in] interval The minimum number of screen updates to wait for
- * until the buffers are swapped by @ref glfwSwapBuffers.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark This function is not called during context creation, leaving the
- * swap interval set to whatever is the default for that API. This is done
- * because some swap interval extensions used by GLFW do not allow the swap
- * interval to be reset to zero once it has been set to a non-zero value.
- *
- * @remark Some GPU drivers do not honor the requested swap interval, either
- * because of a user setting that overrides the application's request or due to
- * bugs in the driver.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref buffer_swap
- * @sa @ref glfwSwapBuffers
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- *)
- procedure glfwSwapInterval(interval: Integer); cdecl;
- external libglfw3 name _PU + 'glfwSwapInterval';
- (*! @brief Returns whether the specified extension is available.
- *
- * This function returns whether the specified
- * [API extension](@ref context_glext) is supported by the current OpenGL or
- * OpenGL ES context. It searches both for client API extension and context
- * creation API extensions.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * As this functions retrieves and searches one or more extension strings each
- * call, it is recommended that you cache its results if it is going to be used
- * frequently. The extension strings will not change during the lifetime of
- * a context, so there is no danger in doing this.
- *
- * This function does not apply to Vulkan. If you are using Vulkan, see @ref
- * glfwGetRequiredInstanceExtensions, `vkEnumerateInstanceExtensionProperties`
- * and `vkEnumerateDeviceExtensionProperties` instead.
- *
- * @param[in] extension The ASCII encoded name of the extension.
- * @return `GLFW_TRUE` if the extension is available, or `GLFW_FALSE`
- * otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT, @ref GLFW_INVALID_VALUE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_glext
- * @sa @ref glfwGetProcAddress
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- *)
- function glfwExtensionSupported(const extension: PAnsiChar): Integer; cdecl;
- external libglfw3 name _PU + 'glfwExtensionSupported';
- (*! @brief Returns the address of the specified function for the current
- * context.
- *
- * This function returns the address of the specified OpenGL or OpenGL ES
- * [core or extension function](@ref context_glext), if it is supported
- * by the current context.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see @ref glfwGetInstanceProcAddress, `vkGetInstanceProcAddr` and
- * `vkGetDeviceProcAddr` instead.
- *
- * @param[in] procname The ASCII encoded name of the function.
- * @return The address of the function, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark The address of a given function is not guaranteed to be the same
- * between contexts.
- *
- * @remark This function may return a non-`NULL` address despite the
- * associated version or extension not being available. Always check the
- * context version or extension string first.
- *
- * @pointer_lifetime The returned function pointer is valid until the context
- * is destroyed or the library is terminated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_glext
- * @sa @ref glfwExtensionSupported
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- *)
- function glfwGetProcAddress(const procname: PAnsiChar): GLFWglproc; cdecl;
- external libglfw3 name _PU + 'glfwGetProcAddress';
- (*! @brief Returns whether the Vulkan loader and an ICD have been found.
- *
- * This function returns whether the Vulkan loader and any minimally functional
- * ICD have been found.
- *
- * The availability of a Vulkan loader and even an ICD does not by itself guarantee that
- * surface creation or even instance creation is possible. Call @ref
- * glfwGetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan
- * surface creation are available and @ref glfwGetPhysicalDevicePresentationSupport to
- * check whether a queue family of a physical device supports image presentation.
- *
- * @return `GLFW_TRUE` if Vulkan is minimally available, or `GLFW_FALSE`
- * otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref vulkan_support
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- *)
- function glfwVulkanSupported(): Integer; cdecl;
- external libglfw3 name _PU + 'glfwVulkanSupported';
- (*! @brief Returns the Vulkan instance extensions required by GLFW.
- *
- * This function returns an array of names of Vulkan instance extensions required
- * by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the
- * list will always contain `VK_KHR_surface`, so if you don't require any
- * additional extensions you can pass this list directly to the
- * `VkInstanceCreateInfo` struct.
- *
- * If Vulkan is not available on the machine, this function returns `NULL` and
- * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
- * to check whether Vulkan is at least minimally available.
- *
- * If Vulkan is available but no set of extensions allowing window surface
- * creation was found, this function returns `NULL`. You may still use Vulkan
- * for off-screen rendering and compute work.
- *
- * @param[out] count Where to store the number of extensions in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of ASCII encoded extension names, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_API_UNAVAILABLE.
- *
- * @remark Additional extensions may be required by future versions of GLFW.
- * You should check if any extensions you wish to enable are already in the
- * returned array, as it is an error to specify an extension more than once in
- * the `VkInstanceCreateInfo` struct.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * library is terminated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref vulkan_ext
- * @sa @ref glfwCreateWindowSurface
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- *)
- function glfwGetRequiredInstanceExtensions(count: PUInt32): PPAnsiChar; cdecl;
- external libglfw3 name _PU + 'glfwGetRequiredInstanceExtensions';
- implementation
- end.
|