123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831 |
- <?xml version="1.0"?>
- <!-- This file was automatically generated from C sources - DO NOT EDIT!
- To affect the contents of this file, edit the original C definitions,
- and/or use gtk-doc annotations. -->
- <repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="GModule" version="2.0"/>
- <include name="Gio" version="2.0"/>
- <package name="gdk-pixbuf-2.0"/>
- <c:include name="gdk-pixbuf/gdk-pixbuf.h"/>
- <namespace name="GdkPixbuf"
- version="2.0"
- shared-library="libgdk_pixbuf-2.0.so.0"
- c:identifier-prefixes="Gdk"
- c:symbol-prefixes="gdk">
- <enumeration name="Colorspace"
- glib:type-name="GdkColorspace"
- glib:get-type="gdk_colorspace_get_type"
- c:type="GdkColorspace">
- <doc xml:space="preserve">This enumeration defines the color spaces that are supported by
- the gdk-pixbuf library. Currently only RGB is supported.</doc>
- <member name="rgb"
- value="0"
- c:identifier="GDK_COLORSPACE_RGB"
- glib:nick="rgb">
- <doc xml:space="preserve">Indicates a red/green/blue additive color space.</doc>
- </member>
- </enumeration>
- <enumeration name="InterpType"
- glib:type-name="GdkInterpType"
- glib:get-type="gdk_interp_type_get_type"
- c:type="GdkInterpType">
- <doc xml:space="preserve">This enumeration describes the different interpolation modes that
- can be used with the scaling functions. @GDK_INTERP_NEAREST is
- the fastest scaling method, but has horrible quality when
- scaling down. @GDK_INTERP_BILINEAR is the best choice if you
- aren't sure what to choose, it has a good speed/quality balance.
- <note>
- Cubic filtering is missing from the list; hyperbolic
- interpolation is just as fast and results in higher quality.
- </note></doc>
- <member name="nearest"
- value="0"
- c:identifier="GDK_INTERP_NEAREST"
- glib:nick="nearest">
- <doc xml:space="preserve">Nearest neighbor sampling; this is the fastest
- and lowest quality mode. Quality is normally unacceptable when scaling
- down, but may be OK when scaling up.</doc>
- </member>
- <member name="tiles"
- value="1"
- c:identifier="GDK_INTERP_TILES"
- glib:nick="tiles">
- <doc xml:space="preserve">This is an accurate simulation of the PostScript
- image operator without any interpolation enabled. Each pixel is
- rendered as a tiny parallelogram of solid color, the edges of which
- are implemented with antialiasing. It resembles nearest neighbor for
- enlargement, and bilinear for reduction.</doc>
- </member>
- <member name="bilinear"
- value="2"
- c:identifier="GDK_INTERP_BILINEAR"
- glib:nick="bilinear">
- <doc xml:space="preserve">Best quality/speed balance; use this mode by
- default. Bilinear interpolation. For enlargement, it is
- equivalent to point-sampling the ideal bilinear-interpolated image.
- For reduction, it is equivalent to laying down small tiles and
- integrating over the coverage area.</doc>
- </member>
- <member name="hyper"
- value="3"
- c:identifier="GDK_INTERP_HYPER"
- glib:nick="hyper">
- <doc xml:space="preserve">This is the slowest and highest quality
- reconstruction function. It is derived from the hyperbolic filters in
- Wolberg's "Digital Image Warping", and is formally defined as the
- hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
- image (the filter is designed to be idempotent for 1:1 pixel mapping).</doc>
- </member>
- </enumeration>
- <constant name="PIXBUF_FEATURES_H"
- value="1"
- c:type="GDK_PIXBUF_FEATURES_H">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PIXBUF_MAGIC_NUMBER"
- value="1197763408"
- c:type="GDK_PIXBUF_MAGIC_NUMBER">
- <doc xml:space="preserve">Magic number for #GdkPixdata structures.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PIXBUF_MAJOR" value="2" c:type="GDK_PIXBUF_MAJOR">
- <doc xml:space="preserve">Major version of gdk-pixbuf library, that is the "0" in
- "0.8.2" for example.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PIXBUF_MICRO" value="0" c:type="GDK_PIXBUF_MICRO">
- <doc xml:space="preserve">Micro version of gdk-pixbuf library, that is the "2" in
- "0.8.2" for example.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PIXBUF_MINOR" value="34" c:type="GDK_PIXBUF_MINOR">
- <doc xml:space="preserve">Minor version of gdk-pixbuf library, that is the "8" in
- "0.8.2" for example.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="PIXBUF_VERSION" value="2.34.0" c:type="GDK_PIXBUF_VERSION">
- <doc xml:space="preserve">Contains the full version of the gdk-pixbuf header as a string.
- This is the version being compiled against; contrast with
- #gdk_pixbuf_version.</doc>
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="PIXDATA_HEADER_LENGTH"
- value="24"
- c:type="GDK_PIXDATA_HEADER_LENGTH">
- <doc xml:space="preserve">The length of a #GdkPixdata structure without the @pixel_data pointer.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <class name="Pixbuf"
- c:symbol-prefix="pixbuf"
- c:type="GdkPixbuf"
- parent="GObject.Object"
- glib:type-name="GdkPixbuf"
- glib:get-type="gdk_pixbuf_get_type">
- <doc xml:space="preserve">This is the main structure in the gdk-pixbuf library. It is
- used to represent images. It contains information about the
- image's pixel data, its color space, bits per sample, width and
- height, and the rowstride (the number of bytes between the start of
- one row and the start of the next).</doc>
- <implements name="Gio.Icon"/>
- <implements name="Gio.LoadableIcon"/>
- <constructor name="new" c:identifier="gdk_pixbuf_new">
- <doc xml:space="preserve">Creates a new #GdkPixbuf structure and allocates a buffer for it. The
- buffer has an optimal rowstride. Note that the buffer is not cleared;
- you will have to fill it completely yourself.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created #GdkPixbuf with a reference count of 1, or
- %NULL if not enough memory could be allocated for the image buffer.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="colorspace" transfer-ownership="none">
- <doc xml:space="preserve">Color space for image</doc>
- <type name="Colorspace" c:type="GdkColorspace"/>
- </parameter>
- <parameter name="has_alpha" transfer-ownership="none">
- <doc xml:space="preserve">Whether the image should have transparency information</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="bits_per_sample" transfer-ownership="none">
- <doc xml:space="preserve">Number of bits per color sample</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">Width of image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">Height of image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_bytes"
- c:identifier="gdk_pixbuf_new_from_bytes"
- version="2.32">
- <doc xml:space="preserve">Creates a new #GdkPixbuf out of in-memory readonly image data.
- Currently only RGB images with 8 bits per sample are supported.
- This is the #GBytes variant of gdk_pixbuf_new_from_data().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference count of 1.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">Image data in 8-bit/sample packed format inside a #GBytes</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- <parameter name="colorspace" transfer-ownership="none">
- <doc xml:space="preserve">Colorspace for the image data</doc>
- <type name="Colorspace" c:type="GdkColorspace"/>
- </parameter>
- <parameter name="has_alpha" transfer-ownership="none">
- <doc xml:space="preserve">Whether the data has an opacity channel</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="bits_per_sample" transfer-ownership="none">
- <doc xml:space="preserve">Number of bits per sample</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">Width of the image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">Height of the image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="rowstride" transfer-ownership="none">
- <doc xml:space="preserve">Distance in bytes between row starts</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_data"
- c:identifier="gdk_pixbuf_new_from_data">
- <doc xml:space="preserve">Creates a new #GdkPixbuf out of in-memory image data. Currently only RGB
- images with 8 bits per sample are supported.
- Since you are providing a pre-allocated pixel buffer, you must also
- specify a way to free that data. This is done with a function of
- type #GdkPixbufDestroyNotify. When a pixbuf created with is
- finalized, your destroy notification function will be called, and
- it is its responsibility to free the pixel array.
- See also gdk_pixbuf_new_from_bytes().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference count of 1.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">Image data in 8-bit/sample packed format</doc>
- <array zero-terminated="0" c:type="guchar*">
- <type name="guint8" c:type="guchar"/>
- </array>
- </parameter>
- <parameter name="colorspace" transfer-ownership="none">
- <doc xml:space="preserve">Colorspace for the image data</doc>
- <type name="Colorspace" c:type="GdkColorspace"/>
- </parameter>
- <parameter name="has_alpha" transfer-ownership="none">
- <doc xml:space="preserve">Whether the data has an opacity channel</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="bits_per_sample" transfer-ownership="none">
- <doc xml:space="preserve">Number of bits per sample</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">Width of the image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">Height of the image in pixels, must be > 0</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="rowstride" transfer-ownership="none">
- <doc xml:space="preserve">Distance in bytes between row starts</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="destroy_fn"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="8">
- <doc xml:space="preserve">Function used to free the data when the pixbuf's reference count
- drops to zero, or %NULL if the data should not be freed</doc>
- <type name="PixbufDestroyNotify" c:type="GdkPixbufDestroyNotify"/>
- </parameter>
- <parameter name="destroy_fn_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">Closure data to pass to the destroy notification function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_file"
- c:identifier="gdk_pixbuf_new_from_file"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from a file. The file format is
- detected automatically. If %NULL is returned, then @error will be set.
- Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL if
- any of several error conditions occurred: the file could not be opened,
- there was no loader for the file's format, there was not enough memory to
- allocate the image buffer, or the image file contained invalid data.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_file_at_scale"
- c:identifier="gdk_pixbuf_new_from_file_at_scale"
- version="2.6"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from a file. The file format is
- detected automatically. If %NULL is returned, then @error will be set.
- Possible errors are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.
- The image will be scaled to fit in the requested size, optionally preserving
- the image's aspect ratio.
- When preserving the aspect ratio, a @width of -1 will cause the image
- to be scaled to the exact given height, and a @height of -1 will cause
- the image to be scaled to the exact given width. When not preserving
- aspect ratio, a @width or @height of -1 means to not scale the image
- at all in that dimension. Negative values for @width and @height are
- allowed since 2.8.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL
- if any of several error conditions occurred: the file could not be opened,
- there was no loader for the file's format, there was not enough memory to
- allocate the image buffer, or the image file contained invalid data.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="preserve_aspect_ratio" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_file_at_size"
- c:identifier="gdk_pixbuf_new_from_file_at_size"
- version="2.4"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from a file.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set. Possible errors are in the #GDK_PIXBUF_ERROR and
- #G_FILE_ERROR domains.
- The image will be scaled to fit in the requested size, preserving
- the image's aspect ratio. Note that the returned pixbuf may be smaller
- than @width x @height, if the aspect ratio requires it. To load
- and image at the requested size, regardless of aspect ratio, use
- gdk_pixbuf_new_from_file_at_scale().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or
- %NULL if any of several error conditions occurred: the file could not
- be opened, there was no loader for the file's format, there was not
- enough memory to allocate the image buffer, or the image file contained
- invalid data.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_inline"
- c:identifier="gdk_pixbuf_new_from_inline"
- deprecated="1"
- deprecated-version="2.32"
- throws="1">
- <doc xml:space="preserve">Create a #GdkPixbuf from a flat representation that is suitable for
- storing as inline data in a program. This is useful if you want to
- ship a program with images, but don't want to depend on any
- external files.
- gdk-pixbuf ships with a program called [gdk-pixbuf-csource][gdk-pixbuf-csource],
- which allows for conversion of #GdkPixbufs into such a inline representation.
- In almost all cases, you should pass the `--raw` option to
- `gdk-pixbuf-csource`. A sample invocation would be:
- |[
- gdk-pixbuf-csource --raw --name=myimage_inline myimage.png
- ]|
- For the typical case where the inline pixbuf is read-only static data,
- you don't need to copy the pixel data unless you intend to write to
- it, so you can pass %FALSE for @copy_pixels. (If you pass `--rle` to
- `gdk-pixbuf-csource`, a copy will be made even if @copy_pixels is %FALSE,
- so using this option is generally a bad idea.)
- If you create a pixbuf from const inline data compiled into your
- program, it's probably safe to ignore errors and disable length checks,
- since things will always succeed:
- |[
- pixbuf = gdk_pixbuf_new_from_inline (-1, myimage_inline, FALSE, NULL);
- ]|
- For non-const inline data, you could get out of memory. For untrusted
- inline data located at runtime, you could have corrupt inline data in
- addition.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created #GdkPixbuf structure with a reference,
- count of 1, or %NULL if an error occurred.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="data_length" transfer-ownership="none">
- <doc xml:space="preserve">Length in bytes of the @data argument or -1 to
- disable length checks</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">Byte data containing a
- serialized #GdkPixdata structure</doc>
- <array length="0" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="copy_pixels" transfer-ownership="none">
- <doc xml:space="preserve">Whether to copy the pixel data, or use direct pointers
- @data for the resulting pixbuf</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_resource"
- c:identifier="gdk_pixbuf_new_from_resource"
- version="2.26"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from an resource.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="resource_path" transfer-ownership="none">
- <doc xml:space="preserve">the path of the resource file</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_resource_at_scale"
- c:identifier="gdk_pixbuf_new_from_resource_at_scale"
- version="2.26"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from an resource.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set.
- The image will be scaled to fit in the requested size, optionally
- preserving the image's aspect ratio. When preserving the aspect ratio,
- a @width of -1 will cause the image to be scaled to the exact given
- height, and a @height of -1 will cause the image to be scaled to the
- exact given width. When not preserving aspect ratio, a @width or
- @height of -1 means to not scale the image at all in that dimension.
- The stream is not closed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="resource_path" transfer-ownership="none">
- <doc xml:space="preserve">the path of the resource file</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="preserve_aspect_ratio" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_stream"
- c:identifier="gdk_pixbuf_new_from_stream"
- version="2.14"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from an input stream.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set. The @cancellable can be used to abort the operation
- from another thread. If the operation was cancelled, the error
- %G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
- the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
- The stream is not closed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_stream_at_scale"
- c:identifier="gdk_pixbuf_new_from_stream_at_scale"
- version="2.14"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf by loading an image from an input stream.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set. The @cancellable can be used to abort the operation
- from another thread. If the operation was cancelled, the error
- %G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
- the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
- The image will be scaled to fit in the requested size, optionally
- preserving the image's aspect ratio.
- When preserving the aspect ratio, a @width of -1 will cause the image to be
- scaled to the exact given height, and a @height of -1 will cause the image
- to be scaled to the exact given width. If both @width and @height are
- given, this function will behave as if the smaller of the two values
- is passed as -1.
- When not preserving aspect ratio, a @width or @height of -1 means to not
- scale the image at all in that dimension.
- The stream is not closed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">The width the image should have or -1 to not constrain the width</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">The height the image should have or -1 to not constrain the height</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="preserve_aspect_ratio" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_stream_finish"
- c:identifier="gdk_pixbuf_new_from_stream_finish"
- version="2.24"
- throws="1">
- <doc xml:space="preserve">Finishes an asynchronous pixbuf creation operation started with
- gdk_pixbuf_new_from_stream_async().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a #GdkPixbuf or %NULL on error. Free the returned
- object with g_object_unref().</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="async_result" transfer-ownership="none">
- <doc xml:space="preserve">a #GAsyncResult</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_xpm_data"
- c:identifier="gdk_pixbuf_new_from_xpm_data">
- <doc xml:space="preserve">Creates a new pixbuf by parsing XPM data in memory. This data is commonly
- the result of including an XPM file into a program's C source.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">Pointer to inline XPM data.</doc>
- <array c:type="char**">
- <type name="utf8" c:type="char*"/>
- </array>
- </parameter>
- </parameters>
- </constructor>
- <function name="from_pixdata"
- c:identifier="gdk_pixbuf_from_pixdata"
- deprecated="1"
- deprecated-version="2.32"
- throws="1">
- <doc xml:space="preserve">Converts a #GdkPixdata to a #GdkPixbuf. If @copy_pixels is %TRUE or
- if the pixel data is run-length-encoded, the pixel data is copied into
- newly-allocated memory; otherwise it is reused.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a new #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <parameter name="pixdata" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixdata to convert into a #GdkPixbuf.</doc>
- <type name="Pixdata" c:type="const GdkPixdata*"/>
- </parameter>
- <parameter name="copy_pixels" transfer-ownership="none">
- <doc xml:space="preserve">whether to copy raw pixel data; run-length encoded
- pixel data is always copied.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_file_info"
- c:identifier="gdk_pixbuf_get_file_info"
- version="2.4">
- <doc xml:space="preserve">Parses an image file far enough to determine its format and size.</doc>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve">A #GdkPixbufFormat describing
- the image format of the file or %NULL if the image format wasn't
- recognized. The return value is owned by #GdkPixbuf and should
- not be freed.</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">The name of the file to identify.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="width"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve">Return location for the width of the
- image, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="height"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full"
- optional="1"
- allow-none="1">
- <doc xml:space="preserve">Return location for the height of the
- image, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_file_info_async"
- c:identifier="gdk_pixbuf_get_file_info_async"
- version="2.32">
- <doc xml:space="preserve">Asynchronously parses an image file far enough to determine its
- format and size.
- For more details see gdk_pixbuf_get_file_info(), which is the synchronous
- version of this function.
- When the operation is finished, @callback will be called in the
- main thread. You can then call gdk_pixbuf_get_file_info_finish() to
- get the result of the operation.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">The name of the file to identify</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="3">
- <doc xml:space="preserve">a #GAsyncReadyCallback to call when the the pixbuf is loaded</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to pass to the callback function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_file_info_finish"
- c:identifier="gdk_pixbuf_get_file_info_finish"
- version="2.32"
- throws="1">
- <doc xml:space="preserve">Finishes an asynchronous pixbuf parsing operation started with
- gdk_pixbuf_get_file_info_async().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">A #GdkPixbufFormat describing the image
- format of the file or %NULL if the image format wasn't
- recognized. The return value is owned by GdkPixbuf and should
- not be freed.</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </return-value>
- <parameters>
- <parameter name="async_result" transfer-ownership="none">
- <doc xml:space="preserve">a #GAsyncResult</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- <parameter name="width"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">Return location for the width of the image, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- <parameter name="height"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">Return location for the height of the image, or %NULL</doc>
- <type name="gint" c:type="gint*"/>
- </parameter>
- </parameters>
- </function>
- <function name="get_formats"
- c:identifier="gdk_pixbuf_get_formats"
- version="2.2">
- <doc xml:space="preserve">Obtains the available information about the image formats supported
- by GdkPixbuf.</doc>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve">A list of
- #GdkPixbufFormats describing the supported image formats. The list should
- be freed when it is no longer needed, but the structures themselves are
- owned by #GdkPixbuf and should not be freed.</doc>
- <type name="GLib.SList" c:type="GSList*">
- <type name="PixbufFormat"/>
- </type>
- </return-value>
- </function>
- <function name="new_from_stream_async"
- c:identifier="gdk_pixbuf_new_from_stream_async"
- version="2.24">
- <doc xml:space="preserve">Creates a new pixbuf by asynchronously loading an image from an input stream.
- For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
- version of this function.
- When the operation is finished, @callback will be called in the main thread.
- You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream from which to load the pixbuf</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="3">
- <doc xml:space="preserve">a #GAsyncReadyCallback to call when the the pixbuf is loaded</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to pass to the callback function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_from_stream_at_scale_async"
- c:identifier="gdk_pixbuf_new_from_stream_at_scale_async"
- version="2.24">
- <doc xml:space="preserve">Creates a new pixbuf by asynchronously loading an image from an input stream.
- For more details see gdk_pixbuf_new_from_stream_at_scale(), which is the synchronous
- version of this function.
- When the operation is finished, @callback will be called in the main thread.
- You can then call gdk_pixbuf_new_from_stream_finish() to get the result of the operation.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream from which to load the pixbuf</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">the width the image should have or -1 to not constrain the width</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">the height the image should have or -1 to not constrain the height</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="preserve_aspect_ratio" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to preserve the image's aspect ratio</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="6">
- <doc xml:space="preserve">a #GAsyncReadyCallback to call when the the pixbuf is loaded</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to pass to the callback function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <function name="save_to_stream_finish"
- c:identifier="gdk_pixbuf_save_to_stream_finish"
- version="2.24"
- throws="1">
- <doc xml:space="preserve">Finishes an asynchronous pixbuf save operation started with
- gdk_pixbuf_save_to_stream_async().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the pixbuf was saved successfully, %FALSE if an error was set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="async_result" transfer-ownership="none">
- <doc xml:space="preserve">a #GAsyncResult</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- </parameters>
- </function>
- <method name="add_alpha" c:identifier="gdk_pixbuf_add_alpha">
- <doc xml:space="preserve">Takes an existing pixbuf and adds an alpha channel to it.
- If the existing pixbuf already had an alpha channel, the channel
- values are copied from the original; otherwise, the alpha channel
- is initialized to 255 (full opacity).
- If @substitute_color is %TRUE, then the color specified by (@r, @g, @b) will be
- assigned zero opacity. That is, if you pass (255, 255, 255) for the
- substitute color, all white pixels will become fully transparent.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="substitute_color" transfer-ownership="none">
- <doc xml:space="preserve">Whether to set a color to zero opacity. If this
- is %FALSE, then the (@r, @g, @b) arguments will be ignored.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="r" transfer-ownership="none">
- <doc xml:space="preserve">Red value to substitute.</doc>
- <type name="guint8" c:type="guchar"/>
- </parameter>
- <parameter name="g" transfer-ownership="none">
- <doc xml:space="preserve">Green value to substitute.</doc>
- <type name="guint8" c:type="guchar"/>
- </parameter>
- <parameter name="b" transfer-ownership="none">
- <doc xml:space="preserve">Blue value to substitute.</doc>
- <type name="guint8" c:type="guchar"/>
- </parameter>
- </parameters>
- </method>
- <method name="apply_embedded_orientation"
- c:identifier="gdk_pixbuf_apply_embedded_orientation"
- version="2.12">
- <doc xml:space="preserve">Takes an existing pixbuf and checks for the presence of an
- associated "orientation" option, which may be provided by the
- jpeg loader (which reads the exif orientation tag) or the
- tiff loader (which reads the tiff orientation tag, and
- compensates it for the partial transforms performed by
- libtiff). If an orientation option/tag is present, the
- appropriate transform will be performed so that the pixbuf
- is oriented correctly.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or a reference to the
- input pixbuf (with an increased reference count).</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">A #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="composite" c:identifier="gdk_pixbuf_composite">
- <doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
- @scale_x and @scale_y then translating by @offset_x and @offset_y.
- This gives an image in the coordinates of the destination pixbuf.
- The rectangle (@dest_x, @dest_y, @dest_width, @dest_height)
- is then composited onto the corresponding rectangle of the
- original destination image.
- When the destination rectangle contains parts not in the source
- image, the data at the edges of the source image is replicated
- to infinity.
- </doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- <parameter name="dest_x" transfer-ownership="none">
- <doc xml:space="preserve">the left coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_y" transfer-ownership="none">
- <doc xml:space="preserve">the top coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve">the width of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve">the height of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="offset_x" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="offset_y" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_x" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the X direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_y" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the Y direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="interp_type" transfer-ownership="none">
- <doc xml:space="preserve">the interpolation type for the transformation.</doc>
- <type name="InterpType" c:type="GdkInterpType"/>
- </parameter>
- <parameter name="overall_alpha" transfer-ownership="none">
- <doc xml:space="preserve">overall alpha for source image (0..255)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="composite_color" c:identifier="gdk_pixbuf_composite_color">
- <doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
- @scale_x and @scale_y then translating by @offset_x and @offset_y,
- then composites the rectangle (@dest_x ,@dest_y, @dest_width,
- @dest_height) of the resulting image with a checkboard of the
- colors @color1 and @color2 and renders it onto the destination
- image.
- See gdk_pixbuf_composite_color_simple() for a simpler variant of this
- function suitable for many tasks.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- <parameter name="dest_x" transfer-ownership="none">
- <doc xml:space="preserve">the left coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_y" transfer-ownership="none">
- <doc xml:space="preserve">the top coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve">the width of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve">the height of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="offset_x" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="offset_y" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_x" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the X direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_y" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the Y direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="interp_type" transfer-ownership="none">
- <doc xml:space="preserve">the interpolation type for the transformation.</doc>
- <type name="InterpType" c:type="GdkInterpType"/>
- </parameter>
- <parameter name="overall_alpha" transfer-ownership="none">
- <doc xml:space="preserve">overall alpha for source image (0..255)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="check_x" transfer-ownership="none">
- <doc xml:space="preserve">the X offset for the checkboard (origin of checkboard is at -@check_x, -@check_y)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="check_y" transfer-ownership="none">
- <doc xml:space="preserve">the Y offset for the checkboard</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="check_size" transfer-ownership="none">
- <doc xml:space="preserve">the size of checks in the checkboard (must be a power of two)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="color1" transfer-ownership="none">
- <doc xml:space="preserve">the color of check at upper left</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="color2" transfer-ownership="none">
- <doc xml:space="preserve">the color of the other check</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="composite_color_simple"
- c:identifier="gdk_pixbuf_composite_color_simple">
- <doc xml:space="preserve">Creates a new #GdkPixbuf by scaling @src to @dest_width x
- @dest_height and compositing the result with a checkboard of colors
- @color1 and @color2.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">the new #GdkPixbuf, or %NULL if not enough memory could be
- allocated for it.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve">the width of destination image</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve">the height of destination image</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="interp_type" transfer-ownership="none">
- <doc xml:space="preserve">the interpolation type for the transformation.</doc>
- <type name="InterpType" c:type="GdkInterpType"/>
- </parameter>
- <parameter name="overall_alpha" transfer-ownership="none">
- <doc xml:space="preserve">overall alpha for source image (0..255)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="check_size" transfer-ownership="none">
- <doc xml:space="preserve">the size of checks in the checkboard (must be a power of two)</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="color1" transfer-ownership="none">
- <doc xml:space="preserve">the color of check at upper left</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="color2" transfer-ownership="none">
- <doc xml:space="preserve">the color of the other check</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="copy" c:identifier="gdk_pixbuf_copy">
- <doc xml:space="preserve">Creates a new #GdkPixbuf with a copy of the information in the specified
- @pixbuf.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf with a reference count of 1, or %NULL if
- not enough memory could be allocated.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="copy_area" c:identifier="gdk_pixbuf_copy_area">
- <doc xml:space="preserve">Copies a rectangular area from @src_pixbuf to @dest_pixbuf. Conversion of
- pixbuf formats is done automatically.
- If the source rectangle overlaps the destination rectangle on the
- same pixbuf, it will be overwritten during the copy operation.
- Therefore, you can not use this function to scroll a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src_pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">Source pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="src_x" transfer-ownership="none">
- <doc xml:space="preserve">Source X coordinate within @src_pixbuf.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="src_y" transfer-ownership="none">
- <doc xml:space="preserve">Source Y coordinate within @src_pixbuf.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">Width of the area to copy.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">Height of the area to copy.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">Destination pixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- <parameter name="dest_x" transfer-ownership="none">
- <doc xml:space="preserve">X coordinate within @dest_pixbuf.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_y" transfer-ownership="none">
- <doc xml:space="preserve">Y coordinate within @dest_pixbuf.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="fill" c:identifier="gdk_pixbuf_fill">
- <doc xml:space="preserve">Clears a pixbuf to the given RGBA value, converting the RGBA value into
- the pixbuf's pixel format. The alpha will be ignored if the pixbuf
- doesn't have an alpha channel.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="pixel" transfer-ownership="none">
- <doc xml:space="preserve">RGBA pixel to clear to
- (0xffffffff is opaque white, 0x00000000 transparent black)</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="flip" c:identifier="gdk_pixbuf_flip" version="2.6">
- <doc xml:space="preserve">Flips a pixbuf horizontally or vertically and returns the
- result in a new pixbuf.</doc>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve">the new #GdkPixbuf, or %NULL
- if not enough memory could be allocated for it.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="horizontal" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to flip horizontally, %FALSE to flip vertically</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_bits_per_sample"
- c:identifier="gdk_pixbuf_get_bits_per_sample">
- <doc xml:space="preserve">Queries the number of bits per color sample in a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Number of bits per color sample.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_byte_length"
- c:identifier="gdk_pixbuf_get_byte_length"
- version="2.26">
- <doc xml:space="preserve">Returns the length of the pixel data, in bytes.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the pixel data.</doc>
- <type name="gsize" c:type="gsize"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_colorspace" c:identifier="gdk_pixbuf_get_colorspace">
- <doc xml:space="preserve">Queries the color space of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Color space.</doc>
- <type name="Colorspace" c:type="GdkColorspace"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_has_alpha" c:identifier="gdk_pixbuf_get_has_alpha">
- <doc xml:space="preserve">Queries whether a pixbuf has an alpha channel (opacity information).</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if it has an alpha channel, %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_height" c:identifier="gdk_pixbuf_get_height">
- <doc xml:space="preserve">Queries the height of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Height in pixels.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_n_channels" c:identifier="gdk_pixbuf_get_n_channels">
- <doc xml:space="preserve">Queries the number of channels of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Number of channels.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_option" c:identifier="gdk_pixbuf_get_option">
- <doc xml:space="preserve">Looks up @key in the list of options that may have been attached to the
- @pixbuf when it was loaded, or that may have been attached by another
- function using gdk_pixbuf_set_option().
- For instance, the ANI loader provides "Title" and "Artist" options.
- The ICO, XBM, and XPM loaders provide "x_hot" and "y_hot" hot-spot
- options for cursor definitions. The PNG loader provides the tEXt ancillary
- chunk key/value pairs as options. Since 2.12, the TIFF and JPEG loaders
- return an "orientation" option string that corresponds to the embedded
- TIFF/Exif orientation tag (if present). Since 2.32, the TIFF loader sets
- the "multipage" option string to "yes" when a multi-page TIFF is loaded.
- Since 2.32 the JPEG and PNG loaders set "x-dpi" and "y-dpi" if the file
- contains image density information in dots per inch.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the value associated with @key. This is a nul-terminated
- string that should not be freed or %NULL if @key was not found.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="key" transfer-ownership="none">
- <doc xml:space="preserve">a nul-terminated string.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_options"
- c:identifier="gdk_pixbuf_get_options"
- version="2.32">
- <doc xml:space="preserve">Returns a #GHashTable with a list of all the options that may have been
- attached to the @pixbuf when it was loaded, or that may have been
- attached by another function using gdk_pixbuf_set_option().
- See gdk_pixbuf_get_option() for more details.</doc>
- <return-value transfer-ownership="container">
- <doc xml:space="preserve">a #GHashTable of key/values</doc>
- <type name="GLib.HashTable" c:type="GHashTable*">
- <type name="utf8"/>
- <type name="utf8"/>
- </type>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pixels"
- c:identifier="gdk_pixbuf_get_pixels"
- shadowed-by="get_pixels_with_length">
- <doc xml:space="preserve">Queries a pointer to the pixel data of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">A pointer to the pixbuf's pixel data.
- Please see the section on [image data](image-data) for information
- about how the pixel data is stored in memory.
- This function will cause an implicit copy of the pixbuf data if the
- pixbuf was created from read-only data.</doc>
- <array zero-terminated="0" c:type="guchar*">
- <type name="guint8" c:type="guchar"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pixels_with_length"
- c:identifier="gdk_pixbuf_get_pixels_with_length"
- shadows="get_pixels"
- version="2.26">
- <doc xml:space="preserve">Queries a pointer to the pixel data of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">A pointer to the pixbuf's
- pixel data. Please see the section on [image data](image-data)
- for information about how the pixel data is stored in memory.
- This function will cause an implicit copy of the pixbuf data if the
- pixbuf was created from read-only data.</doc>
- <array length="0" zero-terminated="0" c:type="guchar*">
- <type name="guint8" c:type="guchar"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="length"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">The length of the binary data.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_rowstride" c:identifier="gdk_pixbuf_get_rowstride">
- <doc xml:space="preserve">Queries the rowstride of a pixbuf, which is the number of bytes between
- the start of a row and the start of the next row.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Distance between row starts.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_width" c:identifier="gdk_pixbuf_get_width">
- <doc xml:space="preserve">Queries the width of a pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Width in pixels.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="new_subpixbuf" c:identifier="gdk_pixbuf_new_subpixbuf">
- <doc xml:space="preserve">Creates a new pixbuf which represents a sub-region of @src_pixbuf.
- The new pixbuf shares its pixels with the original pixbuf, so
- writing to one affects both. The new pixbuf holds a reference to
- @src_pixbuf, so @src_pixbuf will not be finalized until the new
- pixbuf is finalized.
- Note that if @src_pixbuf is read-only, this function will force it
- to be mutable.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a new pixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src_pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="src_x" transfer-ownership="none">
- <doc xml:space="preserve">X coord in @src_pixbuf</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="src_y" transfer-ownership="none">
- <doc xml:space="preserve">Y coord in @src_pixbuf</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">width of region in @src_pixbuf</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">height of region in @src_pixbuf</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="read_pixel_bytes"
- c:identifier="gdk_pixbuf_read_pixel_bytes"
- version="2.32">
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A new reference to a read-only copy of
- the pixel data. Note that for mutable pixbufs, this function will
- incur a one-time copy of the pixel data for conversion into the
- returned #GBytes.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="read_pixels"
- c:identifier="gdk_pixbuf_read_pixels"
- version="2.32">
- <doc xml:space="preserve">Returns a read-only pointer to the raw pixel data; must not be
- modified. This function allows skipping the implicit copy that
- must be made if gdk_pixbuf_get_pixels() is called on a read-only
- pixbuf.</doc>
- <return-value transfer-ownership="none">
- <type name="guint8" c:type="const guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref"
- c:identifier="gdk_pixbuf_ref"
- introspectable="0"
- deprecated="1"
- deprecated-version="2.0">
- <doc xml:space="preserve">Adds a reference to a pixbuf.</doc>
- <doc-deprecated xml:space="preserve">Use g_object_ref().</doc-deprecated>
- <return-value>
- <doc xml:space="preserve">The same as the @pixbuf argument.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="rotate_simple"
- c:identifier="gdk_pixbuf_rotate_simple"
- version="2.6">
- <doc xml:space="preserve">Rotates a pixbuf by a multiple of 90 degrees, and returns the
- result in a new pixbuf.</doc>
- <return-value transfer-ownership="full" nullable="1">
- <doc xml:space="preserve">the new #GdkPixbuf, or %NULL
- if not enough memory could be allocated for it.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="angle" transfer-ownership="none">
- <doc xml:space="preserve">the angle to rotate by</doc>
- <type name="PixbufRotation" c:type="GdkPixbufRotation"/>
- </parameter>
- </parameters>
- </method>
- <method name="saturate_and_pixelate"
- c:identifier="gdk_pixbuf_saturate_and_pixelate">
- <doc xml:space="preserve">Modifies saturation and optionally pixelates @src, placing the result in
- @dest. @src and @dest may be the same pixbuf with no ill effects. If
- @saturation is 1.0 then saturation is not changed. If it's less than 1.0,
- saturation is reduced (the image turns toward grayscale); if greater than
- 1.0, saturation is increased (the image gets more vivid colors). If @pixelate
- is %TRUE, then pixels are faded in a checkerboard pattern to create a
- pixelated image. @src and @dest must have the same image format, size, and
- rowstride.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">source image</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve">place to write modified version of @src</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- <parameter name="saturation" transfer-ownership="none">
- <doc xml:space="preserve">saturation factor</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- <parameter name="pixelate" transfer-ownership="none">
- <doc xml:space="preserve">whether to pixelate</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="save" c:identifier="gdk_pixbuf_save" introspectable="0">
- <doc xml:space="preserve">Saves pixbuf to a file in format @type. By default, "jpeg", "png", "ico"
- and "bmp" are possible file formats to save in, but more formats may be
- installed. The list of all writable formats can be determined in the
- following way:
- |[
- void add_if_writable (GdkPixbufFormat *data, GSList **list)
- {
- if (gdk_pixbuf_format_is_writable (data))
- *list = g_slist_prepend (*list, data);
- }
- GSList *formats = gdk_pixbuf_get_formats ();
- GSList *writable_formats = NULL;
- g_slist_foreach (formats, add_if_writable, &writable_formats);
- g_slist_free (formats);
- ]|
- If @error is set, %FALSE will be returned. Possible errors include
- those in the #GDK_PIXBUF_ERROR domain and those in the #G_FILE_ERROR domain.
- The variable argument list should be %NULL-terminated; if not empty,
- it should contain pairs of strings that modify the save
- parameters. For example:
- |[
- gdk_pixbuf_save (pixbuf, handle, "jpeg", &error, "quality", "100", NULL);
- ]|
- Currently only few parameters exist. JPEG images can be saved with a
- "quality" parameter; its value should be in the range [0,100]. JPEG
- and PNG density can be set by setting the "x-dpi" and "y-dpi" parameters
- to the appropriate values in dots per inch.
- Text chunks can be attached to PNG images by specifying parameters of
- the form "tEXt::key", where key is an ASCII string of length 1-79.
- The values are UTF-8 encoded strings. The PNG compression level can
- be specified using the "compression" parameter; it's value is in an
- integer in the range of [0,9].
- ICC color profiles can also be embedded into PNG, JPEG and TIFF images.
- The "icc-profile" value should be the complete ICC profile encoded
- into base64.
- |[
- gchar *contents;
- gchar *contents_encode;
- gsize length;
- g_file_get_contents ("/home/hughsie/.color/icc/L225W.icm", &contents, &length, NULL);
- contents_encode = g_base64_encode ((const guchar *) contents, length);
- gdk_pixbuf_save (pixbuf, handle, "png", &error, "icc-profile", contents_encode, NULL);
- ]|
- TIFF images recognize: (1) a "bits-per-sample" option (integer) which
- can be either 1 for saving bi-level CCITTFAX4 images, or 8 for saving
- 8-bits per sample; (2) a "compression" option (integer) which can be
- 1 for no compression, 2 for Huffman, 5 for LZW, 7 for JPEG and 8 for
- DEFLATE (see the libtiff documentation and tiff.h for all supported
- codec values); (3) an "icc-profile" option (zero-terminated string)
- containing a base64 encoded ICC color profile.
- ICO images can be saved in depth 16, 24, or 32, by using the "depth"
- parameter. When the ICO saver is given "x_hot" and "y_hot" parameters,
- it produces a CUR instead of an ICO.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">name of file to save.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="error"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">return location for error, or %NULL</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">list of key-value save options, followed by %NULL</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_buffer"
- c:identifier="gdk_pixbuf_save_to_buffer"
- version="2.4"
- introspectable="0">
- <doc xml:space="preserve">Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
- "png", "tiff", "ico" or "bmp". This is a convenience function that uses
- gdk_pixbuf_save_to_callback() to do the real work. Note that the buffer
- is not nul-terminated and may contain embedded nuls.
- If @error is set, %FALSE will be returned and @buffer will be set to
- %NULL. Possible errors include those in the #GDK_PIXBUF_ERROR
- domain.
- See gdk_pixbuf_save() for more details.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location to receive a pointer
- to the new buffer.</doc>
- <array length="1" zero-terminated="0" c:type="gchar**">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="buffer_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location to receive the size of the new buffer.</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="error"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">return location for error, or %NULL</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">list of key-value save options</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_bufferv"
- c:identifier="gdk_pixbuf_save_to_bufferv"
- version="2.4"
- throws="1">
- <doc xml:space="preserve">Saves pixbuf to a new buffer in format @type, which is currently "jpeg",
- "tiff", "png", "ico" or "bmp". See gdk_pixbuf_save_to_buffer()
- for more details.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="buffer"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">
- location to receive a pointer to the new buffer.</doc>
- <array length="1" zero-terminated="0" c:type="gchar**">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="buffer_size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location to receive the size of the new buffer.</doc>
- <type name="gsize" c:type="gsize*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="option_keys" transfer-ownership="none">
- <doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
- <array c:type="char**">
- <type name="utf8" c:type="char*"/>
- </array>
- </parameter>
- <parameter name="option_values" transfer-ownership="none">
- <doc xml:space="preserve">values for named options</doc>
- <array c:type="char**">
- <type name="utf8" c:type="char*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_callback"
- c:identifier="gdk_pixbuf_save_to_callback"
- version="2.4"
- introspectable="0">
- <doc xml:space="preserve">Saves pixbuf in format @type by feeding the produced data to a
- callback. Can be used when you want to store the image to something
- other than a file, such as an in-memory buffer or a socket.
- If @error is set, %FALSE will be returned. Possible errors
- include those in the #GDK_PIXBUF_ERROR domain and whatever the save
- function generates.
- See gdk_pixbuf_save() for more details.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="save_func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve">a function that is called to save each block of data that
- the save routine generates.</doc>
- <type name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">user data to pass to the save function.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="error"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">return location for error, or %NULL</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">list of key-value save options</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_callbackv"
- c:identifier="gdk_pixbuf_save_to_callbackv"
- version="2.4"
- throws="1">
- <doc xml:space="preserve">Saves pixbuf to a callback in format @type, which is currently "jpeg",
- "png", "tiff", "ico" or "bmp". If @error is set, %FALSE will be returned. See
- gdk_pixbuf_save_to_callback () for more details.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="save_func"
- transfer-ownership="none"
- scope="call"
- closure="1">
- <doc xml:space="preserve">a function that is called to save each block of data that
- the save routine generates.</doc>
- <type name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">user data to pass to the save function.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="option_keys" transfer-ownership="none">
- <doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
- <array c:type="char**">
- <type name="utf8"/>
- </array>
- </parameter>
- <parameter name="option_values" transfer-ownership="none">
- <doc xml:space="preserve">values for named options</doc>
- <array c:type="char**">
- <type name="utf8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_stream"
- c:identifier="gdk_pixbuf_save_to_stream"
- version="2.14"
- introspectable="0">
- <doc xml:space="preserve">Saves @pixbuf to an output stream.
- Supported file formats are currently "jpeg", "tiff", "png", "ico" or
- "bmp". See gdk_pixbuf_save_to_buffer() for more details.
- The @cancellable can be used to abort the operation from another
- thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED
- will be returned. Other possible errors are in the #GDK_PIXBUF_ERROR
- and %G_IO_ERROR domains.
- The stream is not closed.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the pixbuf was saved successfully, %FALSE if an
- error was set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GOutputStream to save the pixbuf to</doc>
- <type name="Gio.OutputStream" c:type="GOutputStream*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="error"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">return location for error, or %NULL</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">list of key-value save options</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="save_to_stream_async"
- c:identifier="gdk_pixbuf_save_to_stream_async"
- version="2.24"
- introspectable="0">
- <doc xml:space="preserve">Saves @pixbuf to an output stream asynchronously.
- For more details see gdk_pixbuf_save_to_stream(), which is the synchronous
- version of this function.
- When the operation is finished, @callback will be called in the main thread.
- You can then call gdk_pixbuf_save_to_stream_finish() to get the result of the operation.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GOutputStream to which to save the pixbuf</doc>
- <type name="Gio.OutputStream" c:type="GOutputStream*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="4">
- <doc xml:space="preserve">a #GAsyncReadyCallback to call when the the pixbuf is loaded</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to pass to the callback function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">list of key-value save options</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <method name="savev" c:identifier="gdk_pixbuf_savev" throws="1">
- <doc xml:space="preserve">Saves pixbuf to a file in @type, which is currently "jpeg", "png", "tiff", "ico" or "bmp".
- If @error is set, %FALSE will be returned.
- See gdk_pixbuf_save () for more details.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether an error was set</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">name of file to save.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">name of file format.</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- <parameter name="option_keys" transfer-ownership="none">
- <doc xml:space="preserve">name of options to set, %NULL-terminated</doc>
- <array c:type="char**">
- <type name="utf8" c:type="char*"/>
- </array>
- </parameter>
- <parameter name="option_values" transfer-ownership="none">
- <doc xml:space="preserve">values for named options</doc>
- <array c:type="char**">
- <type name="utf8" c:type="char*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="scale" c:identifier="gdk_pixbuf_scale">
- <doc xml:space="preserve">Creates a transformation of the source image @src by scaling by
- @scale_x and @scale_y then translating by @offset_x and @offset_y,
- then renders the rectangle (@dest_x, @dest_y, @dest_width,
- @dest_height) of the resulting image onto the destination image
- replacing the previous contents.
- Try to use gdk_pixbuf_scale_simple() first, this function is
- the industrial-strength power tool you can fall back to if
- gdk_pixbuf_scale_simple() isn't powerful enough.
- If the source rectangle overlaps the destination rectangle on the
- same pixbuf, it will be overwritten during the scaling which
- results in rendering artifacts.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest" transfer-ownership="none">
- <doc xml:space="preserve">the #GdkPixbuf into which to render the results</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- <parameter name="dest_x" transfer-ownership="none">
- <doc xml:space="preserve">the left coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_y" transfer-ownership="none">
- <doc xml:space="preserve">the top coordinate for region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve">the width of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve">the height of the region to render</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="offset_x" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the X direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="offset_y" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the Y direction (currently rounded to an integer)</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_x" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the X direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="scale_y" transfer-ownership="none">
- <doc xml:space="preserve">the scale factor in the Y direction</doc>
- <type name="gdouble" c:type="double"/>
- </parameter>
- <parameter name="interp_type" transfer-ownership="none">
- <doc xml:space="preserve">the interpolation type for the transformation.</doc>
- <type name="InterpType" c:type="GdkInterpType"/>
- </parameter>
- </parameters>
- </method>
- <method name="scale_simple" c:identifier="gdk_pixbuf_scale_simple">
- <doc xml:space="preserve">Create a new #GdkPixbuf containing a copy of @src scaled to
- @dest_width x @dest_height. Leaves @src unaffected. @interp_type
- should be #GDK_INTERP_NEAREST if you want maximum speed (but when
- scaling down #GDK_INTERP_NEAREST is usually unusably ugly). The
- default @interp_type should be #GDK_INTERP_BILINEAR which offers
- reasonable quality and speed.
- You can scale a sub-portion of @src by creating a sub-pixbuf
- pointing into @src; see gdk_pixbuf_new_subpixbuf().
- For more complicated scaling/compositing see gdk_pixbuf_scale()
- and gdk_pixbuf_composite().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">the new #GdkPixbuf, or %NULL if not enough memory could be
- allocated for it.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="src" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbuf</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </instance-parameter>
- <parameter name="dest_width" transfer-ownership="none">
- <doc xml:space="preserve">the width of destination image</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="dest_height" transfer-ownership="none">
- <doc xml:space="preserve">the height of destination image</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="interp_type" transfer-ownership="none">
- <doc xml:space="preserve">the interpolation type for the transformation.</doc>
- <type name="InterpType" c:type="GdkInterpType"/>
- </parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gdk_pixbuf_unref"
- introspectable="0"
- deprecated="1"
- deprecated-version="2.0">
- <doc xml:space="preserve">Removes a reference from a pixbuf.</doc>
- <doc-deprecated xml:space="preserve">Use g_object_unref().</doc-deprecated>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </instance-parameter>
- </parameters>
- </method>
- <property name="bits-per-sample"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve">The number of bits per sample.
- Currently only 8 bit per sample are supported.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="colorspace"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="Colorspace"/>
- </property>
- <property name="has-alpha"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="height"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="n-channels"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve">The number of samples per pixel.
- Currently, only 3 or 4 samples per pixel are supported.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="pixel-bytes"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="GLib.Bytes"/>
- </property>
- <property name="pixels"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gpointer" c:type="gpointer"/>
- </property>
- <property name="rowstride"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <doc xml:space="preserve">The number of bytes between the start of a row and
- the start of the next row. This number must (obviously)
- be at least as large as the width of the pixbuf.</doc>
- <type name="gint" c:type="gint"/>
- </property>
- <property name="width"
- writable="1"
- construct-only="1"
- transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- </class>
- <enumeration name="PixbufAlphaMode"
- glib:type-name="GdkPixbufAlphaMode"
- glib:get-type="gdk_pixbuf_alpha_mode_get_type"
- c:type="GdkPixbufAlphaMode">
- <doc xml:space="preserve">These values can be passed to
- gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
- channel of an image should be handled. This function can create a
- bilevel clipping mask (black and white) and use it while painting
- the image. In the future, when the X Window System gets an alpha
- channel extension, it will be possible to do full alpha
- compositing onto arbitrary drawables. For now both cases fall
- back to a bilevel clipping mask.</doc>
- <member name="bilevel"
- value="0"
- c:identifier="GDK_PIXBUF_ALPHA_BILEVEL"
- glib:nick="bilevel">
- <doc xml:space="preserve">A bilevel clipping mask (black and white)
- will be created and used to draw the image. Pixels below 0.5 opacity
- will be considered fully transparent, and all others will be
- considered fully opaque.</doc>
- </member>
- <member name="full"
- value="1"
- c:identifier="GDK_PIXBUF_ALPHA_FULL"
- glib:nick="full">
- <doc xml:space="preserve">For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
- In the future it will do full alpha compositing.</doc>
- </member>
- </enumeration>
- <class name="PixbufAnimation"
- c:symbol-prefix="pixbuf_animation"
- c:type="GdkPixbufAnimation"
- parent="GObject.Object"
- glib:type-name="GdkPixbufAnimation"
- glib:get-type="gdk_pixbuf_animation_get_type">
- <doc xml:space="preserve">An opaque struct representing an animation.</doc>
- <constructor name="new_from_file"
- c:identifier="gdk_pixbuf_animation_new_from_file"
- throws="1">
- <doc xml:space="preserve">Creates a new animation by loading it from a file. The file format is
- detected automatically. If the file's format does not support multi-frame
- images, then an animation with a single frame will be created. Possible errors
- are in the #GDK_PIXBUF_ERROR and #G_FILE_ERROR domains.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created animation with a reference count of 1, or %NULL
- if any of several error conditions ocurred: the file could not be opened,
- there was no loader for the file's format, there was not enough memory to
- allocate the image buffer, or the image file contained invalid data.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <parameter name="filename" transfer-ownership="none">
- <doc xml:space="preserve">Name of file to load, in the GLib file name encoding</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_resource"
- c:identifier="gdk_pixbuf_animation_new_from_resource"
- version="2.28"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf animation by loading an image from an resource.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created animation, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <parameter name="resource_path" transfer-ownership="none">
- <doc xml:space="preserve">the path of the resource file</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_stream"
- c:identifier="gdk_pixbuf_animation_new_from_stream"
- version="2.28"
- throws="1">
- <doc xml:space="preserve">Creates a new animation by loading it from an input stream.
- The file format is detected automatically. If %NULL is returned, then
- @error will be set. The @cancellable can be used to abort the operation
- from another thread. If the operation was cancelled, the error
- %G_IO_ERROR_CANCELLED will be returned. Other possible errors are in
- the #GDK_PIXBUF_ERROR and %G_IO_ERROR domains.
- The stream is not closed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf, or %NULL if any of several error
- conditions occurred: the file could not be opened, the image format is
- not supported, there was not enough memory to allocate the image buffer,
- the stream contained invalid data, or the operation was cancelled.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream to load the pixbuf from</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_from_stream_finish"
- c:identifier="gdk_pixbuf_animation_new_from_stream_finish"
- version="2.28"
- throws="1">
- <doc xml:space="preserve">Finishes an asynchronous pixbuf animation creation operation started with
- gdk_pixbuf_animation_new_from_stream_async().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a #GdkPixbufAnimation or %NULL on error. Free the returned
- object with g_object_unref().</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <parameter name="async_result" transfer-ownership="none">
- <doc xml:space="preserve">a #GAsyncResult</doc>
- <type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
- </parameter>
- </parameters>
- </constructor>
- <function name="new_from_stream_async"
- c:identifier="gdk_pixbuf_animation_new_from_stream_async"
- version="2.28">
- <doc xml:space="preserve">Creates a new animation by asynchronously loading an image from an input stream.
- For more details see gdk_pixbuf_new_from_stream(), which is the synchronous
- version of this function.
- When the operation is finished, @callback will be called in the main thread.
- You can then call gdk_pixbuf_animation_new_from_stream_finish() to get the
- result of the operation.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">a #GInputStream from which to load the animation</doc>
- <type name="Gio.InputStream" c:type="GInputStream*"/>
- </parameter>
- <parameter name="cancellable"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">optional #GCancellable object, %NULL to ignore</doc>
- <type name="Gio.Cancellable" c:type="GCancellable*"/>
- </parameter>
- <parameter name="callback"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- scope="async"
- closure="3">
- <doc xml:space="preserve">a #GAsyncReadyCallback to call when the the pixbuf is loaded</doc>
- <type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
- </parameter>
- <parameter name="user_data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to pass to the callback function</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </function>
- <method name="get_height" c:identifier="gdk_pixbuf_animation_get_height">
- <doc xml:space="preserve">Queries the height of the bounding box of a pixbuf animation.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Height of the bounding box of the animation.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">An animation.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_iter" c:identifier="gdk_pixbuf_animation_get_iter">
- <doc xml:space="preserve">Get an iterator for displaying an animation. The iterator provides
- the frames that should be displayed at a given time. It should be
- freed after use with g_object_unref().
- @start_time would normally come from g_get_current_time(), and marks
- the beginning of animation playback. After creating an iterator, you
- should immediately display the pixbuf returned by
- gdk_pixbuf_animation_iter_get_pixbuf(). Then, you should install
- a timeout (with g_timeout_add()) or by some other mechanism ensure
- that you'll update the image after
- gdk_pixbuf_animation_iter_get_delay_time() milliseconds. Each time
- the image is updated, you should reinstall the timeout with the new,
- possibly-changed delay time.
- As a shortcut, if @start_time is %NULL, the result of
- g_get_current_time() will be used automatically.
- To update the image (i.e. possibly change the result of
- gdk_pixbuf_animation_iter_get_pixbuf() to a new frame of the animation),
- call gdk_pixbuf_animation_iter_advance().
- If you're using #GdkPixbufLoader, in addition to updating the image
- after the delay time, you should also update it whenever you
- receive the area_updated signal and
- gdk_pixbuf_animation_iter_on_currently_loading_frame() returns
- %TRUE. In this case, the frame currently being fed into the loader
- has received new data, so needs to be refreshed. The delay time for
- a frame may also be modified after an area_updated signal, for
- example if the delay time for a frame is encoded in the data after
- the frame itself. So your timeout should be reinstalled after any
- area_updated signal.
- A delay time of -1 is possible, indicating "infinite."</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">an iterator to move over the animation</doc>
- <type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufAnimation</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- <parameter name="start_time"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">time when the animation starts playing</doc>
- <type name="GLib.TimeVal" c:type="const GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_static_image"
- c:identifier="gdk_pixbuf_animation_get_static_image">
- <doc xml:space="preserve">If an animation is really just a plain image (has only one frame),
- this function returns that image. If the animation is an animation,
- this function returns a reasonable thing to display as a static
- unanimated image, which might be the first frame, or something more
- sophisticated. If an animation hasn't loaded any frames yet, this
- function will return %NULL.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">unanimated image representing the animation</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufAnimation</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_width" c:identifier="gdk_pixbuf_animation_get_width">
- <doc xml:space="preserve">Queries the width of the bounding box of a pixbuf animation.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Width of the bounding box of the animation.</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">An animation.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_static_image"
- c:identifier="gdk_pixbuf_animation_is_static_image">
- <doc xml:space="preserve">If you load a file with gdk_pixbuf_animation_new_from_file() and it
- turns out to be a plain, unanimated image, then this function will
- return %TRUE. Use gdk_pixbuf_animation_get_static_image() to retrieve
- the image.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the "animation" was really just an image</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufAnimation</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="ref"
- c:identifier="gdk_pixbuf_animation_ref"
- introspectable="0"
- deprecated="1"
- deprecated-version="2.0">
- <doc xml:space="preserve">Adds a reference to an animation.</doc>
- <doc-deprecated xml:space="preserve">Use g_object_ref().</doc-deprecated>
- <return-value>
- <doc xml:space="preserve">The same as the @animation argument.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">An animation.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unref"
- c:identifier="gdk_pixbuf_animation_unref"
- introspectable="0"
- deprecated="1"
- deprecated-version="2.0">
- <doc xml:space="preserve">Removes a reference from an animation.</doc>
- <doc-deprecated xml:space="preserve">Use g_object_unref().</doc-deprecated>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">An animation.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <class name="PixbufAnimationIter"
- c:symbol-prefix="pixbuf_animation_iter"
- c:type="GdkPixbufAnimationIter"
- parent="GObject.Object"
- glib:type-name="GdkPixbufAnimationIter"
- glib:get-type="gdk_pixbuf_animation_iter_get_type">
- <doc xml:space="preserve">An opaque struct representing an iterator which points to a
- certain position in an animation.</doc>
- <method name="advance" c:identifier="gdk_pixbuf_animation_iter_advance">
- <doc xml:space="preserve">Possibly advances an animation to a new frame. Chooses the frame based
- on the start time passed to gdk_pixbuf_animation_get_iter().
- @current_time would normally come from g_get_current_time(), and
- must be greater than or equal to the time passed to
- gdk_pixbuf_animation_get_iter(), and must increase or remain
- unchanged each time gdk_pixbuf_animation_iter_get_pixbuf() is
- called. That is, you can't go backward in time; animations only
- play forward.
- As a shortcut, pass %NULL for the current time and g_get_current_time()
- will be invoked on your behalf. So you only need to explicitly pass
- @current_time if you're doing something odd like playing the animation
- at double speed.
- If this function returns %FALSE, there's no need to update the animation
- display, assuming the display had been rendered prior to advancing;
- if %TRUE, you need to call gdk_pixbuf_animation_iter_get_pixbuf()
- and update the display with the new pixbuf.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the image may need updating</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="iter" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufAnimationIter</doc>
- <type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
- </instance-parameter>
- <parameter name="current_time"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">current time</doc>
- <type name="GLib.TimeVal" c:type="const GTimeVal*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_delay_time"
- c:identifier="gdk_pixbuf_animation_iter_get_delay_time">
- <doc xml:space="preserve">Gets the number of milliseconds the current pixbuf should be displayed,
- or -1 if the current pixbuf should be displayed forever. g_timeout_add()
- conveniently takes a timeout in milliseconds, so you can use a timeout
- to schedule the next update.
- Note that some formats, like GIF, might clamp the timeout values in the
- image file to avoid updates that are just too quick. The minimum timeout
- for GIF images is currently 20 milliseconds.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">delay time in milliseconds (thousandths of a second)</doc>
- <type name="gint" c:type="int"/>
- </return-value>
- <parameters>
- <instance-parameter name="iter" transfer-ownership="none">
- <doc xml:space="preserve">an animation iterator</doc>
- <type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pixbuf"
- c:identifier="gdk_pixbuf_animation_iter_get_pixbuf">
- <doc xml:space="preserve">Gets the current pixbuf which should be displayed; the pixbuf might not
- be the same size as the animation itself
- (gdk_pixbuf_animation_get_width(), gdk_pixbuf_animation_get_height()).
- This pixbuf should be displayed for
- gdk_pixbuf_animation_iter_get_delay_time() milliseconds. The caller
- of this function does not own a reference to the returned pixbuf;
- the returned pixbuf will become invalid when the iterator advances
- to the next frame, which may happen anytime you call
- gdk_pixbuf_animation_iter_advance(). Copy the pixbuf to keep it
- (don't just add a reference), as it may get recycled as you advance
- the iterator.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the pixbuf to be displayed</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="iter" transfer-ownership="none">
- <doc xml:space="preserve">an animation iterator</doc>
- <type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="on_currently_loading_frame"
- c:identifier="gdk_pixbuf_animation_iter_on_currently_loading_frame">
- <doc xml:space="preserve">Used to determine how to respond to the area_updated signal on
- #GdkPixbufLoader when loading an animation. area_updated is emitted
- for an area of the frame currently streaming in to the loader. So if
- you're on the currently loading frame, you need to redraw the screen for
- the updated area.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the frame we're on is partially loaded, or the last frame</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="iter" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufAnimationIter</doc>
- <type name="PixbufAnimationIter" c:type="GdkPixbufAnimationIter*"/>
- </instance-parameter>
- </parameters>
- </method>
- </class>
- <callback name="PixbufDestroyNotify" c:type="GdkPixbufDestroyNotify">
- <doc xml:space="preserve">A function of this type is responsible for freeing the pixel array
- of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
- pass in a pre-allocated pixel array so that a pixbuf can be
- created from it; in this case you will need to pass in a function
- of #GdkPixbufDestroyNotify so that the pixel data can be freed
- when the pixbuf is finalized.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="pixels" transfer-ownership="none">
- <doc xml:space="preserve">The pixel array of the pixbuf
- that is being finalized.</doc>
- <array zero-terminated="0" c:type="guchar*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="1">
- <doc xml:space="preserve">User closure data.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <enumeration name="PixbufError"
- glib:type-name="GdkPixbufError"
- glib:get-type="gdk_pixbuf_error_get_type"
- c:type="GdkPixbufError"
- glib:error-domain="gdk-pixbuf-error-quark">
- <doc xml:space="preserve">An error code in the #GDK_PIXBUF_ERROR domain. Many gdk-pixbuf
- operations can cause errors in this domain, or in the #G_FILE_ERROR
- domain.</doc>
- <member name="corrupt_image"
- value="0"
- c:identifier="GDK_PIXBUF_ERROR_CORRUPT_IMAGE"
- glib:nick="corrupt-image">
- <doc xml:space="preserve">An image file was broken somehow.</doc>
- </member>
- <member name="insufficient_memory"
- value="1"
- c:identifier="GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY"
- glib:nick="insufficient-memory">
- <doc xml:space="preserve">Not enough memory.</doc>
- </member>
- <member name="bad_option"
- value="2"
- c:identifier="GDK_PIXBUF_ERROR_BAD_OPTION"
- glib:nick="bad-option">
- <doc xml:space="preserve">A bad option was passed to a pixbuf save module.</doc>
- </member>
- <member name="unknown_type"
- value="3"
- c:identifier="GDK_PIXBUF_ERROR_UNKNOWN_TYPE"
- glib:nick="unknown-type">
- <doc xml:space="preserve">Unknown image type.</doc>
- </member>
- <member name="unsupported_operation"
- value="4"
- c:identifier="GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION"
- glib:nick="unsupported-operation">
- <doc xml:space="preserve">Don't know how to perform the
- given operation on the type of image at hand.</doc>
- </member>
- <member name="failed"
- value="5"
- c:identifier="GDK_PIXBUF_ERROR_FAILED"
- glib:nick="failed">
- <doc xml:space="preserve">Generic failure code, something went wrong.</doc>
- </member>
- <member name="incomplete_animation"
- value="6"
- c:identifier="GDK_PIXBUF_ERROR_INCOMPLETE_ANIMATION"
- glib:nick="incomplete-animation">
- <doc xml:space="preserve">Only part of the animation was loaded.</doc>
- </member>
- <function name="quark" c:identifier="gdk_pixbuf_error_quark">
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </enumeration>
- <record name="PixbufFormat"
- c:type="GdkPixbufFormat"
- glib:type-name="GdkPixbufFormat"
- glib:get-type="gdk_pixbuf_format_get_type"
- c:symbol-prefix="pixbuf_format">
- <method name="copy" c:identifier="gdk_pixbuf_format_copy" version="2.22">
- <doc xml:space="preserve">Creates a copy of @format</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">the newly allocated copy of a #GdkPixbufFormat. Use
- gdk_pixbuf_format_free() to free the resources when done</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="const GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="free" c:identifier="gdk_pixbuf_format_free" version="2.22">
- <doc xml:space="preserve">Frees the resources allocated when copying a #GdkPixbufFormat
- using gdk_pixbuf_format_copy()</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_description"
- c:identifier="gdk_pixbuf_format_get_description"
- version="2.2">
- <doc xml:space="preserve">Returns a description of the format.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a description of the format.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extensions"
- c:identifier="gdk_pixbuf_format_get_extensions"
- version="2.2">
- <doc xml:space="preserve">Returns the filename extensions typically used for files in the
- given format.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a %NULL-terminated array of filename extensions which must be
- freed with g_strfreev() when it is no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_license"
- c:identifier="gdk_pixbuf_format_get_license"
- version="2.6">
- <doc xml:space="preserve">Returns information about the license of the image loader for the format. The
- returned string should be a shorthand for a wellknown license, e.g. "LGPL",
- "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license. This
- string should be freed with g_free() when it's no longer needed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a string describing the license of @format.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_mime_types"
- c:identifier="gdk_pixbuf_format_get_mime_types"
- version="2.2">
- <doc xml:space="preserve">Returns the mime types supported by the format.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a %NULL-terminated array of mime types which must be freed with
- g_strfreev() when it is no longer needed.</doc>
- <array c:type="gchar**">
- <type name="utf8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_name"
- c:identifier="gdk_pixbuf_format_get_name"
- version="2.2">
- <doc xml:space="preserve">Returns the name of the format.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">the name of the format.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_disabled"
- c:identifier="gdk_pixbuf_format_is_disabled"
- version="2.6">
- <doc xml:space="preserve">Returns whether this image format is disabled. See
- gdk_pixbuf_format_set_disabled().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether this image format is disabled.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_scalable"
- c:identifier="gdk_pixbuf_format_is_scalable"
- version="2.6">
- <doc xml:space="preserve">Returns whether this image format is scalable. If a file is in a
- scalable format, it is preferable to load it at the desired size,
- rather than loading it at the default size and scaling the
- resulting pixbuf to the desired size.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether this image format is scalable.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="is_writable"
- c:identifier="gdk_pixbuf_format_is_writable"
- version="2.2">
- <doc xml:space="preserve">Returns whether pixbufs can be saved in the given format.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">whether pixbufs can be saved in the given format.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_disabled"
- c:identifier="gdk_pixbuf_format_set_disabled"
- version="2.6">
- <doc xml:space="preserve">Disables or enables an image format. If a format is disabled,
- gdk-pixbuf won't use the image loader for this format to load
- images. Applications can use this to avoid using image loaders
- with an inappropriate license, see gdk_pixbuf_format_get_license().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="format" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufFormat</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </instance-parameter>
- <parameter name="disabled" transfer-ownership="none">
- <doc xml:space="preserve">%TRUE to disable the format @format</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <class name="PixbufLoader"
- c:symbol-prefix="pixbuf_loader"
- c:type="GdkPixbufLoader"
- parent="GObject.Object"
- glib:type-name="GdkPixbufLoader"
- glib:get-type="gdk_pixbuf_loader_get_type"
- glib:type-struct="PixbufLoaderClass">
- <doc xml:space="preserve">The GdkPixbufLoader struct contains only private
- fields.</doc>
- <constructor name="new" c:identifier="gdk_pixbuf_loader_new">
- <doc xml:space="preserve">Creates a new pixbuf loader object.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </return-value>
- </constructor>
- <constructor name="new_with_mime_type"
- c:identifier="gdk_pixbuf_loader_new_with_mime_type"
- version="2.4"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf loader object that always attempts to parse
- image data as if it were an image of mime type @mime_type, instead of
- identifying the type automatically. Useful if you want an error if
- the image isn't the expected mime type, for loading image formats
- that can't be reliably identified by looking at the data, or if
- the user manually forces a specific mime type.
- The list of supported mime types depends on what image loaders
- are installed, but typically "image/png", "image/jpeg", "image/gif",
- "image/tiff" and "image/x-xpixmap" are among the supported mime types.
- To obtain the full list of supported mime types, call
- gdk_pixbuf_format_get_mime_types() on each of the #GdkPixbufFormat
- structs returned by gdk_pixbuf_get_formats().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </return-value>
- <parameters>
- <parameter name="mime_type" transfer-ownership="none">
- <doc xml:space="preserve">the mime type to be loaded</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <constructor name="new_with_type"
- c:identifier="gdk_pixbuf_loader_new_with_type"
- throws="1">
- <doc xml:space="preserve">Creates a new pixbuf loader object that always attempts to parse
- image data as if it were an image of type @image_type, instead of
- identifying the type automatically. Useful if you want an error if
- the image isn't the expected type, for loading image formats
- that can't be reliably identified by looking at the data, or if
- the user manually forces a specific type.
- The list of supported image formats depends on what image loaders
- are installed, but typically "png", "jpeg", "gif", "tiff" and
- "xpm" are among the supported formats. To obtain the full list of
- supported image formats, call gdk_pixbuf_format_get_name() on each
- of the #GdkPixbufFormat structs returned by gdk_pixbuf_get_formats().</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly-created pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </return-value>
- <parameters>
- <parameter name="image_type" transfer-ownership="none">
- <doc xml:space="preserve">name of the image format to be loaded with the image</doc>
- <type name="utf8" c:type="const char*"/>
- </parameter>
- </parameters>
- </constructor>
- <virtual-method name="area_prepared">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="area_updated">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- <parameter name="x" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="closed">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="size_prepared">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="close" c:identifier="gdk_pixbuf_loader_close" throws="1">
- <doc xml:space="preserve">Informs a pixbuf loader that no further writes with
- gdk_pixbuf_loader_write() will occur, so that it can free its
- internal loading structures. Also, tries to parse any data that
- hasn't yet been parsed; if the remaining data is partial or
- corrupt, an error will be returned. If %FALSE is returned, @error
- will be set to an error from the #GDK_PIXBUF_ERROR or #G_FILE_ERROR
- domains. If you're just cancelling a load rather than expecting it
- to be finished, passing %NULL for @error to ignore it is
- reasonable.
- Remember that this does not unref the loader, so if you plan not to
- use it anymore, please g_object_unref() it.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if all image data written so far was successfully
- passed out via the update_area signal</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_animation"
- c:identifier="gdk_pixbuf_loader_get_animation">
- <doc xml:space="preserve">Queries the #GdkPixbufAnimation that a pixbuf loader is currently creating.
- In general it only makes sense to call this function after the "area-prepared"
- signal has been emitted by the loader. If the loader doesn't have enough
- bytes yet (hasn't emitted the "area-prepared" signal) this function will
- return %NULL.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The #GdkPixbufAnimation that the loader is loading, or %NULL if
- not enough data has been read to determine the information.</doc>
- <type name="PixbufAnimation" c:type="GdkPixbufAnimation*"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_format"
- c:identifier="gdk_pixbuf_loader_get_format"
- version="2.2">
- <doc xml:space="preserve">Obtains the available information about the format of the
- currently loading image file.</doc>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve">A #GdkPixbufFormat or
- %NULL. The return value is owned by GdkPixbuf and should not be
- freed.</doc>
- <type name="PixbufFormat" c:type="GdkPixbufFormat*"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_pixbuf" c:identifier="gdk_pixbuf_loader_get_pixbuf">
- <doc xml:space="preserve">Queries the #GdkPixbuf that a pixbuf loader is currently creating.
- In general it only makes sense to call this function after the
- "area-prepared" signal has been emitted by the loader; this means
- that enough data has been read to know the size of the image that
- will be allocated. If the loader has not received enough data via
- gdk_pixbuf_loader_write(), then this function returns %NULL. The
- returned pixbuf will be the same in all future calls to the loader,
- so simply calling g_object_ref() should be sufficient to continue
- using it. Additionally, if the loader is an animation, it will
- return the "static image" of the animation
- (see gdk_pixbuf_animation_get_static_image()).</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The #GdkPixbuf that the loader is creating, or %NULL if not
- enough data has been read to determine how to create the image buffer.</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_size"
- c:identifier="gdk_pixbuf_loader_set_size"
- version="2.2">
- <doc xml:space="preserve">Causes the image to be scaled while it is loaded. The desired
- image size can be determined relative to the original size of
- the image by calling gdk_pixbuf_loader_set_size() from a
- signal handler for the ::size-prepared signal.
- Attempts to set the desired image size are ignored after the
- emission of the ::size-prepared signal.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">The desired width of the image being loaded.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">The desired height of the image being loaded.</doc>
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </method>
- <method name="write" c:identifier="gdk_pixbuf_loader_write" throws="1">
- <doc xml:space="preserve">This will cause a pixbuf loader to parse the next @count bytes of
- an image. It will return %TRUE if the data was loaded successfully,
- and %FALSE if an error occurred. In the latter case, the loader
- will be closed, and will not accept further writes. If %FALSE is
- returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
- or #G_FILE_ERROR domains.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the write was successful, or %FALSE if the loader
- cannot parse the buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve">Pointer to image data.</doc>
- <array length="1" zero-terminated="0" c:type="guchar*">
- <type name="guint8" c:type="guchar"/>
- </array>
- </parameter>
- <parameter name="count" transfer-ownership="none">
- <doc xml:space="preserve">Length of the @buf buffer in bytes.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </method>
- <method name="write_bytes"
- c:identifier="gdk_pixbuf_loader_write_bytes"
- version="2.30"
- throws="1">
- <doc xml:space="preserve">This will cause a pixbuf loader to parse a buffer inside a #GBytes
- for an image. It will return %TRUE if the data was loaded successfully,
- and %FALSE if an error occurred. In the latter case, the loader
- will be closed, and will not accept further writes. If %FALSE is
- returned, @error will be set to an error from the #GDK_PIXBUF_ERROR
- or #G_FILE_ERROR domains.
- See also: gdk_pixbuf_loader_write()</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the write was successful, or %FALSE if the loader
- cannot parse the buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="loader" transfer-ownership="none">
- <doc xml:space="preserve">A pixbuf loader.</doc>
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">The image data as a #GBytes</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </parameter>
- </parameters>
- </method>
- <field name="parent_instance">
- <type name="GObject.Object" c:type="GObject"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="gpointer" c:type="gpointer"/>
- </field>
- <glib:signal name="area-prepared" when="last">
- <doc xml:space="preserve">This signal is emitted when the pixbuf loader has allocated the
- pixbuf in the desired size. After this signal is emitted,
- applications can call gdk_pixbuf_loader_get_pixbuf() to fetch
- the partially-loaded pixbuf.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="area-updated" when="last">
- <doc xml:space="preserve">This signal is emitted when a significant area of the image being
- loaded has been updated. Normally it means that a complete
- scanline has been read in, but it could be a different area as
- well. Applications can use this signal to know when to repaint
- areas of an image that is being loaded.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="x" transfer-ownership="none">
- <doc xml:space="preserve">X offset of upper-left corner of the updated area.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <doc xml:space="preserve">Y offset of upper-left corner of the updated area.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">Width of updated area.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">Height of updated area.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </glib:signal>
- <glib:signal name="closed" when="last">
- <doc xml:space="preserve">This signal is emitted when gdk_pixbuf_loader_close() is called.
- It can be used by different parts of an application to receive
- notification when an image loader is closed by the code that
- drives it.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- </glib:signal>
- <glib:signal name="size-prepared" when="last">
- <doc xml:space="preserve">This signal is emitted when the pixbuf loader has been fed the
- initial amount of data that is required to figure out the size
- of the image that it will create. Applications can call
- gdk_pixbuf_loader_set_size() in response to this signal to set
- the desired size to which the image should be scaled.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">the original width of the image</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">the original height of the image</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </glib:signal>
- </class>
- <record name="PixbufLoaderClass"
- c:type="GdkPixbufLoaderClass"
- glib:is-gtype-struct-for="PixbufLoader">
- <field name="parent_class">
- <type name="GObject.ObjectClass" c:type="GObjectClass"/>
- </field>
- <field name="size_prepared">
- <callback name="size_prepared">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="area_prepared">
- <callback name="area_prepared">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="area_updated">
- <callback name="area_updated">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </parameter>
- <parameter name="x" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="y" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="width" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <type name="gint" c:type="int"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="closed">
- <callback name="closed">
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="loader" transfer-ownership="none">
- <type name="PixbufLoader" c:type="GdkPixbufLoader*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- </record>
- <enumeration name="PixbufRotation"
- glib:type-name="GdkPixbufRotation"
- glib:get-type="gdk_pixbuf_rotation_get_type"
- c:type="GdkPixbufRotation">
- <doc xml:space="preserve">The possible rotations which can be passed to gdk_pixbuf_rotate_simple().
- To make them easier to use, their numerical values are the actual degrees.</doc>
- <member name="none"
- value="0"
- c:identifier="GDK_PIXBUF_ROTATE_NONE"
- glib:nick="none">
- <doc xml:space="preserve">No rotation.</doc>
- </member>
- <member name="counterclockwise"
- value="90"
- c:identifier="GDK_PIXBUF_ROTATE_COUNTERCLOCKWISE"
- glib:nick="counterclockwise">
- <doc xml:space="preserve">Rotate by 90 degrees.</doc>
- </member>
- <member name="upsidedown"
- value="180"
- c:identifier="GDK_PIXBUF_ROTATE_UPSIDEDOWN"
- glib:nick="upsidedown">
- <doc xml:space="preserve">Rotate by 180 degrees.</doc>
- </member>
- <member name="clockwise"
- value="270"
- c:identifier="GDK_PIXBUF_ROTATE_CLOCKWISE"
- glib:nick="clockwise">
- <doc xml:space="preserve">Rotate by 270 degrees.</doc>
- </member>
- </enumeration>
- <callback name="PixbufSaveFunc" c:type="GdkPixbufSaveFunc" version="2.4">
- <doc xml:space="preserve">Specifies the type of the function passed to
- gdk_pixbuf_save_to_callback(). It is called once for each block of
- bytes that is "written" by gdk_pixbuf_save_to_callback(). If
- successful it should return %TRUE. If an error occurs it should set
- @error and return %FALSE, in which case gdk_pixbuf_save_to_callback()
- will fail with the same error.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if successful, %FALSE (with @error set) if failed.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buf" transfer-ownership="none">
- <doc xml:space="preserve">bytes to be written.</doc>
- <array length="1" zero-terminated="0" c:type="gchar*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="count" transfer-ownership="none">
- <doc xml:space="preserve">number of bytes in @buf.</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- <parameter name="error"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">A location to return an error.</doc>
- <type name="GLib.Error" c:type="GError**"/>
- </parameter>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1"
- closure="3">
- <doc xml:space="preserve">user data passed to gdk_pixbuf_save_to_callback().</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- </parameters>
- </callback>
- <class name="PixbufSimpleAnim"
- c:symbol-prefix="pixbuf_simple_anim"
- c:type="GdkPixbufSimpleAnim"
- parent="PixbufAnimation"
- glib:type-name="GdkPixbufSimpleAnim"
- glib:get-type="gdk_pixbuf_simple_anim_get_type"
- glib:type-struct="PixbufSimpleAnimClass">
- <doc xml:space="preserve">An opaque struct representing a simple animation.</doc>
- <constructor name="new"
- c:identifier="gdk_pixbuf_simple_anim_new"
- version="2.8">
- <doc xml:space="preserve">Creates a new, empty animation.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a newly allocated #GdkPixbufSimpleAnim</doc>
- <type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
- </return-value>
- <parameters>
- <parameter name="width" transfer-ownership="none">
- <doc xml:space="preserve">the width of the animation</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="height" transfer-ownership="none">
- <doc xml:space="preserve">the height of the animation</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="rate" transfer-ownership="none">
- <doc xml:space="preserve">the speed of the animation, in frames per second</doc>
- <type name="gfloat" c:type="gfloat"/>
- </parameter>
- </parameters>
- </constructor>
- <method name="add_frame"
- c:identifier="gdk_pixbuf_simple_anim_add_frame"
- version="2.8">
- <doc xml:space="preserve">Adds a new frame to @animation. The @pixbuf must
- have the dimensions specified when the animation
- was constructed.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
- <type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
- </instance-parameter>
- <parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">the pixbuf to add</doc>
- <type name="Pixbuf" c:type="GdkPixbuf*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_loop"
- c:identifier="gdk_pixbuf_simple_anim_get_loop"
- version="2.18">
- <doc xml:space="preserve">Gets whether @animation should loop indefinitely when it reaches the end.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the animation loops forever, %FALSE otherwise</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
- <type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_loop"
- c:identifier="gdk_pixbuf_simple_anim_set_loop"
- version="2.18">
- <doc xml:space="preserve">Sets whether @animation should loop indefinitely when it reaches the end.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="animation" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixbufSimpleAnim</doc>
- <type name="PixbufSimpleAnim" c:type="GdkPixbufSimpleAnim*"/>
- </instance-parameter>
- <parameter name="loop" transfer-ownership="none">
- <doc xml:space="preserve">whether to loop the animation</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <property name="loop"
- version="2.18"
- writable="1"
- transfer-ownership="none">
- <doc xml:space="preserve">Whether the animation should loop when it reaches the end.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- </class>
- <record name="PixbufSimpleAnimClass"
- c:type="GdkPixbufSimpleAnimClass"
- disguised="1"
- glib:is-gtype-struct-for="PixbufSimpleAnim">
- </record>
- <class name="PixbufSimpleAnimIter"
- c:symbol-prefix="pixbuf_simple_anim_iter"
- parent="PixbufAnimationIter"
- glib:type-name="GdkPixbufSimpleAnimIter"
- glib:get-type="gdk_pixbuf_simple_anim_iter_get_type">
- </class>
- <record name="Pixdata" c:type="GdkPixdata">
- <doc xml:space="preserve">A #GdkPixdata contains pixbuf information in a form suitable for
- serialization and streaming.</doc>
- <field name="magic" writable="1">
- <doc xml:space="preserve">magic number. A valid #GdkPixdata structure must have
- #GDK_PIXBUF_MAGIC_NUMBER here.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="length" writable="1">
- <doc xml:space="preserve">less than 1 to disable length checks, otherwise
- #GDK_PIXDATA_HEADER_LENGTH + length of @pixel_data.</doc>
- <type name="gint32" c:type="gint32"/>
- </field>
- <field name="pixdata_type" writable="1">
- <doc xml:space="preserve">information about colorspace, sample width and
- encoding, in a #GdkPixdataType.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="rowstride" writable="1">
- <doc xml:space="preserve">Distance in bytes between rows.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="width" writable="1">
- <doc xml:space="preserve">Width of the image in pixels.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="height" writable="1">
- <doc xml:space="preserve">Height of the image in pixels.</doc>
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="pixel_data" writable="1">
- <doc xml:space="preserve">@width x @height pixels, encoded according to @pixdata_type
- and @rowstride.</doc>
- <array zero-terminated="0" c:type="guint8*">
- <type name="guint8"/>
- </array>
- </field>
- <method name="deserialize"
- c:identifier="gdk_pixdata_deserialize"
- deprecated="1"
- deprecated-version="2.32"
- throws="1">
- <doc xml:space="preserve">Deserializes (reconstruct) a #GdkPixdata structure from a byte stream.
- The byte stream consists of a straightforward writeout of the
- #GdkPixdata fields in network byte order, plus the @pixel_data
- bytes the structure points to.
- The @pixdata contents are reconstructed byte by byte and are checked
- for validity. This function may fail with %GDK_PIXBUF_ERROR_CORRUPT_IMAGE
- or %GDK_PIXBUF_ERROR_UNKNOWN_TYPE.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">Upon successful deserialization %TRUE is returned,
- %FALSE otherwise.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixdata" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixdata structure to be filled in.</doc>
- <type name="Pixdata" c:type="GdkPixdata*"/>
- </instance-parameter>
- <parameter name="stream_length" transfer-ownership="none">
- <doc xml:space="preserve">length of the stream used for deserialization.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="stream" transfer-ownership="none">
- <doc xml:space="preserve">stream of bytes containing a
- serialized #GdkPixdata structure.</doc>
- <array length="0" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="from_pixbuf"
- c:identifier="gdk_pixdata_from_pixbuf"
- introspectable="0"
- deprecated="1"
- deprecated-version="2.32">
- <doc xml:space="preserve">Converts a #GdkPixbuf to a #GdkPixdata. If @use_rle is %TRUE, the
- pixel data is run-length encoded into newly-allocated memory and a
- pointer to that memory is returned.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="none" nullable="1">
- <doc xml:space="preserve">If @use_rle is %TRUE, a pointer to the
- newly-allocated memory for the run-length encoded pixel data,
- otherwise %NULL.</doc>
- <type name="gpointer" c:type="gpointer"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixdata" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixdata to fill.</doc>
- <type name="Pixdata" c:type="GdkPixdata*"/>
- </instance-parameter>
- <parameter name="pixbuf" transfer-ownership="none">
- <doc xml:space="preserve">the data to fill @pixdata with.</doc>
- <type name="Pixbuf" c:type="const GdkPixbuf*"/>
- </parameter>
- <parameter name="use_rle" transfer-ownership="none">
- <doc xml:space="preserve">whether to use run-length encoding for the pixel data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="serialize"
- c:identifier="gdk_pixdata_serialize"
- deprecated="1"
- deprecated-version="2.32">
- <doc xml:space="preserve">Serializes a #GdkPixdata structure into a byte stream.
- The byte stream consists of a straightforward writeout of the
- #GdkPixdata fields in network byte order, plus the @pixel_data
- bytes the structure points to.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A
- newly-allocated string containing the serialized #GdkPixdata
- structure.</doc>
- <array length="0" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="pixdata" transfer-ownership="none">
- <doc xml:space="preserve">a valid #GdkPixdata structure to serialize.</doc>
- <type name="Pixdata" c:type="const GdkPixdata*"/>
- </instance-parameter>
- <parameter name="stream_length_p"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location to store the resulting stream length in.</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="to_csource"
- c:identifier="gdk_pixdata_to_csource"
- deprecated="1"
- deprecated-version="2.32">
- <doc xml:space="preserve">Generates C source code suitable for compiling images directly
- into programs.
- gdk-pixbuf ships with a program called
- [gdk-pixbuf-csource][gdk-pixbuf-csource], which offers a command
- line interface to this function.</doc>
- <doc-deprecated xml:space="preserve">Use #GResource instead.</doc-deprecated>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a newly-allocated string containing the C source form
- of @pixdata.</doc>
- <type name="GLib.String" c:type="GString*"/>
- </return-value>
- <parameters>
- <instance-parameter name="pixdata" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixdata to convert to C source.</doc>
- <type name="Pixdata" c:type="GdkPixdata*"/>
- </instance-parameter>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve">used for naming generated data structures or macros.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dump_type" transfer-ownership="none">
- <doc xml:space="preserve">a #GdkPixdataDumpType determining the kind of C
- source to be generated.</doc>
- <type name="PixdataDumpType" c:type="GdkPixdataDumpType"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <bitfield name="PixdataDumpType" c:type="GdkPixdataDumpType">
- <doc xml:space="preserve">An enumeration which is used by gdk_pixdata_to_csource() to
- determine the form of C source to be generated. The three values
- @GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT
- and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are
- @GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining
- elements are optional flags that can be freely added.</doc>
- <member name="pixdata_stream"
- value="0"
- c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STREAM">
- <doc xml:space="preserve">Generate pixbuf data stream (a single
- string containing a serialized #GdkPixdata structure in network byte
- order).</doc>
- </member>
- <member name="pixdata_struct"
- value="1"
- c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STRUCT">
- <doc xml:space="preserve">Generate #GdkPixdata structure (needs
- the #GdkPixdata structure definition from gdk-pixdata.h).</doc>
- </member>
- <member name="macros" value="2" c:identifier="GDK_PIXDATA_DUMP_MACROS">
- <doc xml:space="preserve">Generate <function>*_ROWSTRIDE</function>,
- <function>*_WIDTH</function>, <function>*_HEIGHT</function>,
- <function>*_BYTES_PER_PIXEL</function> and
- <function>*_RLE_PIXEL_DATA</function> or <function>*_PIXEL_DATA</function>
- macro definitions for the image.</doc>
- </member>
- <member name="gtypes" value="0" c:identifier="GDK_PIXDATA_DUMP_GTYPES">
- <doc xml:space="preserve">Generate GLib data types instead of
- standard C data types.</doc>
- </member>
- <member name="ctypes" value="256" c:identifier="GDK_PIXDATA_DUMP_CTYPES">
- <doc xml:space="preserve">Generate standard C data types instead of
- GLib data types.</doc>
- </member>
- <member name="static" value="512" c:identifier="GDK_PIXDATA_DUMP_STATIC">
- <doc xml:space="preserve">Generate static symbols.</doc>
- </member>
- <member name="const" value="1024" c:identifier="GDK_PIXDATA_DUMP_CONST">
- <doc xml:space="preserve">Generate const symbols.</doc>
- </member>
- <member name="rle_decoder"
- value="65536"
- c:identifier="GDK_PIXDATA_DUMP_RLE_DECODER">
- <doc xml:space="preserve">Provide a <function>*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)</function>
- macro definition to decode run-length encoded image data.</doc>
- </member>
- </bitfield>
- <bitfield name="PixdataType" c:type="GdkPixdataType">
- <doc xml:space="preserve">An enumeration containing three sets of flags for a #GdkPixdata struct:
- one for the used colorspace, one for the width of the samples and one
- for the encoding of the pixel data.</doc>
- <member name="color_type_rgb"
- value="1"
- c:identifier="GDK_PIXDATA_COLOR_TYPE_RGB">
- <doc xml:space="preserve">each pixel has red, green and blue samples.</doc>
- </member>
- <member name="color_type_rgba"
- value="2"
- c:identifier="GDK_PIXDATA_COLOR_TYPE_RGBA">
- <doc xml:space="preserve">each pixel has red, green and blue samples
- and an alpha value.</doc>
- </member>
- <member name="color_type_mask"
- value="255"
- c:identifier="GDK_PIXDATA_COLOR_TYPE_MASK">
- <doc xml:space="preserve">mask for the colortype flags of the enum.</doc>
- </member>
- <member name="sample_width_8"
- value="65536"
- c:identifier="GDK_PIXDATA_SAMPLE_WIDTH_8">
- <doc xml:space="preserve">each sample has 8 bits.</doc>
- </member>
- <member name="sample_width_mask"
- value="983040"
- c:identifier="GDK_PIXDATA_SAMPLE_WIDTH_MASK">
- <doc xml:space="preserve">mask for the sample width flags of the enum.</doc>
- </member>
- <member name="encoding_raw"
- value="16777216"
- c:identifier="GDK_PIXDATA_ENCODING_RAW">
- <doc xml:space="preserve">the pixel data is in raw form.</doc>
- </member>
- <member name="encoding_rle"
- value="33554432"
- c:identifier="GDK_PIXDATA_ENCODING_RLE">
- <doc xml:space="preserve">the pixel data is run-length encoded. Runs may
- be up to 127 bytes long; their length is stored in a single byte
- preceding the pixel data for the run. If a run is constant, its length
- byte has the high bit set and the pixel data consists of a single pixel
- which must be repeated.</doc>
- </member>
- <member name="encoding_mask"
- value="251658240"
- c:identifier="GDK_PIXDATA_ENCODING_MASK">
- <doc xml:space="preserve">mask for the encoding flags of the enum.</doc>
- </member>
- </bitfield>
- <function name="pixbuf_error_quark"
- c:identifier="gdk_pixbuf_error_quark"
- moved-to="PixbufError.quark">
- <return-value transfer-ownership="none">
- <type name="GLib.Quark" c:type="GQuark"/>
- </return-value>
- </function>
- </namespace>
- </repository>
|