12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961 |
- /* Generated by wayland-scanner 1.11.0 */
- #ifndef WAYLAND_CLIENT_PROTOCOL_H
- #define WAYLAND_CLIENT_PROTOCOL_H
- #include <stdint.h>
- #include <stddef.h>
- #include "wayland-client.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * @page page_wayland The wayland protocol
- * @section page_ifaces_wayland Interfaces
- * - @subpage page_iface_wl_display - core global object
- * - @subpage page_iface_wl_registry - global registry object
- * - @subpage page_iface_wl_callback - callback object
- * - @subpage page_iface_wl_compositor - the compositor singleton
- * - @subpage page_iface_wl_shm_pool - a shared memory pool
- * - @subpage page_iface_wl_shm - shared memory support
- * - @subpage page_iface_wl_buffer - content for a wl_surface
- * - @subpage page_iface_wl_data_offer - offer to transfer data
- * - @subpage page_iface_wl_data_source - offer to transfer data
- * - @subpage page_iface_wl_data_device - data transfer device
- * - @subpage page_iface_wl_data_device_manager - data transfer interface
- * - @subpage page_iface_wl_shell - create desktop-style surfaces
- * - @subpage page_iface_wl_shell_surface - desktop-style metadata interface
- * - @subpage page_iface_wl_surface - an onscreen surface
- * - @subpage page_iface_wl_seat - group of input devices
- * - @subpage page_iface_wl_pointer - pointer input device
- * - @subpage page_iface_wl_keyboard - keyboard input device
- * - @subpage page_iface_wl_touch - touchscreen input device
- * - @subpage page_iface_wl_output - compositor output region
- * - @subpage page_iface_wl_region - region interface
- * - @subpage page_iface_wl_subcompositor - sub-surface compositing
- * - @subpage page_iface_wl_subsurface - sub-surface interface to a wl_surface
- * @section page_copyright_wayland Copyright
- * <pre>
- *
- * Copyright © 2008-2011 Kristian Høgsberg
- * Copyright © 2010-2011 Intel Corporation
- * Copyright © 2012-2013 Collabora, Ltd.
- *
- * Permission is hereby granted, free of charge, to any person
- * obtaining a copy of this software and associated documentation files
- * (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge,
- * publish, distribute, sublicense, and/or sell copies of the Software,
- * and to permit persons to whom the Software is furnished to do so,
- * subject to the following conditions:
- *
- * The above copyright notice and this permission notice (including the
- * next paragraph) shall be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
- * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
- * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- * </pre>
- */
- struct wl_buffer;
- struct wl_callback;
- struct wl_compositor;
- struct wl_data_device;
- struct wl_data_device_manager;
- struct wl_data_offer;
- struct wl_data_source;
- struct wl_display;
- struct wl_keyboard;
- struct wl_output;
- struct wl_pointer;
- struct wl_region;
- struct wl_registry;
- struct wl_seat;
- struct wl_shell;
- struct wl_shell_surface;
- struct wl_shm;
- struct wl_shm_pool;
- struct wl_subcompositor;
- struct wl_subsurface;
- struct wl_surface;
- struct wl_touch;
- /**
- * @page page_iface_wl_display wl_display
- * @section page_iface_wl_display_desc Description
- *
- * The core global object. This is a special singleton object. It
- * is used for internal Wayland protocol features.
- * @section page_iface_wl_display_api API
- * See @ref iface_wl_display.
- */
- /**
- * @defgroup iface_wl_display The wl_display interface
- *
- * The core global object. This is a special singleton object. It
- * is used for internal Wayland protocol features.
- */
- extern const struct wl_interface wl_display_interface;
- /**
- * @page page_iface_wl_registry wl_registry
- * @section page_iface_wl_registry_desc Description
- *
- * The global registry object. The server has a number of global
- * objects that are available to all clients. These objects
- * typically represent an actual object in the server (for example,
- * an input device) or they are singleton objects that provide
- * extension functionality.
- *
- * When a client creates a registry object, the registry object
- * will emit a global event for each global currently in the
- * registry. Globals come and go as a result of device or
- * monitor hotplugs, reconfiguration or other events, and the
- * registry will send out global and global_remove events to
- * keep the client up to date with the changes. To mark the end
- * of the initial burst of events, the client can use the
- * wl_display.sync request immediately after calling
- * wl_display.get_registry.
- *
- * A client can bind to a global object by using the bind
- * request. This creates a client-side handle that lets the object
- * emit events to the client and lets the client invoke requests on
- * the object.
- * @section page_iface_wl_registry_api API
- * See @ref iface_wl_registry.
- */
- /**
- * @defgroup iface_wl_registry The wl_registry interface
- *
- * The global registry object. The server has a number of global
- * objects that are available to all clients. These objects
- * typically represent an actual object in the server (for example,
- * an input device) or they are singleton objects that provide
- * extension functionality.
- *
- * When a client creates a registry object, the registry object
- * will emit a global event for each global currently in the
- * registry. Globals come and go as a result of device or
- * monitor hotplugs, reconfiguration or other events, and the
- * registry will send out global and global_remove events to
- * keep the client up to date with the changes. To mark the end
- * of the initial burst of events, the client can use the
- * wl_display.sync request immediately after calling
- * wl_display.get_registry.
- *
- * A client can bind to a global object by using the bind
- * request. This creates a client-side handle that lets the object
- * emit events to the client and lets the client invoke requests on
- * the object.
- */
- extern const struct wl_interface wl_registry_interface;
- /**
- * @page page_iface_wl_callback wl_callback
- * @section page_iface_wl_callback_desc Description
- *
- * Clients can handle the 'done' event to get notified when
- * the related request is done.
- * @section page_iface_wl_callback_api API
- * See @ref iface_wl_callback.
- */
- /**
- * @defgroup iface_wl_callback The wl_callback interface
- *
- * Clients can handle the 'done' event to get notified when
- * the related request is done.
- */
- extern const struct wl_interface wl_callback_interface;
- /**
- * @page page_iface_wl_compositor wl_compositor
- * @section page_iface_wl_compositor_desc Description
- *
- * A compositor. This object is a singleton global. The
- * compositor is in charge of combining the contents of multiple
- * surfaces into one displayable output.
- * @section page_iface_wl_compositor_api API
- * See @ref iface_wl_compositor.
- */
- /**
- * @defgroup iface_wl_compositor The wl_compositor interface
- *
- * A compositor. This object is a singleton global. The
- * compositor is in charge of combining the contents of multiple
- * surfaces into one displayable output.
- */
- extern const struct wl_interface wl_compositor_interface;
- /**
- * @page page_iface_wl_shm_pool wl_shm_pool
- * @section page_iface_wl_shm_pool_desc Description
- *
- * The wl_shm_pool object encapsulates a piece of memory shared
- * between the compositor and client. Through the wl_shm_pool
- * object, the client can allocate shared memory wl_buffer objects.
- * All objects created through the same pool share the same
- * underlying mapped memory. Reusing the mapped memory avoids the
- * setup/teardown overhead and is useful when interactively resizing
- * a surface or for many small buffers.
- * @section page_iface_wl_shm_pool_api API
- * See @ref iface_wl_shm_pool.
- */
- /**
- * @defgroup iface_wl_shm_pool The wl_shm_pool interface
- *
- * The wl_shm_pool object encapsulates a piece of memory shared
- * between the compositor and client. Through the wl_shm_pool
- * object, the client can allocate shared memory wl_buffer objects.
- * All objects created through the same pool share the same
- * underlying mapped memory. Reusing the mapped memory avoids the
- * setup/teardown overhead and is useful when interactively resizing
- * a surface or for many small buffers.
- */
- extern const struct wl_interface wl_shm_pool_interface;
- /**
- * @page page_iface_wl_shm wl_shm
- * @section page_iface_wl_shm_desc Description
- *
- * A global singleton object that provides support for shared
- * memory.
- *
- * Clients can create wl_shm_pool objects using the create_pool
- * request.
- *
- * At connection setup time, the wl_shm object emits one or more
- * format events to inform clients about the valid pixel formats
- * that can be used for buffers.
- * @section page_iface_wl_shm_api API
- * See @ref iface_wl_shm.
- */
- /**
- * @defgroup iface_wl_shm The wl_shm interface
- *
- * A global singleton object that provides support for shared
- * memory.
- *
- * Clients can create wl_shm_pool objects using the create_pool
- * request.
- *
- * At connection setup time, the wl_shm object emits one or more
- * format events to inform clients about the valid pixel formats
- * that can be used for buffers.
- */
- extern const struct wl_interface wl_shm_interface;
- /**
- * @page page_iface_wl_buffer wl_buffer
- * @section page_iface_wl_buffer_desc Description
- *
- * A buffer provides the content for a wl_surface. Buffers are
- * created through factory interfaces such as wl_drm, wl_shm or
- * similar. It has a width and a height and can be attached to a
- * wl_surface, but the mechanism by which a client provides and
- * updates the contents is defined by the buffer factory interface.
- * @section page_iface_wl_buffer_api API
- * See @ref iface_wl_buffer.
- */
- /**
- * @defgroup iface_wl_buffer The wl_buffer interface
- *
- * A buffer provides the content for a wl_surface. Buffers are
- * created through factory interfaces such as wl_drm, wl_shm or
- * similar. It has a width and a height and can be attached to a
- * wl_surface, but the mechanism by which a client provides and
- * updates the contents is defined by the buffer factory interface.
- */
- extern const struct wl_interface wl_buffer_interface;
- /**
- * @page page_iface_wl_data_offer wl_data_offer
- * @section page_iface_wl_data_offer_desc Description
- *
- * A wl_data_offer represents a piece of data offered for transfer
- * by another client (the source client). It is used by the
- * copy-and-paste and drag-and-drop mechanisms. The offer
- * describes the different mime types that the data can be
- * converted to and provides the mechanism for transferring the
- * data directly from the source client.
- * @section page_iface_wl_data_offer_api API
- * See @ref iface_wl_data_offer.
- */
- /**
- * @defgroup iface_wl_data_offer The wl_data_offer interface
- *
- * A wl_data_offer represents a piece of data offered for transfer
- * by another client (the source client). It is used by the
- * copy-and-paste and drag-and-drop mechanisms. The offer
- * describes the different mime types that the data can be
- * converted to and provides the mechanism for transferring the
- * data directly from the source client.
- */
- extern const struct wl_interface wl_data_offer_interface;
- /**
- * @page page_iface_wl_data_source wl_data_source
- * @section page_iface_wl_data_source_desc Description
- *
- * The wl_data_source object is the source side of a wl_data_offer.
- * It is created by the source client in a data transfer and
- * provides a way to describe the offered data and a way to respond
- * to requests to transfer the data.
- * @section page_iface_wl_data_source_api API
- * See @ref iface_wl_data_source.
- */
- /**
- * @defgroup iface_wl_data_source The wl_data_source interface
- *
- * The wl_data_source object is the source side of a wl_data_offer.
- * It is created by the source client in a data transfer and
- * provides a way to describe the offered data and a way to respond
- * to requests to transfer the data.
- */
- extern const struct wl_interface wl_data_source_interface;
- /**
- * @page page_iface_wl_data_device wl_data_device
- * @section page_iface_wl_data_device_desc Description
- *
- * There is one wl_data_device per seat which can be obtained
- * from the global wl_data_device_manager singleton.
- *
- * A wl_data_device provides access to inter-client data transfer
- * mechanisms such as copy-and-paste and drag-and-drop.
- * @section page_iface_wl_data_device_api API
- * See @ref iface_wl_data_device.
- */
- /**
- * @defgroup iface_wl_data_device The wl_data_device interface
- *
- * There is one wl_data_device per seat which can be obtained
- * from the global wl_data_device_manager singleton.
- *
- * A wl_data_device provides access to inter-client data transfer
- * mechanisms such as copy-and-paste and drag-and-drop.
- */
- extern const struct wl_interface wl_data_device_interface;
- /**
- * @page page_iface_wl_data_device_manager wl_data_device_manager
- * @section page_iface_wl_data_device_manager_desc Description
- *
- * The wl_data_device_manager is a singleton global object that
- * provides access to inter-client data transfer mechanisms such as
- * copy-and-paste and drag-and-drop. These mechanisms are tied to
- * a wl_seat and this interface lets a client get a wl_data_device
- * corresponding to a wl_seat.
- *
- * Depending on the version bound, the objects created from the bound
- * wl_data_device_manager object will have different requirements for
- * functioning properly. See wl_data_source.set_actions,
- * wl_data_offer.accept and wl_data_offer.finish for details.
- * @section page_iface_wl_data_device_manager_api API
- * See @ref iface_wl_data_device_manager.
- */
- /**
- * @defgroup iface_wl_data_device_manager The wl_data_device_manager interface
- *
- * The wl_data_device_manager is a singleton global object that
- * provides access to inter-client data transfer mechanisms such as
- * copy-and-paste and drag-and-drop. These mechanisms are tied to
- * a wl_seat and this interface lets a client get a wl_data_device
- * corresponding to a wl_seat.
- *
- * Depending on the version bound, the objects created from the bound
- * wl_data_device_manager object will have different requirements for
- * functioning properly. See wl_data_source.set_actions,
- * wl_data_offer.accept and wl_data_offer.finish for details.
- */
- extern const struct wl_interface wl_data_device_manager_interface;
- /**
- * @page page_iface_wl_shell wl_shell
- * @section page_iface_wl_shell_desc Description
- *
- * This interface is implemented by servers that provide
- * desktop-style user interfaces.
- *
- * It allows clients to associate a wl_shell_surface with
- * a basic surface.
- * @section page_iface_wl_shell_api API
- * See @ref iface_wl_shell.
- */
- /**
- * @defgroup iface_wl_shell The wl_shell interface
- *
- * This interface is implemented by servers that provide
- * desktop-style user interfaces.
- *
- * It allows clients to associate a wl_shell_surface with
- * a basic surface.
- */
- extern const struct wl_interface wl_shell_interface;
- /**
- * @page page_iface_wl_shell_surface wl_shell_surface
- * @section page_iface_wl_shell_surface_desc Description
- *
- * An interface that may be implemented by a wl_surface, for
- * implementations that provide a desktop-style user interface.
- *
- * It provides requests to treat surfaces like toplevel, fullscreen
- * or popup windows, move, resize or maximize them, associate
- * metadata like title and class, etc.
- *
- * On the server side the object is automatically destroyed when
- * the related wl_surface is destroyed. On the client side,
- * wl_shell_surface_destroy() must be called before destroying
- * the wl_surface object.
- * @section page_iface_wl_shell_surface_api API
- * See @ref iface_wl_shell_surface.
- */
- /**
- * @defgroup iface_wl_shell_surface The wl_shell_surface interface
- *
- * An interface that may be implemented by a wl_surface, for
- * implementations that provide a desktop-style user interface.
- *
- * It provides requests to treat surfaces like toplevel, fullscreen
- * or popup windows, move, resize or maximize them, associate
- * metadata like title and class, etc.
- *
- * On the server side the object is automatically destroyed when
- * the related wl_surface is destroyed. On the client side,
- * wl_shell_surface_destroy() must be called before destroying
- * the wl_surface object.
- */
- extern const struct wl_interface wl_shell_surface_interface;
- /**
- * @page page_iface_wl_surface wl_surface
- * @section page_iface_wl_surface_desc Description
- *
- * A surface is a rectangular area that is displayed on the screen.
- * It has a location, size and pixel contents.
- *
- * The size of a surface (and relative positions on it) is described
- * in surface-local coordinates, which may differ from the buffer
- * coordinates of the pixel content, in case a buffer_transform
- * or a buffer_scale is used.
- *
- * A surface without a "role" is fairly useless: a compositor does
- * not know where, when or how to present it. The role is the
- * purpose of a wl_surface. Examples of roles are a cursor for a
- * pointer (as set by wl_pointer.set_cursor), a drag icon
- * (wl_data_device.start_drag), a sub-surface
- * (wl_subcompositor.get_subsurface), and a window as defined by a
- * shell protocol (e.g. wl_shell.get_shell_surface).
- *
- * A surface can have only one role at a time. Initially a
- * wl_surface does not have a role. Once a wl_surface is given a
- * role, it is set permanently for the whole lifetime of the
- * wl_surface object. Giving the current role again is allowed,
- * unless explicitly forbidden by the relevant interface
- * specification.
- *
- * Surface roles are given by requests in other interfaces such as
- * wl_pointer.set_cursor. The request should explicitly mention
- * that this request gives a role to a wl_surface. Often, this
- * request also creates a new protocol object that represents the
- * role and adds additional functionality to wl_surface. When a
- * client wants to destroy a wl_surface, they must destroy this 'role
- * object' before the wl_surface.
- *
- * Destroying the role object does not remove the role from the
- * wl_surface, but it may stop the wl_surface from "playing the role".
- * For instance, if a wl_subsurface object is destroyed, the wl_surface
- * it was created for will be unmapped and forget its position and
- * z-order. It is allowed to create a wl_subsurface for the same
- * wl_surface again, but it is not allowed to use the wl_surface as
- * a cursor (cursor is a different role than sub-surface, and role
- * switching is not allowed).
- * @section page_iface_wl_surface_api API
- * See @ref iface_wl_surface.
- */
- /**
- * @defgroup iface_wl_surface The wl_surface interface
- *
- * A surface is a rectangular area that is displayed on the screen.
- * It has a location, size and pixel contents.
- *
- * The size of a surface (and relative positions on it) is described
- * in surface-local coordinates, which may differ from the buffer
- * coordinates of the pixel content, in case a buffer_transform
- * or a buffer_scale is used.
- *
- * A surface without a "role" is fairly useless: a compositor does
- * not know where, when or how to present it. The role is the
- * purpose of a wl_surface. Examples of roles are a cursor for a
- * pointer (as set by wl_pointer.set_cursor), a drag icon
- * (wl_data_device.start_drag), a sub-surface
- * (wl_subcompositor.get_subsurface), and a window as defined by a
- * shell protocol (e.g. wl_shell.get_shell_surface).
- *
- * A surface can have only one role at a time. Initially a
- * wl_surface does not have a role. Once a wl_surface is given a
- * role, it is set permanently for the whole lifetime of the
- * wl_surface object. Giving the current role again is allowed,
- * unless explicitly forbidden by the relevant interface
- * specification.
- *
- * Surface roles are given by requests in other interfaces such as
- * wl_pointer.set_cursor. The request should explicitly mention
- * that this request gives a role to a wl_surface. Often, this
- * request also creates a new protocol object that represents the
- * role and adds additional functionality to wl_surface. When a
- * client wants to destroy a wl_surface, they must destroy this 'role
- * object' before the wl_surface.
- *
- * Destroying the role object does not remove the role from the
- * wl_surface, but it may stop the wl_surface from "playing the role".
- * For instance, if a wl_subsurface object is destroyed, the wl_surface
- * it was created for will be unmapped and forget its position and
- * z-order. It is allowed to create a wl_subsurface for the same
- * wl_surface again, but it is not allowed to use the wl_surface as
- * a cursor (cursor is a different role than sub-surface, and role
- * switching is not allowed).
- */
- extern const struct wl_interface wl_surface_interface;
- /**
- * @page page_iface_wl_seat wl_seat
- * @section page_iface_wl_seat_desc Description
- *
- * A seat is a group of keyboards, pointer and touch devices. This
- * object is published as a global during start up, or when such a
- * device is hot plugged. A seat typically has a pointer and
- * maintains a keyboard focus and a pointer focus.
- * @section page_iface_wl_seat_api API
- * See @ref iface_wl_seat.
- */
- /**
- * @defgroup iface_wl_seat The wl_seat interface
- *
- * A seat is a group of keyboards, pointer and touch devices. This
- * object is published as a global during start up, or when such a
- * device is hot plugged. A seat typically has a pointer and
- * maintains a keyboard focus and a pointer focus.
- */
- extern const struct wl_interface wl_seat_interface;
- /**
- * @page page_iface_wl_pointer wl_pointer
- * @section page_iface_wl_pointer_desc Description
- *
- * The wl_pointer interface represents one or more input devices,
- * such as mice, which control the pointer location and pointer_focus
- * of a seat.
- *
- * The wl_pointer interface generates motion, enter and leave
- * events for the surfaces that the pointer is located over,
- * and button and axis events for button presses, button releases
- * and scrolling.
- * @section page_iface_wl_pointer_api API
- * See @ref iface_wl_pointer.
- */
- /**
- * @defgroup iface_wl_pointer The wl_pointer interface
- *
- * The wl_pointer interface represents one or more input devices,
- * such as mice, which control the pointer location and pointer_focus
- * of a seat.
- *
- * The wl_pointer interface generates motion, enter and leave
- * events for the surfaces that the pointer is located over,
- * and button and axis events for button presses, button releases
- * and scrolling.
- */
- extern const struct wl_interface wl_pointer_interface;
- /**
- * @page page_iface_wl_keyboard wl_keyboard
- * @section page_iface_wl_keyboard_desc Description
- *
- * The wl_keyboard interface represents one or more keyboards
- * associated with a seat.
- * @section page_iface_wl_keyboard_api API
- * See @ref iface_wl_keyboard.
- */
- /**
- * @defgroup iface_wl_keyboard The wl_keyboard interface
- *
- * The wl_keyboard interface represents one or more keyboards
- * associated with a seat.
- */
- extern const struct wl_interface wl_keyboard_interface;
- /**
- * @page page_iface_wl_touch wl_touch
- * @section page_iface_wl_touch_desc Description
- *
- * The wl_touch interface represents a touchscreen
- * associated with a seat.
- *
- * Touch interactions can consist of one or more contacts.
- * For each contact, a series of events is generated, starting
- * with a down event, followed by zero or more motion events,
- * and ending with an up event. Events relating to the same
- * contact point can be identified by the ID of the sequence.
- * @section page_iface_wl_touch_api API
- * See @ref iface_wl_touch.
- */
- /**
- * @defgroup iface_wl_touch The wl_touch interface
- *
- * The wl_touch interface represents a touchscreen
- * associated with a seat.
- *
- * Touch interactions can consist of one or more contacts.
- * For each contact, a series of events is generated, starting
- * with a down event, followed by zero or more motion events,
- * and ending with an up event. Events relating to the same
- * contact point can be identified by the ID of the sequence.
- */
- extern const struct wl_interface wl_touch_interface;
- /**
- * @page page_iface_wl_output wl_output
- * @section page_iface_wl_output_desc Description
- *
- * An output describes part of the compositor geometry. The
- * compositor works in the 'compositor coordinate system' and an
- * output corresponds to a rectangular area in that space that is
- * actually visible. This typically corresponds to a monitor that
- * displays part of the compositor space. This object is published
- * as global during start up, or when a monitor is hotplugged.
- * @section page_iface_wl_output_api API
- * See @ref iface_wl_output.
- */
- /**
- * @defgroup iface_wl_output The wl_output interface
- *
- * An output describes part of the compositor geometry. The
- * compositor works in the 'compositor coordinate system' and an
- * output corresponds to a rectangular area in that space that is
- * actually visible. This typically corresponds to a monitor that
- * displays part of the compositor space. This object is published
- * as global during start up, or when a monitor is hotplugged.
- */
- extern const struct wl_interface wl_output_interface;
- /**
- * @page page_iface_wl_region wl_region
- * @section page_iface_wl_region_desc Description
- *
- * A region object describes an area.
- *
- * Region objects are used to describe the opaque and input
- * regions of a surface.
- * @section page_iface_wl_region_api API
- * See @ref iface_wl_region.
- */
- /**
- * @defgroup iface_wl_region The wl_region interface
- *
- * A region object describes an area.
- *
- * Region objects are used to describe the opaque and input
- * regions of a surface.
- */
- extern const struct wl_interface wl_region_interface;
- /**
- * @page page_iface_wl_subcompositor wl_subcompositor
- * @section page_iface_wl_subcompositor_desc Description
- *
- * The global interface exposing sub-surface compositing capabilities.
- * A wl_surface, that has sub-surfaces associated, is called the
- * parent surface. Sub-surfaces can be arbitrarily nested and create
- * a tree of sub-surfaces.
- *
- * The root surface in a tree of sub-surfaces is the main
- * surface. The main surface cannot be a sub-surface, because
- * sub-surfaces must always have a parent.
- *
- * A main surface with its sub-surfaces forms a (compound) window.
- * For window management purposes, this set of wl_surface objects is
- * to be considered as a single window, and it should also behave as
- * such.
- *
- * The aim of sub-surfaces is to offload some of the compositing work
- * within a window from clients to the compositor. A prime example is
- * a video player with decorations and video in separate wl_surface
- * objects. This should allow the compositor to pass YUV video buffer
- * processing to dedicated overlay hardware when possible.
- * @section page_iface_wl_subcompositor_api API
- * See @ref iface_wl_subcompositor.
- */
- /**
- * @defgroup iface_wl_subcompositor The wl_subcompositor interface
- *
- * The global interface exposing sub-surface compositing capabilities.
- * A wl_surface, that has sub-surfaces associated, is called the
- * parent surface. Sub-surfaces can be arbitrarily nested and create
- * a tree of sub-surfaces.
- *
- * The root surface in a tree of sub-surfaces is the main
- * surface. The main surface cannot be a sub-surface, because
- * sub-surfaces must always have a parent.
- *
- * A main surface with its sub-surfaces forms a (compound) window.
- * For window management purposes, this set of wl_surface objects is
- * to be considered as a single window, and it should also behave as
- * such.
- *
- * The aim of sub-surfaces is to offload some of the compositing work
- * within a window from clients to the compositor. A prime example is
- * a video player with decorations and video in separate wl_surface
- * objects. This should allow the compositor to pass YUV video buffer
- * processing to dedicated overlay hardware when possible.
- */
- extern const struct wl_interface wl_subcompositor_interface;
- /**
- * @page page_iface_wl_subsurface wl_subsurface
- * @section page_iface_wl_subsurface_desc Description
- *
- * An additional interface to a wl_surface object, which has been
- * made a sub-surface. A sub-surface has one parent surface. A
- * sub-surface's size and position are not limited to that of the parent.
- * Particularly, a sub-surface is not automatically clipped to its
- * parent's area.
- *
- * A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
- * and the parent surface is mapped. The order of which one happens
- * first is irrelevant. A sub-surface is hidden if the parent becomes
- * hidden, or if a NULL wl_buffer is applied. These rules apply
- * recursively through the tree of surfaces.
- *
- * The behaviour of a wl_surface.commit request on a sub-surface
- * depends on the sub-surface's mode. The possible modes are
- * synchronized and desynchronized, see methods
- * wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
- * mode caches the wl_surface state to be applied when the parent's
- * state gets applied, and desynchronized mode applies the pending
- * wl_surface state directly. A sub-surface is initially in the
- * synchronized mode.
- *
- * Sub-surfaces have also other kind of state, which is managed by
- * wl_subsurface requests, as opposed to wl_surface requests. This
- * state includes the sub-surface position relative to the parent
- * surface (wl_subsurface.set_position), and the stacking order of
- * the parent and its sub-surfaces (wl_subsurface.place_above and
- * .place_below). This state is applied when the parent surface's
- * wl_surface state is applied, regardless of the sub-surface's mode.
- * As the exception, set_sync and set_desync are effective immediately.
- *
- * The main surface can be thought to be always in desynchronized mode,
- * since it does not have a parent in the sub-surfaces sense.
- *
- * Even if a sub-surface is in desynchronized mode, it will behave as
- * in synchronized mode, if its parent surface behaves as in
- * synchronized mode. This rule is applied recursively throughout the
- * tree of surfaces. This means, that one can set a sub-surface into
- * synchronized mode, and then assume that all its child and grand-child
- * sub-surfaces are synchronized, too, without explicitly setting them.
- *
- * If the wl_surface associated with the wl_subsurface is destroyed, the
- * wl_subsurface object becomes inert. Note, that destroying either object
- * takes effect immediately. If you need to synchronize the removal
- * of a sub-surface to the parent surface update, unmap the sub-surface
- * first by attaching a NULL wl_buffer, update parent, and then destroy
- * the sub-surface.
- *
- * If the parent wl_surface object is destroyed, the sub-surface is
- * unmapped.
- * @section page_iface_wl_subsurface_api API
- * See @ref iface_wl_subsurface.
- */
- /**
- * @defgroup iface_wl_subsurface The wl_subsurface interface
- *
- * An additional interface to a wl_surface object, which has been
- * made a sub-surface. A sub-surface has one parent surface. A
- * sub-surface's size and position are not limited to that of the parent.
- * Particularly, a sub-surface is not automatically clipped to its
- * parent's area.
- *
- * A sub-surface becomes mapped, when a non-NULL wl_buffer is applied
- * and the parent surface is mapped. The order of which one happens
- * first is irrelevant. A sub-surface is hidden if the parent becomes
- * hidden, or if a NULL wl_buffer is applied. These rules apply
- * recursively through the tree of surfaces.
- *
- * The behaviour of a wl_surface.commit request on a sub-surface
- * depends on the sub-surface's mode. The possible modes are
- * synchronized and desynchronized, see methods
- * wl_subsurface.set_sync and wl_subsurface.set_desync. Synchronized
- * mode caches the wl_surface state to be applied when the parent's
- * state gets applied, and desynchronized mode applies the pending
- * wl_surface state directly. A sub-surface is initially in the
- * synchronized mode.
- *
- * Sub-surfaces have also other kind of state, which is managed by
- * wl_subsurface requests, as opposed to wl_surface requests. This
- * state includes the sub-surface position relative to the parent
- * surface (wl_subsurface.set_position), and the stacking order of
- * the parent and its sub-surfaces (wl_subsurface.place_above and
- * .place_below). This state is applied when the parent surface's
- * wl_surface state is applied, regardless of the sub-surface's mode.
- * As the exception, set_sync and set_desync are effective immediately.
- *
- * The main surface can be thought to be always in desynchronized mode,
- * since it does not have a parent in the sub-surfaces sense.
- *
- * Even if a sub-surface is in desynchronized mode, it will behave as
- * in synchronized mode, if its parent surface behaves as in
- * synchronized mode. This rule is applied recursively throughout the
- * tree of surfaces. This means, that one can set a sub-surface into
- * synchronized mode, and then assume that all its child and grand-child
- * sub-surfaces are synchronized, too, without explicitly setting them.
- *
- * If the wl_surface associated with the wl_subsurface is destroyed, the
- * wl_subsurface object becomes inert. Note, that destroying either object
- * takes effect immediately. If you need to synchronize the removal
- * of a sub-surface to the parent surface update, unmap the sub-surface
- * first by attaching a NULL wl_buffer, update parent, and then destroy
- * the sub-surface.
- *
- * If the parent wl_surface object is destroyed, the sub-surface is
- * unmapped.
- */
- extern const struct wl_interface wl_subsurface_interface;
- #ifndef WL_DISPLAY_ERROR_ENUM
- #define WL_DISPLAY_ERROR_ENUM
- /**
- * @ingroup iface_wl_display
- * global error values
- *
- * These errors are global and can be emitted in response to any
- * server request.
- */
- enum wl_display_error {
- /**
- * server couldn't find object
- */
- WL_DISPLAY_ERROR_INVALID_OBJECT = 0,
- /**
- * method doesn't exist on the specified interface
- */
- WL_DISPLAY_ERROR_INVALID_METHOD = 1,
- /**
- * server is out of memory
- */
- WL_DISPLAY_ERROR_NO_MEMORY = 2,
- };
- #endif /* WL_DISPLAY_ERROR_ENUM */
- /**
- * @ingroup iface_wl_display
- * @struct wl_display_listener
- */
- struct wl_display_listener {
- /**
- * fatal error event
- *
- * The error event is sent out when a fatal (non-recoverable)
- * error has occurred. The object_id argument is the object where
- * the error occurred, most often in response to a request to that
- * object. The code identifies the error and is defined by the
- * object interface. As such, each interface defines its own set of
- * error codes. The message is a brief description of the error,
- * for (debugging) convenience.
- * @param object_id object where the error occurred
- * @param code error code
- * @param message error description
- */
- void (*error)(void *data,
- struct wl_display *wl_display,
- void *object_id,
- uint32_t code,
- const char *message);
- /**
- * acknowledge object ID deletion
- *
- * This event is used internally by the object ID management
- * logic. When a client deletes an object, the server will send
- * this event to acknowledge that it has seen the delete request.
- * When the client receives this event, it will know that it can
- * safely reuse the object ID.
- * @param id deleted object id
- */
- void (*delete_id)(void *data,
- struct wl_display *wl_display,
- uint32_t id);
- };
- /**
- * @ingroup wl_display_iface
- */
- static inline int
- wl_display_add_listener(struct wl_display *wl_display,
- const struct wl_display_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_display,
- (void (**)(void)) listener, data);
- }
- #define WL_DISPLAY_SYNC 0
- #define WL_DISPLAY_GET_REGISTRY 1
- /**
- * @ingroup iface_wl_display
- */
- #define WL_DISPLAY_SYNC_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_display
- */
- #define WL_DISPLAY_GET_REGISTRY_SINCE_VERSION 1
- /** @ingroup iface_wl_display */
- static inline void
- wl_display_set_user_data(struct wl_display *wl_display, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_display, user_data);
- }
- /** @ingroup iface_wl_display */
- static inline void *
- wl_display_get_user_data(struct wl_display *wl_display)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_display);
- }
- static inline uint32_t
- wl_display_get_version(struct wl_display *wl_display)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_display);
- }
- /**
- * @ingroup iface_wl_display
- *
- * The sync request asks the server to emit the 'done' event
- * on the returned wl_callback object. Since requests are
- * handled in-order and events are delivered in-order, this can
- * be used as a barrier to ensure all previous requests and the
- * resulting events have been handled.
- *
- * The object returned by this request will be destroyed by the
- * compositor after the callback is fired and as such the client must not
- * attempt to use it after that point.
- *
- * The callback_data passed in the callback is the event serial.
- */
- static inline struct wl_callback *
- wl_display_sync(struct wl_display *wl_display)
- {
- struct wl_proxy *callback;
- callback = wl_proxy_marshal_constructor((struct wl_proxy *) wl_display,
- WL_DISPLAY_SYNC, &wl_callback_interface, NULL);
- return (struct wl_callback *) callback;
- }
- /**
- * @ingroup iface_wl_display
- *
- * This request creates a registry object that allows the client
- * to list and bind the global objects available from the
- * compositor.
- */
- static inline struct wl_registry *
- wl_display_get_registry(struct wl_display *wl_display)
- {
- struct wl_proxy *registry;
- registry = wl_proxy_marshal_constructor((struct wl_proxy *) wl_display,
- WL_DISPLAY_GET_REGISTRY, &wl_registry_interface, NULL);
- return (struct wl_registry *) registry;
- }
- /**
- * @ingroup iface_wl_registry
- * @struct wl_registry_listener
- */
- struct wl_registry_listener {
- /**
- * announce global object
- *
- * Notify the client of global objects.
- *
- * The event notifies the client that a global object with the
- * given name is now available, and it implements the given version
- * of the given interface.
- * @param name numeric name of the global object
- * @param interface interface implemented by the object
- * @param version interface version
- */
- void (*global)(void *data,
- struct wl_registry *wl_registry,
- uint32_t name,
- const char *interface,
- uint32_t version);
- /**
- * announce removal of global object
- *
- * Notify the client of removed global objects.
- *
- * This event notifies the client that the global identified by
- * name is no longer available. If the client bound to the global
- * using the bind request, the client should now destroy that
- * object.
- *
- * The object remains valid and requests to the object will be
- * ignored until the client destroys it, to avoid races between the
- * global going away and a client sending a request to it.
- * @param name numeric name of the global object
- */
- void (*global_remove)(void *data,
- struct wl_registry *wl_registry,
- uint32_t name);
- };
- /**
- * @ingroup wl_registry_iface
- */
- static inline int
- wl_registry_add_listener(struct wl_registry *wl_registry,
- const struct wl_registry_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_registry,
- (void (**)(void)) listener, data);
- }
- #define WL_REGISTRY_BIND 0
- /**
- * @ingroup iface_wl_registry
- */
- #define WL_REGISTRY_BIND_SINCE_VERSION 1
- /** @ingroup iface_wl_registry */
- static inline void
- wl_registry_set_user_data(struct wl_registry *wl_registry, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_registry, user_data);
- }
- /** @ingroup iface_wl_registry */
- static inline void *
- wl_registry_get_user_data(struct wl_registry *wl_registry)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_registry);
- }
- static inline uint32_t
- wl_registry_get_version(struct wl_registry *wl_registry)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_registry);
- }
- /** @ingroup iface_wl_registry */
- static inline void
- wl_registry_destroy(struct wl_registry *wl_registry)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_registry);
- }
- /**
- * @ingroup iface_wl_registry
- *
- * Binds a new, client-created object to the server using the
- * specified name as the identifier.
- */
- static inline void *
- wl_registry_bind(struct wl_registry *wl_registry, uint32_t name, const struct wl_interface *interface, uint32_t version)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor_versioned((struct wl_proxy *) wl_registry,
- WL_REGISTRY_BIND, interface, version, name, interface->name, version, NULL);
- return (void *) id;
- }
- /**
- * @ingroup iface_wl_callback
- * @struct wl_callback_listener
- */
- struct wl_callback_listener {
- /**
- * done event
- *
- * Notify the client when the related request is done.
- * @param callback_data request-specific data for the wl_callback
- */
- void (*done)(void *data,
- struct wl_callback *wl_callback,
- uint32_t callback_data);
- };
- /**
- * @ingroup wl_callback_iface
- */
- static inline int
- wl_callback_add_listener(struct wl_callback *wl_callback,
- const struct wl_callback_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_callback,
- (void (**)(void)) listener, data);
- }
- /** @ingroup iface_wl_callback */
- static inline void
- wl_callback_set_user_data(struct wl_callback *wl_callback, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_callback, user_data);
- }
- /** @ingroup iface_wl_callback */
- static inline void *
- wl_callback_get_user_data(struct wl_callback *wl_callback)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_callback);
- }
- static inline uint32_t
- wl_callback_get_version(struct wl_callback *wl_callback)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_callback);
- }
- /** @ingroup iface_wl_callback */
- static inline void
- wl_callback_destroy(struct wl_callback *wl_callback)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_callback);
- }
- #define WL_COMPOSITOR_CREATE_SURFACE 0
- #define WL_COMPOSITOR_CREATE_REGION 1
- /**
- * @ingroup iface_wl_compositor
- */
- #define WL_COMPOSITOR_CREATE_SURFACE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_compositor
- */
- #define WL_COMPOSITOR_CREATE_REGION_SINCE_VERSION 1
- /** @ingroup iface_wl_compositor */
- static inline void
- wl_compositor_set_user_data(struct wl_compositor *wl_compositor, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_compositor, user_data);
- }
- /** @ingroup iface_wl_compositor */
- static inline void *
- wl_compositor_get_user_data(struct wl_compositor *wl_compositor)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_compositor);
- }
- static inline uint32_t
- wl_compositor_get_version(struct wl_compositor *wl_compositor)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_compositor);
- }
- /** @ingroup iface_wl_compositor */
- static inline void
- wl_compositor_destroy(struct wl_compositor *wl_compositor)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_compositor);
- }
- /**
- * @ingroup iface_wl_compositor
- *
- * Ask the compositor to create a new surface.
- */
- static inline struct wl_surface *
- wl_compositor_create_surface(struct wl_compositor *wl_compositor)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_compositor,
- WL_COMPOSITOR_CREATE_SURFACE, &wl_surface_interface, NULL);
- return (struct wl_surface *) id;
- }
- /**
- * @ingroup iface_wl_compositor
- *
- * Ask the compositor to create a new region.
- */
- static inline struct wl_region *
- wl_compositor_create_region(struct wl_compositor *wl_compositor)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_compositor,
- WL_COMPOSITOR_CREATE_REGION, &wl_region_interface, NULL);
- return (struct wl_region *) id;
- }
- #define WL_SHM_POOL_CREATE_BUFFER 0
- #define WL_SHM_POOL_DESTROY 1
- #define WL_SHM_POOL_RESIZE 2
- /**
- * @ingroup iface_wl_shm_pool
- */
- #define WL_SHM_POOL_CREATE_BUFFER_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shm_pool
- */
- #define WL_SHM_POOL_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shm_pool
- */
- #define WL_SHM_POOL_RESIZE_SINCE_VERSION 1
- /** @ingroup iface_wl_shm_pool */
- static inline void
- wl_shm_pool_set_user_data(struct wl_shm_pool *wl_shm_pool, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_shm_pool, user_data);
- }
- /** @ingroup iface_wl_shm_pool */
- static inline void *
- wl_shm_pool_get_user_data(struct wl_shm_pool *wl_shm_pool)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_shm_pool);
- }
- static inline uint32_t
- wl_shm_pool_get_version(struct wl_shm_pool *wl_shm_pool)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_shm_pool);
- }
- /**
- * @ingroup iface_wl_shm_pool
- *
- * Create a wl_buffer object from the pool.
- *
- * The buffer is created offset bytes into the pool and has
- * width and height as specified. The stride argument specifies
- * the number of bytes from the beginning of one row to the beginning
- * of the next. The format is the pixel format of the buffer and
- * must be one of those advertised through the wl_shm.format event.
- *
- * A buffer will keep a reference to the pool it was created from
- * so it is valid to destroy the pool immediately after creating
- * a buffer from it.
- */
- static inline struct wl_buffer *
- wl_shm_pool_create_buffer(struct wl_shm_pool *wl_shm_pool, int32_t offset, int32_t width, int32_t height, int32_t stride, uint32_t format)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shm_pool,
- WL_SHM_POOL_CREATE_BUFFER, &wl_buffer_interface, NULL, offset, width, height, stride, format);
- return (struct wl_buffer *) id;
- }
- /**
- * @ingroup iface_wl_shm_pool
- *
- * Destroy the shared memory pool.
- *
- * The mmapped memory will be released when all
- * buffers that have been created from this pool
- * are gone.
- */
- static inline void
- wl_shm_pool_destroy(struct wl_shm_pool *wl_shm_pool)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shm_pool,
- WL_SHM_POOL_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_shm_pool);
- }
- /**
- * @ingroup iface_wl_shm_pool
- *
- * This request will cause the server to remap the backing memory
- * for the pool from the file descriptor passed when the pool was
- * created, but using the new size. This request can only be
- * used to make the pool bigger.
- */
- static inline void
- wl_shm_pool_resize(struct wl_shm_pool *wl_shm_pool, int32_t size)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shm_pool,
- WL_SHM_POOL_RESIZE, size);
- }
- #ifndef WL_SHM_ERROR_ENUM
- #define WL_SHM_ERROR_ENUM
- /**
- * @ingroup iface_wl_shm
- * wl_shm error values
- *
- * These errors can be emitted in response to wl_shm requests.
- */
- enum wl_shm_error {
- /**
- * buffer format is not known
- */
- WL_SHM_ERROR_INVALID_FORMAT = 0,
- /**
- * invalid size or stride during pool or buffer creation
- */
- WL_SHM_ERROR_INVALID_STRIDE = 1,
- /**
- * mmapping the file descriptor failed
- */
- WL_SHM_ERROR_INVALID_FD = 2,
- };
- #endif /* WL_SHM_ERROR_ENUM */
- #ifndef WL_SHM_FORMAT_ENUM
- #define WL_SHM_FORMAT_ENUM
- /**
- * @ingroup iface_wl_shm
- * pixel formats
- *
- * This describes the memory layout of an individual pixel.
- *
- * All renderers should support argb8888 and xrgb8888 but any other
- * formats are optional and may not be supported by the particular
- * renderer in use.
- */
- enum wl_shm_format {
- /**
- * 32-bit ARGB format
- */
- WL_SHM_FORMAT_ARGB8888 = 0,
- /**
- * 32-bit RGB format
- */
- WL_SHM_FORMAT_XRGB8888 = 1,
- WL_SHM_FORMAT_C8 = 0x20203843,
- WL_SHM_FORMAT_RGB332 = 0x38424752,
- WL_SHM_FORMAT_BGR233 = 0x38524742,
- WL_SHM_FORMAT_XRGB4444 = 0x32315258,
- WL_SHM_FORMAT_XBGR4444 = 0x32314258,
- WL_SHM_FORMAT_RGBX4444 = 0x32315852,
- WL_SHM_FORMAT_BGRX4444 = 0x32315842,
- WL_SHM_FORMAT_ARGB4444 = 0x32315241,
- WL_SHM_FORMAT_ABGR4444 = 0x32314241,
- WL_SHM_FORMAT_RGBA4444 = 0x32314152,
- WL_SHM_FORMAT_BGRA4444 = 0x32314142,
- WL_SHM_FORMAT_XRGB1555 = 0x35315258,
- WL_SHM_FORMAT_XBGR1555 = 0x35314258,
- WL_SHM_FORMAT_RGBX5551 = 0x35315852,
- WL_SHM_FORMAT_BGRX5551 = 0x35315842,
- WL_SHM_FORMAT_ARGB1555 = 0x35315241,
- WL_SHM_FORMAT_ABGR1555 = 0x35314241,
- WL_SHM_FORMAT_RGBA5551 = 0x35314152,
- WL_SHM_FORMAT_BGRA5551 = 0x35314142,
- WL_SHM_FORMAT_RGB565 = 0x36314752,
- WL_SHM_FORMAT_BGR565 = 0x36314742,
- WL_SHM_FORMAT_RGB888 = 0x34324752,
- WL_SHM_FORMAT_BGR888 = 0x34324742,
- WL_SHM_FORMAT_XBGR8888 = 0x34324258,
- WL_SHM_FORMAT_RGBX8888 = 0x34325852,
- WL_SHM_FORMAT_BGRX8888 = 0x34325842,
- WL_SHM_FORMAT_ABGR8888 = 0x34324241,
- WL_SHM_FORMAT_RGBA8888 = 0x34324152,
- WL_SHM_FORMAT_BGRA8888 = 0x34324142,
- WL_SHM_FORMAT_XRGB2101010 = 0x30335258,
- WL_SHM_FORMAT_XBGR2101010 = 0x30334258,
- WL_SHM_FORMAT_RGBX1010102 = 0x30335852,
- WL_SHM_FORMAT_BGRX1010102 = 0x30335842,
- WL_SHM_FORMAT_ARGB2101010 = 0x30335241,
- WL_SHM_FORMAT_ABGR2101010 = 0x30334241,
- WL_SHM_FORMAT_RGBA1010102 = 0x30334152,
- WL_SHM_FORMAT_BGRA1010102 = 0x30334142,
- WL_SHM_FORMAT_YUYV = 0x56595559,
- WL_SHM_FORMAT_YVYU = 0x55595659,
- WL_SHM_FORMAT_UYVY = 0x59565955,
- WL_SHM_FORMAT_VYUY = 0x59555956,
- WL_SHM_FORMAT_AYUV = 0x56555941,
- WL_SHM_FORMAT_NV12 = 0x3231564e,
- WL_SHM_FORMAT_NV21 = 0x3132564e,
- WL_SHM_FORMAT_NV16 = 0x3631564e,
- WL_SHM_FORMAT_NV61 = 0x3136564e,
- WL_SHM_FORMAT_YUV410 = 0x39565559,
- WL_SHM_FORMAT_YVU410 = 0x39555659,
- WL_SHM_FORMAT_YUV411 = 0x31315559,
- WL_SHM_FORMAT_YVU411 = 0x31315659,
- WL_SHM_FORMAT_YUV420 = 0x32315559,
- WL_SHM_FORMAT_YVU420 = 0x32315659,
- WL_SHM_FORMAT_YUV422 = 0x36315559,
- WL_SHM_FORMAT_YVU422 = 0x36315659,
- WL_SHM_FORMAT_YUV444 = 0x34325559,
- WL_SHM_FORMAT_YVU444 = 0x34325659,
- };
- #endif /* WL_SHM_FORMAT_ENUM */
- /**
- * @ingroup iface_wl_shm
- * @struct wl_shm_listener
- */
- struct wl_shm_listener {
- /**
- * pixel format description
- *
- * Informs the client about a valid pixel format that can be used
- * for buffers. Known formats include argb8888 and xrgb8888.
- * @param format buffer pixel format
- */
- void (*format)(void *data,
- struct wl_shm *wl_shm,
- uint32_t format);
- };
- /**
- * @ingroup wl_shm_iface
- */
- static inline int
- wl_shm_add_listener(struct wl_shm *wl_shm,
- const struct wl_shm_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_shm,
- (void (**)(void)) listener, data);
- }
- #define WL_SHM_CREATE_POOL 0
- /**
- * @ingroup iface_wl_shm
- */
- #define WL_SHM_CREATE_POOL_SINCE_VERSION 1
- /** @ingroup iface_wl_shm */
- static inline void
- wl_shm_set_user_data(struct wl_shm *wl_shm, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_shm, user_data);
- }
- /** @ingroup iface_wl_shm */
- static inline void *
- wl_shm_get_user_data(struct wl_shm *wl_shm)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_shm);
- }
- static inline uint32_t
- wl_shm_get_version(struct wl_shm *wl_shm)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_shm);
- }
- /** @ingroup iface_wl_shm */
- static inline void
- wl_shm_destroy(struct wl_shm *wl_shm)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_shm);
- }
- /**
- * @ingroup iface_wl_shm
- *
- * Create a new wl_shm_pool object.
- *
- * The pool can be used to create shared memory based buffer
- * objects. The server will mmap size bytes of the passed file
- * descriptor, to use as backing memory for the pool.
- */
- static inline struct wl_shm_pool *
- wl_shm_create_pool(struct wl_shm *wl_shm, int32_t fd, int32_t size)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shm,
- WL_SHM_CREATE_POOL, &wl_shm_pool_interface, NULL, fd, size);
- return (struct wl_shm_pool *) id;
- }
- /**
- * @ingroup iface_wl_buffer
- * @struct wl_buffer_listener
- */
- struct wl_buffer_listener {
- /**
- * compositor releases buffer
- *
- * Sent when this wl_buffer is no longer used by the compositor.
- * The client is now free to reuse or destroy this buffer and its
- * backing storage.
- *
- * If a client receives a release event before the frame callback
- * requested in the same wl_surface.commit that attaches this
- * wl_buffer to a surface, then the client is immediately free to
- * reuse the buffer and its backing storage, and does not need a
- * second buffer for the next surface content update. Typically
- * this is possible, when the compositor maintains a copy of the
- * wl_surface contents, e.g. as a GL texture. This is an important
- * optimization for GL(ES) compositors with wl_shm clients.
- */
- void (*release)(void *data,
- struct wl_buffer *wl_buffer);
- };
- /**
- * @ingroup wl_buffer_iface
- */
- static inline int
- wl_buffer_add_listener(struct wl_buffer *wl_buffer,
- const struct wl_buffer_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_buffer,
- (void (**)(void)) listener, data);
- }
- #define WL_BUFFER_DESTROY 0
- /**
- * @ingroup iface_wl_buffer
- */
- #define WL_BUFFER_DESTROY_SINCE_VERSION 1
- /** @ingroup iface_wl_buffer */
- static inline void
- wl_buffer_set_user_data(struct wl_buffer *wl_buffer, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_buffer, user_data);
- }
- /** @ingroup iface_wl_buffer */
- static inline void *
- wl_buffer_get_user_data(struct wl_buffer *wl_buffer)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_buffer);
- }
- static inline uint32_t
- wl_buffer_get_version(struct wl_buffer *wl_buffer)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_buffer);
- }
- /**
- * @ingroup iface_wl_buffer
- *
- * Destroy a buffer. If and how you need to release the backing
- * storage is defined by the buffer factory interface.
- *
- * For possible side-effects to a surface, see wl_surface.attach.
- */
- static inline void
- wl_buffer_destroy(struct wl_buffer *wl_buffer)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_buffer,
- WL_BUFFER_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_buffer);
- }
- #ifndef WL_DATA_OFFER_ERROR_ENUM
- #define WL_DATA_OFFER_ERROR_ENUM
- enum wl_data_offer_error {
- /**
- * finish request was called untimely
- */
- WL_DATA_OFFER_ERROR_INVALID_FINISH = 0,
- /**
- * action mask contains invalid values
- */
- WL_DATA_OFFER_ERROR_INVALID_ACTION_MASK = 1,
- /**
- * action argument has an invalid value
- */
- WL_DATA_OFFER_ERROR_INVALID_ACTION = 2,
- /**
- * offer doesn't accept this request
- */
- WL_DATA_OFFER_ERROR_INVALID_OFFER = 3,
- };
- #endif /* WL_DATA_OFFER_ERROR_ENUM */
- /**
- * @ingroup iface_wl_data_offer
- * @struct wl_data_offer_listener
- */
- struct wl_data_offer_listener {
- /**
- * advertise offered mime type
- *
- * Sent immediately after creating the wl_data_offer object. One
- * event per offered mime type.
- * @param mime_type offered mime type
- */
- void (*offer)(void *data,
- struct wl_data_offer *wl_data_offer,
- const char *mime_type);
- /**
- * notify the source-side available actions
- *
- * This event indicates the actions offered by the data source.
- * It will be sent right after wl_data_device.enter, or anytime the
- * source side changes its offered actions through
- * wl_data_source.set_actions.
- * @param source_actions actions offered by the data source
- * @since 3
- */
- void (*source_actions)(void *data,
- struct wl_data_offer *wl_data_offer,
- uint32_t source_actions);
- /**
- * notify the selected action
- *
- * This event indicates the action selected by the compositor
- * after matching the source/destination side actions. Only one
- * action (or none) will be offered here.
- *
- * This event can be emitted multiple times during the
- * drag-and-drop operation in response to destination side action
- * changes through wl_data_offer.set_actions.
- *
- * This event will no longer be emitted after wl_data_device.drop
- * happened on the drag-and-drop destination, the client must honor
- * the last action received, or the last preferred one set through
- * wl_data_offer.set_actions when handling an "ask" action.
- *
- * Compositors may also change the selected action on the fly,
- * mainly in response to keyboard modifier changes during the
- * drag-and-drop operation.
- *
- * The most recent action received is always the valid one. Prior
- * to receiving wl_data_device.drop, the chosen action may change
- * (e.g. due to keyboard modifiers being pressed). At the time of
- * receiving wl_data_device.drop the drag-and-drop destination must
- * honor the last action received.
- *
- * Action changes may still happen after wl_data_device.drop,
- * especially on "ask" actions, where the drag-and-drop destination
- * may choose another action afterwards. Action changes happening
- * at this stage are always the result of inter-client negotiation,
- * the compositor shall no longer be able to induce a different
- * action.
- *
- * Upon "ask" actions, it is expected that the drag-and-drop
- * destination may potentially choose a different action and/or
- * mime type, based on wl_data_offer.source_actions and finally
- * chosen by the user (e.g. popping up a menu with the available
- * options). The final wl_data_offer.set_actions and
- * wl_data_offer.accept requests must happen before the call to
- * wl_data_offer.finish.
- * @param dnd_action action selected by the compositor
- * @since 3
- */
- void (*action)(void *data,
- struct wl_data_offer *wl_data_offer,
- uint32_t dnd_action);
- };
- /**
- * @ingroup wl_data_offer_iface
- */
- static inline int
- wl_data_offer_add_listener(struct wl_data_offer *wl_data_offer,
- const struct wl_data_offer_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_data_offer,
- (void (**)(void)) listener, data);
- }
- #define WL_DATA_OFFER_ACCEPT 0
- #define WL_DATA_OFFER_RECEIVE 1
- #define WL_DATA_OFFER_DESTROY 2
- #define WL_DATA_OFFER_FINISH 3
- #define WL_DATA_OFFER_SET_ACTIONS 4
- /**
- * @ingroup iface_wl_data_offer
- */
- #define WL_DATA_OFFER_ACCEPT_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_offer
- */
- #define WL_DATA_OFFER_RECEIVE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_offer
- */
- #define WL_DATA_OFFER_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_offer
- */
- #define WL_DATA_OFFER_FINISH_SINCE_VERSION 3
- /**
- * @ingroup iface_wl_data_offer
- */
- #define WL_DATA_OFFER_SET_ACTIONS_SINCE_VERSION 3
- /** @ingroup iface_wl_data_offer */
- static inline void
- wl_data_offer_set_user_data(struct wl_data_offer *wl_data_offer, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_data_offer, user_data);
- }
- /** @ingroup iface_wl_data_offer */
- static inline void *
- wl_data_offer_get_user_data(struct wl_data_offer *wl_data_offer)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_data_offer);
- }
- static inline uint32_t
- wl_data_offer_get_version(struct wl_data_offer *wl_data_offer)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_data_offer);
- }
- /**
- * @ingroup iface_wl_data_offer
- *
- * Indicate that the client can accept the given mime type, or
- * NULL for not accepted.
- *
- * For objects of version 2 or older, this request is used by the
- * client to give feedback whether the client can receive the given
- * mime type, or NULL if none is accepted; the feedback does not
- * determine whether the drag-and-drop operation succeeds or not.
- *
- * For objects of version 3 or newer, this request determines the
- * final result of the drag-and-drop operation. If the end result
- * is that no mime types were accepted, the drag-and-drop operation
- * will be cancelled and the corresponding drag source will receive
- * wl_data_source.cancelled. Clients may still use this event in
- * conjunction with wl_data_source.action for feedback.
- */
- static inline void
- wl_data_offer_accept(struct wl_data_offer *wl_data_offer, uint32_t serial, const char *mime_type)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
- WL_DATA_OFFER_ACCEPT, serial, mime_type);
- }
- /**
- * @ingroup iface_wl_data_offer
- *
- * To transfer the offered data, the client issues this request
- * and indicates the mime type it wants to receive. The transfer
- * happens through the passed file descriptor (typically created
- * with the pipe system call). The source client writes the data
- * in the mime type representation requested and then closes the
- * file descriptor.
- *
- * The receiving client reads from the read end of the pipe until
- * EOF and then closes its end, at which point the transfer is
- * complete.
- *
- * This request may happen multiple times for different mime types,
- * both before and after wl_data_device.drop. Drag-and-drop destination
- * clients may preemptively fetch data or examine it more closely to
- * determine acceptance.
- */
- static inline void
- wl_data_offer_receive(struct wl_data_offer *wl_data_offer, const char *mime_type, int32_t fd)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
- WL_DATA_OFFER_RECEIVE, mime_type, fd);
- }
- /**
- * @ingroup iface_wl_data_offer
- *
- * Destroy the data offer.
- */
- static inline void
- wl_data_offer_destroy(struct wl_data_offer *wl_data_offer)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
- WL_DATA_OFFER_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_data_offer);
- }
- /**
- * @ingroup iface_wl_data_offer
- *
- * Notifies the compositor that the drag destination successfully
- * finished the drag-and-drop operation.
- *
- * Upon receiving this request, the compositor will emit
- * wl_data_source.dnd_finished on the drag source client.
- *
- * It is a client error to perform other requests than
- * wl_data_offer.destroy after this one. It is also an error to perform
- * this request after a NULL mime type has been set in
- * wl_data_offer.accept or no action was received through
- * wl_data_offer.action.
- */
- static inline void
- wl_data_offer_finish(struct wl_data_offer *wl_data_offer)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
- WL_DATA_OFFER_FINISH);
- }
- /**
- * @ingroup iface_wl_data_offer
- *
- * Sets the actions that the destination side client supports for
- * this operation. This request may trigger the emission of
- * wl_data_source.action and wl_data_offer.action events if the compositor
- * needs to change the selected action.
- *
- * This request can be called multiple times throughout the
- * drag-and-drop operation, typically in response to wl_data_device.enter
- * or wl_data_device.motion events.
- *
- * This request determines the final result of the drag-and-drop
- * operation. If the end result is that no action is accepted,
- * the drag source will receive wl_drag_source.cancelled.
- *
- * The dnd_actions argument must contain only values expressed in the
- * wl_data_device_manager.dnd_actions enum, and the preferred_action
- * argument must only contain one of those values set, otherwise it
- * will result in a protocol error.
- *
- * While managing an "ask" action, the destination drag-and-drop client
- * may perform further wl_data_offer.receive requests, and is expected
- * to perform one last wl_data_offer.set_actions request with a preferred
- * action other than "ask" (and optionally wl_data_offer.accept) before
- * requesting wl_data_offer.finish, in order to convey the action selected
- * by the user. If the preferred action is not in the
- * wl_data_offer.source_actions mask, an error will be raised.
- *
- * If the "ask" action is dismissed (e.g. user cancellation), the client
- * is expected to perform wl_data_offer.destroy right away.
- *
- * This request can only be made on drag-and-drop offers, a protocol error
- * will be raised otherwise.
- */
- static inline void
- wl_data_offer_set_actions(struct wl_data_offer *wl_data_offer, uint32_t dnd_actions, uint32_t preferred_action)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_offer,
- WL_DATA_OFFER_SET_ACTIONS, dnd_actions, preferred_action);
- }
- #ifndef WL_DATA_SOURCE_ERROR_ENUM
- #define WL_DATA_SOURCE_ERROR_ENUM
- enum wl_data_source_error {
- /**
- * action mask contains invalid values
- */
- WL_DATA_SOURCE_ERROR_INVALID_ACTION_MASK = 0,
- /**
- * source doesn't accept this request
- */
- WL_DATA_SOURCE_ERROR_INVALID_SOURCE = 1,
- };
- #endif /* WL_DATA_SOURCE_ERROR_ENUM */
- /**
- * @ingroup iface_wl_data_source
- * @struct wl_data_source_listener
- */
- struct wl_data_source_listener {
- /**
- * a target accepts an offered mime type
- *
- * Sent when a target accepts pointer_focus or motion events. If
- * a target does not accept any of the offered types, type is NULL.
- *
- * Used for feedback during drag-and-drop.
- * @param mime_type mime type accepted by the target
- */
- void (*target)(void *data,
- struct wl_data_source *wl_data_source,
- const char *mime_type);
- /**
- * send the data
- *
- * Request for data from the client. Send the data as the
- * specified mime type over the passed file descriptor, then close
- * it.
- * @param mime_type mime type for the data
- * @param fd file descriptor for the data
- */
- void (*send)(void *data,
- struct wl_data_source *wl_data_source,
- const char *mime_type,
- int32_t fd);
- /**
- * selection was cancelled
- *
- * This data source is no longer valid. There are several reasons
- * why this could happen:
- *
- * - The data source has been replaced by another data source. -
- * The drag-and-drop operation was performed, but the drop
- * destination did not accept any of the mime types offered through
- * wl_data_source.target. - The drag-and-drop operation was
- * performed, but the drop destination did not select any of the
- * actions present in the mask offered through
- * wl_data_source.action. - The drag-and-drop operation was
- * performed but didn't happen over a surface. - The compositor
- * cancelled the drag-and-drop operation (e.g. compositor dependent
- * timeouts to avoid stale drag-and-drop transfers).
- *
- * The client should clean up and destroy this data source.
- *
- * For objects of version 2 or older, wl_data_source.cancelled will
- * only be emitted if the data source was replaced by another data
- * source.
- */
- void (*cancelled)(void *data,
- struct wl_data_source *wl_data_source);
- /**
- * the drag-and-drop operation physically finished
- *
- * The user performed the drop action. This event does not
- * indicate acceptance, wl_data_source.cancelled may still be
- * emitted afterwards if the drop destination does not accept any
- * mime type.
- *
- * However, this event might however not be received if the
- * compositor cancelled the drag-and-drop operation before this
- * event could happen.
- *
- * Note that the data_source may still be used in the future and
- * should not be destroyed here.
- * @since 3
- */
- void (*dnd_drop_performed)(void *data,
- struct wl_data_source *wl_data_source);
- /**
- * the drag-and-drop operation concluded
- *
- * The drop destination finished interoperating with this data
- * source, so the client is now free to destroy this data source
- * and free all associated data.
- *
- * If the action used to perform the operation was "move", the
- * source can now delete the transferred data.
- * @since 3
- */
- void (*dnd_finished)(void *data,
- struct wl_data_source *wl_data_source);
- /**
- * notify the selected action
- *
- * This event indicates the action selected by the compositor
- * after matching the source/destination side actions. Only one
- * action (or none) will be offered here.
- *
- * This event can be emitted multiple times during the
- * drag-and-drop operation, mainly in response to destination side
- * changes through wl_data_offer.set_actions, and as the data
- * device enters/leaves surfaces.
- *
- * It is only possible to receive this event after
- * wl_data_source.dnd_drop_performed if the drag-and-drop operation
- * ended in an "ask" action, in which case the final
- * wl_data_source.action event will happen immediately before
- * wl_data_source.dnd_finished.
- *
- * Compositors may also change the selected action on the fly,
- * mainly in response to keyboard modifier changes during the
- * drag-and-drop operation.
- *
- * The most recent action received is always the valid one. The
- * chosen action may change alongside negotiation (e.g. an "ask"
- * action can turn into a "move" operation), so the effects of the
- * final action must always be applied in
- * wl_data_offer.dnd_finished.
- *
- * Clients can trigger cursor surface changes from this point, so
- * they reflect the current action.
- * @param dnd_action action selected by the compositor
- * @since 3
- */
- void (*action)(void *data,
- struct wl_data_source *wl_data_source,
- uint32_t dnd_action);
- };
- /**
- * @ingroup wl_data_source_iface
- */
- static inline int
- wl_data_source_add_listener(struct wl_data_source *wl_data_source,
- const struct wl_data_source_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_data_source,
- (void (**)(void)) listener, data);
- }
- #define WL_DATA_SOURCE_OFFER 0
- #define WL_DATA_SOURCE_DESTROY 1
- #define WL_DATA_SOURCE_SET_ACTIONS 2
- /**
- * @ingroup iface_wl_data_source
- */
- #define WL_DATA_SOURCE_OFFER_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_source
- */
- #define WL_DATA_SOURCE_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_source
- */
- #define WL_DATA_SOURCE_SET_ACTIONS_SINCE_VERSION 3
- /** @ingroup iface_wl_data_source */
- static inline void
- wl_data_source_set_user_data(struct wl_data_source *wl_data_source, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_data_source, user_data);
- }
- /** @ingroup iface_wl_data_source */
- static inline void *
- wl_data_source_get_user_data(struct wl_data_source *wl_data_source)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_data_source);
- }
- static inline uint32_t
- wl_data_source_get_version(struct wl_data_source *wl_data_source)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_data_source);
- }
- /**
- * @ingroup iface_wl_data_source
- *
- * This request adds a mime type to the set of mime types
- * advertised to targets. Can be called several times to offer
- * multiple types.
- */
- static inline void
- wl_data_source_offer(struct wl_data_source *wl_data_source, const char *mime_type)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_source,
- WL_DATA_SOURCE_OFFER, mime_type);
- }
- /**
- * @ingroup iface_wl_data_source
- *
- * Destroy the data source.
- */
- static inline void
- wl_data_source_destroy(struct wl_data_source *wl_data_source)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_source,
- WL_DATA_SOURCE_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_data_source);
- }
- /**
- * @ingroup iface_wl_data_source
- *
- * Sets the actions that the source side client supports for this
- * operation. This request may trigger wl_data_source.action and
- * wl_data_offer.action events if the compositor needs to change the
- * selected action.
- *
- * The dnd_actions argument must contain only values expressed in the
- * wl_data_device_manager.dnd_actions enum, otherwise it will result
- * in a protocol error.
- *
- * This request must be made once only, and can only be made on sources
- * used in drag-and-drop, so it must be performed before
- * wl_data_device.start_drag. Attempting to use the source other than
- * for drag-and-drop will raise a protocol error.
- */
- static inline void
- wl_data_source_set_actions(struct wl_data_source *wl_data_source, uint32_t dnd_actions)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_source,
- WL_DATA_SOURCE_SET_ACTIONS, dnd_actions);
- }
- #ifndef WL_DATA_DEVICE_ERROR_ENUM
- #define WL_DATA_DEVICE_ERROR_ENUM
- enum wl_data_device_error {
- /**
- * given wl_surface has another role
- */
- WL_DATA_DEVICE_ERROR_ROLE = 0,
- };
- #endif /* WL_DATA_DEVICE_ERROR_ENUM */
- /**
- * @ingroup iface_wl_data_device
- * @struct wl_data_device_listener
- */
- struct wl_data_device_listener {
- /**
- * introduce a new wl_data_offer
- *
- * The data_offer event introduces a new wl_data_offer object,
- * which will subsequently be used in either the data_device.enter
- * event (for drag-and-drop) or the data_device.selection event
- * (for selections). Immediately following the
- * data_device_data_offer event, the new data_offer object will
- * send out data_offer.offer events to describe the mime types it
- * offers.
- * @param id the new data_offer object
- */
- void (*data_offer)(void *data,
- struct wl_data_device *wl_data_device,
- struct wl_data_offer *id);
- /**
- * initiate drag-and-drop session
- *
- * This event is sent when an active drag-and-drop pointer enters
- * a surface owned by the client. The position of the pointer at
- * enter time is provided by the x and y arguments, in
- * surface-local coordinates.
- * @param serial serial number of the enter event
- * @param surface client surface entered
- * @param x surface-local x coordinate
- * @param y surface-local y coordinate
- * @param id source data_offer object
- */
- void (*enter)(void *data,
- struct wl_data_device *wl_data_device,
- uint32_t serial,
- struct wl_surface *surface,
- wl_fixed_t x,
- wl_fixed_t y,
- struct wl_data_offer *id);
- /**
- * end drag-and-drop session
- *
- * This event is sent when the drag-and-drop pointer leaves the
- * surface and the session ends. The client must destroy the
- * wl_data_offer introduced at enter time at this point.
- */
- void (*leave)(void *data,
- struct wl_data_device *wl_data_device);
- /**
- * drag-and-drop session motion
- *
- * This event is sent when the drag-and-drop pointer moves within
- * the currently focused surface. The new position of the pointer
- * is provided by the x and y arguments, in surface-local
- * coordinates.
- * @param time timestamp with millisecond granularity
- * @param x surface-local x coordinate
- * @param y surface-local y coordinate
- */
- void (*motion)(void *data,
- struct wl_data_device *wl_data_device,
- uint32_t time,
- wl_fixed_t x,
- wl_fixed_t y);
- /**
- * end drag-and-drop session successfully
- *
- * The event is sent when a drag-and-drop operation is ended
- * because the implicit grab is removed.
- *
- * The drag-and-drop destination is expected to honor the last
- * action received through wl_data_offer.action, if the resulting
- * action is "copy" or "move", the destination can still perform
- * wl_data_offer.receive requests, and is expected to end all
- * transfers with a wl_data_offer.finish request.
- *
- * If the resulting action is "ask", the action will not be
- * considered final. The drag-and-drop destination is expected to
- * perform one last wl_data_offer.set_actions request, or
- * wl_data_offer.destroy in order to cancel the operation.
- */
- void (*drop)(void *data,
- struct wl_data_device *wl_data_device);
- /**
- * advertise new selection
- *
- * The selection event is sent out to notify the client of a new
- * wl_data_offer for the selection for this device. The
- * data_device.data_offer and the data_offer.offer events are sent
- * out immediately before this event to introduce the data offer
- * object. The selection event is sent to a client immediately
- * before receiving keyboard focus and when a new selection is set
- * while the client has keyboard focus. The data_offer is valid
- * until a new data_offer or NULL is received or until the client
- * loses keyboard focus. The client must destroy the previous
- * selection data_offer, if any, upon receiving this event.
- * @param id selection data_offer object
- */
- void (*selection)(void *data,
- struct wl_data_device *wl_data_device,
- struct wl_data_offer *id);
- };
- /**
- * @ingroup wl_data_device_iface
- */
- static inline int
- wl_data_device_add_listener(struct wl_data_device *wl_data_device,
- const struct wl_data_device_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_data_device,
- (void (**)(void)) listener, data);
- }
- #define WL_DATA_DEVICE_START_DRAG 0
- #define WL_DATA_DEVICE_SET_SELECTION 1
- #define WL_DATA_DEVICE_RELEASE 2
- /**
- * @ingroup iface_wl_data_device
- */
- #define WL_DATA_DEVICE_START_DRAG_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_device
- */
- #define WL_DATA_DEVICE_SET_SELECTION_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_device
- */
- #define WL_DATA_DEVICE_RELEASE_SINCE_VERSION 2
- /** @ingroup iface_wl_data_device */
- static inline void
- wl_data_device_set_user_data(struct wl_data_device *wl_data_device, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_data_device, user_data);
- }
- /** @ingroup iface_wl_data_device */
- static inline void *
- wl_data_device_get_user_data(struct wl_data_device *wl_data_device)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_data_device);
- }
- static inline uint32_t
- wl_data_device_get_version(struct wl_data_device *wl_data_device)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_data_device);
- }
- /** @ingroup iface_wl_data_device */
- static inline void
- wl_data_device_destroy(struct wl_data_device *wl_data_device)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_data_device);
- }
- /**
- * @ingroup iface_wl_data_device
- *
- * This request asks the compositor to start a drag-and-drop
- * operation on behalf of the client.
- *
- * The source argument is the data source that provides the data
- * for the eventual data transfer. If source is NULL, enter, leave
- * and motion events are sent only to the client that initiated the
- * drag and the client is expected to handle the data passing
- * internally.
- *
- * The origin surface is the surface where the drag originates and
- * the client must have an active implicit grab that matches the
- * serial.
- *
- * The icon surface is an optional (can be NULL) surface that
- * provides an icon to be moved around with the cursor. Initially,
- * the top-left corner of the icon surface is placed at the cursor
- * hotspot, but subsequent wl_surface.attach request can move the
- * relative position. Attach requests must be confirmed with
- * wl_surface.commit as usual. The icon surface is given the role of
- * a drag-and-drop icon. If the icon surface already has another role,
- * it raises a protocol error.
- *
- * The current and pending input regions of the icon wl_surface are
- * cleared, and wl_surface.set_input_region is ignored until the
- * wl_surface is no longer used as the icon surface. When the use
- * as an icon ends, the current and pending input regions become
- * undefined, and the wl_surface is unmapped.
- */
- static inline void
- wl_data_device_start_drag(struct wl_data_device *wl_data_device, struct wl_data_source *source, struct wl_surface *origin, struct wl_surface *icon, uint32_t serial)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_device,
- WL_DATA_DEVICE_START_DRAG, source, origin, icon, serial);
- }
- /**
- * @ingroup iface_wl_data_device
- *
- * This request asks the compositor to set the selection
- * to the data from the source on behalf of the client.
- *
- * To unset the selection, set the source to NULL.
- */
- static inline void
- wl_data_device_set_selection(struct wl_data_device *wl_data_device, struct wl_data_source *source, uint32_t serial)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_device,
- WL_DATA_DEVICE_SET_SELECTION, source, serial);
- }
- /**
- * @ingroup iface_wl_data_device
- *
- * This request destroys the data device.
- */
- static inline void
- wl_data_device_release(struct wl_data_device *wl_data_device)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_data_device,
- WL_DATA_DEVICE_RELEASE);
- wl_proxy_destroy((struct wl_proxy *) wl_data_device);
- }
- #ifndef WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM
- #define WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM
- /**
- * @ingroup iface_wl_data_device_manager
- * drag and drop actions
- *
- * This is a bitmask of the available/preferred actions in a
- * drag-and-drop operation.
- *
- * In the compositor, the selected action is a result of matching the
- * actions offered by the source and destination sides. "action" events
- * with a "none" action will be sent to both source and destination if
- * there is no match. All further checks will effectively happen on
- * (source actions ∩ destination actions).
- *
- * In addition, compositors may also pick different actions in
- * reaction to key modifiers being pressed. One common design that
- * is used in major toolkits (and the behavior recommended for
- * compositors) is:
- *
- * - If no modifiers are pressed, the first match (in bit order)
- * will be used.
- * - Pressing Shift selects "move", if enabled in the mask.
- * - Pressing Control selects "copy", if enabled in the mask.
- *
- * Behavior beyond that is considered implementation-dependent.
- * Compositors may for example bind other modifiers (like Alt/Meta)
- * or drags initiated with other buttons than BTN_LEFT to specific
- * actions (e.g. "ask").
- */
- enum wl_data_device_manager_dnd_action {
- WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE = 0,
- WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY = 1,
- WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE = 2,
- WL_DATA_DEVICE_MANAGER_DND_ACTION_ASK = 4,
- };
- #endif /* WL_DATA_DEVICE_MANAGER_DND_ACTION_ENUM */
- #define WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE 0
- #define WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE 1
- /**
- * @ingroup iface_wl_data_device_manager
- */
- #define WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_data_device_manager
- */
- #define WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE_SINCE_VERSION 1
- /** @ingroup iface_wl_data_device_manager */
- static inline void
- wl_data_device_manager_set_user_data(struct wl_data_device_manager *wl_data_device_manager, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_data_device_manager, user_data);
- }
- /** @ingroup iface_wl_data_device_manager */
- static inline void *
- wl_data_device_manager_get_user_data(struct wl_data_device_manager *wl_data_device_manager)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_data_device_manager);
- }
- static inline uint32_t
- wl_data_device_manager_get_version(struct wl_data_device_manager *wl_data_device_manager)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_data_device_manager);
- }
- /** @ingroup iface_wl_data_device_manager */
- static inline void
- wl_data_device_manager_destroy(struct wl_data_device_manager *wl_data_device_manager)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_data_device_manager);
- }
- /**
- * @ingroup iface_wl_data_device_manager
- *
- * Create a new data source.
- */
- static inline struct wl_data_source *
- wl_data_device_manager_create_data_source(struct wl_data_device_manager *wl_data_device_manager)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_data_device_manager,
- WL_DATA_DEVICE_MANAGER_CREATE_DATA_SOURCE, &wl_data_source_interface, NULL);
- return (struct wl_data_source *) id;
- }
- /**
- * @ingroup iface_wl_data_device_manager
- *
- * Create a new data device for a given seat.
- */
- static inline struct wl_data_device *
- wl_data_device_manager_get_data_device(struct wl_data_device_manager *wl_data_device_manager, struct wl_seat *seat)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_data_device_manager,
- WL_DATA_DEVICE_MANAGER_GET_DATA_DEVICE, &wl_data_device_interface, NULL, seat);
- return (struct wl_data_device *) id;
- }
- #ifndef WL_SHELL_ERROR_ENUM
- #define WL_SHELL_ERROR_ENUM
- enum wl_shell_error {
- /**
- * given wl_surface has another role
- */
- WL_SHELL_ERROR_ROLE = 0,
- };
- #endif /* WL_SHELL_ERROR_ENUM */
- #define WL_SHELL_GET_SHELL_SURFACE 0
- /**
- * @ingroup iface_wl_shell
- */
- #define WL_SHELL_GET_SHELL_SURFACE_SINCE_VERSION 1
- /** @ingroup iface_wl_shell */
- static inline void
- wl_shell_set_user_data(struct wl_shell *wl_shell, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_shell, user_data);
- }
- /** @ingroup iface_wl_shell */
- static inline void *
- wl_shell_get_user_data(struct wl_shell *wl_shell)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_shell);
- }
- static inline uint32_t
- wl_shell_get_version(struct wl_shell *wl_shell)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_shell);
- }
- /** @ingroup iface_wl_shell */
- static inline void
- wl_shell_destroy(struct wl_shell *wl_shell)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_shell);
- }
- /**
- * @ingroup iface_wl_shell
- *
- * Create a shell surface for an existing surface. This gives
- * the wl_surface the role of a shell surface. If the wl_surface
- * already has another role, it raises a protocol error.
- *
- * Only one shell surface can be associated with a given surface.
- */
- static inline struct wl_shell_surface *
- wl_shell_get_shell_surface(struct wl_shell *wl_shell, struct wl_surface *surface)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_shell,
- WL_SHELL_GET_SHELL_SURFACE, &wl_shell_surface_interface, NULL, surface);
- return (struct wl_shell_surface *) id;
- }
- #ifndef WL_SHELL_SURFACE_RESIZE_ENUM
- #define WL_SHELL_SURFACE_RESIZE_ENUM
- /**
- * @ingroup iface_wl_shell_surface
- * edge values for resizing
- *
- * These values are used to indicate which edge of a surface
- * is being dragged in a resize operation. The server may
- * use this information to adapt its behavior, e.g. choose
- * an appropriate cursor image.
- */
- enum wl_shell_surface_resize {
- WL_SHELL_SURFACE_RESIZE_NONE = 0,
- WL_SHELL_SURFACE_RESIZE_TOP = 1,
- WL_SHELL_SURFACE_RESIZE_BOTTOM = 2,
- WL_SHELL_SURFACE_RESIZE_LEFT = 4,
- WL_SHELL_SURFACE_RESIZE_TOP_LEFT = 5,
- WL_SHELL_SURFACE_RESIZE_BOTTOM_LEFT = 6,
- WL_SHELL_SURFACE_RESIZE_RIGHT = 8,
- WL_SHELL_SURFACE_RESIZE_TOP_RIGHT = 9,
- WL_SHELL_SURFACE_RESIZE_BOTTOM_RIGHT = 10,
- };
- #endif /* WL_SHELL_SURFACE_RESIZE_ENUM */
- #ifndef WL_SHELL_SURFACE_TRANSIENT_ENUM
- #define WL_SHELL_SURFACE_TRANSIENT_ENUM
- /**
- * @ingroup iface_wl_shell_surface
- * details of transient behaviour
- *
- * These flags specify details of the expected behaviour
- * of transient surfaces. Used in the set_transient request.
- */
- enum wl_shell_surface_transient {
- /**
- * do not set keyboard focus
- */
- WL_SHELL_SURFACE_TRANSIENT_INACTIVE = 0x1,
- };
- #endif /* WL_SHELL_SURFACE_TRANSIENT_ENUM */
- #ifndef WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM
- #define WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM
- /**
- * @ingroup iface_wl_shell_surface
- * different method to set the surface fullscreen
- *
- * Hints to indicate to the compositor how to deal with a conflict
- * between the dimensions of the surface and the dimensions of the
- * output. The compositor is free to ignore this parameter.
- */
- enum wl_shell_surface_fullscreen_method {
- /**
- * no preference, apply default policy
- */
- WL_SHELL_SURFACE_FULLSCREEN_METHOD_DEFAULT = 0,
- /**
- * scale, preserve the surface's aspect ratio and center on output
- */
- WL_SHELL_SURFACE_FULLSCREEN_METHOD_SCALE = 1,
- /**
- * switch output mode to the smallest mode that can fit the surface, add black borders to compensate size mismatch
- */
- WL_SHELL_SURFACE_FULLSCREEN_METHOD_DRIVER = 2,
- /**
- * no upscaling, center on output and add black borders to compensate size mismatch
- */
- WL_SHELL_SURFACE_FULLSCREEN_METHOD_FILL = 3,
- };
- #endif /* WL_SHELL_SURFACE_FULLSCREEN_METHOD_ENUM */
- /**
- * @ingroup iface_wl_shell_surface
- * @struct wl_shell_surface_listener
- */
- struct wl_shell_surface_listener {
- /**
- * ping client
- *
- * Ping a client to check if it is receiving events and sending
- * requests. A client is expected to reply with a pong request.
- * @param serial serial number of the ping
- */
- void (*ping)(void *data,
- struct wl_shell_surface *wl_shell_surface,
- uint32_t serial);
- /**
- * suggest resize
- *
- * The configure event asks the client to resize its surface.
- *
- * The size is a hint, in the sense that the client is free to
- * ignore it if it doesn't resize, pick a smaller size (to satisfy
- * aspect ratio or resize in steps of NxM pixels).
- *
- * The edges parameter provides a hint about how the surface was
- * resized. The client may use this information to decide how to
- * adjust its content to the new size (e.g. a scrolling area might
- * adjust its content position to leave the viewable content
- * unmoved).
- *
- * The client is free to dismiss all but the last configure event
- * it received.
- *
- * The width and height arguments specify the size of the window in
- * surface-local coordinates.
- * @param edges how the surface was resized
- * @param width new width of the surface
- * @param height new height of the surface
- */
- void (*configure)(void *data,
- struct wl_shell_surface *wl_shell_surface,
- uint32_t edges,
- int32_t width,
- int32_t height);
- /**
- * popup interaction is done
- *
- * The popup_done event is sent out when a popup grab is broken,
- * that is, when the user clicks a surface that doesn't belong to
- * the client owning the popup surface.
- */
- void (*popup_done)(void *data,
- struct wl_shell_surface *wl_shell_surface);
- };
- /**
- * @ingroup wl_shell_surface_iface
- */
- static inline int
- wl_shell_surface_add_listener(struct wl_shell_surface *wl_shell_surface,
- const struct wl_shell_surface_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_shell_surface,
- (void (**)(void)) listener, data);
- }
- #define WL_SHELL_SURFACE_PONG 0
- #define WL_SHELL_SURFACE_MOVE 1
- #define WL_SHELL_SURFACE_RESIZE 2
- #define WL_SHELL_SURFACE_SET_TOPLEVEL 3
- #define WL_SHELL_SURFACE_SET_TRANSIENT 4
- #define WL_SHELL_SURFACE_SET_FULLSCREEN 5
- #define WL_SHELL_SURFACE_SET_POPUP 6
- #define WL_SHELL_SURFACE_SET_MAXIMIZED 7
- #define WL_SHELL_SURFACE_SET_TITLE 8
- #define WL_SHELL_SURFACE_SET_CLASS 9
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_PONG_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_MOVE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_RESIZE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_TOPLEVEL_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_TRANSIENT_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_FULLSCREEN_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_POPUP_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_MAXIMIZED_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_TITLE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_shell_surface
- */
- #define WL_SHELL_SURFACE_SET_CLASS_SINCE_VERSION 1
- /** @ingroup iface_wl_shell_surface */
- static inline void
- wl_shell_surface_set_user_data(struct wl_shell_surface *wl_shell_surface, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_shell_surface, user_data);
- }
- /** @ingroup iface_wl_shell_surface */
- static inline void *
- wl_shell_surface_get_user_data(struct wl_shell_surface *wl_shell_surface)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_shell_surface);
- }
- static inline uint32_t
- wl_shell_surface_get_version(struct wl_shell_surface *wl_shell_surface)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_shell_surface);
- }
- /** @ingroup iface_wl_shell_surface */
- static inline void
- wl_shell_surface_destroy(struct wl_shell_surface *wl_shell_surface)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_shell_surface);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * A client must respond to a ping event with a pong request or
- * the client may be deemed unresponsive.
- */
- static inline void
- wl_shell_surface_pong(struct wl_shell_surface *wl_shell_surface, uint32_t serial)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_PONG, serial);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Start a pointer-driven move of the surface.
- *
- * This request must be used in response to a button press event.
- * The server may ignore move requests depending on the state of
- * the surface (e.g. fullscreen or maximized).
- */
- static inline void
- wl_shell_surface_move(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_MOVE, seat, serial);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Start a pointer-driven resizing of the surface.
- *
- * This request must be used in response to a button press event.
- * The server may ignore resize requests depending on the state of
- * the surface (e.g. fullscreen or maximized).
- */
- static inline void
- wl_shell_surface_resize(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial, uint32_t edges)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_RESIZE, seat, serial, edges);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Map the surface as a toplevel surface.
- *
- * A toplevel surface is not fullscreen, maximized or transient.
- */
- static inline void
- wl_shell_surface_set_toplevel(struct wl_shell_surface *wl_shell_surface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_TOPLEVEL);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Map the surface relative to an existing surface.
- *
- * The x and y arguments specify the location of the upper left
- * corner of the surface relative to the upper left corner of the
- * parent surface, in surface-local coordinates.
- *
- * The flags argument controls details of the transient behaviour.
- */
- static inline void
- wl_shell_surface_set_transient(struct wl_shell_surface *wl_shell_surface, struct wl_surface *parent, int32_t x, int32_t y, uint32_t flags)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_TRANSIENT, parent, x, y, flags);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Map the surface as a fullscreen surface.
- *
- * If an output parameter is given then the surface will be made
- * fullscreen on that output. If the client does not specify the
- * output then the compositor will apply its policy - usually
- * choosing the output on which the surface has the biggest surface
- * area.
- *
- * The client may specify a method to resolve a size conflict
- * between the output size and the surface size - this is provided
- * through the method parameter.
- *
- * The framerate parameter is used only when the method is set
- * to "driver", to indicate the preferred framerate. A value of 0
- * indicates that the client does not care about framerate. The
- * framerate is specified in mHz, that is framerate of 60000 is 60Hz.
- *
- * A method of "scale" or "driver" implies a scaling operation of
- * the surface, either via a direct scaling operation or a change of
- * the output mode. This will override any kind of output scaling, so
- * that mapping a surface with a buffer size equal to the mode can
- * fill the screen independent of buffer_scale.
- *
- * A method of "fill" means we don't scale up the buffer, however
- * any output scale is applied. This means that you may run into
- * an edge case where the application maps a buffer with the same
- * size of the output mode but buffer_scale 1 (thus making a
- * surface larger than the output). In this case it is allowed to
- * downscale the results to fit the screen.
- *
- * The compositor must reply to this request with a configure event
- * with the dimensions for the output on which the surface will
- * be made fullscreen.
- */
- static inline void
- wl_shell_surface_set_fullscreen(struct wl_shell_surface *wl_shell_surface, uint32_t method, uint32_t framerate, struct wl_output *output)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_FULLSCREEN, method, framerate, output);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Map the surface as a popup.
- *
- * A popup surface is a transient surface with an added pointer
- * grab.
- *
- * An existing implicit grab will be changed to owner-events mode,
- * and the popup grab will continue after the implicit grab ends
- * (i.e. releasing the mouse button does not cause the popup to
- * be unmapped).
- *
- * The popup grab continues until the window is destroyed or a
- * mouse button is pressed in any other client's window. A click
- * in any of the client's surfaces is reported as normal, however,
- * clicks in other clients' surfaces will be discarded and trigger
- * the callback.
- *
- * The x and y arguments specify the location of the upper left
- * corner of the surface relative to the upper left corner of the
- * parent surface, in surface-local coordinates.
- */
- static inline void
- wl_shell_surface_set_popup(struct wl_shell_surface *wl_shell_surface, struct wl_seat *seat, uint32_t serial, struct wl_surface *parent, int32_t x, int32_t y, uint32_t flags)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_POPUP, seat, serial, parent, x, y, flags);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Map the surface as a maximized surface.
- *
- * If an output parameter is given then the surface will be
- * maximized on that output. If the client does not specify the
- * output then the compositor will apply its policy - usually
- * choosing the output on which the surface has the biggest surface
- * area.
- *
- * The compositor will reply with a configure event telling
- * the expected new surface size. The operation is completed
- * on the next buffer attach to this surface.
- *
- * A maximized surface typically fills the entire output it is
- * bound to, except for desktop elements such as panels. This is
- * the main difference between a maximized shell surface and a
- * fullscreen shell surface.
- *
- * The details depend on the compositor implementation.
- */
- static inline void
- wl_shell_surface_set_maximized(struct wl_shell_surface *wl_shell_surface, struct wl_output *output)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_MAXIMIZED, output);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Set a short title for the surface.
- *
- * This string may be used to identify the surface in a task bar,
- * window list, or other user interface elements provided by the
- * compositor.
- *
- * The string must be encoded in UTF-8.
- */
- static inline void
- wl_shell_surface_set_title(struct wl_shell_surface *wl_shell_surface, const char *title)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_TITLE, title);
- }
- /**
- * @ingroup iface_wl_shell_surface
- *
- * Set a class for the surface.
- *
- * The surface class identifies the general class of applications
- * to which the surface belongs. A common convention is to use the
- * file name (or the full path if it is a non-standard location) of
- * the application's .desktop file as the class.
- */
- static inline void
- wl_shell_surface_set_class(struct wl_shell_surface *wl_shell_surface, const char *class_)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_shell_surface,
- WL_SHELL_SURFACE_SET_CLASS, class_);
- }
- #ifndef WL_SURFACE_ERROR_ENUM
- #define WL_SURFACE_ERROR_ENUM
- /**
- * @ingroup iface_wl_surface
- * wl_surface error values
- *
- * These errors can be emitted in response to wl_surface requests.
- */
- enum wl_surface_error {
- /**
- * buffer scale value is invalid
- */
- WL_SURFACE_ERROR_INVALID_SCALE = 0,
- /**
- * buffer transform value is invalid
- */
- WL_SURFACE_ERROR_INVALID_TRANSFORM = 1,
- };
- #endif /* WL_SURFACE_ERROR_ENUM */
- /**
- * @ingroup iface_wl_surface
- * @struct wl_surface_listener
- */
- struct wl_surface_listener {
- /**
- * surface enters an output
- *
- * This is emitted whenever a surface's creation, movement, or
- * resizing results in some part of it being within the scanout
- * region of an output.
- *
- * Note that a surface may be overlapping with zero or more
- * outputs.
- * @param output output entered by the surface
- */
- void (*enter)(void *data,
- struct wl_surface *wl_surface,
- struct wl_output *output);
- /**
- * surface leaves an output
- *
- * This is emitted whenever a surface's creation, movement, or
- * resizing results in it no longer having any part of it within
- * the scanout region of an output.
- * @param output output left by the surface
- */
- void (*leave)(void *data,
- struct wl_surface *wl_surface,
- struct wl_output *output);
- };
- /**
- * @ingroup wl_surface_iface
- */
- static inline int
- wl_surface_add_listener(struct wl_surface *wl_surface,
- const struct wl_surface_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_surface,
- (void (**)(void)) listener, data);
- }
- #define WL_SURFACE_DESTROY 0
- #define WL_SURFACE_ATTACH 1
- #define WL_SURFACE_DAMAGE 2
- #define WL_SURFACE_FRAME 3
- #define WL_SURFACE_SET_OPAQUE_REGION 4
- #define WL_SURFACE_SET_INPUT_REGION 5
- #define WL_SURFACE_COMMIT 6
- #define WL_SURFACE_SET_BUFFER_TRANSFORM 7
- #define WL_SURFACE_SET_BUFFER_SCALE 8
- #define WL_SURFACE_DAMAGE_BUFFER 9
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_ATTACH_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_DAMAGE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_FRAME_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_SET_OPAQUE_REGION_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_SET_INPUT_REGION_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_COMMIT_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_SET_BUFFER_TRANSFORM_SINCE_VERSION 2
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_SET_BUFFER_SCALE_SINCE_VERSION 3
- /**
- * @ingroup iface_wl_surface
- */
- #define WL_SURFACE_DAMAGE_BUFFER_SINCE_VERSION 4
- /** @ingroup iface_wl_surface */
- static inline void
- wl_surface_set_user_data(struct wl_surface *wl_surface, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_surface, user_data);
- }
- /** @ingroup iface_wl_surface */
- static inline void *
- wl_surface_get_user_data(struct wl_surface *wl_surface)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_surface);
- }
- static inline uint32_t
- wl_surface_get_version(struct wl_surface *wl_surface)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_surface);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * Deletes the surface and invalidates its object ID.
- */
- static inline void
- wl_surface_destroy(struct wl_surface *wl_surface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_surface);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * Set a buffer as the content of this surface.
- *
- * The new size of the surface is calculated based on the buffer
- * size transformed by the inverse buffer_transform and the
- * inverse buffer_scale. This means that the supplied buffer
- * must be an integer multiple of the buffer_scale.
- *
- * The x and y arguments specify the location of the new pending
- * buffer's upper left corner, relative to the current buffer's upper
- * left corner, in surface-local coordinates. In other words, the
- * x and y, combined with the new surface size define in which
- * directions the surface's size changes.
- *
- * Surface contents are double-buffered state, see wl_surface.commit.
- *
- * The initial surface contents are void; there is no content.
- * wl_surface.attach assigns the given wl_buffer as the pending
- * wl_buffer. wl_surface.commit makes the pending wl_buffer the new
- * surface contents, and the size of the surface becomes the size
- * calculated from the wl_buffer, as described above. After commit,
- * there is no pending buffer until the next attach.
- *
- * Committing a pending wl_buffer allows the compositor to read the
- * pixels in the wl_buffer. The compositor may access the pixels at
- * any time after the wl_surface.commit request. When the compositor
- * will not access the pixels anymore, it will send the
- * wl_buffer.release event. Only after receiving wl_buffer.release,
- * the client may reuse the wl_buffer. A wl_buffer that has been
- * attached and then replaced by another attach instead of committed
- * will not receive a release event, and is not used by the
- * compositor.
- *
- * Destroying the wl_buffer after wl_buffer.release does not change
- * the surface contents. However, if the client destroys the
- * wl_buffer before receiving the wl_buffer.release event, the surface
- * contents become undefined immediately.
- *
- * If wl_surface.attach is sent with a NULL wl_buffer, the
- * following wl_surface.commit will remove the surface content.
- */
- static inline void
- wl_surface_attach(struct wl_surface *wl_surface, struct wl_buffer *buffer, int32_t x, int32_t y)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_ATTACH, buffer, x, y);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request is used to describe the regions where the pending
- * buffer is different from the current surface contents, and where
- * the surface therefore needs to be repainted. The compositor
- * ignores the parts of the damage that fall outside of the surface.
- *
- * Damage is double-buffered state, see wl_surface.commit.
- *
- * The damage rectangle is specified in surface-local coordinates.
- *
- * The initial value for pending damage is empty: no damage.
- * wl_surface.damage adds pending damage: the new pending damage
- * is the union of old pending damage and the given rectangle.
- *
- * wl_surface.commit assigns pending damage as the current damage,
- * and clears pending damage. The server will clear the current
- * damage as it repaints the surface.
- *
- * Alternatively, damage can be posted with wl_surface.damage_buffer
- * which uses buffer coordinates instead of surface coordinates,
- * and is probably the preferred and intuitive way of doing this.
- */
- static inline void
- wl_surface_damage(struct wl_surface *wl_surface, int32_t x, int32_t y, int32_t width, int32_t height)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_DAMAGE, x, y, width, height);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * Request a notification when it is a good time to start drawing a new
- * frame, by creating a frame callback. This is useful for throttling
- * redrawing operations, and driving animations.
- *
- * When a client is animating on a wl_surface, it can use the 'frame'
- * request to get notified when it is a good time to draw and commit the
- * next frame of animation. If the client commits an update earlier than
- * that, it is likely that some updates will not make it to the display,
- * and the client is wasting resources by drawing too often.
- *
- * The frame request will take effect on the next wl_surface.commit.
- * The notification will only be posted for one frame unless
- * requested again. For a wl_surface, the notifications are posted in
- * the order the frame requests were committed.
- *
- * The server must send the notifications so that a client
- * will not send excessive updates, while still allowing
- * the highest possible update rate for clients that wait for the reply
- * before drawing again. The server should give some time for the client
- * to draw and commit after sending the frame callback events to let it
- * hit the next output refresh.
- *
- * A server should avoid signaling the frame callbacks if the
- * surface is not visible in any way, e.g. the surface is off-screen,
- * or completely obscured by other opaque surfaces.
- *
- * The object returned by this request will be destroyed by the
- * compositor after the callback is fired and as such the client must not
- * attempt to use it after that point.
- *
- * The callback_data passed in the callback is the current time, in
- * milliseconds, with an undefined base.
- */
- static inline struct wl_callback *
- wl_surface_frame(struct wl_surface *wl_surface)
- {
- struct wl_proxy *callback;
- callback = wl_proxy_marshal_constructor((struct wl_proxy *) wl_surface,
- WL_SURFACE_FRAME, &wl_callback_interface, NULL);
- return (struct wl_callback *) callback;
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request sets the region of the surface that contains
- * opaque content.
- *
- * The opaque region is an optimization hint for the compositor
- * that lets it optimize the redrawing of content behind opaque
- * regions. Setting an opaque region is not required for correct
- * behaviour, but marking transparent content as opaque will result
- * in repaint artifacts.
- *
- * The opaque region is specified in surface-local coordinates.
- *
- * The compositor ignores the parts of the opaque region that fall
- * outside of the surface.
- *
- * Opaque region is double-buffered state, see wl_surface.commit.
- *
- * wl_surface.set_opaque_region changes the pending opaque region.
- * wl_surface.commit copies the pending region to the current region.
- * Otherwise, the pending and current regions are never changed.
- *
- * The initial value for an opaque region is empty. Setting the pending
- * opaque region has copy semantics, and the wl_region object can be
- * destroyed immediately. A NULL wl_region causes the pending opaque
- * region to be set to empty.
- */
- static inline void
- wl_surface_set_opaque_region(struct wl_surface *wl_surface, struct wl_region *region)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_SET_OPAQUE_REGION, region);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request sets the region of the surface that can receive
- * pointer and touch events.
- *
- * Input events happening outside of this region will try the next
- * surface in the server surface stack. The compositor ignores the
- * parts of the input region that fall outside of the surface.
- *
- * The input region is specified in surface-local coordinates.
- *
- * Input region is double-buffered state, see wl_surface.commit.
- *
- * wl_surface.set_input_region changes the pending input region.
- * wl_surface.commit copies the pending region to the current region.
- * Otherwise the pending and current regions are never changed,
- * except cursor and icon surfaces are special cases, see
- * wl_pointer.set_cursor and wl_data_device.start_drag.
- *
- * The initial value for an input region is infinite. That means the
- * whole surface will accept input. Setting the pending input region
- * has copy semantics, and the wl_region object can be destroyed
- * immediately. A NULL wl_region causes the input region to be set
- * to infinite.
- */
- static inline void
- wl_surface_set_input_region(struct wl_surface *wl_surface, struct wl_region *region)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_SET_INPUT_REGION, region);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * Surface state (input, opaque, and damage regions, attached buffers,
- * etc.) is double-buffered. Protocol requests modify the pending state,
- * as opposed to the current state in use by the compositor. A commit
- * request atomically applies all pending state, replacing the current
- * state. After commit, the new pending state is as documented for each
- * related request.
- *
- * On commit, a pending wl_buffer is applied first, and all other state
- * second. This means that all coordinates in double-buffered state are
- * relative to the new wl_buffer coming into use, except for
- * wl_surface.attach itself. If there is no pending wl_buffer, the
- * coordinates are relative to the current surface contents.
- *
- * All requests that need a commit to become effective are documented
- * to affect double-buffered state.
- *
- * Other interfaces may add further double-buffered surface state.
- */
- static inline void
- wl_surface_commit(struct wl_surface *wl_surface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_COMMIT);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request sets an optional transformation on how the compositor
- * interprets the contents of the buffer attached to the surface. The
- * accepted values for the transform parameter are the values for
- * wl_output.transform.
- *
- * Buffer transform is double-buffered state, see wl_surface.commit.
- *
- * A newly created surface has its buffer transformation set to normal.
- *
- * wl_surface.set_buffer_transform changes the pending buffer
- * transformation. wl_surface.commit copies the pending buffer
- * transformation to the current one. Otherwise, the pending and current
- * values are never changed.
- *
- * The purpose of this request is to allow clients to render content
- * according to the output transform, thus permitting the compositor to
- * use certain optimizations even if the display is rotated. Using
- * hardware overlays and scanning out a client buffer for fullscreen
- * surfaces are examples of such optimizations. Those optimizations are
- * highly dependent on the compositor implementation, so the use of this
- * request should be considered on a case-by-case basis.
- *
- * Note that if the transform value includes 90 or 270 degree rotation,
- * the width of the buffer will become the surface height and the height
- * of the buffer will become the surface width.
- *
- * If transform is not one of the values from the
- * wl_output.transform enum the invalid_transform protocol error
- * is raised.
- */
- static inline void
- wl_surface_set_buffer_transform(struct wl_surface *wl_surface, int32_t transform)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_SET_BUFFER_TRANSFORM, transform);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request sets an optional scaling factor on how the compositor
- * interprets the contents of the buffer attached to the window.
- *
- * Buffer scale is double-buffered state, see wl_surface.commit.
- *
- * A newly created surface has its buffer scale set to 1.
- *
- * wl_surface.set_buffer_scale changes the pending buffer scale.
- * wl_surface.commit copies the pending buffer scale to the current one.
- * Otherwise, the pending and current values are never changed.
- *
- * The purpose of this request is to allow clients to supply higher
- * resolution buffer data for use on high resolution outputs. It is
- * intended that you pick the same buffer scale as the scale of the
- * output that the surface is displayed on. This means the compositor
- * can avoid scaling when rendering the surface on that output.
- *
- * Note that if the scale is larger than 1, then you have to attach
- * a buffer that is larger (by a factor of scale in each dimension)
- * than the desired surface size.
- *
- * If scale is not positive the invalid_scale protocol error is
- * raised.
- */
- static inline void
- wl_surface_set_buffer_scale(struct wl_surface *wl_surface, int32_t scale)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_SET_BUFFER_SCALE, scale);
- }
- /**
- * @ingroup iface_wl_surface
- *
- * This request is used to describe the regions where the pending
- * buffer is different from the current surface contents, and where
- * the surface therefore needs to be repainted. The compositor
- * ignores the parts of the damage that fall outside of the surface.
- *
- * Damage is double-buffered state, see wl_surface.commit.
- *
- * The damage rectangle is specified in buffer coordinates.
- *
- * The initial value for pending damage is empty: no damage.
- * wl_surface.damage_buffer adds pending damage: the new pending
- * damage is the union of old pending damage and the given rectangle.
- *
- * wl_surface.commit assigns pending damage as the current damage,
- * and clears pending damage. The server will clear the current
- * damage as it repaints the surface.
- *
- * This request differs from wl_surface.damage in only one way - it
- * takes damage in buffer coordinates instead of surface-local
- * coordinates. While this generally is more intuitive than surface
- * coordinates, it is especially desirable when using wp_viewport
- * or when a drawing library (like EGL) is unaware of buffer scale
- * and buffer transform.
- *
- * Note: Because buffer transformation changes and damage requests may
- * be interleaved in the protocol stream, it is impossible to determine
- * the actual mapping between surface and buffer damage until
- * wl_surface.commit time. Therefore, compositors wishing to take both
- * kinds of damage into account will have to accumulate damage from the
- * two requests separately and only transform from one to the other
- * after receiving the wl_surface.commit.
- */
- static inline void
- wl_surface_damage_buffer(struct wl_surface *wl_surface, int32_t x, int32_t y, int32_t width, int32_t height)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_surface,
- WL_SURFACE_DAMAGE_BUFFER, x, y, width, height);
- }
- #ifndef WL_SEAT_CAPABILITY_ENUM
- #define WL_SEAT_CAPABILITY_ENUM
- /**
- * @ingroup iface_wl_seat
- * seat capability bitmask
- *
- * This is a bitmask of capabilities this seat has; if a member is
- * set, then it is present on the seat.
- */
- enum wl_seat_capability {
- /**
- * the seat has pointer devices
- */
- WL_SEAT_CAPABILITY_POINTER = 1,
- /**
- * the seat has one or more keyboards
- */
- WL_SEAT_CAPABILITY_KEYBOARD = 2,
- /**
- * the seat has touch devices
- */
- WL_SEAT_CAPABILITY_TOUCH = 4,
- };
- #endif /* WL_SEAT_CAPABILITY_ENUM */
- /**
- * @ingroup iface_wl_seat
- * @struct wl_seat_listener
- */
- struct wl_seat_listener {
- /**
- * seat capabilities changed
- *
- * This is emitted whenever a seat gains or loses the pointer,
- * keyboard or touch capabilities. The argument is a capability
- * enum containing the complete set of capabilities this seat has.
- *
- * When the pointer capability is added, a client may create a
- * wl_pointer object using the wl_seat.get_pointer request. This
- * object will receive pointer events until the capability is
- * removed in the future.
- *
- * When the pointer capability is removed, a client should destroy
- * the wl_pointer objects associated with the seat where the
- * capability was removed, using the wl_pointer.release request. No
- * further pointer events will be received on these objects.
- *
- * In some compositors, if a seat regains the pointer capability
- * and a client has a previously obtained wl_pointer object of
- * version 4 or less, that object may start sending pointer events
- * again. This behavior is considered a misinterpretation of the
- * intended behavior and must not be relied upon by the client.
- * wl_pointer objects of version 5 or later must not send events if
- * created before the most recent event notifying the client of an
- * added pointer capability.
- *
- * The above behavior also applies to wl_keyboard and wl_touch with
- * the keyboard and touch capabilities, respectively.
- * @param capabilities capabilities of the seat
- */
- void (*capabilities)(void *data,
- struct wl_seat *wl_seat,
- uint32_t capabilities);
- /**
- * unique identifier for this seat
- *
- * In a multiseat configuration this can be used by the client to
- * help identify which physical devices the seat represents. Based
- * on the seat configuration used by the compositor.
- * @param name seat identifier
- * @since 2
- */
- void (*name)(void *data,
- struct wl_seat *wl_seat,
- const char *name);
- };
- /**
- * @ingroup wl_seat_iface
- */
- static inline int
- wl_seat_add_listener(struct wl_seat *wl_seat,
- const struct wl_seat_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_seat,
- (void (**)(void)) listener, data);
- }
- #define WL_SEAT_GET_POINTER 0
- #define WL_SEAT_GET_KEYBOARD 1
- #define WL_SEAT_GET_TOUCH 2
- #define WL_SEAT_RELEASE 3
- /**
- * @ingroup iface_wl_seat
- */
- #define WL_SEAT_GET_POINTER_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_seat
- */
- #define WL_SEAT_GET_KEYBOARD_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_seat
- */
- #define WL_SEAT_GET_TOUCH_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_seat
- */
- #define WL_SEAT_RELEASE_SINCE_VERSION 5
- /** @ingroup iface_wl_seat */
- static inline void
- wl_seat_set_user_data(struct wl_seat *wl_seat, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_seat, user_data);
- }
- /** @ingroup iface_wl_seat */
- static inline void *
- wl_seat_get_user_data(struct wl_seat *wl_seat)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_seat);
- }
- static inline uint32_t
- wl_seat_get_version(struct wl_seat *wl_seat)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_seat);
- }
- /** @ingroup iface_wl_seat */
- static inline void
- wl_seat_destroy(struct wl_seat *wl_seat)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_seat);
- }
- /**
- * @ingroup iface_wl_seat
- *
- * The ID provided will be initialized to the wl_pointer interface
- * for this seat.
- *
- * This request only takes effect if the seat has the pointer
- * capability, or has had the pointer capability in the past.
- * It is a protocol violation to issue this request on a seat that has
- * never had the pointer capability.
- */
- static inline struct wl_pointer *
- wl_seat_get_pointer(struct wl_seat *wl_seat)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
- WL_SEAT_GET_POINTER, &wl_pointer_interface, NULL);
- return (struct wl_pointer *) id;
- }
- /**
- * @ingroup iface_wl_seat
- *
- * The ID provided will be initialized to the wl_keyboard interface
- * for this seat.
- *
- * This request only takes effect if the seat has the keyboard
- * capability, or has had the keyboard capability in the past.
- * It is a protocol violation to issue this request on a seat that has
- * never had the keyboard capability.
- */
- static inline struct wl_keyboard *
- wl_seat_get_keyboard(struct wl_seat *wl_seat)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
- WL_SEAT_GET_KEYBOARD, &wl_keyboard_interface, NULL);
- return (struct wl_keyboard *) id;
- }
- /**
- * @ingroup iface_wl_seat
- *
- * The ID provided will be initialized to the wl_touch interface
- * for this seat.
- *
- * This request only takes effect if the seat has the touch
- * capability, or has had the touch capability in the past.
- * It is a protocol violation to issue this request on a seat that has
- * never had the touch capability.
- */
- static inline struct wl_touch *
- wl_seat_get_touch(struct wl_seat *wl_seat)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_seat,
- WL_SEAT_GET_TOUCH, &wl_touch_interface, NULL);
- return (struct wl_touch *) id;
- }
- /**
- * @ingroup iface_wl_seat
- *
- * Using this request a client can tell the server that it is not going to
- * use the seat object anymore.
- */
- static inline void
- wl_seat_release(struct wl_seat *wl_seat)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_seat,
- WL_SEAT_RELEASE);
- wl_proxy_destroy((struct wl_proxy *) wl_seat);
- }
- #ifndef WL_POINTER_ERROR_ENUM
- #define WL_POINTER_ERROR_ENUM
- enum wl_pointer_error {
- /**
- * given wl_surface has another role
- */
- WL_POINTER_ERROR_ROLE = 0,
- };
- #endif /* WL_POINTER_ERROR_ENUM */
- #ifndef WL_POINTER_BUTTON_STATE_ENUM
- #define WL_POINTER_BUTTON_STATE_ENUM
- /**
- * @ingroup iface_wl_pointer
- * physical button state
- *
- * Describes the physical state of a button that produced the button
- * event.
- */
- enum wl_pointer_button_state {
- /**
- * the button is not pressed
- */
- WL_POINTER_BUTTON_STATE_RELEASED = 0,
- /**
- * the button is pressed
- */
- WL_POINTER_BUTTON_STATE_PRESSED = 1,
- };
- #endif /* WL_POINTER_BUTTON_STATE_ENUM */
- #ifndef WL_POINTER_AXIS_ENUM
- #define WL_POINTER_AXIS_ENUM
- /**
- * @ingroup iface_wl_pointer
- * axis types
- *
- * Describes the axis types of scroll events.
- */
- enum wl_pointer_axis {
- WL_POINTER_AXIS_VERTICAL_SCROLL = 0,
- WL_POINTER_AXIS_HORIZONTAL_SCROLL = 1,
- };
- #endif /* WL_POINTER_AXIS_ENUM */
- #ifndef WL_POINTER_AXIS_SOURCE_ENUM
- #define WL_POINTER_AXIS_SOURCE_ENUM
- /**
- * @ingroup iface_wl_pointer
- * axis source types
- *
- * Describes the source types for axis events. This indicates to the
- * client how an axis event was physically generated; a client may
- * adjust the user interface accordingly. For example, scroll events
- * from a "finger" source may be in a smooth coordinate space with
- * kinetic scrolling whereas a "wheel" source may be in discrete steps
- * of a number of lines.
- *
- * The "continuous" axis source is a device generating events in a
- * continuous coordinate space, but using something other than a
- * finger. One example for this source is button-based scrolling where
- * the vertical motion of a device is converted to scroll events while
- * a button is held down.
- */
- enum wl_pointer_axis_source {
- /**
- * a physical wheel
- */
- WL_POINTER_AXIS_SOURCE_WHEEL = 0,
- /**
- * finger on a touch surface
- */
- WL_POINTER_AXIS_SOURCE_FINGER = 1,
- /**
- * continuous coordinate space
- */
- WL_POINTER_AXIS_SOURCE_CONTINUOUS = 2,
- };
- #endif /* WL_POINTER_AXIS_SOURCE_ENUM */
- /**
- * @ingroup iface_wl_pointer
- * @struct wl_pointer_listener
- */
- struct wl_pointer_listener {
- /**
- * enter event
- *
- * Notification that this seat's pointer is focused on a certain
- * surface.
- *
- * When a seat's focus enters a surface, the pointer image is
- * undefined and a client should respond to this event by setting
- * an appropriate pointer image with the set_cursor request.
- * @param serial serial number of the enter event
- * @param surface surface entered by the pointer
- * @param surface_x surface-local x coordinate
- * @param surface_y surface-local y coordinate
- */
- void (*enter)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t serial,
- struct wl_surface *surface,
- wl_fixed_t surface_x,
- wl_fixed_t surface_y);
- /**
- * leave event
- *
- * Notification that this seat's pointer is no longer focused on
- * a certain surface.
- *
- * The leave notification is sent before the enter notification for
- * the new focus.
- * @param serial serial number of the leave event
- * @param surface surface left by the pointer
- */
- void (*leave)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t serial,
- struct wl_surface *surface);
- /**
- * pointer motion event
- *
- * Notification of pointer location change. The arguments
- * surface_x and surface_y are the location relative to the focused
- * surface.
- * @param time timestamp with millisecond granularity
- * @param surface_x surface-local x coordinate
- * @param surface_y surface-local y coordinate
- */
- void (*motion)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t time,
- wl_fixed_t surface_x,
- wl_fixed_t surface_y);
- /**
- * pointer button event
- *
- * Mouse button click and release notifications.
- *
- * The location of the click is given by the last motion or enter
- * event. The time argument is a timestamp with millisecond
- * granularity, with an undefined base.
- * @param serial serial number of the button event
- * @param time timestamp with millisecond granularity
- * @param button button that produced the event
- * @param state physical state of the button
- */
- void (*button)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t serial,
- uint32_t time,
- uint32_t button,
- uint32_t state);
- /**
- * axis event
- *
- * Scroll and other axis notifications.
- *
- * For scroll events (vertical and horizontal scroll axes), the
- * value parameter is the length of a vector along the specified
- * axis in a coordinate space identical to those of motion events,
- * representing a relative movement along the specified axis.
- *
- * For devices that support movements non-parallel to axes multiple
- * axis events will be emitted.
- *
- * When applicable, for example for touch pads, the server can
- * choose to emit scroll events where the motion vector is
- * equivalent to a motion event vector.
- *
- * When applicable, a client can transform its content relative to
- * the scroll distance.
- * @param time timestamp with millisecond granularity
- * @param axis axis type
- * @param value length of vector in surface-local coordinate space
- */
- void (*axis)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t time,
- uint32_t axis,
- wl_fixed_t value);
- /**
- * end of a pointer event sequence
- *
- * Indicates the end of a set of events that logically belong
- * together. A client is expected to accumulate the data in all
- * events within the frame before proceeding.
- *
- * All wl_pointer events before a wl_pointer.frame event belong
- * logically together. For example, in a diagonal scroll motion the
- * compositor will send an optional wl_pointer.axis_source event,
- * two wl_pointer.axis events (horizontal and vertical) and finally
- * a wl_pointer.frame event. The client may use this information to
- * calculate a diagonal vector for scrolling.
- *
- * When multiple wl_pointer.axis events occur within the same
- * frame, the motion vector is the combined motion of all events.
- * When a wl_pointer.axis and a wl_pointer.axis_stop event occur
- * within the same frame, this indicates that axis movement in one
- * axis has stopped but continues in the other axis. When multiple
- * wl_pointer.axis_stop events occur within the same frame, this
- * indicates that these axes stopped in the same instance.
- *
- * A wl_pointer.frame event is sent for every logical event group,
- * even if the group only contains a single wl_pointer event.
- * Specifically, a client may get a sequence: motion, frame,
- * button, frame, axis, frame, axis_stop, frame.
- *
- * The wl_pointer.enter and wl_pointer.leave events are logical
- * events generated by the compositor and not the hardware. These
- * events are also grouped by a wl_pointer.frame. When a pointer
- * moves from one surface to another, a compositor should group the
- * wl_pointer.leave event within the same wl_pointer.frame.
- * However, a client must not rely on wl_pointer.leave and
- * wl_pointer.enter being in the same wl_pointer.frame.
- * Compositor-specific policies may require the wl_pointer.leave
- * and wl_pointer.enter event being split across multiple
- * wl_pointer.frame groups.
- * @since 5
- */
- void (*frame)(void *data,
- struct wl_pointer *wl_pointer);
- /**
- * axis source event
- *
- * Source information for scroll and other axes.
- *
- * This event does not occur on its own. It is sent before a
- * wl_pointer.frame event and carries the source information for
- * all events within that frame.
- *
- * The source specifies how this event was generated. If the source
- * is wl_pointer.axis_source.finger, a wl_pointer.axis_stop event
- * will be sent when the user lifts the finger off the device.
- *
- * If the source is wl_pointer axis_source.wheel or
- * wl_pointer.axis_source.continuous, a wl_pointer.axis_stop event
- * may or may not be sent. Whether a compositor sends an axis_stop
- * event for these sources is hardware-specific and
- * implementation-dependent; clients must not rely on receiving an
- * axis_stop event for these scroll sources and should treat scroll
- * sequences from these scroll sources as unterminated by default.
- *
- * This event is optional. If the source is unknown for a
- * particular axis event sequence, no event is sent. Only one
- * wl_pointer.axis_source event is permitted per frame.
- *
- * The order of wl_pointer.axis_discrete and wl_pointer.axis_source
- * is not guaranteed.
- * @param axis_source source of the axis event
- * @since 5
- */
- void (*axis_source)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t axis_source);
- /**
- * axis stop event
- *
- * Stop notification for scroll and other axes.
- *
- * For some wl_pointer.axis_source types, a wl_pointer.axis_stop
- * event is sent to notify a client that the axis sequence has
- * terminated. This enables the client to implement kinetic
- * scrolling. See the wl_pointer.axis_source documentation for
- * information on when this event may be generated.
- *
- * Any wl_pointer.axis events with the same axis_source after this
- * event should be considered as the start of a new axis motion.
- *
- * The timestamp is to be interpreted identical to the timestamp in
- * the wl_pointer.axis event. The timestamp value may be the same
- * as a preceding wl_pointer.axis event.
- * @param time timestamp with millisecond granularity
- * @param axis the axis stopped with this event
- * @since 5
- */
- void (*axis_stop)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t time,
- uint32_t axis);
- /**
- * axis click event
- *
- * Discrete step information for scroll and other axes.
- *
- * This event carries the axis value of the wl_pointer.axis event
- * in discrete steps (e.g. mouse wheel clicks).
- *
- * This event does not occur on its own, it is coupled with a
- * wl_pointer.axis event that represents this axis value on a
- * continuous scale. The protocol guarantees that each
- * axis_discrete event is always followed by exactly one axis event
- * with the same axis number within the same wl_pointer.frame. Note
- * that the protocol allows for other events to occur between the
- * axis_discrete and its coupled axis event, including other
- * axis_discrete or axis events.
- *
- * This event is optional; continuous scrolling devices like
- * two-finger scrolling on touchpads do not have discrete steps and
- * do not generate this event.
- *
- * The discrete value carries the directional information. e.g. a
- * value of -2 is two steps towards the negative direction of this
- * axis.
- *
- * The axis number is identical to the axis number in the
- * associated axis event.
- *
- * The order of wl_pointer.axis_discrete and wl_pointer.axis_source
- * is not guaranteed.
- * @param axis axis type
- * @param discrete number of steps
- * @since 5
- */
- void (*axis_discrete)(void *data,
- struct wl_pointer *wl_pointer,
- uint32_t axis,
- int32_t discrete);
- };
- /**
- * @ingroup wl_pointer_iface
- */
- static inline int
- wl_pointer_add_listener(struct wl_pointer *wl_pointer,
- const struct wl_pointer_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_pointer,
- (void (**)(void)) listener, data);
- }
- #define WL_POINTER_SET_CURSOR 0
- #define WL_POINTER_RELEASE 1
- /**
- * @ingroup iface_wl_pointer
- */
- #define WL_POINTER_SET_CURSOR_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_pointer
- */
- #define WL_POINTER_RELEASE_SINCE_VERSION 3
- /** @ingroup iface_wl_pointer */
- static inline void
- wl_pointer_set_user_data(struct wl_pointer *wl_pointer, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_pointer, user_data);
- }
- /** @ingroup iface_wl_pointer */
- static inline void *
- wl_pointer_get_user_data(struct wl_pointer *wl_pointer)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_pointer);
- }
- static inline uint32_t
- wl_pointer_get_version(struct wl_pointer *wl_pointer)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_pointer);
- }
- /** @ingroup iface_wl_pointer */
- static inline void
- wl_pointer_destroy(struct wl_pointer *wl_pointer)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_pointer);
- }
- /**
- * @ingroup iface_wl_pointer
- *
- * Set the pointer surface, i.e., the surface that contains the
- * pointer image (cursor). This request gives the surface the role
- * of a cursor. If the surface already has another role, it raises
- * a protocol error.
- *
- * The cursor actually changes only if the pointer
- * focus for this device is one of the requesting client's surfaces
- * or the surface parameter is the current pointer surface. If
- * there was a previous surface set with this request it is
- * replaced. If surface is NULL, the pointer image is hidden.
- *
- * The parameters hotspot_x and hotspot_y define the position of
- * the pointer surface relative to the pointer location. Its
- * top-left corner is always at (x, y) - (hotspot_x, hotspot_y),
- * where (x, y) are the coordinates of the pointer location, in
- * surface-local coordinates.
- *
- * On surface.attach requests to the pointer surface, hotspot_x
- * and hotspot_y are decremented by the x and y parameters
- * passed to the request. Attach must be confirmed by
- * wl_surface.commit as usual.
- *
- * The hotspot can also be updated by passing the currently set
- * pointer surface to this request with new values for hotspot_x
- * and hotspot_y.
- *
- * The current and pending input regions of the wl_surface are
- * cleared, and wl_surface.set_input_region is ignored until the
- * wl_surface is no longer used as the cursor. When the use as a
- * cursor ends, the current and pending input regions become
- * undefined, and the wl_surface is unmapped.
- */
- static inline void
- wl_pointer_set_cursor(struct wl_pointer *wl_pointer, uint32_t serial, struct wl_surface *surface, int32_t hotspot_x, int32_t hotspot_y)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_pointer,
- WL_POINTER_SET_CURSOR, serial, surface, hotspot_x, hotspot_y);
- }
- /**
- * @ingroup iface_wl_pointer
- *
- * Using this request a client can tell the server that it is not going to
- * use the pointer object anymore.
- *
- * This request destroys the pointer proxy object, so clients must not call
- * wl_pointer_destroy() after using this request.
- */
- static inline void
- wl_pointer_release(struct wl_pointer *wl_pointer)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_pointer,
- WL_POINTER_RELEASE);
- wl_proxy_destroy((struct wl_proxy *) wl_pointer);
- }
- #ifndef WL_KEYBOARD_KEYMAP_FORMAT_ENUM
- #define WL_KEYBOARD_KEYMAP_FORMAT_ENUM
- /**
- * @ingroup iface_wl_keyboard
- * keyboard mapping format
- *
- * This specifies the format of the keymap provided to the
- * client with the wl_keyboard.keymap event.
- */
- enum wl_keyboard_keymap_format {
- /**
- * no keymap; client must understand how to interpret the raw keycode
- */
- WL_KEYBOARD_KEYMAP_FORMAT_NO_KEYMAP = 0,
- /**
- * libxkbcommon compatible; to determine the xkb keycode, clients must add 8 to the key event keycode
- */
- WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1 = 1,
- };
- #endif /* WL_KEYBOARD_KEYMAP_FORMAT_ENUM */
- #ifndef WL_KEYBOARD_KEY_STATE_ENUM
- #define WL_KEYBOARD_KEY_STATE_ENUM
- /**
- * @ingroup iface_wl_keyboard
- * physical key state
- *
- * Describes the physical state of a key that produced the key event.
- */
- enum wl_keyboard_key_state {
- /**
- * key is not pressed
- */
- WL_KEYBOARD_KEY_STATE_RELEASED = 0,
- /**
- * key is pressed
- */
- WL_KEYBOARD_KEY_STATE_PRESSED = 1,
- };
- #endif /* WL_KEYBOARD_KEY_STATE_ENUM */
- /**
- * @ingroup iface_wl_keyboard
- * @struct wl_keyboard_listener
- */
- struct wl_keyboard_listener {
- /**
- * keyboard mapping
- *
- * This event provides a file descriptor to the client which can
- * be memory-mapped to provide a keyboard mapping description.
- * @param format keymap format
- * @param fd keymap file descriptor
- * @param size keymap size, in bytes
- */
- void (*keymap)(void *data,
- struct wl_keyboard *wl_keyboard,
- uint32_t format,
- int32_t fd,
- uint32_t size);
- /**
- * enter event
- *
- * Notification that this seat's keyboard focus is on a certain
- * surface.
- * @param serial serial number of the enter event
- * @param surface surface gaining keyboard focus
- * @param keys the currently pressed keys
- */
- void (*enter)(void *data,
- struct wl_keyboard *wl_keyboard,
- uint32_t serial,
- struct wl_surface *surface,
- struct wl_array *keys);
- /**
- * leave event
- *
- * Notification that this seat's keyboard focus is no longer on a
- * certain surface.
- *
- * The leave notification is sent before the enter notification for
- * the new focus.
- * @param serial serial number of the leave event
- * @param surface surface that lost keyboard focus
- */
- void (*leave)(void *data,
- struct wl_keyboard *wl_keyboard,
- uint32_t serial,
- struct wl_surface *surface);
- /**
- * key event
- *
- * A key was pressed or released. The time argument is a
- * timestamp with millisecond granularity, with an undefined base.
- * @param serial serial number of the key event
- * @param time timestamp with millisecond granularity
- * @param key key that produced the event
- * @param state physical state of the key
- */
- void (*key)(void *data,
- struct wl_keyboard *wl_keyboard,
- uint32_t serial,
- uint32_t time,
- uint32_t key,
- uint32_t state);
- /**
- * modifier and group state
- *
- * Notifies clients that the modifier and/or group state has
- * changed, and it should update its local state.
- * @param serial serial number of the modifiers event
- * @param mods_depressed depressed modifiers
- * @param mods_latched latched modifiers
- * @param mods_locked locked modifiers
- * @param group keyboard layout
- */
- void (*modifiers)(void *data,
- struct wl_keyboard *wl_keyboard,
- uint32_t serial,
- uint32_t mods_depressed,
- uint32_t mods_latched,
- uint32_t mods_locked,
- uint32_t group);
- /**
- * repeat rate and delay
- *
- * Informs the client about the keyboard's repeat rate and delay.
- *
- * This event is sent as soon as the wl_keyboard object has been
- * created, and is guaranteed to be received by the client before
- * any key press event.
- *
- * Negative values for either rate or delay are illegal. A rate of
- * zero will disable any repeating (regardless of the value of
- * delay).
- *
- * This event can be sent later on as well with a new value if
- * necessary, so clients should continue listening for the event
- * past the creation of wl_keyboard.
- * @param rate the rate of repeating keys in characters per second
- * @param delay delay in milliseconds since key down until repeating starts
- * @since 4
- */
- void (*repeat_info)(void *data,
- struct wl_keyboard *wl_keyboard,
- int32_t rate,
- int32_t delay);
- };
- /**
- * @ingroup wl_keyboard_iface
- */
- static inline int
- wl_keyboard_add_listener(struct wl_keyboard *wl_keyboard,
- const struct wl_keyboard_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_keyboard,
- (void (**)(void)) listener, data);
- }
- #define WL_KEYBOARD_RELEASE 0
- /**
- * @ingroup iface_wl_keyboard
- */
- #define WL_KEYBOARD_RELEASE_SINCE_VERSION 3
- /** @ingroup iface_wl_keyboard */
- static inline void
- wl_keyboard_set_user_data(struct wl_keyboard *wl_keyboard, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_keyboard, user_data);
- }
- /** @ingroup iface_wl_keyboard */
- static inline void *
- wl_keyboard_get_user_data(struct wl_keyboard *wl_keyboard)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_keyboard);
- }
- static inline uint32_t
- wl_keyboard_get_version(struct wl_keyboard *wl_keyboard)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_keyboard);
- }
- /** @ingroup iface_wl_keyboard */
- static inline void
- wl_keyboard_destroy(struct wl_keyboard *wl_keyboard)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_keyboard);
- }
- /**
- * @ingroup iface_wl_keyboard
- */
- static inline void
- wl_keyboard_release(struct wl_keyboard *wl_keyboard)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_keyboard,
- WL_KEYBOARD_RELEASE);
- wl_proxy_destroy((struct wl_proxy *) wl_keyboard);
- }
- /**
- * @ingroup iface_wl_touch
- * @struct wl_touch_listener
- */
- struct wl_touch_listener {
- /**
- * touch down event and beginning of a touch sequence
- *
- * A new touch point has appeared on the surface. This touch
- * point is assigned a unique ID. Future events from this touch
- * point reference this ID. The ID ceases to be valid after a touch
- * up event and may be reused in the future.
- * @param serial serial number of the touch down event
- * @param time timestamp with millisecond granularity
- * @param surface surface touched
- * @param id the unique ID of this touch point
- * @param x surface-local x coordinate
- * @param y surface-local y coordinate
- */
- void (*down)(void *data,
- struct wl_touch *wl_touch,
- uint32_t serial,
- uint32_t time,
- struct wl_surface *surface,
- int32_t id,
- wl_fixed_t x,
- wl_fixed_t y);
- /**
- * end of a touch event sequence
- *
- * The touch point has disappeared. No further events will be
- * sent for this touch point and the touch point's ID is released
- * and may be reused in a future touch down event.
- * @param serial serial number of the touch up event
- * @param time timestamp with millisecond granularity
- * @param id the unique ID of this touch point
- */
- void (*up)(void *data,
- struct wl_touch *wl_touch,
- uint32_t serial,
- uint32_t time,
- int32_t id);
- /**
- * update of touch point coordinates
- *
- * A touch point has changed coordinates.
- * @param time timestamp with millisecond granularity
- * @param id the unique ID of this touch point
- * @param x surface-local x coordinate
- * @param y surface-local y coordinate
- */
- void (*motion)(void *data,
- struct wl_touch *wl_touch,
- uint32_t time,
- int32_t id,
- wl_fixed_t x,
- wl_fixed_t y);
- /**
- * end of touch frame event
- *
- * Indicates the end of a contact point list.
- */
- void (*frame)(void *data,
- struct wl_touch *wl_touch);
- /**
- * touch session cancelled
- *
- * Sent if the compositor decides the touch stream is a global
- * gesture. No further events are sent to the clients from that
- * particular gesture. Touch cancellation applies to all touch
- * points currently active on this client's surface. The client is
- * responsible for finalizing the touch points, future touch points
- * on this surface may reuse the touch point ID.
- */
- void (*cancel)(void *data,
- struct wl_touch *wl_touch);
- };
- /**
- * @ingroup wl_touch_iface
- */
- static inline int
- wl_touch_add_listener(struct wl_touch *wl_touch,
- const struct wl_touch_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_touch,
- (void (**)(void)) listener, data);
- }
- #define WL_TOUCH_RELEASE 0
- /**
- * @ingroup iface_wl_touch
- */
- #define WL_TOUCH_RELEASE_SINCE_VERSION 3
- /** @ingroup iface_wl_touch */
- static inline void
- wl_touch_set_user_data(struct wl_touch *wl_touch, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_touch, user_data);
- }
- /** @ingroup iface_wl_touch */
- static inline void *
- wl_touch_get_user_data(struct wl_touch *wl_touch)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_touch);
- }
- static inline uint32_t
- wl_touch_get_version(struct wl_touch *wl_touch)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_touch);
- }
- /** @ingroup iface_wl_touch */
- static inline void
- wl_touch_destroy(struct wl_touch *wl_touch)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_touch);
- }
- /**
- * @ingroup iface_wl_touch
- */
- static inline void
- wl_touch_release(struct wl_touch *wl_touch)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_touch,
- WL_TOUCH_RELEASE);
- wl_proxy_destroy((struct wl_proxy *) wl_touch);
- }
- #ifndef WL_OUTPUT_SUBPIXEL_ENUM
- #define WL_OUTPUT_SUBPIXEL_ENUM
- /**
- * @ingroup iface_wl_output
- * subpixel geometry information
- *
- * This enumeration describes how the physical
- * pixels on an output are laid out.
- */
- enum wl_output_subpixel {
- WL_OUTPUT_SUBPIXEL_UNKNOWN = 0,
- WL_OUTPUT_SUBPIXEL_NONE = 1,
- WL_OUTPUT_SUBPIXEL_HORIZONTAL_RGB = 2,
- WL_OUTPUT_SUBPIXEL_HORIZONTAL_BGR = 3,
- WL_OUTPUT_SUBPIXEL_VERTICAL_RGB = 4,
- WL_OUTPUT_SUBPIXEL_VERTICAL_BGR = 5,
- };
- #endif /* WL_OUTPUT_SUBPIXEL_ENUM */
- #ifndef WL_OUTPUT_TRANSFORM_ENUM
- #define WL_OUTPUT_TRANSFORM_ENUM
- /**
- * @ingroup iface_wl_output
- * transform from framebuffer to output
- *
- * This describes the transform that a compositor will apply to a
- * surface to compensate for the rotation or mirroring of an
- * output device.
- *
- * The flipped values correspond to an initial flip around a
- * vertical axis followed by rotation.
- *
- * The purpose is mainly to allow clients to render accordingly and
- * tell the compositor, so that for fullscreen surfaces, the
- * compositor will still be able to scan out directly from client
- * surfaces.
- */
- enum wl_output_transform {
- WL_OUTPUT_TRANSFORM_NORMAL = 0,
- WL_OUTPUT_TRANSFORM_90 = 1,
- WL_OUTPUT_TRANSFORM_180 = 2,
- WL_OUTPUT_TRANSFORM_270 = 3,
- WL_OUTPUT_TRANSFORM_FLIPPED = 4,
- WL_OUTPUT_TRANSFORM_FLIPPED_90 = 5,
- WL_OUTPUT_TRANSFORM_FLIPPED_180 = 6,
- WL_OUTPUT_TRANSFORM_FLIPPED_270 = 7,
- };
- #endif /* WL_OUTPUT_TRANSFORM_ENUM */
- #ifndef WL_OUTPUT_MODE_ENUM
- #define WL_OUTPUT_MODE_ENUM
- /**
- * @ingroup iface_wl_output
- * mode information
- *
- * These flags describe properties of an output mode.
- * They are used in the flags bitfield of the mode event.
- */
- enum wl_output_mode {
- /**
- * indicates this is the current mode
- */
- WL_OUTPUT_MODE_CURRENT = 0x1,
- /**
- * indicates this is the preferred mode
- */
- WL_OUTPUT_MODE_PREFERRED = 0x2,
- };
- #endif /* WL_OUTPUT_MODE_ENUM */
- /**
- * @ingroup iface_wl_output
- * @struct wl_output_listener
- */
- struct wl_output_listener {
- /**
- * properties of the output
- *
- * The geometry event describes geometric properties of the
- * output. The event is sent when binding to the output object and
- * whenever any of the properties change.
- * @param x x position within the global compositor space
- * @param y y position within the global compositor space
- * @param physical_width width in millimeters of the output
- * @param physical_height height in millimeters of the output
- * @param subpixel subpixel orientation of the output
- * @param make textual description of the manufacturer
- * @param model textual description of the model
- * @param transform transform that maps framebuffer to output
- */
- void (*geometry)(void *data,
- struct wl_output *wl_output,
- int32_t x,
- int32_t y,
- int32_t physical_width,
- int32_t physical_height,
- int32_t subpixel,
- const char *make,
- const char *model,
- int32_t transform);
- /**
- * advertise available modes for the output
- *
- * The mode event describes an available mode for the output.
- *
- * The event is sent when binding to the output object and there
- * will always be one mode, the current mode. The event is sent
- * again if an output changes mode, for the mode that is now
- * current. In other words, the current mode is always the last
- * mode that was received with the current flag set.
- *
- * The size of a mode is given in physical hardware units of the
- * output device. This is not necessarily the same as the output
- * size in the global compositor space. For instance, the output
- * may be scaled, as described in wl_output.scale, or transformed,
- * as described in wl_output.transform.
- * @param flags bitfield of mode flags
- * @param width width of the mode in hardware units
- * @param height height of the mode in hardware units
- * @param refresh vertical refresh rate in mHz
- */
- void (*mode)(void *data,
- struct wl_output *wl_output,
- uint32_t flags,
- int32_t width,
- int32_t height,
- int32_t refresh);
- /**
- * sent all information about output
- *
- * This event is sent after all other properties have been sent
- * after binding to the output object and after any other property
- * changes done after that. This allows changes to the output
- * properties to be seen as atomic, even if they happen via
- * multiple events.
- * @since 2
- */
- void (*done)(void *data,
- struct wl_output *wl_output);
- /**
- * output scaling properties
- *
- * This event contains scaling geometry information that is not
- * in the geometry event. It may be sent after binding the output
- * object or if the output scale changes later. If it is not sent,
- * the client should assume a scale of 1.
- *
- * A scale larger than 1 means that the compositor will
- * automatically scale surface buffers by this amount when
- * rendering. This is used for very high resolution displays where
- * applications rendering at the native resolution would be too
- * small to be legible.
- *
- * It is intended that scaling aware clients track the current
- * output of a surface, and if it is on a scaled output it should
- * use wl_surface.set_buffer_scale with the scale of the output.
- * That way the compositor can avoid scaling the surface, and the
- * client can supply a higher detail image.
- * @param factor scaling factor of output
- * @since 2
- */
- void (*scale)(void *data,
- struct wl_output *wl_output,
- int32_t factor);
- };
- /**
- * @ingroup wl_output_iface
- */
- static inline int
- wl_output_add_listener(struct wl_output *wl_output,
- const struct wl_output_listener *listener, void *data)
- {
- return wl_proxy_add_listener((struct wl_proxy *) wl_output,
- (void (**)(void)) listener, data);
- }
- /** @ingroup iface_wl_output */
- static inline void
- wl_output_set_user_data(struct wl_output *wl_output, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_output, user_data);
- }
- /** @ingroup iface_wl_output */
- static inline void *
- wl_output_get_user_data(struct wl_output *wl_output)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_output);
- }
- static inline uint32_t
- wl_output_get_version(struct wl_output *wl_output)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_output);
- }
- /** @ingroup iface_wl_output */
- static inline void
- wl_output_destroy(struct wl_output *wl_output)
- {
- wl_proxy_destroy((struct wl_proxy *) wl_output);
- }
- #define WL_REGION_DESTROY 0
- #define WL_REGION_ADD 1
- #define WL_REGION_SUBTRACT 2
- /**
- * @ingroup iface_wl_region
- */
- #define WL_REGION_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_region
- */
- #define WL_REGION_ADD_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_region
- */
- #define WL_REGION_SUBTRACT_SINCE_VERSION 1
- /** @ingroup iface_wl_region */
- static inline void
- wl_region_set_user_data(struct wl_region *wl_region, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_region, user_data);
- }
- /** @ingroup iface_wl_region */
- static inline void *
- wl_region_get_user_data(struct wl_region *wl_region)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_region);
- }
- static inline uint32_t
- wl_region_get_version(struct wl_region *wl_region)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_region);
- }
- /**
- * @ingroup iface_wl_region
- *
- * Destroy the region. This will invalidate the object ID.
- */
- static inline void
- wl_region_destroy(struct wl_region *wl_region)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_region,
- WL_REGION_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_region);
- }
- /**
- * @ingroup iface_wl_region
- *
- * Add the specified rectangle to the region.
- */
- static inline void
- wl_region_add(struct wl_region *wl_region, int32_t x, int32_t y, int32_t width, int32_t height)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_region,
- WL_REGION_ADD, x, y, width, height);
- }
- /**
- * @ingroup iface_wl_region
- *
- * Subtract the specified rectangle from the region.
- */
- static inline void
- wl_region_subtract(struct wl_region *wl_region, int32_t x, int32_t y, int32_t width, int32_t height)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_region,
- WL_REGION_SUBTRACT, x, y, width, height);
- }
- #ifndef WL_SUBCOMPOSITOR_ERROR_ENUM
- #define WL_SUBCOMPOSITOR_ERROR_ENUM
- enum wl_subcompositor_error {
- /**
- * the to-be sub-surface is invalid
- */
- WL_SUBCOMPOSITOR_ERROR_BAD_SURFACE = 0,
- };
- #endif /* WL_SUBCOMPOSITOR_ERROR_ENUM */
- #define WL_SUBCOMPOSITOR_DESTROY 0
- #define WL_SUBCOMPOSITOR_GET_SUBSURFACE 1
- /**
- * @ingroup iface_wl_subcompositor
- */
- #define WL_SUBCOMPOSITOR_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subcompositor
- */
- #define WL_SUBCOMPOSITOR_GET_SUBSURFACE_SINCE_VERSION 1
- /** @ingroup iface_wl_subcompositor */
- static inline void
- wl_subcompositor_set_user_data(struct wl_subcompositor *wl_subcompositor, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_subcompositor, user_data);
- }
- /** @ingroup iface_wl_subcompositor */
- static inline void *
- wl_subcompositor_get_user_data(struct wl_subcompositor *wl_subcompositor)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_subcompositor);
- }
- static inline uint32_t
- wl_subcompositor_get_version(struct wl_subcompositor *wl_subcompositor)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_subcompositor);
- }
- /**
- * @ingroup iface_wl_subcompositor
- *
- * Informs the server that the client will not be using this
- * protocol object anymore. This does not affect any other
- * objects, wl_subsurface objects included.
- */
- static inline void
- wl_subcompositor_destroy(struct wl_subcompositor *wl_subcompositor)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subcompositor,
- WL_SUBCOMPOSITOR_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_subcompositor);
- }
- /**
- * @ingroup iface_wl_subcompositor
- *
- * Create a sub-surface interface for the given surface, and
- * associate it with the given parent surface. This turns a
- * plain wl_surface into a sub-surface.
- *
- * The to-be sub-surface must not already have another role, and it
- * must not have an existing wl_subsurface object. Otherwise a protocol
- * error is raised.
- */
- static inline struct wl_subsurface *
- wl_subcompositor_get_subsurface(struct wl_subcompositor *wl_subcompositor, struct wl_surface *surface, struct wl_surface *parent)
- {
- struct wl_proxy *id;
- id = wl_proxy_marshal_constructor((struct wl_proxy *) wl_subcompositor,
- WL_SUBCOMPOSITOR_GET_SUBSURFACE, &wl_subsurface_interface, NULL, surface, parent);
- return (struct wl_subsurface *) id;
- }
- #ifndef WL_SUBSURFACE_ERROR_ENUM
- #define WL_SUBSURFACE_ERROR_ENUM
- enum wl_subsurface_error {
- /**
- * wl_surface is not a sibling or the parent
- */
- WL_SUBSURFACE_ERROR_BAD_SURFACE = 0,
- };
- #endif /* WL_SUBSURFACE_ERROR_ENUM */
- #define WL_SUBSURFACE_DESTROY 0
- #define WL_SUBSURFACE_SET_POSITION 1
- #define WL_SUBSURFACE_PLACE_ABOVE 2
- #define WL_SUBSURFACE_PLACE_BELOW 3
- #define WL_SUBSURFACE_SET_SYNC 4
- #define WL_SUBSURFACE_SET_DESYNC 5
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_DESTROY_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_SET_POSITION_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_PLACE_ABOVE_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_PLACE_BELOW_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_SET_SYNC_SINCE_VERSION 1
- /**
- * @ingroup iface_wl_subsurface
- */
- #define WL_SUBSURFACE_SET_DESYNC_SINCE_VERSION 1
- /** @ingroup iface_wl_subsurface */
- static inline void
- wl_subsurface_set_user_data(struct wl_subsurface *wl_subsurface, void *user_data)
- {
- wl_proxy_set_user_data((struct wl_proxy *) wl_subsurface, user_data);
- }
- /** @ingroup iface_wl_subsurface */
- static inline void *
- wl_subsurface_get_user_data(struct wl_subsurface *wl_subsurface)
- {
- return wl_proxy_get_user_data((struct wl_proxy *) wl_subsurface);
- }
- static inline uint32_t
- wl_subsurface_get_version(struct wl_subsurface *wl_subsurface)
- {
- return wl_proxy_get_version((struct wl_proxy *) wl_subsurface);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * The sub-surface interface is removed from the wl_surface object
- * that was turned into a sub-surface with a
- * wl_subcompositor.get_subsurface request. The wl_surface's association
- * to the parent is deleted, and the wl_surface loses its role as
- * a sub-surface. The wl_surface is unmapped.
- */
- static inline void
- wl_subsurface_destroy(struct wl_subsurface *wl_subsurface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_DESTROY);
- wl_proxy_destroy((struct wl_proxy *) wl_subsurface);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * This schedules a sub-surface position change.
- * The sub-surface will be moved so that its origin (top left
- * corner pixel) will be at the location x, y of the parent surface
- * coordinate system. The coordinates are not restricted to the parent
- * surface area. Negative values are allowed.
- *
- * The scheduled coordinates will take effect whenever the state of the
- * parent surface is applied. When this happens depends on whether the
- * parent surface is in synchronized mode or not. See
- * wl_subsurface.set_sync and wl_subsurface.set_desync for details.
- *
- * If more than one set_position request is invoked by the client before
- * the commit of the parent surface, the position of a new request always
- * replaces the scheduled position from any previous request.
- *
- * The initial position is 0, 0.
- */
- static inline void
- wl_subsurface_set_position(struct wl_subsurface *wl_subsurface, int32_t x, int32_t y)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_SET_POSITION, x, y);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * This sub-surface is taken from the stack, and put back just
- * above the reference surface, changing the z-order of the sub-surfaces.
- * The reference surface must be one of the sibling surfaces, or the
- * parent surface. Using any other surface, including this sub-surface,
- * will cause a protocol error.
- *
- * The z-order is double-buffered. Requests are handled in order and
- * applied immediately to a pending state. The final pending state is
- * copied to the active state the next time the state of the parent
- * surface is applied. When this happens depends on whether the parent
- * surface is in synchronized mode or not. See wl_subsurface.set_sync and
- * wl_subsurface.set_desync for details.
- *
- * A new sub-surface is initially added as the top-most in the stack
- * of its siblings and parent.
- */
- static inline void
- wl_subsurface_place_above(struct wl_subsurface *wl_subsurface, struct wl_surface *sibling)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_PLACE_ABOVE, sibling);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * The sub-surface is placed just below the reference surface.
- * See wl_subsurface.place_above.
- */
- static inline void
- wl_subsurface_place_below(struct wl_subsurface *wl_subsurface, struct wl_surface *sibling)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_PLACE_BELOW, sibling);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * Change the commit behaviour of the sub-surface to synchronized
- * mode, also described as the parent dependent mode.
- *
- * In synchronized mode, wl_surface.commit on a sub-surface will
- * accumulate the committed state in a cache, but the state will
- * not be applied and hence will not change the compositor output.
- * The cached state is applied to the sub-surface immediately after
- * the parent surface's state is applied. This ensures atomic
- * updates of the parent and all its synchronized sub-surfaces.
- * Applying the cached state will invalidate the cache, so further
- * parent surface commits do not (re-)apply old state.
- *
- * See wl_subsurface for the recursive effect of this mode.
- */
- static inline void
- wl_subsurface_set_sync(struct wl_subsurface *wl_subsurface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_SET_SYNC);
- }
- /**
- * @ingroup iface_wl_subsurface
- *
- * Change the commit behaviour of the sub-surface to desynchronized
- * mode, also described as independent or freely running mode.
- *
- * In desynchronized mode, wl_surface.commit on a sub-surface will
- * apply the pending state directly, without caching, as happens
- * normally with a wl_surface. Calling wl_surface.commit on the
- * parent surface has no effect on the sub-surface's wl_surface
- * state. This mode allows a sub-surface to be updated on its own.
- *
- * If cached state exists when wl_surface.commit is called in
- * desynchronized mode, the pending state is added to the cached
- * state, and applied as a whole. This invalidates the cache.
- *
- * Note: even if a sub-surface is set to desynchronized, a parent
- * sub-surface may override it to behave as synchronized. For details,
- * see wl_subsurface.
- *
- * If a surface's parent surface behaves as desynchronized, then
- * the cached state is applied on set_desync.
- */
- static inline void
- wl_subsurface_set_desync(struct wl_subsurface *wl_subsurface)
- {
- wl_proxy_marshal((struct wl_proxy *) wl_subsurface,
- WL_SUBSURFACE_SET_DESYNC);
- }
- #ifdef __cplusplus
- }
- #endif
- #endif
|